From d36c8e323a6f8df998edd185de8972dc5e6f87f0 Mon Sep 17 00:00:00 2001 From: jsdelfino Date: Mon, 16 Nov 2009 06:37:38 +0000 Subject: Cleaning up SVN structure, moving tag under sca-cpp/tags. git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@880619 13f79535-47bb-0310-9956-ffa450edef68 --- .../tuscany/sca/cpp/tools/common/BodyPart.html | 396 ++++++++++++++ .../tuscany/sca/cpp/tools/common/CParsingTool.html | 389 ++++++++++++++ .../sca/cpp/tools/common/Configuration.html | 373 +++++++++++++ .../sca/cpp/tools/common/DirectoryTree.html | 289 ++++++++++ .../tuscany/sca/cpp/tools/common/FileActor.html | 231 ++++++++ .../tuscany/sca/cpp/tools/common/FilePart.html | 538 +++++++++++++++++++ .../tuscany/sca/cpp/tools/common/Headers.html | 403 ++++++++++++++ .../sca/cpp/tools/common/InputCppSourceCode.html | 297 +++++++++++ .../tuscany/sca/cpp/tools/common/MethodPart.html | 307 +++++++++++ .../tuscany/sca/cpp/tools/common/Options.html | 294 +++++++++++ .../tuscany/sca/cpp/tools/common/Parameter.html | 392 ++++++++++++++ .../sca/cpp/tools/common/ParsingException.html | 284 ++++++++++ .../sca/cpp/tools/common/PrototypePart.html | 309 +++++++++++ .../tuscany/sca/cpp/tools/common/Signature.html | 584 +++++++++++++++++++++ .../apache/tuscany/sca/cpp/tools/common/Utils.html | 411 +++++++++++++++ .../sca/cpp/tools/common/class-use/BodyPart.html | 177 +++++++ .../cpp/tools/common/class-use/CParsingTool.html | 186 +++++++ .../cpp/tools/common/class-use/Configuration.html | 138 +++++ .../cpp/tools/common/class-use/DirectoryTree.html | 138 +++++ .../sca/cpp/tools/common/class-use/FileActor.html | 256 +++++++++ .../sca/cpp/tools/common/class-use/FilePart.html | 184 +++++++ .../sca/cpp/tools/common/class-use/Headers.html | 192 +++++++ .../tools/common/class-use/InputCppSourceCode.html | 138 +++++ .../sca/cpp/tools/common/class-use/MethodPart.html | 138 +++++ .../sca/cpp/tools/common/class-use/Options.html | 138 +++++ .../sca/cpp/tools/common/class-use/Parameter.html | 192 +++++++ .../tools/common/class-use/ParsingException.html | 196 +++++++ .../cpp/tools/common/class-use/PrototypePart.html | 138 +++++ .../sca/cpp/tools/common/class-use/Signature.html | 208 ++++++++ .../sca/cpp/tools/common/class-use/Utils.html | 138 +++++ .../sca/cpp/tools/common/package-frame.html | 78 +++ .../sca/cpp/tools/common/package-summary.html | 273 ++++++++++ .../tuscany/sca/cpp/tools/common/package-tree.html | 162 ++++++ .../tuscany/sca/cpp/tools/common/package-use.html | 231 ++++++++ .../tools/services/ComponentDomNodeHandler.html | 303 +++++++++++ .../tools/services/ComponentTypeFileHandler.html | 299 +++++++++++ .../sca/cpp/tools/services/DirectoryScanner.html | 271 ++++++++++ .../tuscany/sca/cpp/tools/services/DomHandler.html | 341 ++++++++++++ .../sca/cpp/tools/services/DomNodeHandler.html | 262 +++++++++ .../cpp/tools/services/GenericDomNodeHandler.html | 396 ++++++++++++++ .../sca/cpp/tools/services/LittleClass.html | 231 ++++++++ .../services/ModuleOrFragmentFileHandler.html | 258 +++++++++ .../tools/services/ReferenceDomNodeHandler.html | 311 +++++++++++ .../tuscany/sca/cpp/tools/services/Scagen.html | 344 ++++++++++++ .../cpp/tools/services/ServiceDomNodeHandler.html | 305 +++++++++++ .../sca/cpp/tools/services/ServicesGenerator.html | 312 +++++++++++ .../sca/cpp/tools/services/XMLFileActor.html | 469 +++++++++++++++++ .../class-use/ComponentDomNodeHandler.html | 138 +++++ .../class-use/ComponentTypeFileHandler.html | 138 +++++ .../tools/services/class-use/DirectoryScanner.html | 138 +++++ .../cpp/tools/services/class-use/DomHandler.html | 138 +++++ .../tools/services/class-use/DomNodeHandler.html | 212 ++++++++ .../services/class-use/GenericDomNodeHandler.html | 204 +++++++ .../cpp/tools/services/class-use/LittleClass.html | 138 +++++ .../class-use/ModuleOrFragmentFileHandler.html | 138 +++++ .../class-use/ReferenceDomNodeHandler.html | 138 +++++ .../sca/cpp/tools/services/class-use/Scagen.html | 138 +++++ .../services/class-use/ServiceDomNodeHandler.html | 138 +++++ .../services/class-use/ServicesGenerator.html | 138 +++++ .../cpp/tools/services/class-use/XMLFileActor.html | 186 +++++++ .../sca/cpp/tools/services/package-frame.html | 65 +++ .../sca/cpp/tools/services/package-summary.html | 364 +++++++++++++ .../sca/cpp/tools/services/package-tree.html | 162 ++++++ .../sca/cpp/tools/services/package-use.html | 179 +++++++ 64 files changed, 15652 insertions(+) create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/BodyPart.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/CParsingTool.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Configuration.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/DirectoryTree.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/FileActor.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/FilePart.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Headers.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/InputCppSourceCode.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/MethodPart.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Options.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Parameter.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/ParsingException.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/PrototypePart.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Signature.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Utils.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/BodyPart.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/CParsingTool.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Configuration.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/DirectoryTree.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/FileActor.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/FilePart.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Headers.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/InputCppSourceCode.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/MethodPart.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Options.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Parameter.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/ParsingException.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/PrototypePart.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Signature.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Utils.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-frame.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-summary.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-tree.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-use.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ComponentDomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ComponentTypeFileHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DirectoryScanner.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DomHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/GenericDomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/LittleClass.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ModuleOrFragmentFileHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ReferenceDomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/Scagen.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ServiceDomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ServicesGenerator.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/XMLFileActor.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ComponentDomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ComponentTypeFileHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DirectoryScanner.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DomHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/GenericDomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/LittleClass.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ModuleOrFragmentFileHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ReferenceDomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/Scagen.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ServiceDomNodeHandler.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ServicesGenerator.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/XMLFileActor.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-frame.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-summary.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-tree.html create mode 100644 sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-use.html (limited to 'sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache') diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/BodyPart.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/BodyPart.html new file mode 100644 index 0000000000..88b29695e0 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/BodyPart.html @@ -0,0 +1,396 @@ + + + + + + +BodyPart (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class BodyPart

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.BodyPart
+
+
+
+
public class BodyPart
extends java.lang.Object
+ +

+A snippet of C or C++ source code. If this snippet ends with a return + statement, this body part also contains the return value. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intCATCH + +
+           
+static intRETURN + +
+           
+static intTRAILING + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ ParametergetCaughtValue() + +
+           
+ java.lang.StringgetCodeFragment() + +
+           
+ java.lang.StringgetReturnValue() + +
+           
+ booleanisCatch() + +
+           
+ booleanisReturn() + +
+           
+ booleanisTrailing() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+TRAILING

+
+public static final int TRAILING
+
+
+
See Also:
Constant Field Values
+
+
+ +

+RETURN

+
+public static final int RETURN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+CATCH

+
+public static final int CATCH
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + + + + +
+Method Detail
+ +

+getCodeFragment

+
+public java.lang.String getCodeFragment()
+
+
+
+
+
+
+ +

+isTrailing

+
+public boolean isTrailing()
+
+
+
+
+
+
+ +

+isReturn

+
+public boolean isReturn()
+
+
+
+
+
+
+ +

+isCatch

+
+public boolean isCatch()
+
+
+
+
+
+
+ +

+getReturnValue

+
+public java.lang.String getReturnValue()
+
+
+
+
+
+
+ +

+getCaughtValue

+
+public Parameter getCaughtValue()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/CParsingTool.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/CParsingTool.html new file mode 100644 index 0000000000..f688955d94 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/CParsingTool.html @@ -0,0 +1,389 @@ + + + + + + +CParsingTool (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class CParsingTool

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.CParsingTool
+
+
+
Direct Known Subclasses:
Scagen, ServicesGenerator
+
+
+
+
public class CParsingTool
extends java.lang.Object
+ +

+The superclass of tools that parse C/C++ code. This CParsingTool provides + some useful common methods. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  booleanfailed + +
+           
+protected  Headersheaders + +
+           
+  + + + + + + + + + + + +
+Constructor Summary
+protected CParsingTool(java.lang.String[] args) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  java.io.FilecheckFile(java.lang.String option) + +
+          Checks the source directory looks good.
+protected  java.io.FilemaybeCreateDirectory(java.lang.String option) + +
+          Checks the target directory and creates it if it doesn't already exist.
+protected  HeaderspreparseHeaders(java.lang.String option) + +
+          Read in any include files before the main processing of the tool is done.
+protected  voidprintUsage() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+failed

+
+protected boolean failed
+
+
+
+
+
+ +

+headers

+
+protected Headers headers
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+CParsingTool

+
+protected CParsingTool(java.lang.String[] args)
+                throws java.lang.Exception
+
+
+ + + + + + + + +
+Method Detail
+ +

+preparseHeaders

+
+protected Headers preparseHeaders(java.lang.String option)
+                           throws java.lang.Exception
+
+
Read in any include files before the main processing of the tool is done. + This constructs the Headers. +

+

+ +
Throws: +
java.lang.Exception
+
+
+
+ +

+checkFile

+
+protected java.io.File checkFile(java.lang.String option)
+                          throws java.lang.Exception
+
+
Checks the source directory looks good. +

+

+ +
Throws: +
java.lang.Exception
+
+
+
+ +

+maybeCreateDirectory

+
+protected java.io.File maybeCreateDirectory(java.lang.String option)
+                                     throws java.lang.Exception
+
+
Checks the target directory and creates it if it doesn't already exist. +

+

+ +
Throws: +
java.lang.Exception
+
+
+
+ +

+printUsage

+
+protected void printUsage()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Configuration.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Configuration.html new file mode 100644 index 0000000000..5fa0f3af67 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Configuration.html @@ -0,0 +1,373 @@ + + + + + + +Configuration (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class Configuration

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.Configuration
+
+
+
+
public class Configuration
extends java.lang.Object
+ +

+Encapsulates the tool's configuration file +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static booleanclassExcluded(java.lang.String s) + +
+           
+static booleanfileExcluded(java.lang.String s) + +
+           
+static java.lang.StringgetConfigured(java.lang.String key) + +
+           
+static voidinitialise(java.lang.String filename) + +
+          Reads in the configuration file
+static booleanisAttribute(java.lang.String s) + +
+           
+static booleanisDefine(java.lang.String s) + +
+           
+static booleanisMacro(java.lang.String s) + +
+           
+static booleanmethodExcluded(java.lang.String className, + java.lang.String method) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+initialise

+
+public static void initialise(java.lang.String filename)
+                       throws java.lang.Exception
+
+
Reads in the configuration file +

+

+ +
Throws: +
java.lang.Exception
+
+
+
+ +

+fileExcluded

+
+public static boolean fileExcluded(java.lang.String s)
+
+
+
+
+
+
+ +

+classExcluded

+
+public static boolean classExcluded(java.lang.String s)
+
+
+
+
+
+
+ +

+methodExcluded

+
+public static boolean methodExcluded(java.lang.String className,
+                                     java.lang.String method)
+
+
+
+
+
+
+ +

+isMacro

+
+public static boolean isMacro(java.lang.String s)
+
+
+
+
+
+
+ +

+isDefine

+
+public static boolean isDefine(java.lang.String s)
+
+
+
+
+
+
+ +

+isAttribute

+
+public static boolean isAttribute(java.lang.String s)
+
+
+
+
+
+
+ +

+getConfigured

+
+public static java.lang.String getConfigured(java.lang.String key)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/DirectoryTree.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/DirectoryTree.html new file mode 100644 index 0000000000..88913b0dc8 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/DirectoryTree.html @@ -0,0 +1,289 @@ + + + + + + +DirectoryTree (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class DirectoryTree

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.DirectoryTree
+
+
+
+
public class DirectoryTree
extends java.lang.Object
+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
DirectoryTree(FileActor actor, + java.util.Set extensions) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static java.lang.StringmaybeAppendSeparator(java.lang.String name) + +
+           
+ voidwalkTree(java.io.File source, + java.io.File target, + int depth) + +
+          Starts adding trace into the given file.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+DirectoryTree

+
+public DirectoryTree(FileActor actor,
+                     java.util.Set extensions)
+
+
+ + + + + + + + +
+Method Detail
+ +

+walkTree

+
+public void walkTree(java.io.File source,
+                     java.io.File target,
+                     int depth)
+              throws java.lang.Exception
+
+
Starts adding trace into the given file. If the given file is a directory + then this the starting directory and all code beneath and in this + directory will be given trace. +

+

+
Parameters:
source - - + either the starting directory or one file to add trace to. +
Throws: +
java.lang.Exception
+
+
+
+ +

+maybeAppendSeparator

+
+public static java.lang.String maybeAppendSeparator(java.lang.String name)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/FileActor.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/FileActor.html new file mode 100644 index 0000000000..adc1ec6aab --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/FileActor.html @@ -0,0 +1,231 @@ + + + + + + +FileActor (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Interface FileActor

+
+
All Known Implementing Classes:
Headers, XMLFileActor
+
+
+
+
public interface FileActor
+ +

+DirectoryTree calls this interface to allow implementations of this interface + to act on a file in the directory tree. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactOnFile(java.io.File source, + java.io.File target, + int depth) + +
+           
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+actOnFile

+
+public void actOnFile(java.io.File source,
+                      java.io.File target,
+                      int depth)
+               throws java.lang.Exception
+
+
+ +
Throws: +
java.lang.Exception
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/FilePart.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/FilePart.html new file mode 100644 index 0000000000..c5e0c1da1c --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/FilePart.html @@ -0,0 +1,538 @@ + + + + + + +FilePart (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class FilePart

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.FilePart
+
+
+
Direct Known Subclasses:
MethodPart, PrototypePart
+
+
+
+
public class FilePart
extends java.lang.Object
+ +

+A piece of C++ source code +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intBEGINSCOPE + +
+           
+static intCLASSATTRIBUTE + +
+           
+static intCOMMENT + +
+           
+protected  java.lang.Stringcppsource + +
+           
+static intDIRECTIVE + +
+           
+static intENDSCOPE + +
+           
+static intENUM + +
+           
+static intFIELD + +
+           
+static intMACRO + +
+           
+static intMETHOD + +
+           
+static intPROTOTYPE + +
+           
+protected  inttype + +
+           
+static intTYPEDEF + +
+           
+static intUNKNOWN + +
+           
+static intWHITESPACE + +
+           
+  + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetType() + +
+           
+ java.lang.StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+UNKNOWN

+
+public static final int UNKNOWN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+COMMENT

+
+public static final int COMMENT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+METHOD

+
+public static final int METHOD
+
+
+
See Also:
Constant Field Values
+
+
+ +

+FIELD

+
+public static final int FIELD
+
+
+
See Also:
Constant Field Values
+
+
+ +

+BEGINSCOPE

+
+public static final int BEGINSCOPE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ENDSCOPE

+
+public static final int ENDSCOPE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DIRECTIVE

+
+public static final int DIRECTIVE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+WHITESPACE

+
+public static final int WHITESPACE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MACRO

+
+public static final int MACRO
+
+
+
See Also:
Constant Field Values
+
+
+ +

+CLASSATTRIBUTE

+
+public static final int CLASSATTRIBUTE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+ENUM

+
+public static final int ENUM
+
+
+
See Also:
Constant Field Values
+
+
+ +

+PROTOTYPE

+
+public static final int PROTOTYPE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+TYPEDEF

+
+public static final int TYPEDEF
+
+
+
See Also:
Constant Field Values
+
+
+ +

+cppsource

+
+protected java.lang.String cppsource
+
+
+
+
+
+ +

+type

+
+protected int type
+
+
+
+
+ + + + + + + + + + + +
+Method Detail
+ +

+getType

+
+public int getType()
+
+
+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Headers.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Headers.html new file mode 100644 index 0000000000..3d08c1df43 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Headers.html @@ -0,0 +1,403 @@ + + + + + + +Headers (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class Headers

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.Headers
+
+
+
All Implemented Interfaces:
FileActor
+
+
+
+
public class Headers
extends java.lang.Object
implements FileActor
+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
Headers() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactOnFile(java.io.File header, + java.io.File ignored, + int depth) + +
+           
+ booleanfailed() + +
+           
+ java.util.ListgetAllMethods() + +
+          Tuscany change - a method to get all the method signatures at once
+ java.util.ListgetMethods(java.lang.String method) + +
+           
+ booleanisClassName(java.lang.String text) + +
+           
+ booleanisInstanceMethod(Signature sign) + +
+           
+ booleanisStaticMethod(Signature sign) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+Headers

+
+public Headers()
+
+
+ + + + + + + + +
+Method Detail
+ +

+actOnFile

+
+public void actOnFile(java.io.File header,
+                      java.io.File ignored,
+                      int depth)
+               throws java.lang.Exception
+
+
+
Specified by:
actOnFile in interface FileActor
+
+
+ +
Throws: +
java.lang.Exception
+
+
+
+ +

+failed

+
+public boolean failed()
+
+
+
+
+
+
+
+
+
+ +

+isInstanceMethod

+
+public boolean isInstanceMethod(Signature sign)
+
+
+
+
+
+
+
+
+
+ +

+isStaticMethod

+
+public boolean isStaticMethod(Signature sign)
+
+
+
+
+
+
+
+
+
+ +

+getMethods

+
+public java.util.List getMethods(java.lang.String method)
+
+
+
+
+
+
+
+
+
+ +

+getAllMethods

+
+public java.util.List getAllMethods()
+
+
Tuscany change - a method to get all the method signatures at once +

+

+
+
+
+
+
+
+
+ +

+isClassName

+
+public boolean isClassName(java.lang.String text)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/InputCppSourceCode.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/InputCppSourceCode.html new file mode 100644 index 0000000000..0d48df2ac7 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/InputCppSourceCode.html @@ -0,0 +1,297 @@ + + + + + + +InputCppSourceCode (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class InputCppSourceCode

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.InputCppSourceCode
+
+
+
+
public class InputCppSourceCode
extends java.lang.Object
+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
InputCppSourceCode(java.io.BufferedReader br, + java.lang.String name) + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetName() + +
+           
+ java.util.IteratorgetPartIterator() + +
+           
+ java.lang.StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+InputCppSourceCode

+
+public InputCppSourceCode(java.io.BufferedReader br,
+                          java.lang.String name)
+                   throws java.lang.Exception
+
+
+ + + + + + + + +
+Method Detail
+ +

+getPartIterator

+
+public java.util.Iterator getPartIterator()
+
+
+
+
+
+
+ +

+getName

+
+public java.lang.String getName()
+
+
+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/MethodPart.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/MethodPart.html new file mode 100644 index 0000000000..591a36b08c --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/MethodPart.html @@ -0,0 +1,307 @@ + + + + + + +MethodPart (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class MethodPart

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.FilePart
+      extended byorg.apache.tuscany.sca.cpp.tools.common.MethodPart
+
+
+
+
public class MethodPart
extends FilePart
+ +

+A C or C++ method from a piece of source code. The method has a signature and + a body (the bit between the braces). +

+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class org.apache.tuscany.sca.cpp.tools.common.FilePart
BEGINSCOPE, CLASSATTRIBUTE, COMMENT, cppsource, DIRECTIVE, ENDSCOPE, ENUM, FIELD, MACRO, METHOD, PROTOTYPE, type, TYPEDEF, UNKNOWN, WHITESPACE
+  + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ BodyPart[]getBodyParts() + +
+          Returns the method body as code snippets, each ending with a place where + a trace statement belongs.
+ java.lang.StringgetOriginalSignature() + +
+           
+ SignaturegetSignature() + +
+           
+ + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.common.FilePart
getType, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+getSignature

+
+public Signature getSignature()
+
+
+
+
+
+
+ +

+getOriginalSignature

+
+public java.lang.String getOriginalSignature()
+
+
+
+
+
+
+ +

+getBodyParts

+
+public BodyPart[] getBodyParts()
+                        throws ParsingException
+
+
Returns the method body as code snippets, each ending with a place where + a trace statement belongs. The end of the first code snippet is where the + entry trace should go. The end of every other snippet is a return from + the method. +

+

+ +
Throws: +
ParsingException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Options.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Options.html new file mode 100644 index 0000000000..57c1e42dab --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Options.html @@ -0,0 +1,294 @@ + + + + + + +Options (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class Options

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.Options
+
+
+
+
public class Options
extends java.lang.Object
+ +

+Command line options passed to a tool's main program. All command line + options should begin with a dash "-". Some command line options take a value + which is the next parameter after the option. Others do not. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static java.lang.ObjectgetOption(java.lang.String key) + +
+           
+static booleanquiet() + +
+           
+static voidset(java.lang.String[] args) + +
+          Initialises the options based on the args passed to main
+static booleanverbose() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+set

+
+public static void set(java.lang.String[] args)
+
+
Initialises the options based on the args passed to main +

+

+
+
+
+
+ +

+getOption

+
+public static java.lang.Object getOption(java.lang.String key)
+
+
+
+
+
+
+ +

+verbose

+
+public static boolean verbose()
+
+
+
+
+
+
+ +

+quiet

+
+public static boolean quiet()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Parameter.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Parameter.html new file mode 100644 index 0000000000..e61c2ae9ae --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Parameter.html @@ -0,0 +1,392 @@ + + + + + + +Parameter (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class Parameter

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.Parameter
+
+
+
+
public class Parameter
extends java.lang.Object
+ +

+A parameter from a method signature. The parameter is the datatype plus its + name but not its value. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(java.lang.Object o) + +
+          For two parameters to match their types must match or both be null, but + the parameters names don't have to match.
+ booleanfailed() + +
+           
+ java.lang.StringgetName() + +
+           
+ java.lang.StringgetType() + +
+           
+ java.lang.StringgetTypeWithoutConst() + +
+           
+ booleanisDotDotDot() + +
+           
+ booleanisVoid() + +
+           
+ java.util.Iteratoriterator() + +
+           
+ java.lang.StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+failed

+
+public boolean failed()
+
+
+
+
+
+
+ +

+getType

+
+public java.lang.String getType()
+
+
+
+
+
+
+ +

+getTypeWithoutConst

+
+public java.lang.String getTypeWithoutConst()
+
+
+
+
+
+
+ +

+getName

+
+public java.lang.String getName()
+
+
+
+
+
+
+ +

+isVoid

+
+public boolean isVoid()
+
+
+
+
+
+
+ +

+isDotDotDot

+
+public boolean isDotDotDot()
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object o)
+
+
For two parameters to match their types must match or both be null, but + the parameters names don't have to match. Just because a parameter is + called something different in a header file as in the the source file + doesn't mean it's a different parameter. +

+

+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
+
+
+
+ +

+iterator

+
+public java.util.Iterator iterator()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/ParsingException.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/ParsingException.html new file mode 100644 index 0000000000..29585ad7ee --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/ParsingException.html @@ -0,0 +1,284 @@ + + + + + + +ParsingException (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class ParsingException

+
+java.lang.Object
+  extended byjava.lang.Throwable
+      extended byjava.lang.Exception
+          extended byorg.apache.tuscany.sca.cpp.tools.common.ParsingException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class ParsingException
extends java.lang.Exception
+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
ParsingException() + +
+           
ParsingException(java.lang.String message) + +
+           
ParsingException(java.lang.String message, + java.lang.Throwable cause) + +
+           
ParsingException(java.lang.Throwable cause) + +
+           
+  + + + + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+ParsingException

+
+public ParsingException()
+
+
+
+ +

+ParsingException

+
+public ParsingException(java.lang.String message)
+
+
+
+ +

+ParsingException

+
+public ParsingException(java.lang.String message,
+                        java.lang.Throwable cause)
+
+
+
+ +

+ParsingException

+
+public ParsingException(java.lang.Throwable cause)
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/PrototypePart.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/PrototypePart.html new file mode 100644 index 0000000000..bfd601d5b3 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/PrototypePart.html @@ -0,0 +1,309 @@ + + + + + + +PrototypePart (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class PrototypePart

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.FilePart
+      extended byorg.apache.tuscany.sca.cpp.tools.common.PrototypePart
+
+
+
+
public class PrototypePart
extends FilePart
+ +

+A function prototype in an include file and possibly in a class definition. +

+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class org.apache.tuscany.sca.cpp.tools.common.FilePart
BEGINSCOPE, CLASSATTRIBUTE, COMMENT, cppsource, DIRECTIVE, ENDSCOPE, ENUM, FIELD, MACRO, METHOD, PROTOTYPE, type, TYPEDEF, UNKNOWN, WHITESPACE
+  + + + + + + + + + + +
+Constructor Summary
PrototypePart(java.lang.String s, + java.lang.String className, + java.lang.String namespace) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ SignaturegetSignature() + +
+           
+ voidsetScope(java.lang.String scope) + +
+           
+ + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.common.FilePart
getType, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+PrototypePart

+
+public PrototypePart(java.lang.String s,
+                     java.lang.String className,
+                     java.lang.String namespace)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getSignature

+
+public Signature getSignature()
+
+
+
+
+
+
+ +

+setScope

+
+public void setScope(java.lang.String scope)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Signature.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Signature.html new file mode 100644 index 0000000000..2a2eef3678 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Signature.html @@ -0,0 +1,584 @@ + + + + + + +Signature (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class Signature

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.Signature
+
+
+
+
public class Signature
extends java.lang.Object
+ +

+A C or C++ method signature with the ability to parse it. TODO: properly + support variable length argument lists using "..." TODO: passing or returning + function pointers (hopefully not needed) TODO: Cope with ~ Classname() +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(java.lang.Object obj) + +
+           
+ booleanfailed() + +
+           
+ java.lang.StringgetAttributes() + +
+           
+ java.lang.StringgetClassName() + +
+           
+ java.lang.StringgetMethodName() + +
+           
+ java.lang.StringgetNamespace() + +
+           
+ java.lang.StringgetOriginal() + +
+           
+ Parameter[]getParameters() + +
+           
+ ParametergetReturnType() + +
+           
+ java.lang.StringgetScope() + +
+           
+ java.lang.StringgetTrimClassName() + +
+           
+ booleanisConstructor() + +
+           
+ booleanisDestructor() + +
+           
+ intoriginalLength() + +
+           
+ voidsetNamespace(java.lang.String namespace) + +
+           
+ voidsetScope(java.lang.String scope) + +
+          Sets the scope, but only if the scope is not set by an explicit attribute + in the signature.
+ java.lang.StringtoString() + +
+           
+ java.lang.StringtoStringWithoutAttrs() + +
+           
+ booleantraceable() + +
+          Should this method be traced?
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+getOriginal

+
+public java.lang.String getOriginal()
+
+
+
+
+
+
+ +

+originalLength

+
+public int originalLength()
+
+
+
+
+
+
+ +

+failed

+
+public boolean failed()
+
+
+
+
+
+
+ +

+getAttributes

+
+public java.lang.String getAttributes()
+
+
+
+
+
+
+ +

+getClassName

+
+public java.lang.String getClassName()
+
+
+
+
+
+
+ +

+setNamespace

+
+public void setNamespace(java.lang.String namespace)
+
+
+
Parameters:
namespace - The namespace to set.
+
+
+
+ +

+getNamespace

+
+public java.lang.String getNamespace()
+
+
+ +
Returns:
Returns the namespace.
+
+
+
+ +

+getTrimClassName

+
+public java.lang.String getTrimClassName()
+
+
+
+
+
+
+ +

+getMethodName

+
+public java.lang.String getMethodName()
+
+
+
+
+
+
+ +

+getReturnType

+
+public Parameter getReturnType()
+
+
+
+
+
+
+ +

+getParameters

+
+public Parameter[] getParameters()
+
+
+
+
+
+
+ +

+isConstructor

+
+public boolean isConstructor()
+
+
+
+
+
+
+ +

+isDestructor

+
+public boolean isDestructor()
+
+
+
+
+
+
+ +

+getScope

+
+public java.lang.String getScope()
+
+
+
+
+
+
+ +

+setScope

+
+public void setScope(java.lang.String scope)
+
+
Sets the scope, but only if the scope is not set by an explicit attribute + in the signature. +

+

+
+
+
+
+ +

+traceable

+
+public boolean traceable()
+
+
Should this method be traced? +

+

+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object obj)
+
+
+
+
+
+
+ +

+toStringWithoutAttrs

+
+public java.lang.String toStringWithoutAttrs()
+
+
+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Utils.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Utils.html new file mode 100644 index 0000000000..8571178678 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/Utils.html @@ -0,0 +1,411 @@ + + + + + + +Utils (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.common +
+Class Utils

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.Utils
+
+
+
+
public final class Utils
extends java.lang.Object
+ +

+Static utility methods. Some of these methods are similar to the methods on + java.lang.String except they are aware of C/C++ comments and string literals. + + TODO: Many of these methods would perform better using StringBuffer not + String +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.util.SetcPrimitives + +
+           
+static java.util.SetcTypeQualifiers + +
+           
+static java.lang.Stringwhitespace + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static voidoutputDebugString(java.lang.String line) + +
+           
+static voidrude(java.lang.String reason) + +
+          This method reports an error level problem
+static voidrude(java.lang.String reason, + java.lang.String filename, + int lineno, + java.lang.String codefragment) + +
+          Failed to parse the source code for some reason.
+static booleansafeEquals(java.lang.Object o1, + java.lang.Object o2) + +
+          A better method than .equals() because it doesn't NullPointerException + when one of the parameters is null.
+static voidscreenMessage(java.lang.String msg) + +
+          This method reports an error level problem
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+cPrimitives

+
+public static final java.util.Set cPrimitives
+
+
+
+
+
+ +

+cTypeQualifiers

+
+public static final java.util.Set cTypeQualifiers
+
+
+
+
+
+ +

+whitespace

+
+public static final java.lang.String whitespace
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + + + + +
+Method Detail
+ +

+rude

+
+public static void rude(java.lang.String reason,
+                        java.lang.String filename,
+                        int lineno,
+                        java.lang.String codefragment)
+                 throws ParsingException
+
+
Failed to parse the source code for some reason. This method prints out a + suitably rude message, and then what? I haven't quite decided yet. + + TODO: Do something sensible here like throw an Exception which will give + up on this file completely and tidy up the output file. It may be just + too dangerous to try to carry on. But we need to fail in such a way that + the build system knows that we've failed for this file and can build this + file without trace. +

+

+ +
Throws: +
ParsingException
+
+
+
+ +

+rude

+
+public static void rude(java.lang.String reason)
+                 throws ParsingException
+
+
This method reports an error level problem +

+

+
Parameters:
reason - why we have an error level problem +
Throws: +
ParsingException
+
+
+
+ +

+screenMessage

+
+public static void screenMessage(java.lang.String msg)
+
+
This method reports an error level problem +

+

+
+
+
+
+ +

+safeEquals

+
+public static boolean safeEquals(java.lang.Object o1,
+                                 java.lang.Object o2)
+
+
A better method than .equals() because it doesn't NullPointerException + when one of the parameters is null. +

+

+
+
+
+
+ +

+outputDebugString

+
+public static void outputDebugString(java.lang.String line)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/BodyPart.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/BodyPart.html new file mode 100644 index 0000000000..109d6c539a --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/BodyPart.html @@ -0,0 +1,177 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.BodyPart (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.BodyPart

+
+ + + + + + + + + +
+Packages that use BodyPart
org.apache.tuscany.sca.cpp.tools.common
+ + 
+  +

+ + + + + +
+Uses of BodyPart in org.apache.tuscany.sca.cpp.tools.common
+  +

+ + + + + + + + +
Methods in org.apache.tuscany.sca.cpp.tools.common that return BodyPart +
+ BodyPart[]MethodPart.getBodyParts() + +
+          Returns the method body as code snippets, each ending with a place where + a trace statement belongs.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/CParsingTool.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/CParsingTool.html new file mode 100644 index 0000000000..36cb776f02 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/CParsingTool.html @@ -0,0 +1,186 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.CParsingTool (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.CParsingTool

+
+ + + + + + + + + +
+Packages that use CParsingTool
org.apache.tuscany.sca.cpp.tools.services
+ + 
+  +

+ + + + + +
+Uses of CParsingTool in org.apache.tuscany.sca.cpp.tools.services
+  +

+ + + + + + + + + + + + +
Subclasses of CParsingTool in org.apache.tuscany.sca.cpp.tools.services +
+ classScagen + +
+          This is the main top level class.
+ classServicesGenerator + +
+          This class is the main class that handles the function that parses a C++ + interface header file into a DOM that holds all the semantic information + about the interface - method names, parameters and return values.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Configuration.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Configuration.html new file mode 100644 index 0000000000..bb2432666e --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Configuration.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.Configuration (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.Configuration

+
+No usage of org.apache.tuscany.sca.cpp.tools.common.Configuration +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/DirectoryTree.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/DirectoryTree.html new file mode 100644 index 0000000000..4140168273 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/DirectoryTree.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.DirectoryTree (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.DirectoryTree

+
+No usage of org.apache.tuscany.sca.cpp.tools.common.DirectoryTree +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/FileActor.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/FileActor.html new file mode 100644 index 0000000000..3ab90283bd --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/FileActor.html @@ -0,0 +1,256 @@ + + + + + + +Uses of Interface org.apache.tuscany.sca.cpp.tools.common.FileActor (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Interface
org.apache.tuscany.sca.cpp.tools.common.FileActor

+
+ + + + + + + + + + + + + +
+Packages that use FileActor
org.apache.tuscany.sca.cpp.tools.common
+ + 
org.apache.tuscany.sca.cpp.tools.services
+ + 
+  +

+ + + + + +
+Uses of FileActor in org.apache.tuscany.sca.cpp.tools.common
+  +

+ + + + + + + + +
Classes in org.apache.tuscany.sca.cpp.tools.common that implement FileActor +
+ classHeaders + +
+           
+  +

+ + + + + + + +
Constructors in org.apache.tuscany.sca.cpp.tools.common with parameters of type FileActor +
DirectoryTree(FileActor actor, + java.util.Set extensions) + +
+           
+  +

+ + + + + +
+Uses of FileActor in org.apache.tuscany.sca.cpp.tools.services
+  +

+ + + + + + + + + + + + + + + + +
Classes in org.apache.tuscany.sca.cpp.tools.services that implement FileActor +
+ classComponentTypeFileHandler + +
+          The purpose of this class is to specialise the map of XML element handlers + for a XXX.componentType file that is used by the XMLFileActor
+ classModuleOrFragmentFileHandler + +
+          The purpose of this class is purely to specialise the handler map to one with + a specific ComponentDomNodeHandler.
+ classXMLFileActor + +
+          The purpose of this abstract class is to provide a home for the standard + processing that is involved in turning a XML file into an internal DOM.
+  +

+ + + + + + + +
Constructors in org.apache.tuscany.sca.cpp.tools.services with parameters of type FileActor +
DirectoryScanner(FileActor actor, + java.util.Set extensions) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/FilePart.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/FilePart.html new file mode 100644 index 0000000000..aa4796486e --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/FilePart.html @@ -0,0 +1,184 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.FilePart (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.FilePart

+
+ + + + + + + + + +
+Packages that use FilePart
org.apache.tuscany.sca.cpp.tools.common
+ + 
+  +

+ + + + + +
+Uses of FilePart in org.apache.tuscany.sca.cpp.tools.common
+  +

+ + + + + + + + + + + + +
Subclasses of FilePart in org.apache.tuscany.sca.cpp.tools.common +
+ classMethodPart + +
+          A C or C++ method from a piece of source code.
+ classPrototypePart + +
+          A function prototype in an include file and possibly in a class definition.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Headers.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Headers.html new file mode 100644 index 0000000000..60190bbada --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Headers.html @@ -0,0 +1,192 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.Headers (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.Headers

+
+ + + + + + + + + +
+Packages that use Headers
org.apache.tuscany.sca.cpp.tools.common
+ + 
+  +

+ + + + + +
+Uses of Headers in org.apache.tuscany.sca.cpp.tools.common
+  +

+ + + + + + + + +
Fields in org.apache.tuscany.sca.cpp.tools.common declared as Headers +
+protected  HeadersCParsingTool.headers + +
+           
+  +

+ + + + + + + + +
Methods in org.apache.tuscany.sca.cpp.tools.common that return Headers +
+protected  HeadersCParsingTool.preparseHeaders(java.lang.String option) + +
+          Read in any include files before the main processing of the tool is done.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/InputCppSourceCode.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/InputCppSourceCode.html new file mode 100644 index 0000000000..463968468c --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/InputCppSourceCode.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.InputCppSourceCode (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.InputCppSourceCode

+
+No usage of org.apache.tuscany.sca.cpp.tools.common.InputCppSourceCode +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/MethodPart.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/MethodPart.html new file mode 100644 index 0000000000..19b474a7e7 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/MethodPart.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.MethodPart (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.MethodPart

+
+No usage of org.apache.tuscany.sca.cpp.tools.common.MethodPart +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Options.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Options.html new file mode 100644 index 0000000000..040187072f --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Options.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.Options (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.Options

+
+No usage of org.apache.tuscany.sca.cpp.tools.common.Options +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Parameter.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Parameter.html new file mode 100644 index 0000000000..a91a2c687b --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Parameter.html @@ -0,0 +1,192 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.Parameter (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.Parameter

+
+ + + + + + + + + +
+Packages that use Parameter
org.apache.tuscany.sca.cpp.tools.common
+ + 
+  +

+ + + + + +
+Uses of Parameter in org.apache.tuscany.sca.cpp.tools.common
+  +

+ + + + + + + + + + + + + + + + +
Methods in org.apache.tuscany.sca.cpp.tools.common that return Parameter +
+ ParameterSignature.getReturnType() + +
+           
+ Parameter[]Signature.getParameters() + +
+           
+ ParameterBodyPart.getCaughtValue() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/ParsingException.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/ParsingException.html new file mode 100644 index 0000000000..dedd25a4f2 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/ParsingException.html @@ -0,0 +1,196 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.ParsingException (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.ParsingException

+
+ + + + + + + + + +
+Packages that use ParsingException
org.apache.tuscany.sca.cpp.tools.common
+ + 
+  +

+ + + + + +
+Uses of ParsingException in org.apache.tuscany.sca.cpp.tools.common
+  +

+ + + + + + + + + + + + + + + + +
Methods in org.apache.tuscany.sca.cpp.tools.common that throw ParsingException +
+static voidUtils.rude(java.lang.String reason, + java.lang.String filename, + int lineno, + java.lang.String codefragment) + +
+          Failed to parse the source code for some reason.
+static voidUtils.rude(java.lang.String reason) + +
+          This method reports an error level problem
+ BodyPart[]MethodPart.getBodyParts() + +
+          Returns the method body as code snippets, each ending with a place where + a trace statement belongs.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/PrototypePart.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/PrototypePart.html new file mode 100644 index 0000000000..22c4575fab --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/PrototypePart.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.PrototypePart (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.PrototypePart

+
+No usage of org.apache.tuscany.sca.cpp.tools.common.PrototypePart +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Signature.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Signature.html new file mode 100644 index 0000000000..228807ba8a --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Signature.html @@ -0,0 +1,208 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.Signature (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.Signature

+
+ + + + + + + + + +
+Packages that use Signature
org.apache.tuscany.sca.cpp.tools.common
+ + 
+  +

+ + + + + +
+Uses of Signature in org.apache.tuscany.sca.cpp.tools.common
+  +

+ + + + + + + + + + + + +
Methods in org.apache.tuscany.sca.cpp.tools.common that return Signature +
+ SignaturePrototypePart.getSignature() + +
+           
+ SignatureMethodPart.getSignature() + +
+           
+  +

+ + + + + + + + + + + + +
Methods in org.apache.tuscany.sca.cpp.tools.common with parameters of type Signature +
+ booleanHeaders.isInstanceMethod(Signature sign) + +
+           
+ booleanHeaders.isStaticMethod(Signature sign) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Utils.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Utils.html new file mode 100644 index 0000000000..cd93afeeb6 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/class-use/Utils.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.common.Utils (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.common.Utils

+
+No usage of org.apache.tuscany.sca.cpp.tools.common.Utils +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-frame.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-frame.html new file mode 100644 index 0000000000..2e0e528f32 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-frame.html @@ -0,0 +1,78 @@ + + + + + + +org.apache.tuscany.sca.cpp.tools.common (SCA for C++ Tools) + + + + + + + + + + + +org.apache.tuscany.sca.cpp.tools.common + + + + +
+Interfaces  + +
+FileActor
+ + + + + + +
+Classes  + +
+BodyPart +
+Configuration +
+CParsingTool +
+DirectoryTree +
+FilePart +
+Headers +
+InputCppSourceCode +
+MethodPart +
+Options +
+Parameter +
+PrototypePart +
+Signature +
+Utils
+ + + + + + +
+Exceptions  + +
+ParsingException
+ + + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-summary.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-summary.html new file mode 100644 index 0000000000..3fa24db0cd --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-summary.html @@ -0,0 +1,273 @@ + + + + + + +org.apache.tuscany.sca.cpp.tools.common (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+Package org.apache.tuscany.sca.cpp.tools.common +

+
+ + +

+See: +
+          Description +

+ + + + + + + + + +
+Interface Summary
FileActorDirectoryTree calls this interface to allow implementations of this interface + to act on a file in the directory tree.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
BodyPartA snippet of C or C++ source code.
ConfigurationEncapsulates the tool's configuration file
CParsingToolThe superclass of tools that parse C/C++ code.
DirectoryTree 
FilePartA piece of C++ source code
Headers 
InputCppSourceCode 
MethodPartA C or C++ method from a piece of source code.
OptionsCommand line options passed to a tool's main program.
ParameterA parameter from a method signature.
PrototypePartA function prototype in an include file and possibly in a class definition.
SignatureA C or C++ method signature with the ability to parse it.
UtilsStatic utility methods.
+  + +

+ + + + + + + + + +
+Exception Summary
ParsingException 
+  + +

+

+Package org.apache.tuscany.sca.cpp.tools.common Description +

+ +

+

+ +

Overview

+ +This package can be used to reflect across C++ source code. It can produce +a network of descriptive objects describing C++ Headers, Signatures, Parameters and so +on that it finds in a given location of the file system. +Each of the descriptive objects has a set of getters that return either +the descriptive child objects, or for primitives, the string that represents the actual +value such as "int" or "myFunction". +

+There are also various utility methods that help with navigating the information, for example the Signature +class has an isConstructor method. The API Javadoc contains further details of these. +

+The package can scan a directory using a file mask to identify what types +of files are to be scanned. In this application we are interested only +in the function prototypes in the C++ header files. +

+The implementation was originated using some java code that was also +contributed to the Apache org.apache.axis.tools.common package. Care +has been taken that the original code was not sourced via Apache. If +this project is adopted by Apache then it is very possible that this +package could be merged with or made obsolete by org.apache.axis.tools.common +and because of this the design and interfaces have been preserved from +the original code as much as possible. + +

+

+

+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-tree.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-tree.html new file mode 100644 index 0000000000..d6ca34c836 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-tree.html @@ -0,0 +1,162 @@ + + + + + + +org.apache.tuscany.sca.cpp.tools.common Class Hierarchy (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Hierarchy For Package org.apache.tuscany.sca.cpp.tools.common +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-use.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-use.html new file mode 100644 index 0000000000..36fda7a829 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/common/package-use.html @@ -0,0 +1,231 @@ + + + + + + +Uses of Package org.apache.tuscany.sca.cpp.tools.common (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Package
org.apache.tuscany.sca.cpp.tools.common

+
+ + + + + + + + + + + + + +
+Packages that use org.apache.tuscany.sca.cpp.tools.common
org.apache.tuscany.sca.cpp.tools.common
+ + 
org.apache.tuscany.sca.cpp.tools.services
+ + 
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in org.apache.tuscany.sca.cpp.tools.common used by org.apache.tuscany.sca.cpp.tools.common
BodyPart + +
+          A snippet of C or C++ source code.
FileActor + +
+          DirectoryTree calls this interface to allow implementations of this interface + to act on a file in the directory tree.
FilePart + +
+          A piece of C++ source code
Headers + +
+           
Parameter + +
+          A parameter from a method signature.
ParsingException + +
+           
Signature + +
+          A C or C++ method signature with the ability to parse it.
+  +

+ + + + + + + + + + + +
+Classes in org.apache.tuscany.sca.cpp.tools.common used by org.apache.tuscany.sca.cpp.tools.services
CParsingTool + +
+          The superclass of tools that parse C/C++ code.
FileActor + +
+          DirectoryTree calls this interface to allow implementations of this interface + to act on a file in the directory tree.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ComponentDomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ComponentDomNodeHandler.html new file mode 100644 index 0000000000..84b07c500a --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ComponentDomNodeHandler.html @@ -0,0 +1,303 @@ + + + + + + +ComponentDomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class ComponentDomNodeHandler

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler
+      extended byorg.apache.tuscany.sca.cpp.tools.services.ComponentDomNodeHandler
+
+
+
All Implemented Interfaces:
DomNodeHandler
+
+
+
+
public class ComponentDomNodeHandler
extends GenericDomNodeHandler
+ +

+This class will do the required processing for the element of a + sca module or fragment file. +

+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from interface org.apache.tuscany.sca.cpp.tools.services.DomNodeHandler
ELEMENT
+  + + + + + + + + + + +
+Constructor Summary
ComponentDomNodeHandler() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidhandleNode(org.w3c.dom.Node node, + java.lang.String contextXPath, + java.util.Map handlers, + java.util.Map parameters) + +
+          This method will do the "normal" processing and then trigger a call to + processComponentNode.
+ + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler
handleChildElements, mapNodeToHandlerAndHandle, transferAttrsToParameters
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+ComponentDomNodeHandler

+
+public ComponentDomNodeHandler()
+
+
+ + + + + + + + +
+Method Detail
+ +

+handleNode

+
+public void handleNode(org.w3c.dom.Node node,
+                       java.lang.String contextXPath,
+                       java.util.Map handlers,
+                       java.util.Map parameters)
+
+
This method will do the "normal" processing and then trigger a call to + processComponentNode. +

+

+
Specified by:
handleNode in interface DomNodeHandler
Overrides:
handleNode in class GenericDomNodeHandler
+
+
+
Parameters:
node - the node being processed
contextXPath - the XPath to the node
handlers - the map pf element names to DomNodeHandlers
parameters - a map of XPaths to parameters values found so far
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ComponentTypeFileHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ComponentTypeFileHandler.html new file mode 100644 index 0000000000..666f530637 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ComponentTypeFileHandler.html @@ -0,0 +1,299 @@ + + + + + + +ComponentTypeFileHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class ComponentTypeFileHandler

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.XMLFileActor
+      extended byorg.apache.tuscany.sca.cpp.tools.services.ComponentTypeFileHandler
+
+
+
All Implemented Interfaces:
FileActor
+
+
+
+
public class ComponentTypeFileHandler
extends XMLFileActor
+ +

+The purpose of this class is to specialise the map of XML element handlers + for a XXX.componentType file that is used by the XMLFileActor +

+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class org.apache.tuscany.sca.cpp.tools.services.XMLFileActor
failed, handlers, parameters, transformerFactory
+  + + + + + + + + + + +
+Constructor Summary
ComponentTypeFileHandler() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidhandleComponentTypeFile(java.io.File componentTypeXML, + java.io.File target) + +
+          This method just exists to add the default starting depth of 1 to the + underlying actOnFile interface
+ + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.services.XMLFileActor
actOnFile, createDomFromXMLFile, getFilesActedOn, getParameter, setParameter
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+ComponentTypeFileHandler

+
+public ComponentTypeFileHandler()
+
+
+ + + + + + + + +
+Method Detail
+ +

+handleComponentTypeFile

+
+public void handleComponentTypeFile(java.io.File componentTypeXML,
+                                    java.io.File target)
+                             throws java.lang.Exception
+
+
This method just exists to add the default starting depth of 1 to the + underlying actOnFile interface +

+

+
Parameters:
componentTypeXML -
target - +
Throws: +
java.lang.Exception
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DirectoryScanner.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DirectoryScanner.html new file mode 100644 index 0000000000..c7c82a3cc0 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DirectoryScanner.html @@ -0,0 +1,271 @@ + + + + + + +DirectoryScanner (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class DirectoryScanner

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.DirectoryScanner
+
+
+
+
public class DirectoryScanner
extends java.lang.Object
+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
DirectoryScanner(FileActor actor, + java.util.Set extensions) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidwalkTree(java.io.File source, + java.io.File target, + int depth) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+DirectoryScanner

+
+public DirectoryScanner(FileActor actor,
+                        java.util.Set extensions)
+
+
+ + + + + + + + +
+Method Detail
+ +

+walkTree

+
+public void walkTree(java.io.File source,
+                     java.io.File target,
+                     int depth)
+              throws java.lang.Exception
+
+
+
Parameters:
source - The module root directory
target - The directory that will holdthe generated output
depth - The depth from the inial starting point, not significant for + the Scagen tool as we are only interested in the module root + directory but present due to the inherited actOnFile interface + whcih come from the oreg.apache.axis.tools practice This + interface has been left unchanged as we hope to reconverge the + parser here with the original one once the changes are fed + back into the original code. +
Throws: +
java.lang.Exception
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DomHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DomHandler.html new file mode 100644 index 0000000000..cf6f2e436c --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DomHandler.html @@ -0,0 +1,341 @@ + + + + + + +DomHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class DomHandler

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler
+      extended byorg.apache.tuscany.sca.cpp.tools.services.DomHandler
+
+
+
All Implemented Interfaces:
DomNodeHandler
+
+
+
+
public class DomHandler
extends GenericDomNodeHandler
+ +

+The purpose of this class it to provide a generic class that can handle both + a DOM and a DOM node. +

+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from interface org.apache.tuscany.sca.cpp.tools.services.DomNodeHandler
ELEMENT
+  + + + + + + + + + + +
+Constructor Summary
DomHandler() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static voidhandleDom(org.w3c.dom.Document dom, + java.util.Map handlers, + java.util.Map parameters) + +
+          This method will run through the initial level of the DOM using the + handlers map
+ voidhandleNode(org.w3c.dom.Node node, + java.lang.String contextXPath, + java.util.Map handlers, + java.util.Map parameters) + +
+          This method will place the attributes in this node into the parameter + map keyed by the XPath and recursively continue processing for any + sub-elements of the node.
+ + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler
handleChildElements, mapNodeToHandlerAndHandle, transferAttrsToParameters
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+DomHandler

+
+public DomHandler()
+
+
+ + + + + + + + +
+Method Detail
+ +

+handleDom

+
+public static void handleDom(org.w3c.dom.Document dom,
+                             java.util.Map handlers,
+                             java.util.Map parameters)
+
+
This method will run through the initial level of the DOM using the + handlers map +

+

+
Parameters:
dom - the document being consumed
handlers - the map from element name to node handler
parameters - a map of parameters - this is often used by a handler to place + a name-value pair, the name is often an Xpath representation + of the location of the data in the DOM but handlers are free + to use whatever they like - the contextXpath is generated as + an Xpath prefix for those handlers that wish to use it.
+
+
+
+ +

+handleNode

+
+public void handleNode(org.w3c.dom.Node node,
+                       java.lang.String contextXPath,
+                       java.util.Map handlers,
+                       java.util.Map parameters)
+
+
Description copied from class: GenericDomNodeHandler
+
This method will place the attributes in this node into the parameter + map keyed by the XPath and recursively continue processing for any + sub-elements of the node. +

+

+
Specified by:
handleNode in interface DomNodeHandler
Overrides:
handleNode in class GenericDomNodeHandler
+
+
+
Parameters:
node - The DOM node being consumed
contextXPath - The XPath to this node
handlers - The map from element name to node handler
parameters - A map of parameters - this is often used by a handler to place + a name-value pair, the name is often an Xpath representation + of the location of the data in the DOM but handlers are free + to use whatever they like - the contextXpath is generated as + an Xpath prefix for those handlers that wish to use it.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DomNodeHandler.html new file mode 100644 index 0000000000..b62f5a4694 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/DomNodeHandler.html @@ -0,0 +1,262 @@ + + + + + + +DomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Interface DomNodeHandler

+
+
All Known Implementing Classes:
GenericDomNodeHandler
+
+
+
+
public interface DomNodeHandler
+ +

+


+ +

+ + + + + + + + + + + + + + +
+Field Summary
+static intELEMENT + +
+           
+  + + + + + + + + + + + + + + +
+Method Summary
+ voidhandleNode(org.w3c.dom.Node node, + java.lang.String contextXPath, + java.util.Map handlers, + java.util.Map parameters) + +
+          An interface for classes that can process DOM nodes.
+  +

+ + + + + + + + +
+Field Detail
+ +

+ELEMENT

+
+public static final int ELEMENT
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + + + + +
+Method Detail
+ +

+handleNode

+
+public void handleNode(org.w3c.dom.Node node,
+                       java.lang.String contextXPath,
+                       java.util.Map handlers,
+                       java.util.Map parameters)
+
+
An interface for classes that can process DOM nodes. +

+

+
Parameters:
node - the DOM node being consumed
contextXPath - the XPath to this node
handlers - The map from element name to node handler
parameters - A map of parameters - this is often used by a handler to place + a name-value pair, the name is often an Xpath representation of the + location of the data in the DOM but handlers are free to use whatever + they like - the contextXpath is generated as an Xpath prefix for those + handlers that wish to use it.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/GenericDomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/GenericDomNodeHandler.html new file mode 100644 index 0000000000..2a7a65c242 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/GenericDomNodeHandler.html @@ -0,0 +1,396 @@ + + + + + + +GenericDomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class GenericDomNodeHandler

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler
+
+
+
All Implemented Interfaces:
DomNodeHandler
+
+
+
Direct Known Subclasses:
ComponentDomNodeHandler, DomHandler, ReferenceDomNodeHandler, ServiceDomNodeHandler
+
+
+
+
public class GenericDomNodeHandler
extends java.lang.Object
implements DomNodeHandler
+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from interface org.apache.tuscany.sca.cpp.tools.services.DomNodeHandler
ELEMENT
+  + + + + + + + + + + +
+Constructor Summary
GenericDomNodeHandler() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidhandleChildElements(org.w3c.dom.Node node, + java.lang.String contextPath, + java.util.Map handlers, + java.util.Map parameters) + +
+          This method will iterate through the DOM node's children and call the + appropriate handler for each one.
+ voidhandleNode(org.w3c.dom.Node node, + java.lang.String contextXPath, + java.util.Map handlers, + java.util.Map parameters) + +
+          This method will place the attributes in this node into the parameter + map keyed by the XPath and recursively continue processing for any + sub-elements of the node.
+static voidmapNodeToHandlerAndHandle(org.w3c.dom.Node node, + java.lang.String contextPath, + java.util.Map handlers, + java.util.Map parameters) + +
+          This method will resolve any registered handler for a particular DOM + element and call the handleNode method on it.
+ voidtransferAttrsToParameters(org.w3c.dom.Node node, + java.lang.String contextPath, + java.util.Map parameters) + +
+          This method parses the DOM attributes into name value pairs in the + parameter map each valued keyed by its XPath.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+GenericDomNodeHandler

+
+public GenericDomNodeHandler()
+
+
+ + + + + + + + +
+Method Detail
+ +

+transferAttrsToParameters

+
+public void transferAttrsToParameters(org.w3c.dom.Node node,
+                                      java.lang.String contextPath,
+                                      java.util.Map parameters)
+
+
This method parses the DOM attributes into name value pairs in the + parameter map each valued keyed by its XPath. +

+

+
+
+
+
Parameters:
node - the DOM node being processed
contextPath - the XPath to the DOM node being processed
parameters - a scratchpad map of name value pairs
+
+
+
+ +

+handleChildElements

+
+public void handleChildElements(org.w3c.dom.Node node,
+                                java.lang.String contextPath,
+                                java.util.Map handlers,
+                                java.util.Map parameters)
+
+
This method will iterate through the DOM node's children and call the + appropriate handler for each one. +

+

+
+
+
+
Parameters:
node - the DOM node being processed
contextPath - the XPath to the DOM node being processed
handlers - a map of element name to handler objects
parameters - a scratchpad map of name value pairs
+
+
+
+ +

+mapNodeToHandlerAndHandle

+
+public static void mapNodeToHandlerAndHandle(org.w3c.dom.Node node,
+                                             java.lang.String contextPath,
+                                             java.util.Map handlers,
+                                             java.util.Map parameters)
+
+
This method will resolve any registered handler for a particular DOM + element and call the handleNode method on it. If the handlers map has a + mapping from "entity" to an instance of EntityHandler which implements + the DomNodeHandler interface then any node that looks like + + + Will be passed to the EntityHandler to process. +

+

+
+
+
+
Parameters:
node - the DOM node being processed
contextPath - the XPath to the DOM node being processed
handlers - a map of element name to handler objects
parameters - a scratchpad map of name value pairs
+
+
+
+ +

+handleNode

+
+public void handleNode(org.w3c.dom.Node node,
+                       java.lang.String contextXPath,
+                       java.util.Map handlers,
+                       java.util.Map parameters)
+
+
This method will place the attributes in this node into the parameter + map keyed by the XPath and recursively continue processing for any + sub-elements of the node. +

+

+
Specified by:
handleNode in interface DomNodeHandler
+
+
+
Parameters:
node - The DOM node being consumed
contextXPath - The XPath to this node
handlers - The map from element name to node handler
parameters - A map of parameters - this is often used by a handler to place + a name-value pair, the name is often an Xpath representation + of the location of the data in the DOM but handlers are free + to use whatever they like - the contextXpath is generated as + an Xpath prefix for those handlers that wish to use it.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/LittleClass.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/LittleClass.html new file mode 100644 index 0000000000..3562f99e07 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/LittleClass.html @@ -0,0 +1,231 @@ + + + + + + +LittleClass (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class LittleClass

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.LittleClass
+
+
+
+
public class LittleClass
extends java.lang.Object
+ +

+This class is just a convenient application class that is loaded in order to + get the application class loader. We are interested in the application class + loader as we use its getResource method to resolve XML files independantly of + where they are. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
LittleClass() + +
+           
+  + + + + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+LittleClass

+
+public LittleClass()
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ModuleOrFragmentFileHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ModuleOrFragmentFileHandler.html new file mode 100644 index 0000000000..71448f7f04 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ModuleOrFragmentFileHandler.html @@ -0,0 +1,258 @@ + + + + + + +ModuleOrFragmentFileHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class ModuleOrFragmentFileHandler

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.XMLFileActor
+      extended byorg.apache.tuscany.sca.cpp.tools.services.ModuleOrFragmentFileHandler
+
+
+
All Implemented Interfaces:
FileActor
+
+
+
+
public class ModuleOrFragmentFileHandler
extends XMLFileActor
+ +

+The purpose of this class is purely to specialise the handler map to one with + a specific ComponentDomNodeHandler. +

+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class org.apache.tuscany.sca.cpp.tools.services.XMLFileActor
failed, handlers, parameters, transformerFactory
+  + + + + + + + + + + +
+Constructor Summary
ModuleOrFragmentFileHandler() + +
+           
+  + + + + + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.services.XMLFileActor
actOnFile, createDomFromXMLFile, getFilesActedOn, getParameter, setParameter
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+ModuleOrFragmentFileHandler

+
+public ModuleOrFragmentFileHandler()
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ReferenceDomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ReferenceDomNodeHandler.html new file mode 100644 index 0000000000..506b804627 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ReferenceDomNodeHandler.html @@ -0,0 +1,311 @@ + + + + + + +ReferenceDomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class ReferenceDomNodeHandler

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler
+      extended byorg.apache.tuscany.sca.cpp.tools.services.ReferenceDomNodeHandler
+
+
+
All Implemented Interfaces:
DomNodeHandler
+
+
+
+
public class ReferenceDomNodeHandler
extends GenericDomNodeHandler
+ +

+The purpose of this class is to process a element in a + componentType file and then trigger a call to the method in ServicesGenerator + to process the interface header file +

+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from interface org.apache.tuscany.sca.cpp.tools.services.DomNodeHandler
ELEMENT
+  + + + + + + + + + + +
+Constructor Summary
ReferenceDomNodeHandler() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidhandleNode(org.w3c.dom.Node node, + java.lang.String contextXPath, + java.util.Map handlers, + java.util.Map parameters) + +
+          This method will place the attributes in this node into the parameter + map keyed by the XPath and recursively continue processing for any + sub-elements of the node.
+ + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler
handleChildElements, mapNodeToHandlerAndHandle, transferAttrsToParameters
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+ReferenceDomNodeHandler

+
+public ReferenceDomNodeHandler()
+
+
+ + + + + + + + +
+Method Detail
+ +

+handleNode

+
+public void handleNode(org.w3c.dom.Node node,
+                       java.lang.String contextXPath,
+                       java.util.Map handlers,
+                       java.util.Map parameters)
+
+
Description copied from class: GenericDomNodeHandler
+
This method will place the attributes in this node into the parameter + map keyed by the XPath and recursively continue processing for any + sub-elements of the node. +

+

+
Specified by:
handleNode in interface DomNodeHandler
Overrides:
handleNode in class GenericDomNodeHandler
+
+
+
Parameters:
node - The DOM node being consumed
contextXPath - The XPath to this node
handlers - The map from element name to node handler
parameters - A map of parameters - this is often used by a handler to place + a name-value pair, the name is often an Xpath representation + of the location of the data in the DOM but handlers are free + to use whatever they like - the contextXpath is generated as + an Xpath prefix for those handlers that wish to use it.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/Scagen.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/Scagen.html new file mode 100644 index 0000000000..08c200c9e8 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/Scagen.html @@ -0,0 +1,344 @@ + + + + + + +Scagen (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class Scagen

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.CParsingTool
+      extended byorg.apache.tuscany.sca.cpp.tools.services.Scagen
+
+
+
+
public class Scagen
extends CParsingTool
+ +

+This is the main top level class. Its purpose is to create a + Module/FragmentFile handler visitor and pass it to a DirectoryScanner for + processing. +

+ +

+


+ +

+ + + + + + + + + + + + + + +
+Field Summary
+static java.util.SetMODULE_EXTENSIONS + +
+           
+ + + + + + + +
Fields inherited from class org.apache.tuscany.sca.cpp.tools.common.CParsingTool
failed, headers
+  + + + + + + + + + + +
+Constructor Summary
Scagen(java.lang.String[] args) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static voidmain(java.lang.String[] args) + +
+          Take a directory scanning class and create a vistor that knows how to + handle any sca.module or .fragment that the scanner comes across.
+protected  voidprintUsage() + +
+          Provide a hint to the user on how to call this class
+ + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.common.CParsingTool
checkFile, maybeCreateDirectory, preparseHeaders
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+MODULE_EXTENSIONS

+
+public static java.util.Set MODULE_EXTENSIONS
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Scagen

+
+public Scagen(java.lang.String[] args)
+       throws java.lang.Exception
+
+ +
Throws: +
java.lang.Exception
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(java.lang.String[] args)
+
+
Take a directory scanning class and create a vistor that knows how to + handle any sca.module or .fragment that the scanner comes across. +

+

+
Parameters:
args - standard main args. THe values we expect in this class are + scagen -dir input_dir -output output_dir
+
+
+
+ +

+printUsage

+
+protected void printUsage()
+
+
Provide a hint to the user on how to call this class +

+

+
Overrides:
printUsage in class CParsingTool
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ServiceDomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ServiceDomNodeHandler.html new file mode 100644 index 0000000000..5970989783 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ServiceDomNodeHandler.html @@ -0,0 +1,305 @@ + + + + + + +ServiceDomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class ServiceDomNodeHandler

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler
+      extended byorg.apache.tuscany.sca.cpp.tools.services.ServiceDomNodeHandler
+
+
+
All Implemented Interfaces:
DomNodeHandler
+
+
+
+
public class ServiceDomNodeHandler
extends GenericDomNodeHandler
+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from interface org.apache.tuscany.sca.cpp.tools.services.DomNodeHandler
ELEMENT
+  + + + + + + + + + + +
+Constructor Summary
ServiceDomNodeHandler() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidhandleNode(org.w3c.dom.Node node, + java.lang.String contextXPath, + java.util.Map handlers, + java.util.Map parameters) + +
+          This method will place the attributes in this node into the parameter + map keyed by the XPath and recursively continue processing for any + sub-elements of the node.
+ + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler
handleChildElements, mapNodeToHandlerAndHandle, transferAttrsToParameters
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+ServiceDomNodeHandler

+
+public ServiceDomNodeHandler()
+
+
+ + + + + + + + +
+Method Detail
+ +

+handleNode

+
+public void handleNode(org.w3c.dom.Node node,
+                       java.lang.String contextXPath,
+                       java.util.Map handlers,
+                       java.util.Map parameters)
+
+
Description copied from class: GenericDomNodeHandler
+
This method will place the attributes in this node into the parameter + map keyed by the XPath and recursively continue processing for any + sub-elements of the node. +

+

+
Specified by:
handleNode in interface DomNodeHandler
Overrides:
handleNode in class GenericDomNodeHandler
+
+
+
Parameters:
node - The DOM node being consumed
contextXPath - The XPath to this node
handlers - The map from element name to node handler
parameters - A map of parameters - this is often used by a handler to place + a name-value pair, the name is often an Xpath representation + of the location of the data in the DOM but handlers are free + to use whatever they like - the contextXpath is generated as + an Xpath prefix for those handlers that wish to use it.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ServicesGenerator.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ServicesGenerator.html new file mode 100644 index 0000000000..ebf2ec4ac5 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/ServicesGenerator.html @@ -0,0 +1,312 @@ + + + + + + +ServicesGenerator (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class ServicesGenerator

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.common.CParsingTool
+      extended byorg.apache.tuscany.sca.cpp.tools.services.ServicesGenerator
+
+
+
+
public class ServicesGenerator
extends CParsingTool
+ +

+This class is the main class that handles the function that parses a C++ + interface header file into a DOM that holds all the semantic information + about the interface - method names, parameters and return values. It then + uses XSLT to generate different "views" of this data plus the parameter map + from other sources that are the C++ programs for the proxy and wrapper + implementations and headers. +

+ +

+


+ +

+ + + + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class org.apache.tuscany.sca.cpp.tools.common.CParsingTool
failed, headers
+  + + + + + + + + + + +
+Constructor Summary
ServicesGenerator(java.lang.String[] args) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidhandleInterfaceHeader(java.util.Map parameters, + boolean forReference) + +
+           
+ + + + + + + +
Methods inherited from class org.apache.tuscany.sca.cpp.tools.common.CParsingTool
checkFile, maybeCreateDirectory, preparseHeaders, printUsage
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+ServicesGenerator

+
+public ServicesGenerator(java.lang.String[] args)
+                  throws java.lang.Exception
+
+
+ + + + + + + + +
+Method Detail
+ +

+handleInterfaceHeader

+
+public static void handleInterfaceHeader(java.util.Map parameters,
+                                         boolean forReference)
+                                  throws java.lang.Exception
+
+
+
Parameters:
parameters -
forReference - true if we are creating a proxy for a reference (rather than + for a service) +
Throws: +
java.lang.Exception - The design is +
    +
  • handleInterfaceHeader +
  • createDOMofMethods +
  • createProxyCPPFromDom(outputDir, dom); +
  • createProxyHeaderFromDom(outputDir, dom); +
+ + plus if we are not generating for a reference element +
    +
  • createWrapperCPPFromDom(outputDir, dom); +
  • createWrapperHeaderFromDom(outputDir, dom); +
      + Each of the create.... methods calls createOutputFromDom with a different + style sheet.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/XMLFileActor.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/XMLFileActor.html new file mode 100644 index 0000000000..67930e3ba8 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/XMLFileActor.html @@ -0,0 +1,469 @@ + + + + + + +XMLFileActor (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +

+ +org.apache.tuscany.sca.cpp.tools.services +
+Class XMLFileActor

+
+java.lang.Object
+  extended byorg.apache.tuscany.sca.cpp.tools.services.XMLFileActor
+
+
+
All Implemented Interfaces:
FileActor
+
+
+
Direct Known Subclasses:
ComponentTypeFileHandler, ModuleOrFragmentFileHandler
+
+
+
+
public abstract class XMLFileActor
extends java.lang.Object
implements FileActor
+ +

+The purpose of this abstract class is to provide a home for the standard + processing that is involved in turning a XML file into an internal DOM. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ booleanfailed + +
+           
+protected static java.util.Maphandlers + +
+           
+protected static java.util.Mapparameters + +
+           
+protected static javax.xml.transform.TransformerFactorytransformerFactory + +
+           
+  + + + + + + + + + + +
+Constructor Summary
XMLFileActor() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactOnFile(java.io.File moduleXML, + java.io.File target, + int depth) + +
+          This method is the main FileActor method
+protected  org.w3c.dom.DocumentcreateDomFromXMLFile(java.io.File xmlSourceFile) + +
+          This method builds an in memory DOM from an XML file
+ intgetFilesActedOn() + +
+           
+ java.lang.ObjectgetParameter(java.lang.String name, + java.lang.Object value) + +
+          Get a parameter
+ voidsetParameter(java.lang.String name, + java.lang.Object value) + +
+          Set a parameter
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+handlers

+
+protected static java.util.Map handlers
+
+
+
+
+
+ +

+parameters

+
+protected static java.util.Map parameters
+
+
+
+
+
+ +

+failed

+
+public boolean failed
+
+
+
+
+
+ +

+transformerFactory

+
+protected static javax.xml.transform.TransformerFactory transformerFactory
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+XMLFileActor

+
+public XMLFileActor()
+
+
+ + + + + + + + +
+Method Detail
+ +

+actOnFile

+
+public void actOnFile(java.io.File moduleXML,
+                      java.io.File target,
+                      int depth)
+               throws java.lang.Exception
+
+
This method is the main FileActor method +

+

+
Specified by:
actOnFile in interface FileActor
+
+
+
Parameters:
moduleXML - the sca.module or fragment file
target - the target directory
depth - not uesed here but in the +
Throws: +
java.lang.Exception
See Also:
Here we create an initial DOM + and kick off the processing (using the handler map that has been set + up by the concrete subclass)., +interface to allow for + recursive diving into a directory structure.
+
+
+
+ +

+createDomFromXMLFile

+
+protected org.w3c.dom.Document createDomFromXMLFile(java.io.File xmlSourceFile)
+
+
This method builds an in memory DOM from an XML file +

+

+
+
+
+
Parameters:
xmlSourceFile - the XML file we are handling +
Returns:
the resulting document
+
+
+
+ +

+setParameter

+
+public void setParameter(java.lang.String name,
+                         java.lang.Object value)
+
+
Set a parameter +

+

+
+
+
+
Parameters:
name -
value -
+
+
+
+ +

+getParameter

+
+public java.lang.Object getParameter(java.lang.String name,
+                                     java.lang.Object value)
+
+
Get a parameter +

+

+
+
+
+
Parameters:
name -
value - +
Returns:
the value of the parameter
+
+
+
+ +

+getFilesActedOn

+
+public int getFilesActedOn()
+
+
+
+
+
+ +
Returns:
Returns the filesActedOn.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ComponentDomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ComponentDomNodeHandler.html new file mode 100644 index 0000000000..5b92855433 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ComponentDomNodeHandler.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.ComponentDomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.ComponentDomNodeHandler

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.ComponentDomNodeHandler +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ComponentTypeFileHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ComponentTypeFileHandler.html new file mode 100644 index 0000000000..5b7fe28bdb --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ComponentTypeFileHandler.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.ComponentTypeFileHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.ComponentTypeFileHandler

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.ComponentTypeFileHandler +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DirectoryScanner.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DirectoryScanner.html new file mode 100644 index 0000000000..2b9b52e3bc --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DirectoryScanner.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.DirectoryScanner (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.DirectoryScanner

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.DirectoryScanner +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DomHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DomHandler.html new file mode 100644 index 0000000000..000ac87acc --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DomHandler.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.DomHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.DomHandler

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.DomHandler +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DomNodeHandler.html new file mode 100644 index 0000000000..ed14ed35cd --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/DomNodeHandler.html @@ -0,0 +1,212 @@ + + + + + + +Uses of Interface org.apache.tuscany.sca.cpp.tools.services.DomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Interface
org.apache.tuscany.sca.cpp.tools.services.DomNodeHandler

+
+ + + + + + + + + +
+Packages that use DomNodeHandler
org.apache.tuscany.sca.cpp.tools.services
+ + 
+  +

+ + + + + +
+Uses of DomNodeHandler in org.apache.tuscany.sca.cpp.tools.services
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + +
Classes in org.apache.tuscany.sca.cpp.tools.services that implement DomNodeHandler +
+ classComponentDomNodeHandler + +
+          This class will do the required processing for the element of a + sca module or fragment file.
+ classDomHandler + +
+          The purpose of this class it to provide a generic class that can handle both + a DOM and a DOM node.
+ classGenericDomNodeHandler + +
+           
+ classReferenceDomNodeHandler + +
+          The purpose of this class is to process a element in a + componentType file and then trigger a call to the method in ServicesGenerator + to process the interface header file
+ classServiceDomNodeHandler + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/GenericDomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/GenericDomNodeHandler.html new file mode 100644 index 0000000000..b35bfde41f --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/GenericDomNodeHandler.html @@ -0,0 +1,204 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.GenericDomNodeHandler

+
+ + + + + + + + + +
+Packages that use GenericDomNodeHandler
org.apache.tuscany.sca.cpp.tools.services
+ + 
+  +

+ + + + + +
+Uses of GenericDomNodeHandler in org.apache.tuscany.sca.cpp.tools.services
+  +

+ + + + + + + + + + + + + + + + + + + + +
Subclasses of GenericDomNodeHandler in org.apache.tuscany.sca.cpp.tools.services +
+ classComponentDomNodeHandler + +
+          This class will do the required processing for the element of a + sca module or fragment file.
+ classDomHandler + +
+          The purpose of this class it to provide a generic class that can handle both + a DOM and a DOM node.
+ classReferenceDomNodeHandler + +
+          The purpose of this class is to process a element in a + componentType file and then trigger a call to the method in ServicesGenerator + to process the interface header file
+ classServiceDomNodeHandler + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/LittleClass.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/LittleClass.html new file mode 100644 index 0000000000..a7597e3212 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/LittleClass.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.LittleClass (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.LittleClass

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.LittleClass +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ModuleOrFragmentFileHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ModuleOrFragmentFileHandler.html new file mode 100644 index 0000000000..4115066abd --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ModuleOrFragmentFileHandler.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.ModuleOrFragmentFileHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.ModuleOrFragmentFileHandler

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.ModuleOrFragmentFileHandler +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ReferenceDomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ReferenceDomNodeHandler.html new file mode 100644 index 0000000000..b86f9da242 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ReferenceDomNodeHandler.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.ReferenceDomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.ReferenceDomNodeHandler

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.ReferenceDomNodeHandler +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/Scagen.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/Scagen.html new file mode 100644 index 0000000000..2a212df7cf --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/Scagen.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.Scagen (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.Scagen

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.Scagen +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ServiceDomNodeHandler.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ServiceDomNodeHandler.html new file mode 100644 index 0000000000..630cee5ec6 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ServiceDomNodeHandler.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.ServiceDomNodeHandler (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.ServiceDomNodeHandler

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.ServiceDomNodeHandler +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ServicesGenerator.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ServicesGenerator.html new file mode 100644 index 0000000000..ecf5d60367 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/ServicesGenerator.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.ServicesGenerator (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.ServicesGenerator

+
+No usage of org.apache.tuscany.sca.cpp.tools.services.ServicesGenerator +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/XMLFileActor.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/XMLFileActor.html new file mode 100644 index 0000000000..4749bbd440 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/class-use/XMLFileActor.html @@ -0,0 +1,186 @@ + + + + + + +Uses of Class org.apache.tuscany.sca.cpp.tools.services.XMLFileActor (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Class
org.apache.tuscany.sca.cpp.tools.services.XMLFileActor

+
+ + + + + + + + + +
+Packages that use XMLFileActor
org.apache.tuscany.sca.cpp.tools.services
+ + 
+  +

+ + + + + +
+Uses of XMLFileActor in org.apache.tuscany.sca.cpp.tools.services
+  +

+ + + + + + + + + + + + +
Subclasses of XMLFileActor in org.apache.tuscany.sca.cpp.tools.services +
+ classComponentTypeFileHandler + +
+          The purpose of this class is to specialise the map of XML element handlers + for a XXX.componentType file that is used by the XMLFileActor
+ classModuleOrFragmentFileHandler + +
+          The purpose of this class is purely to specialise the handler map to one with + a specific ComponentDomNodeHandler.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-frame.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-frame.html new file mode 100644 index 0000000000..67936195cb --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-frame.html @@ -0,0 +1,65 @@ + + + + + + +org.apache.tuscany.sca.cpp.tools.services (SCA for C++ Tools) + + + + + + + + + + + +org.apache.tuscany.sca.cpp.tools.services + + + + +
+Interfaces  + +
+DomNodeHandler
+ + + + + + +
+Classes  + +
+ComponentDomNodeHandler +
+ComponentTypeFileHandler +
+DirectoryScanner +
+DomHandler +
+GenericDomNodeHandler +
+LittleClass +
+ModuleOrFragmentFileHandler +
+ReferenceDomNodeHandler +
+Scagen +
+ServiceDomNodeHandler +
+ServicesGenerator +
+XMLFileActor
+ + + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-summary.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-summary.html new file mode 100644 index 0000000000..7d4ef0c594 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-summary.html @@ -0,0 +1,364 @@ + + + + + + +org.apache.tuscany.sca.cpp.tools.services (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+Package org.apache.tuscany.sca.cpp.tools.services +

+
+ + +

+See: +
+          Description +

+ + + + + + + + + +
+Interface Summary
DomNodeHandler 
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ComponentDomNodeHandlerThis class will do the required processing for the element of a + sca module or fragment file.
ComponentTypeFileHandlerThe purpose of this class is to specialise the map of XML element handlers + for a XXX.componentType file that is used by the XMLFileActor
DirectoryScanner 
DomHandlerThe purpose of this class it to provide a generic class that can handle both + a DOM and a DOM node.
GenericDomNodeHandler 
LittleClassThis class is just a convenient application class that is loaded in order to + get the application class loader.
ModuleOrFragmentFileHandlerThe purpose of this class is purely to specialise the handler map to one with + a specific ComponentDomNodeHandler.
ReferenceDomNodeHandlerThe purpose of this class is to process a element in a + componentType file and then trigger a call to the method in ServicesGenerator + to process the interface header file
ScagenThis is the main top level class.
ServiceDomNodeHandler 
ServicesGeneratorThis class is the main class that handles the function that parses a C++ + interface header file into a DOM that holds all the semantic information + about the interface - method names, parameters and return values.
XMLFileActorThe purpose of this abstract class is to provide a home for the standard + processing that is involved in turning a XML file into an internal DOM.
+  + +

+

+Package org.apache.tuscany.sca.cpp.tools.services Description +

+ +

+

+ +

Overview

+ + + +

This package contains classes that generate C++ wrappers and +proxies for C++ implementations of SCA services.

+ +

What the package does

+ +

The Scagen class main method will take in an input and +output directory name. The input directory is taken to be the SCA module root +directory.  The tool will generate the wrapper and proxy headers and methods +bodies in the output directory.

+ +

These proxies and wrappers enable the SCA for C++ runtime to +act as a conduit for SCA C++ calls in a type free manner. Client code can call +the type specific functions that are in the generated proxy classes. The call +is marshalled into a generic format and a SCA for C++ runtime function with a +standard signature is invoked. The details of the call are passed as data.

+ +

On the other end of the runtime, a generated function with a +standard signature is called, this function will inspect the data that +represents the call’s method name and call the appropriate type specific +function in the C++ implementation.

+ +

The Input Data Used

+ +

The input directory passed to the Scagen method is taken to +be the SCA module root directory. All the sca.module and .fragment files in +that directory are inspected to resolve all the <component/> elements +within them.

+ +

Each <component/> element found is inspected to see if +it has a <implementation.cpp/> element within it.

+ +

Each <implementation.cpp/> element should have a +header attribute that represents a C++ header file that contains function +prototypes for the C++ implementation of the service. An optional class +attribute can be used to select one class if more than one that is present in +the header file. The default class is the one with the same name as the header +file. The tool will verify that the implementation header contains an +appropriate class prototype.

+ + + +

The directory that contains the implementation header should +also contain a matching .componentType file for the equivalent SCA component. So +for example, a MyServiceImpl.h file would have a corresponding MyServiceImpl.componentType +file in the same directory.

+ + + +

Each componentType file is inspected for <service/> +and <reference/> elements. For each <service/> element that is +found that contains a <interface.cpp/> element within it,

+ +

the header attribute of the <interface.cpp/> is taken +as the filename of the C++ interface header for the SCA service.  This C++ +header file is opened and used as a means for specifying the SCA service +resulting in an appropriate wrapper and proxy being generated for this service +interface. Both method bodies and headers are generated in the given output +directory. The processing of a <reference/> element is the same except +that only a proxy header and implementation are generated.

+ + + + + +

Outline Design: How it Works

+ + + +

The basic approach is to scan in the XML files by first +creating a DOM document tree of them and then recursively rifling through the DOM  +with some generic code in the XMLFileActorClass by default this processing will +build up a map which maps the XPath location of attributes to their values. +Additionally subclasses can add to a “handlers map” which maps from the name of +a particular element to an object that implements the DomNodeHandler interface. +If the XMLFileActor code comes across any element that has an equivalent handler +in the handler map the objects handleNode method will be called.

+ +

Typically the DomNodeHandler’s handle node interface will +use XPath to pull out the parameters that it is interested in from the +parameters map that is being built up by the generic code.

+ +

This design was chosen as the Java level specified for the +original implementation did not have direct XPath query of XML data but it was +known that this would be available in Java 1.5 onwards. The design allows the +DOM and parameters map handling to be replaced in the future with JRE 1.5 code +with less impact on the rest of the code.

+ + + +

The processing leads to the parsing of the C++ interface +files using the org\apache\tuscany\sca\cpp\tools\common package. This results +in a Headers object

+ +

that contains a List of Signature objects, each one +representing a function prototype found in the header.

+ + + +

We are aiming to get all the semantic data we want to use +into a DOM document (this represents the model of our input data) and then use +XSLT to create the 4 different views of this data:

+ +

Proxy C++ header

+ +

Proxy C++  body

+ +

Wrapper C++ header

+ +

Wrapper C++ body

+ + + +

So we prepopulate the DOM with parameter data that comes +from the XML files and then iterate through the Signatures that are returned +from the C++ header parser transferring the useful data into the DOM.

+ + + +

We than use 4 XSLT stylesheets to generate the C++ output +files as required.

+ +
+

+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-tree.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-tree.html new file mode 100644 index 0000000000..adceb9d363 --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-tree.html @@ -0,0 +1,162 @@ + + + + + + +org.apache.tuscany.sca.cpp.tools.services Class Hierarchy (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Hierarchy For Package org.apache.tuscany.sca.cpp.tools.services +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + diff --git a/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-use.html b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-use.html new file mode 100644 index 0000000000..f35093ab2a --- /dev/null +++ b/sca-cpp/tags/cpp-sca-20060405/tools/scagen/docs/api/org/apache/tuscany/sca/cpp/tools/services/package-use.html @@ -0,0 +1,179 @@ + + + + + + +Uses of Package org.apache.tuscany.sca.cpp.tools.services (SCA for C++ Tools) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+

+Uses of Package
org.apache.tuscany.sca.cpp.tools.services

+
+ + + + + + + + + +
+Packages that use org.apache.tuscany.sca.cpp.tools.services
org.apache.tuscany.sca.cpp.tools.services
+ + 
+  +

+ + + + + + + + + + + + + + +
+Classes in org.apache.tuscany.sca.cpp.tools.services used by org.apache.tuscany.sca.cpp.tools.services
DomNodeHandler + +
+           
GenericDomNodeHandler + +
+           
XMLFileActor + +
+          The purpose of this abstract class is to provide a home for the standard + processing that is involved in turning a XML file into an internal DOM.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + Copyright 2005 The Apache Software Foundation and Copyright IBM Corp. 2005 All Rights Reserved + + -- cgit v1.2.3