-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #116 from jakejustus/Dev
ClassDocumentation for 11.5+
- Loading branch information
Showing
13 changed files
with
305 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
241 changes: 241 additions & 0 deletions
241
src/java/eu/rssw/pct/oedoc/OpenEdgeDocumentation115.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,241 @@ | ||
| /* | ||
| * The Apache Software License, Version 1.1 | ||
| * | ||
| * Copyright (c) 2002 The Apache Software Foundation. All rights | ||
| * reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions | ||
| * are met: | ||
| * | ||
| * 1. Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * | ||
| * 2. Redistributions in binary form must reproduce the above copyright | ||
| * notice, this list of conditions and the following disclaimer in | ||
| * the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * | ||
| * 3. The end-user documentation included with the redistribution, if | ||
| * any, must include the following acknowlegement: | ||
| * "This product includes software developed by the | ||
| * Apache Software Foundation (http://www.apache.org/)." | ||
| * Alternately, this acknowlegement may appear in the software itself, | ||
| * if and wherever such third-party acknowlegements normally appear. | ||
| * | ||
| * 4. The names "Ant" and "Apache Software | ||
| * Foundation" must not be used to endorse or promote products derived | ||
| * from this software without prior written permission. For written | ||
| * permission, please contact [email protected]. | ||
| * | ||
| * 5. Products derived from this software may not be called "Apache" | ||
| * nor may "Apache" appear in their names without prior written | ||
| * permission of the Apache Group. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED | ||
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | ||
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR | ||
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF | ||
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT | ||
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
| * SUCH DAMAGE. | ||
| * ==================================================================== | ||
| * | ||
| * This software consists of voluntary contributions made by many | ||
| * individuals on behalf of the Apache Software Foundation. For more | ||
| * information on the Apache Software Foundation, please see | ||
| * <http://www.apache.org/>. | ||
| */ | ||
| package eu.rssw.pct.oedoc; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import javax.xml.bind.JAXBException; | ||
|
|
||
| import org.apache.tools.ant.BuildException; | ||
| import org.apache.tools.ant.Project; | ||
| import org.apache.tools.ant.types.FileSet; | ||
| import org.apache.tools.ant.types.Path; | ||
| import org.eclipse.core.runtime.IProgressMonitor; | ||
| import org.eclipse.core.runtime.NullProgressMonitor; | ||
|
|
||
| import com.openedge.core.runtime.IPropath; | ||
| import com.openedge.core.runtime.Propath; | ||
| import com.openedge.pdt.core.ast.ASTManager; | ||
| import com.openedge.pdt.core.ast.ASTNode; | ||
| import com.openedge.pdt.core.ast.IASTManager; | ||
| import com.openedge.pdt.core.ast.PropathASTContext; | ||
| import com.openedge.pdt.core.ast.model.IASTContext; | ||
| import com.openedge.pdt.core.ast.model.IASTNode; | ||
| import com.openedge.pdt.core.ast.model.ICompilationUnit; | ||
| import com.phenix.pct.Messages; | ||
| import com.phenix.pct.PCT; | ||
|
|
||
| /** | ||
| * Class for generating XML documentation from OpenEdge classes | ||
| * | ||
| * @author <a href="mailto:[email protected]">Gilles QUERRET </a> | ||
| */ | ||
| public class OpenEdgeDocumentation115 extends PCT { | ||
| private File destDir = null; | ||
| private String encoding = null; | ||
| private List<FileSet> filesets = new ArrayList<FileSet>(); | ||
| protected Path propath = null; | ||
|
|
||
| public OpenEdgeDocumentation115() { | ||
| super(); | ||
| createPropath(); | ||
| } | ||
|
|
||
| /** | ||
| * Adds a set of files to archive. | ||
| * | ||
| * @param set FileSet | ||
| */ | ||
| public void addFileset(FileSet set) { | ||
| filesets.add(set); | ||
| } | ||
|
|
||
| /** | ||
| * Build dir | ||
| * | ||
| * @param dir Directory | ||
| */ | ||
| public void setBuildDir(File dir) { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Destination directory | ||
| * | ||
| * @param destFile Directory | ||
| */ | ||
| public void setDestDir(File dir) { | ||
| this.destDir = dir; | ||
| } | ||
|
|
||
| /** | ||
| * Codepage to use when reading files | ||
| * | ||
| * @param encoding String | ||
| */ | ||
| public void setEncoding(String encoding) { | ||
| this.encoding = encoding; | ||
| } | ||
|
|
||
| /** | ||
| * Set the propath to be used when running the procedure | ||
| * | ||
| * @param propath an Ant Path object containing the propath | ||
| */ | ||
| public void addPropath(Path propath) { | ||
| createPropath().append(propath); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new Path instance | ||
| * | ||
| * @return Path | ||
| */ | ||
| public Path createPropath() { | ||
| if (this.propath == null) { | ||
| this.propath = new Path(this.getProject()); | ||
| } | ||
|
|
||
| return this.propath; | ||
| } | ||
|
|
||
| /** | ||
| * Do the work | ||
| * | ||
| * @throws BuildException Something went wrong | ||
| */ | ||
| public void execute() throws BuildException { | ||
| checkDlcHome(); | ||
|
|
||
| // Destination directory must exist | ||
| if (this.destDir == null) { | ||
| throw new BuildException(Messages.getString("OpenEdgeClassDocumentation.0")); | ||
| } | ||
| // There must be at least one fileset | ||
| if (this.filesets.size() == 0) { | ||
| throw new BuildException(Messages.getString("OpenEdgeClassDocumentation.1")); | ||
| } | ||
| IPropath pp = new Propath(new org.eclipse.core.runtime.Path(getProject().getBaseDir().getAbsolutePath()), propath.list()); | ||
| IASTContext astContext = new PropathASTContext(pp); | ||
| IProgressMonitor monitor = new NullProgressMonitor(); | ||
| IASTManager astMgr = ASTManager.getASTManager(); | ||
|
|
||
| log("Generating XML documentation (11.5+ method)", Project.MSG_INFO); | ||
| try { | ||
| for (FileSet fs : filesets) { | ||
| // And get files from fileset | ||
| String[] dsfiles = fs.getDirectoryScanner(this.getProject()).getIncludedFiles(); | ||
|
|
||
| for (int i = 0; i < dsfiles.length; i++) { | ||
| File file = new File(fs.getDir(this.getProject()), dsfiles[i]); | ||
| log("Generating AST for " + file.getAbsolutePath(), Project.MSG_VERBOSE); | ||
| int extPos = file.getName().lastIndexOf('.'); | ||
| String ext = file.getName().substring(extPos); | ||
| boolean isClass = ".cls".equalsIgnoreCase(ext); | ||
|
|
||
| ICompilationUnit root = astMgr.createAST(file, astContext, monitor, IASTManager.EXPAND_ON, IASTManager.DLEVEL_FULL); | ||
| if (isClass) { | ||
| ClassDocumentationVisitor visitor = new ClassDocumentationVisitor(); | ||
| log("Executing AST ClassVisitor " + file.getAbsolutePath(), Project.MSG_VERBOSE); | ||
| root.accept(visitor); | ||
| if (visitor.getPackageName().length() == 0) | ||
| visitor.toXML(new File(destDir, visitor.getClassName() + ".xml")); | ||
| else | ||
| visitor.toXML(new File(destDir, visitor.getPackageName() + "." | ||
| + visitor.getClassName() + ".xml")); | ||
| } else { | ||
| ProcedureDocumentationVisitor visitor = new ProcedureDocumentationVisitor(); | ||
| log("Executing AST ProcedureVisitor " + file.getAbsolutePath(), Project.MSG_VERBOSE); | ||
| root.accept(visitor); | ||
| File destFile = new File(destDir, dsfiles[i] + ".xml"); | ||
| destFile.getParentFile().mkdirs(); | ||
| visitor.toXML(destFile); | ||
| } | ||
| } | ||
| } | ||
| } catch (IOException caught) { | ||
| throw new BuildException(caught); | ||
| } catch (JAXBException caught) { | ||
| throw new BuildException(caught); | ||
| } | ||
| } | ||
|
|
||
| public static void setSourceRange(ASTNode node) { | ||
| if (node instanceof ICompilationUnit) { | ||
| node.setStartPosition(1); | ||
| } | ||
|
|
||
| if ((node.getFirstChild1() == null) || (node.getType() == 22)) { | ||
| node.setStartPosition(node.getTokenStart()); | ||
| node.setLength(node.getTokenLength()); | ||
| } | ||
|
|
||
| IASTNode prev = null; | ||
| for (IASTNode child = node.getFirstChild1(); child != null; child = child.getNextSibling1()) { | ||
| ((ASTNode) child).setParent(node); | ||
| if (prev != null) { | ||
| ((ASTNode) child).setPrevSibling(prev); | ||
| } | ||
| prev = child; | ||
|
|
||
| if (child.getType() != 22) { | ||
| setSourceRange((ASTNode) child); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.