Help for Macros in CommonMacros.inc

# HG changeset patch # User stechong # Date 1258140874 21600 # Node ID 41edc8c123d608eab50963e984f2c890497cd437 # Parent 22956bdb436ebea63882b55b9eeaad10caf175cc# Parent b46382ab04d23acd1e4a17374829a9bc3406f4d7 Merge commit. diff -r 22956bdb436e -r 41edc8c123d6 uidesigner/com.nokia.sdt.component.symbian/src/com/nokia/sdt/component/symbian/sourcegen/macrohelp/MacroHelpGenerator.java --- a/uidesigner/com.nokia.sdt.component.symbian/src/com/nokia/sdt/component/symbian/sourcegen/macrohelp/MacroHelpGenerator.java Fri Nov 13 13:34:02 2009 -0600 +++ b/uidesigner/com.nokia.sdt.component.symbian/src/com/nokia/sdt/component/symbian/sourcegen/macrohelp/MacroHelpGenerator.java Fri Nov 13 13:34:34 2009 -0600 @@ -1,5 +1,5 @@ /* -* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). +* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). * All rights reserved. * This component and the accompanying materials are made available * under the terms of the License "Eclipse Public License v1.0" @@ -25,16 +25,14 @@ import com.nokia.sdt.emf.component.loader.Loader; import com.nokia.cpp.internal.api.utils.core.FileUtils; import com.nokia.cpp.internal.api.utils.core.MessageLocation; -import com.sun.org.apache.html.internal.dom.HTMLDOMImplementationImpl; import org.eclipse.core.runtime.Path; import org.eclipse.emf.common.util.TreeIterator; import org.eclipse.emf.common.util.URI; import org.eclipse.emf.ecore.EObject; +import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; -import org.w3c.dom.html.HTMLDOMImplementation; -import org.w3c.dom.html.HTMLDocument; import java.io.File; import java.io.FileOutputStream; @@ -46,6 +44,7 @@ import java.util.List; import java.util.Map; +import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.transform.Result; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerFactory; @@ -62,6 +61,7 @@ public class MacroHelpGenerator { private SourceGenMacroSupport macroSupport; private Map> macroMap; + private Document document; public static void main(String[] args) { MacroHelpGenerator generator = new MacroHelpGenerator(); @@ -130,22 +130,29 @@ } private void generate(String fName) throws Exception { - HTMLDOMImplementation domImpl = HTMLDOMImplementationImpl.getHTMLDOMImplementation(); - HTMLDocument document = domImpl.createHTMLDocument( - "Help for Macros in " + new File(fName).getName()); + document = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument(); + Element html = document.createElement("html"); + document.appendChild(html); + html.setAttribute("xmlns", "http://www.w3.org/1999/xhtml"); + Element head = document.createElement("head"); + html.appendChild(head); + Element title = document.createElement("title"); + head.appendChild(title); + title.setTextContent("Help for Macros in " + new File(fName).getName()); + Element body = document.createElement("body"); + html.appendChild(body); Element tocParent = document.createElement("p"); - document.getBody().appendChild(tocParent); + body.appendChild(tocParent); Element tocTitle = document.createElement("h1"); tocTitle.setTextContent("Table of contents"); tocParent.appendChild(tocTitle); Element helpParent = document.createElement("p"); - document.getBody().appendChild(helpParent); + body.appendChild(helpParent); for (ResolvedMacro macro : macroMap.get(fName)) { - generateMacroHelp(document, - tocParent, + generateMacroHelp(tocParent, helpParent, macro); tocParent.appendChild(document.createTextNode("\n")); @@ -173,9 +180,8 @@ private void generateMacroHelp( - HTMLDocument document, Element tocParent, - Element helpParent, + Element helpParent, ResolvedMacro macro) { String id = macro.macro.getId(); @@ -201,11 +207,11 @@ helpEntry.setTextContent(id); helpParent.appendChild(helpEntry); - generateMacroDescription(document, helpParent, macro); + generateMacroDescription(helpParent, macro); } - private void generateMacroDescription(HTMLDocument document, - Element helpEntry, ResolvedMacro macro) { + private void generateMacroDescription(Element helpEntry, + ResolvedMacro macro) { DefineMacroType dmt = macro.macro; String help = dmt.getHelp(); @@ -215,7 +221,7 @@ helpEntry.appendChild(para); } else { - helpEntry.appendChild(encodeHTML(document, help)); + helpEntry.appendChild(encodeHTML(help)); } Element header = document.createElement("h3"); @@ -223,12 +229,12 @@ helpEntry.appendChild(header); //Element ul = document.createElement("ul"); - generateMacroArgumentsHelp(document, helpEntry, macro); + generateMacroArgumentsHelp(helpEntry, macro); //helpEntry.appendChild(ul); } - private void generateMacroArgumentsHelp(HTMLDocument document, - Element ul, ResolvedMacro macro) { + private void generateMacroArgumentsHelp(Element ul, + ResolvedMacro macro) { // organize arguments by their origin: // these are already ordered as @@ -269,7 +275,7 @@ } } - private void emitArgumentGroup(HTMLDocument document, + private void emitArgumentGroup(Document document, Element parent, boolean isInherited, ResolvedMacro fromMacro, @@ -321,13 +327,13 @@ }); for (MacroArgumentType argument : arguments) { - generateMacroArgumentHelp(document, table, fromMacro, argument); + generateMacroArgumentHelp(table, fromMacro, argument); } } - private void generateMacroArgumentHelp(HTMLDocument document, - Element table, ResolvedMacro macro, MacroArgumentType argument) { + private void generateMacroArgumentHelp(Element table, + ResolvedMacro macro, MacroArgumentType argument) { Element tr = document.createElement("tr"); table.appendChild(tr); @@ -349,7 +355,7 @@ td = document.createElement("td"); if (argument.getHelp() != null && argument.getHelp().length() > 0) - td.appendChild(encodeHTML(document, argument.getHelp())); + td.appendChild(encodeHTML(argument.getHelp())); else td.setTextContent("\u00A0"); tr.appendChild(td); @@ -357,7 +363,7 @@ //static Pattern PARAGRAPH_PATTERN = Pattern.compile("(.*)(\r?\n)\\s*(\r?\n)", Pattern.MULTILINE); - private Node encodeHTML(HTMLDocument document, String help) { + private Node encodeHTML(String help) { Node el = document.createTextNode(""); boolean hadParagraphs = false; int idx = 0; diff -r 22956bdb436e -r 41edc8c123d6 uidesigner/com.nokia.sdt.series60.componentlibrary/components/CommonMacros.inc.html --- a/uidesigner/com.nokia.sdt.series60.componentlibrary/components/CommonMacros.inc.html Fri Nov 13 13:34:02 2009 -0600 +++ b/uidesigner/com.nokia.sdt.series60.componentlibrary/components/CommonMacros.inc.html Fri Nov 13 13:34:34 2009 -0600 @@ -1,1393 +1,19 @@ - - - -Help for Macros in CommonMacros.inc - - -

-DeclareMethod -

- -

-GenerateDefaultFunctionBody -

- -

-DefineMethod -

- -

-GenerateMethod -

- -

-DefineMethodWithOwnedBody -

- -

-GenerateMethodWithOwnedBody -

- -

-GenerateMethodWithVariantArguments -

- -

-GenerateVirtualMethodOverrideForEventHandler -

- -

-GenerateUserEventHandlerFunction -

- -

DeclareMethod

Declares a method, e.g., the prototype.

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionName	yes		- - name of function - -
FunctionArgs	yes		- - canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3") - -
FunctionName	yes		- - name of function - -
FunctionArgs	yes		- - canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3") - -
DeclLocation	no		- - name of location into which to add the prototype (either this or DeclPhase must be defined) - -
DeclPhase	no		- - name of phase into which to add the prototype (either this or DeclLocation must be defined) - -
ReturnType	no	void	- - return type for function - -
IsStatic	no	false	- - is the function static? - -
IsVirtual	no	false	- - is the function virtual? (ignored if IsStatic) - -
IsConst	no	false	- - add 'const' modifier to function? - -
DeclLocation	no		- - name of location into which to add the prototype (either this or DeclPhase must be defined) - -
DeclPhase	no		- - name of phase into which to add the prototype (either this or DeclLocation must be defined) - -
ReturnType	no	void	- - return type for function - -
IsStatic	no	false	- - is the function static? - -
IsVirtual	no	false	- - is the function virtual? (ignored if IsStatic) - -
IsConst	no	false	- - add 'const' modifier to function? - -

- - -

GenerateDefaultFunctionBody

Create the default body for a function. If FunctionBody is set, emits that. If ReturnType is not void and DefaultReturn is set, create a return statement using its value.

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionLocationId	yes		- - name of the function location to define; body is named id+_BODY - -
FunctionLocationId	yes		- - name of the function location to define; body is named id+_BODY - -
DefaultReturn	no		- - default value to return; overridden if FunctionBody is specified - -
ReturnType	no	void	- - return type for function - -
FunctionBody	no		- - text inside function body (comment and/or code) - -
DefaultReturn	no		- - default value to return; overridden if FunctionBody is specified - -
ReturnType	no	void	- - return type for function - -
FunctionBody	no		- - text inside function body (comment and/or code) - -

- - -

DefineMethod

Defines a method to one location, optionally generating body text, or a default return statement. The generated function is owned by default.

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
DefnLocation	yes		- - name of location into which to add the function - -
FunctionName	yes		- - name of function - -
FunctionArgs	yes		- - canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3") - -
DefnLocation	yes		- - name of location into which to add the function - -
FunctionName	yes		- - name of function - -
FunctionArgs	yes		- - canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3") - -
IsOwned	no	true	- - is the function body owned? - -
IsConst	no	false	- - add 'const' modifier to function? - -
ClassName	no	${className}	- - the class name - -
FunctionComment	no		- - comment appearing before function defn - -
IsEventHandler	no	false	- - is the function body the user event handler? - -
Initializers	no		- - provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically - -
IsOwned	no	true	- - is the function body owned? - -
IsConst	no	false	- - add 'const' modifier to function? - -
ClassName	no	${className}	- - the class name - -
FunctionComment	no		- - comment appearing before function defn - -
IsEventHandler	no	false	- - is the function body the user event handler? - -
Initializers	no		- - provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically - -

Inherited from GenerateDefaultFunctionBody:

- - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionLocationId	yes		- - name of the function location to define; body is named id+_BODY - -
DefaultReturn	no		- - default value to return; overridden if FunctionBody is specified - -
ReturnType	no	void	- - return type for function - -
FunctionBody	no		- - text inside function body (comment and/or code) - -

- - -

GenerateMethod

Declares and defines a method to one location and adds the prototype to another location.

Arguments

- - -

Argument	Req'd?	Default	Description

Inherited from DeclareMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionName	yes		- - name of function - -
FunctionArgs	yes		- - canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3") - -
DeclLocation	no		- - name of location into which to add the prototype (either this or DeclPhase must be defined) - -
DeclPhase	no		- - name of phase into which to add the prototype (either this or DeclLocation must be defined) - -
ReturnType	no	void	- - return type for function - -
IsStatic	no	false	- - is the function static? - -
IsVirtual	no	false	- - is the function virtual? (ignored if IsStatic) - -
IsConst	no	false	- - add 'const' modifier to function? - -

Inherited from DefineMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionLocationId	yes		- - name of the function location to define; body is named id+_BODY - -
DefnLocation	yes		- - name of location into which to add the function - -
DefaultReturn	no		- - default value to return; overridden if FunctionBody is specified - -
FunctionBody	no		- - text inside function body (comment and/or code) - -
IsOwned	no	true	- - is the function body owned? - -
ClassName	no	${className}	- - the class name - -
FunctionComment	no		- - comment appearing before function defn - -
IsEventHandler	no	false	- - is the function body the user event handler? - -
Initializers	no		- - provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically - -

- - -

DefineMethodWithOwnedBody

Defines a method with an owned body section.

The generated function is not owned by default, unlike Method. There may be uses for an owned function with a named owned region, though.

Also, no default function code is generated, so the provided StartFunctionBody, FunctionBody, and EndFunctionBody must account for any return statements.

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionBody	no		- - text inside owned part of function body - -
OwnedRegionLocationId	no	$(FunctionLocationId)_BODY	- - location id for enclosed body - -
OwnedRegionName	no	Generated Contents	- - region name for enclosed body - -
StartFunctionBody	no		- - text inside function body (comment and/or code) before the owned section - -
EndFunctionBody	no		- - text inside function body (comment and/or code) after the owned section - -
FunctionBody	no		- - text inside owned part of function body - -
OwnedRegionLocationId	no	$(FunctionLocationId)_BODY	- - location id for enclosed body - -
OwnedRegionName	no	Generated Contents	- - region name for enclosed body - -
StartFunctionBody	no		- - text inside function body (comment and/or code) before the owned section - -
EndFunctionBody	no		- - text inside function body (comment and/or code) after the owned section - -

Inherited from DefineMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionLocationId	yes		- - name of the function location to define; body is named id+_BODY - -
DefnLocation	yes		- - name of location into which to add the function - -
FunctionName	yes		- - name of function - -
FunctionArgs	yes		- - canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3") - -
DefaultReturn	no		- - default value to return; overridden if FunctionBody is specified - -
ReturnType	no	void	- - return type for function - -
IsOwned	no	true	- - is the function body owned? - -
IsConst	no	false	- - add 'const' modifier to function? - -
ClassName	no	${className}	- - the class name - -
FunctionComment	no		- - comment appearing before function defn - -
IsEventHandler	no	false	- - is the function body the user event handler? - -
Initializers	no		- - provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically - -

- - -

GenerateMethodWithOwnedBody

Declares and defines a method with an owned body section to one location and adds the prototype to another location.

The generated function is not owned by default, unlike Method. There may be uses for an owned function with a named owned region, though.

Arguments

- - -

Argument	Req'd?	Default	Description

Inherited from DefineMethodWithOwnedBody:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionLocationId	yes		- - name of the function location to define; body is named id+_BODY - -
DefnLocation	yes		- - name of location into which to add the function - -
FunctionName	yes		- - name of function - -
FunctionArgs	yes		- - canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3") - -
DefaultReturn	no		- - default value to return; overridden if FunctionBody is specified - -
ReturnType	no	void	- - return type for function - -
FunctionBody	no		- - text inside owned part of function body - -
IsOwned	no	true	- - is the function body owned? - -
IsConst	no	false	- - add 'const' modifier to function? - -
ClassName	no	${className}	- - the class name - -
FunctionComment	no		- - comment appearing before function defn - -
IsEventHandler	no	false	- - is the function body the user event handler? - -
Initializers	no		- - provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically - -
OwnedRegionLocationId	no	$(FunctionLocationId)_BODY	- - location id for enclosed body - -
OwnedRegionName	no	Generated Contents	- - region name for enclosed body - -
StartFunctionBody	no		- - text inside function body (comment and/or code) before the owned section - -
EndFunctionBody	no		- - text inside function body (comment and/or code) after the owned section - -

Inherited from DeclareMethod:

- - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
DeclLocation	no		- - name of location into which to add the prototype (either this or DeclPhase must be defined) - -
DeclPhase	no		- - name of phase into which to add the prototype (either this or DeclLocation must be defined) - -
IsStatic	no	false	- - is the function static? - -
IsVirtual	no	false	- - is the function virtual? (ignored if IsStatic) - -

- - -

GenerateMethodWithVariantArguments

Declares and defines an owned method with variant arguments to one location and adds the prototype to another location.

Variant arguments means design-time variable (not C varargs). The function has a non-empty list of fixed arguments followed by a non-empty list of variable arguments which are generated by a Javascript expression.

The generated function is owned by default. It doesn't make sense to use this non-owned, since this will introduce compile errors when the prototype changes and the old body remains behind.

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionArgs	yes		- - canonical leading static argument list (e.g. "const TInt& aArg, TInt aFoo = 3") Do not include a trailing comma - -
FunctionVarArgsAllowEmpty	yes		- - tell whether the varargs may be empty - -
FunctionVarArgsDeclExpr	yes		- - generator for the variable arguments as appearing in the declaration (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma - -
FunctionVarArgsDefnExpr	yes		- - generator for the variable arguments as appearing in the definition (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma - -
FunctionArgs	yes		- - canonical leading static argument list (e.g. "const TInt& aArg, TInt aFoo = 3") Do not include a trailing comma - -
FunctionVarArgsAllowEmpty	yes		- - tell whether the varargs may be empty - -
FunctionVarArgsDeclExpr	yes		- - generator for the variable arguments as appearing in the declaration (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma - -
FunctionVarArgsDefnExpr	yes		- - generator for the variable arguments as appearing in the definition (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma - -
IsOwned	no	true	- - tell whether the function is owned. In general, it should be, otherwise compile errors will be introduced when the method's signature changes and the old version is left behind. - -
IsOwned	no	true	- - tell whether the function is owned. In general, it should be, otherwise compile errors will be introduced when the method's signature changes and the old version is left behind. - -

Inherited from GenerateMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionName	yes		- - name of function - -
FunctionLocationId	yes		- - name of the function location to define; body is named id+_BODY - -
DefnLocation	yes		- - name of location into which to add the function - -
DeclLocation	no		- - name of location into which to add the prototype (either this or DeclPhase must be defined) - -
DeclPhase	no		- - name of phase into which to add the prototype (either this or DeclLocation must be defined) - -
ReturnType	no	void	- - return type for function - -
IsStatic	no	false	- - is the function static? - -
IsVirtual	no	false	- - is the function virtual? (ignored if IsStatic) - -
IsConst	no	false	- - add 'const' modifier to function? - -
DefaultReturn	no		- - default value to return; overridden if FunctionBody is specified - -
FunctionBody	no		- - text inside function body (comment and/or code) - -
ClassName	no	${className}	- - the class name - -
FunctionComment	no		- - comment appearing before function defn - -
IsEventHandler	no	false	- - is the function body the user event handler? - -
Initializers	no		- - provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically - -

- - -

GenerateVirtualMethodOverrideForEventHandler

Override a virtual method with a non-owned function with an owned body. This must be invoked in a templateGroup that has an ifEvents="..." attribute, so the 'event' variable is available.

Arguments

- - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
ClassName	no	${handlerClassName}	- - the name of the class - -
UserHandlerFunctionArgs	no		- - the arguments passed to the user handler function (== FunctionArgs by default) - -
ClassName	no	${handlerClassName}	- - the name of the class - -
UserHandlerFunctionArgs	no		- - the arguments passed to the user handler function (== FunctionArgs by default) - -

Inherited from GenerateMethodWithOwnedBody:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionLocationId	yes		- - name of the function location to define; body is named id+_BODY - -
DefnLocation	yes		- - name of location into which to add the function - -
FunctionName	yes		- - name of function - -
FunctionArgs	yes		- - canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3") - -
DefaultReturn	no		- - default value to return; overridden if FunctionBody is specified - -
ReturnType	no	void	- - return type for function - -
FunctionBody	no		- - text inside owned part of function body - -
IsOwned	no	true	- - is the function body owned? - -
IsConst	no	false	- - add 'const' modifier to function? - -
FunctionComment	no		- - comment appearing before function defn - -
IsEventHandler	no	false	- - is the function body the user event handler? - -
Initializers	no		- - provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically - -
OwnedRegionLocationId	no	$(FunctionLocationId)_BODY	- - location id for enclosed body - -
OwnedRegionName	no	Generated Contents	- - region name for enclosed body - -
StartFunctionBody	no		- - text inside function body (comment and/or code) before the owned section - -
EndFunctionBody	no		- - text inside function body (comment and/or code) after the owned section - -
DeclLocation	no		- - name of location into which to add the prototype (either this or DeclPhase must be defined) - -
DeclPhase	no		- - name of phase into which to add the prototype (either this or DeclLocation must be defined) - -

- - -

GenerateUserEventHandlerFunction

Define a user handler declaration and function.

Provides a default header comment and body comment.

This is NOT conditional, so include it in a <templateGroup ifEvents="..." />

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionLocationId	yes		- - the id for the event handler function - -
FunctionLocationId	yes		- - the id for the event handler function - -
FunctionName	no	${event.handlerName}	- - the name of the function/method for the handler; generally the default should be used (the name specified in the Events view) - -
FunctionBody	no		- - the body of the function, which by default is a TODO comment - -
ClassName	no	${handlerClassName}	- - the name of the class that receives the handler - -
FunctionComment	no		- - the comment for the function - -
FunctionName	no	${event.handlerName}	- - the name of the function/method for the handler; generally the default should be used (the name specified in the Events view) - -
FunctionBody	no		- - the body of the function, which by default is a TODO comment - -
ClassName	no	${handlerClassName}	- - the name of the class that receives the handler - -
FunctionComment	no		- - the comment for the function - -

Inherited from GenerateMethod:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
FunctionArgs	yes		- - canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3") - -
DefnLocation	yes		- - name of location into which to add the function - -
DeclLocation	no		- - name of location into which to add the prototype (either this or DeclPhase must be defined) - -
DeclPhase	no		- - name of phase into which to add the prototype (either this or DeclLocation must be defined) - -
ReturnType	no	void	- - return type for function - -
IsConst	no	false	- - add 'const' modifier to function? - -
DefaultReturn	no		- - default value to return; overridden if FunctionBody is specified - -
IsOwned	no	true	- - is the function body owned? - -
IsEventHandler	no	false	- - is the function body the user event handler? - -
Initializers	no		- - provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically - -

- -

- - +Help for Macros in CommonMacros.inc

DeclareMethod

GenerateDefaultFunctionBody

DefineMethod

GenerateMethod

DefineMethodWithOwnedBody

GenerateMethodWithOwnedBody

GenerateMethodWithVariantArguments

GenerateVirtualMethodOverrideForEventHandler

GenerateUserEventHandlerFunction

DeclareMethod

Declares a method, e.g., the prototype.

Arguments

Argument	Req'd?	Default	Description
FunctionName	yes		name of function
FunctionArgs	yes		canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")
FunctionName	yes		name of function
FunctionArgs	yes		canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")
DeclLocation	no		name of location into which to add the prototype (either this or DeclPhase must be defined)
DeclPhase	no		name of phase into which to add the prototype (either this or DeclLocation must be defined)
ReturnType	no	void	return type for function
IsStatic	no	false	is the function static?
IsVirtual	no	false	is the function virtual? (ignored if IsStatic)
IsConst	no	false	add 'const' modifier to function?
DeclLocation	no		name of location into which to add the prototype (either this or DeclPhase must be defined)
DeclPhase	no		name of phase into which to add the prototype (either this or DeclLocation must be defined)
ReturnType	no	void	return type for function
IsStatic	no	false	is the function static?
IsVirtual	no	false	is the function virtual? (ignored if IsStatic)
IsConst	no	false	add 'const' modifier to function?

GenerateDefaultFunctionBody

Create the default body for a function. If FunctionBody is set, emits that. If ReturnType is not void and DefaultReturn is set, create a return statement using its value.

Arguments

Argument	Req'd?	Default	Description
FunctionLocationId	yes		name of the function location to define; body is named id+_BODY
FunctionLocationId	yes		name of the function location to define; body is named id+_BODY
DefaultReturn	no		default value to return; overridden if FunctionBody is specified
ReturnType	no	void	return type for function
FunctionBody	no		text inside function body (comment and/or code)
DefaultReturn	no		default value to return; overridden if FunctionBody is specified
ReturnType	no	void	return type for function
FunctionBody	no		text inside function body (comment and/or code)

DefineMethod

Defines a method to one location, optionally generating body text, or a default return statement. The generated function is owned by default.

Arguments

Argument	Req'd?	Default	Description
DefnLocation	yes		name of location into which to add the function
FunctionName	yes		name of function
FunctionArgs	yes		canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")
DefnLocation	yes		name of location into which to add the function
FunctionName	yes		name of function
FunctionArgs	yes		canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")
IsOwned	no	true	is the function body owned?
IsConst	no	false	add 'const' modifier to function?
ClassName	no	${className}	the class name
FunctionComment	no		comment appearing before function defn
IsEventHandler	no	false	is the function body the user event handler?
Initializers	no		provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically
Realize	no	false	If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.
IsOwned	no	true	is the function body owned?
IsConst	no	false	add 'const' modifier to function?
ClassName	no	${className}	the class name
FunctionComment	no		comment appearing before function defn
IsEventHandler	no	false	is the function body the user event handler?
Initializers	no		provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically
Realize	no	false	If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

Inherited from GenerateDefaultFunctionBody:

Argument	Req'd?	Default	Description
FunctionLocationId	yes		name of the function location to define; body is named id+_BODY
DefaultReturn	no		default value to return; overridden if FunctionBody is specified
ReturnType	no	void	return type for function
FunctionBody	no		text inside function body (comment and/or code)

GenerateMethod

Declares and defines a method to one location and adds the prototype to another location.

Arguments

Argument	Req'd?	Default	Description

Inherited from DeclareMethod:

Argument	Req'd?	Default	Description
FunctionName	yes		name of function
FunctionArgs	yes		canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")
DeclLocation	no		name of location into which to add the prototype (either this or DeclPhase must be defined)
DeclPhase	no		name of phase into which to add the prototype (either this or DeclLocation must be defined)
ReturnType	no	void	return type for function
IsStatic	no	false	is the function static?
IsVirtual	no	false	is the function virtual? (ignored if IsStatic)
IsConst	no	false	add 'const' modifier to function?

Inherited from DefineMethod:

Argument	Req'd?	Default	Description
FunctionLocationId	yes		name of the function location to define; body is named id+_BODY
DefnLocation	yes		name of location into which to add the function
DefaultReturn	no		default value to return; overridden if FunctionBody is specified
FunctionBody	no		text inside function body (comment and/or code)
IsOwned	no	true	is the function body owned?
ClassName	no	${className}	the class name
FunctionComment	no		comment appearing before function defn
IsEventHandler	no	false	is the function body the user event handler?
Initializers	no		provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically
Realize	no	false	If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

DefineMethodWithOwnedBody

Defines a method with an owned body section.

The generated function is not owned by default, unlike Method. There may be uses for an owned function with a named owned region, though.

Also, no default function code is generated, so the provided StartFunctionBody, FunctionBody, and EndFunctionBody must account for any return statements.

Arguments

Argument	Req'd?	Default	Description
FunctionBody	no		text inside owned part of function body
OwnedRegionLocationId	no	$(FunctionLocationId)_BODY	location id for enclosed body
OwnedRegionName	no	Generated Contents	region name for enclosed body
StartFunctionBody	no		text inside function body (comment and/or code) before the owned section
EndFunctionBody	no		text inside function body (comment and/or code) after the owned section
FunctionBody	no		text inside owned part of function body
OwnedRegionLocationId	no	$(FunctionLocationId)_BODY	location id for enclosed body
OwnedRegionName	no	Generated Contents	region name for enclosed body
StartFunctionBody	no		text inside function body (comment and/or code) before the owned section
EndFunctionBody	no		text inside function body (comment and/or code) after the owned section

Inherited from DefineMethod:

Argument	Req'd?	Default	Description
FunctionLocationId	yes		name of the function location to define; body is named id+_BODY
DefnLocation	yes		name of location into which to add the function
FunctionName	yes		name of function
FunctionArgs	yes		canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")
DefaultReturn	no		default value to return; overridden if FunctionBody is specified
ReturnType	no	void	return type for function
IsOwned	no	true	is the function body owned?
IsConst	no	false	add 'const' modifier to function?
ClassName	no	${className}	the class name
FunctionComment	no		comment appearing before function defn
IsEventHandler	no	false	is the function body the user event handler?
Initializers	no		provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically
Realize	no	false	If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

GenerateMethodWithOwnedBody

Declares and defines a method with an owned body section to one location and adds the prototype to another location.

The generated function is not owned by default, unlike Method. There may be uses for an owned function with a named owned region, though.

Arguments

Argument	Req'd?	Default	Description

Inherited from DefineMethodWithOwnedBody:

Argument	Req'd?	Default	Description
FunctionLocationId	yes		name of the function location to define; body is named id+_BODY
DefnLocation	yes		name of location into which to add the function
FunctionName	yes		name of function
FunctionArgs	yes		canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")
DefaultReturn	no		default value to return; overridden if FunctionBody is specified
ReturnType	no	void	return type for function
FunctionBody	no		text inside owned part of function body
IsOwned	no	true	is the function body owned?
IsConst	no	false	add 'const' modifier to function?
ClassName	no	${className}	the class name
FunctionComment	no		comment appearing before function defn
IsEventHandler	no	false	is the function body the user event handler?
Initializers	no		provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically
Realize	no	false	If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.
OwnedRegionLocationId	no	$(FunctionLocationId)_BODY	location id for enclosed body
OwnedRegionName	no	Generated Contents	region name for enclosed body
StartFunctionBody	no		text inside function body (comment and/or code) before the owned section
EndFunctionBody	no		text inside function body (comment and/or code) after the owned section

Inherited from DeclareMethod:

Argument	Req'd?	Default	Description
DeclLocation	no		name of location into which to add the prototype (either this or DeclPhase must be defined)
DeclPhase	no		name of phase into which to add the prototype (either this or DeclLocation must be defined)
IsStatic	no	false	is the function static?
IsVirtual	no	false	is the function virtual? (ignored if IsStatic)

GenerateMethodWithVariantArguments

Declares and defines an owned method with variant arguments to one location and adds the prototype to another location.

The generated function is owned by default. It doesn't make sense to use this non-owned, since this will introduce compile errors when the prototype changes and the old body remains behind.

Arguments

Argument	Req'd?	Default	Description
FunctionArgs	yes		canonical leading static argument list (e.g. "const TInt& aArg, TInt aFoo = 3") Do not include a trailing comma
FunctionVarArgsAllowEmpty	yes		tell whether the varargs may be empty
FunctionVarArgsDeclExpr	yes		generator for the variable arguments as appearing in the declaration (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma
FunctionVarArgsDefnExpr	yes		generator for the variable arguments as appearing in the definition (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma
FunctionArgs	yes		canonical leading static argument list (e.g. "const TInt& aArg, TInt aFoo = 3") Do not include a trailing comma
FunctionVarArgsAllowEmpty	yes		tell whether the varargs may be empty
FunctionVarArgsDeclExpr	yes		generator for the variable arguments as appearing in the declaration (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma
FunctionVarArgsDefnExpr	yes		generator for the variable arguments as appearing in the definition (a Javascript expression); if FunctionVarArgsAllowEmpty==false, do not generate a leading comma
IsOwned	no	true	tell whether the function is owned. In general, it should be, otherwise compile errors will be introduced when the method's signature changes and the old version is left behind.
IsOwned	no	true	tell whether the function is owned. In general, it should be, otherwise compile errors will be introduced when the method's signature changes and the old version is left behind.

Inherited from GenerateMethod:

Argument	Req'd?	Default	Description
FunctionName	yes		name of function
FunctionLocationId	yes		name of the function location to define; body is named id+_BODY
DefnLocation	yes		name of location into which to add the function
DeclLocation	no		name of location into which to add the prototype (either this or DeclPhase must be defined)
DeclPhase	no		name of phase into which to add the prototype (either this or DeclLocation must be defined)
ReturnType	no	void	return type for function
IsStatic	no	false	is the function static?
IsVirtual	no	false	is the function virtual? (ignored if IsStatic)
IsConst	no	false	add 'const' modifier to function?
DefaultReturn	no		default value to return; overridden if FunctionBody is specified
FunctionBody	no		text inside function body (comment and/or code)
ClassName	no	${className}	the class name
FunctionComment	no		comment appearing before function defn
IsEventHandler	no	false	is the function body the user event handler?
Initializers	no		provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically
Realize	no	false	If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

GenerateVirtualMethodOverrideForEventHandler

Override a virtual method with a non-owned function with an owned body. This must be invoked in a templateGroup that has an ifEvents="..." attribute, so the 'event' variable is available.

Arguments

Argument	Req'd?	Default	Description
ClassName	no	${handlerClassName}	the name of the class
UserHandlerFunctionArgs	no		the arguments passed to the user handler function (== FunctionArgs by default)
ClassName	no	${handlerClassName}	the name of the class
UserHandlerFunctionArgs	no		the arguments passed to the user handler function (== FunctionArgs by default)

Inherited from GenerateMethodWithOwnedBody:

Argument	Req'd?	Default	Description
FunctionLocationId	yes		name of the function location to define; body is named id+_BODY
DefnLocation	yes		name of location into which to add the function
FunctionName	yes		name of function
FunctionArgs	yes		canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")
DefaultReturn	no		default value to return; overridden if FunctionBody is specified
ReturnType	no	void	return type for function
FunctionBody	no		text inside owned part of function body
IsOwned	no	true	is the function body owned?
IsConst	no	false	add 'const' modifier to function?
FunctionComment	no		comment appearing before function defn
IsEventHandler	no	false	is the function body the user event handler?
Initializers	no		provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically
Realize	no	false	If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.
OwnedRegionLocationId	no	$(FunctionLocationId)_BODY	location id for enclosed body
OwnedRegionName	no	Generated Contents	region name for enclosed body
StartFunctionBody	no		text inside function body (comment and/or code) before the owned section
EndFunctionBody	no		text inside function body (comment and/or code) after the owned section
DeclLocation	no		name of location into which to add the prototype (either this or DeclPhase must be defined)
DeclPhase	no		name of phase into which to add the prototype (either this or DeclLocation must be defined)

GenerateUserEventHandlerFunction

Define a user handler declaration and function.

Provides a default header comment and body comment.

This is NOT conditional, so include it in a <templateGroup ifEvents="..." />

Arguments

Argument	Req'd?	Default	Description
FunctionLocationId	yes		the id for the event handler function
FunctionLocationId	yes		the id for the event handler function
FunctionName	no	${event.handlerName}	the name of the function/method for the handler; generally the default should be used (the name specified in the Events view)
FunctionBody	no		the body of the function, which by default is a TODO comment
ClassName	no	${handlerClassName}	the name of the class that receives the handler
FunctionComment	no		the comment for the function
FunctionName	no	${event.handlerName}	the name of the function/method for the handler; generally the default should be used (the name specified in the Events view)
FunctionBody	no		the body of the function, which by default is a TODO comment
ClassName	no	${handlerClassName}	the name of the class that receives the handler
FunctionComment	no		the comment for the function

Inherited from GenerateMethod:

Argument	Req'd?	Default	Description
FunctionArgs	yes		canonical argument list (e.g. "const TInt& aArg, TInt aFoo = 3")
DefnLocation	yes		name of location into which to add the function
DeclLocation	no		name of location into which to add the prototype (either this or DeclPhase must be defined)
DeclPhase	no		name of phase into which to add the prototype (either this or DeclLocation must be defined)
ReturnType	no	void	return type for function
IsConst	no	false	add 'const' modifier to function?
DefaultReturn	no		default value to return; overridden if FunctionBody is specified
IsOwned	no	true	is the function body owned?
IsEventHandler	no	false	is the function body the user event handler?
Initializers	no		provide any initializer expressions, e.g. for constructors, appearing on a separate line after the argument list and before the function body. Do not provide the leading colon (':') as this is added automatically
Realize	no	false	If true, force the function to be generated. Otherwise, the function is generated only if the FunctionBody is non-empty or if another template contributions to the FunctionLocationId.

\ No newline at end of file diff -r 22956bdb436e -r 41edc8c123d6 uidesigner/com.nokia.sdt.series60.componentlibrary/components/FileAndClassMacros.inc.html --- a/uidesigner/com.nokia.sdt.series60.componentlibrary/components/FileAndClassMacros.inc.html Fri Nov 13 13:34:02 2009 -0600 +++ b/uidesigner/com.nokia.sdt.series60.componentlibrary/components/FileAndClassMacros.inc.html Fri Nov 13 13:34:34 2009 -0600 @@ -1,1097 +1,11 @@ - - - -Help for Macros in FileAndClassMacros.inc - - -

-SourceFileTemplate -

- -

-HeaderFileTemplate -

- -

-ClassTemplate -

- -

-AddCppIncludes -

- -

-ResolvePhases -

- -

SourceFileTemplate

Defines the basic structure for a source file. This defines a file with system includes, user includes, and constants.

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
Dir	no	${src}	- - Project-relative directory for file - -
FileName	no	${instanceName$title}.cpp	- - Filename, inside $(Dir), to create - -
HeaderFileName	no	${instanceName$title}.h	- - Filename of associated header to #include, or blank for no #include - -
LocationPrefix	no	SOURCE	- - String which is prefixed to the location ids defined by this macro. - -
InitialFileHeadContent	no		- - optional stock text for the source file (before system includes, user includes, constants). - NOTE: one-time text, should not depend on modifiable properties - NOTE: does not need to specify default source file template (comments), which is automatic. - -
RealizeSystemIncludes	no	true	- - flag that can be used to avoid generating the system includes section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no system includes ever defined, otherwise, the section will appear out of order when generated. - -
SystemIncludesRegionName	no	Generated System Includes	- - name of the generated section for system includes - -
InitialSystemIncludesContent	no		- - optional stock text for the system includes - -
RealizeUserIncludes	no	true	- - flag that can be used to avoid generating the user includes section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no user includes ever defined, otherwise, the section will appear out of order when generated. - -
UserIncludesRegionName	no	Generated User Includes	- - name of the generated section for user includes - -
InitialUserIncludesContent	no		- - optional stock text for the user includes - -
RealizeConstants	no	true	- - flag that can be used to avoid generating the constants section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no constants ever defined, otherwise, the section will appear out of order when generated. - -
ConstantsRegionName	no	Generated Constants	- - name of the generated section for constants - -
InitialConstantsContent	no		- - optional stock text for the constants - -
InitialFileTailContent	no		- - optional stock text for the source file (after system includes, user includes, constants) which appears at the very end of the file. - NOTE: one-time text, should not depend on modifiable properties - NOTE: this really comes at the very end during initial file generation (unless you emit other templates with mode="at-end"), so if you simply want content after these sections but before other templates you add, just create templates for location="$(LocationPrefix)_FILE". - -
Dir	no	${src}	- - Project-relative directory for file - -
FileName	no	${instanceName$title}.cpp	- - Filename, inside $(Dir), to create - -
HeaderFileName	no	${instanceName$title}.h	- - Filename of associated header to #include, or blank for no #include - -
LocationPrefix	no	SOURCE	- - String which is prefixed to the location ids defined by this macro. - -
InitialFileHeadContent	no		- - optional stock text for the source file (before system includes, user includes, constants). - NOTE: one-time text, should not depend on modifiable properties - NOTE: does not need to specify default source file template (comments), which is automatic. - -
RealizeSystemIncludes	no	true	- - flag that can be used to avoid generating the system includes section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no system includes ever defined, otherwise, the section will appear out of order when generated. - -
SystemIncludesRegionName	no	Generated System Includes	- - name of the generated section for system includes - -
InitialSystemIncludesContent	no		- - optional stock text for the system includes - -
RealizeUserIncludes	no	true	- - flag that can be used to avoid generating the user includes section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no user includes ever defined, otherwise, the section will appear out of order when generated. - -
UserIncludesRegionName	no	Generated User Includes	- - name of the generated section for user includes - -
InitialUserIncludesContent	no		- - optional stock text for the user includes - -
RealizeConstants	no	true	- - flag that can be used to avoid generating the constants section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no constants ever defined, otherwise, the section will appear out of order when generated. - -
ConstantsRegionName	no	Generated Constants	- - name of the generated section for constants - -
InitialConstantsContent	no		- - optional stock text for the constants - -
InitialFileTailContent	no		- - optional stock text for the source file (after system includes, user includes, constants) which appears at the very end of the file. - NOTE: one-time text, should not depend on modifiable properties - NOTE: this really comes at the very end during initial file generation (unless you emit other templates with mode="at-end"), so if you simply want content after these sections but before other templates you add, just create templates for location="$(LocationPrefix)_FILE". - -

- - -

HeaderFileTemplate

Defines the basic structure for a header file.

This defines a file with an include guard, system includes, user includes, event handler includes (non-owned but modifiable), constants, and forward declarations.

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
Dir	no	${inc}	- - Project-relative directory for file - -
FileName	no	${instanceName$title}.h	- - Filename, inside $(Dir), to create - -
IncludeGuardMacro	no	${instanceName$upper}_H	- - Include guard macro (#ifndef ...) to use - -
LocationPrefix	no	HEADER	- - String which is prefixed to the location ids defined by this macro. - -
InitialFileHeadContent	no		- - optional stock text for the top of the header file. NOTE: one-time text, should not depend on modifiable properties NOTE: does not need to specify header file template (comments) or #ifdef guards. - -
RealizeEventHandlerIncludes	no	true	- - flag that can be used to avoid generating the section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no event handler includes ever defined, otherwise, the section will appear out of order when generated. - -
InitialEventHandlerIncludesContent	no		- - optional stock text for the event handler includes. - NOTE: one-time text, should not depend on modifiable properties - -
RealizeOwnedSystemIncludes	no	true	- - flag that can be used to avoid generating the system includes section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no system includes ever defined, otherwise, the section will appear out of order when generated. - -
OwnedSystemIncludesRegionName	no	Generated System Includes	- - name of the generated section for system includes - -
RealizeOwnedUserIncludes	no	true	- - flag that can be used to avoid generating the user includes section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no user includes ever defined, otherwise, the section will appear out of order when generated. - -
OwnedUserIncludesRegionName	no	Generated User Includes	- - name of the generated section for user includes - -
InitialOwnedSystemIncludesContent	no		- - optional stock text for the added system includes - -
InitialOwnedUserIncludesContent	no		- - optional stock text for the user includes. - -
RealizeOwnedConstants	no	true	- - flag that can be used to avoid generating the constants section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no constants ever defined, otherwise, the section will appear out of order when generated. - -
InitialOwnedConstantsContent	no		- - optional stock text for the constants - -
RealizeOwnedForwardDeclarations	no	true	- - flag that can be used to avoid generating the forward declarations section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no forward decls ever defined, otherwise, the section will appear out of order when generated. - -
InitialOwnedForwardDeclarationsContent	no		- - optional stock text for the forward declarations - -
InitialFileTailContent	no		- - optional stock text for the end of the header file. - NOTE: one-time text, should not depend on modifiable properties - NOTE: this really comes at the very end during initial file generation (unless you emit other templates with mode="at-end"), so if you simply want content after these sections but before other templates you add, just create templates for location="$(LocationPrefix)HEADER_FILE". - -
Dir	no	${inc}	- - Project-relative directory for file - -
FileName	no	${instanceName$title}.h	- - Filename, inside $(Dir), to create - -
IncludeGuardMacro	no	${instanceName$upper}_H	- - Include guard macro (#ifndef ...) to use - -
LocationPrefix	no	HEADER	- - String which is prefixed to the location ids defined by this macro. - -
InitialFileHeadContent	no		- - optional stock text for the top of the header file. NOTE: one-time text, should not depend on modifiable properties NOTE: does not need to specify header file template (comments) or #ifdef guards. - -
RealizeEventHandlerIncludes	no	true	- - flag that can be used to avoid generating the section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no event handler includes ever defined, otherwise, the section will appear out of order when generated. - -
InitialEventHandlerIncludesContent	no		- - optional stock text for the event handler includes. - NOTE: one-time text, should not depend on modifiable properties - -
RealizeOwnedSystemIncludes	no	true	- - flag that can be used to avoid generating the system includes section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no system includes ever defined, otherwise, the section will appear out of order when generated. - -
OwnedSystemIncludesRegionName	no	Generated System Includes	- - name of the generated section for system includes - -
RealizeOwnedUserIncludes	no	true	- - flag that can be used to avoid generating the user includes section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no user includes ever defined, otherwise, the section will appear out of order when generated. - -
OwnedUserIncludesRegionName	no	Generated User Includes	- - name of the generated section for user includes - -
InitialOwnedSystemIncludesContent	no		- - optional stock text for the added system includes - -
InitialOwnedUserIncludesContent	no		- - optional stock text for the user includes. - -
RealizeOwnedConstants	no	true	- - flag that can be used to avoid generating the constants section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no constants ever defined, otherwise, the section will appear out of order when generated. - -
InitialOwnedConstantsContent	no		- - optional stock text for the constants - -
RealizeOwnedForwardDeclarations	no	true	- - flag that can be used to avoid generating the forward declarations section unless it is used. - NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no forward decls ever defined, otherwise, the section will appear out of order when generated. - -
InitialOwnedForwardDeclarationsContent	no		- - optional stock text for the forward declarations - -
InitialFileTailContent	no		- - optional stock text for the end of the header file. - NOTE: one-time text, should not depend on modifiable properties - NOTE: this really comes at the very end during initial file generation (unless you emit other templates with mode="at-end"), so if you simply want content after these sections but before other templates you add, just create templates for location="$(LocationPrefix)HEADER_FILE". - -

- - -

ClassTemplate

Defines the basic structure for a class with public, protected, and private regions, with owned sections therein for common purposes.

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
BaseClassName	yes		- - name of the base class, from which this class derives - -
BaseClassName	yes		- - name of the base class, from which this class derives - -
LocationPrefix	no		- - String which is prefixed to the location ids defined by this macro. Useful when one component defines multiple files. - -
BaseLocation	no	HEADER_FILE	- - name of the base location in which to place the class, defaults to HEADER_FILE - -
ClassName	no	${className}	- - name of the class to generate - -
BaseClassAccessor	no	public	- - accessor for the base class, from which this class derives - -
ExtraBaseClasses	no		- - extra interface classes, separated by commas - -
ClassComment	no		- - optional text for the class comment - -
InitialClassHeadContent	no		- - optional text for the start of the class - NOTE: one-time code, should not depend on modifiable properties - -
InitialPublicHeadContent	no		- - optional text for the start of the public section (follows "public:") - NOTE: one-time code, should not depend on modifiable properties - -
RealizePublicOwnedTypes	no	true	- - flag that can be used to avoid generating the public types section unless it is used. - NOTE: if InitialPublicOwnedTypesContent is set, this flag is ignored. - -
InitialPublicOwnedTypesContent	no		- - optional text for the public owned types section - -
RealizePublicOwnedMethods	no	true	- - flag that can be used to avoid generating the public owned methods section unless it is used. - NOTE: if InitialPublicOwnedMethodsContent is set, this flag is ignored. - -
InitialPublicOwnedMethodsContent	no		- - optional text for the public owned methods section - -
InitialPublicTailContent	no		- - optional text for the end of the public section (follows "public:") - NOTE: one-time code, should not depend on modifiable properties - NOTE: content appears at the end of all initially generated public content. - -
InitialProtectedHeadContent	no		- - optional text for the start of the protected section (follows "protected:") - NOTE: one-time code, should not depend on modifiable properties - -
RealizeProtectedOverriddenMethods	no	true	- - flag that can be used to avoid generating the protected overridden methods section unless it is used. - -
InitialProtectedOverriddenMethodsContent	no		- - optional text for the the protected overridden methods section - -
RealizeProtectedUserHandlers	no	true	- - flag that can be used to avoid generating the protected user handlers section unless it is used. This is used for the prototypes for the user-editable event handler methods. - -
InitialProtectedUserHandlersContent	no		- - optional text for the protected user handlers section - -
InitialProtectedTailContent	no		- - optional text for the end of the protected section - NOTE: one-time code, should not depend on modifiable properties - NOTE: content appears at the end of all initially generated protected content. - -
InitialPrivateHeadContent	no		- - optional text for the start of the private section (follows "private:") - NOTE: one-time code, should not depend on modifiable properties - -
RealizePrivateOwnedTypes	no	true	- - flag that can be used to avoid generating the private owned types section unless it is used. - NOTE: if InitialPrivateOwnedTypesContent is set, this flag is ignored. - -
InitialPrivateOwnedTypesContent	no		- - optional text for the the private types section - -
RealizePrivateOwnedInstanceVariables	no	true	- - flag that can be used to avoid generating the private instance variables section unless it is used. - -
InitialPrivateOwnedInstanceVariablesContent	no		- - optional text for the the private instance variables section - -
RealizePrivateOwnedMethods	no	true	- - flag that can be used to avoid generating the private owned methods section unless it is used. - -
InitialPrivateOwnedMethodsContent	no		- - optional text for the the private methods section - -
InitialPrivateTailContent	no		- - optional text for the end of the private section - NOTE: one-time code, should not depend on modifiable properties - NOTE: content appears at the end of all initially generated private content. - -
InitialClassTailContent	no		- - optional text for the end of the class - NOTE: one-time code, should not depend on modifiable properties - -
LocationPrefix	no		- - String which is prefixed to the location ids defined by this macro. Useful when one component defines multiple files. - -
BaseLocation	no	HEADER_FILE	- - name of the base location in which to place the class, defaults to HEADER_FILE - -
ClassName	no	${className}	- - name of the class to generate - -
BaseClassAccessor	no	public	- - accessor for the base class, from which this class derives - -
ExtraBaseClasses	no		- - extra interface classes, separated by commas - -
ClassComment	no		- - optional text for the class comment - -
InitialClassHeadContent	no		- - optional text for the start of the class - NOTE: one-time code, should not depend on modifiable properties - -
InitialPublicHeadContent	no		- - optional text for the start of the public section (follows "public:") - NOTE: one-time code, should not depend on modifiable properties - -
RealizePublicOwnedTypes	no	true	- - flag that can be used to avoid generating the public types section unless it is used. - NOTE: if InitialPublicOwnedTypesContent is set, this flag is ignored. - -
InitialPublicOwnedTypesContent	no		- - optional text for the public owned types section - -
RealizePublicOwnedMethods	no	true	- - flag that can be used to avoid generating the public owned methods section unless it is used. - NOTE: if InitialPublicOwnedMethodsContent is set, this flag is ignored. - -
InitialPublicOwnedMethodsContent	no		- - optional text for the public owned methods section - -
InitialPublicTailContent	no		- - optional text for the end of the public section (follows "public:") - NOTE: one-time code, should not depend on modifiable properties - NOTE: content appears at the end of all initially generated public content. - -
InitialProtectedHeadContent	no		- - optional text for the start of the protected section (follows "protected:") - NOTE: one-time code, should not depend on modifiable properties - -
RealizeProtectedOverriddenMethods	no	true	- - flag that can be used to avoid generating the protected overridden methods section unless it is used. - -
InitialProtectedOverriddenMethodsContent	no		- - optional text for the the protected overridden methods section - -
RealizeProtectedUserHandlers	no	true	- - flag that can be used to avoid generating the protected user handlers section unless it is used. This is used for the prototypes for the user-editable event handler methods. - -
InitialProtectedUserHandlersContent	no		- - optional text for the protected user handlers section - -
InitialProtectedTailContent	no		- - optional text for the end of the protected section - NOTE: one-time code, should not depend on modifiable properties - NOTE: content appears at the end of all initially generated protected content. - -
InitialPrivateHeadContent	no		- - optional text for the start of the private section (follows "private:") - NOTE: one-time code, should not depend on modifiable properties - -
RealizePrivateOwnedTypes	no	true	- - flag that can be used to avoid generating the private owned types section unless it is used. - NOTE: if InitialPrivateOwnedTypesContent is set, this flag is ignored. - -
InitialPrivateOwnedTypesContent	no		- - optional text for the the private types section - -
RealizePrivateOwnedInstanceVariables	no	true	- - flag that can be used to avoid generating the private instance variables section unless it is used. - -
InitialPrivateOwnedInstanceVariablesContent	no		- - optional text for the the private instance variables section - -
RealizePrivateOwnedMethods	no	true	- - flag that can be used to avoid generating the private owned methods section unless it is used. - -
InitialPrivateOwnedMethodsContent	no		- - optional text for the the private methods section - -
InitialPrivateTailContent	no		- - optional text for the end of the private section - NOTE: one-time code, should not depend on modifiable properties - NOTE: content appears at the end of all initially generated private content. - -
InitialClassTailContent	no		- - optional text for the end of the class - NOTE: one-time code, should not depend on modifiable properties - -

- - -

AddCppIncludes

Generate #includes for a space-separated list of headers.

Note: you cannot use variable substitution, script escapes, etc. in the list. Instead, just write explicit contributions for the include, e.g. <template location="MAIN_OWNED_SYSTEM_INCLUDE"> ...

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
Headers	yes		- - a space-separated list of header files - -
Headers	yes		- - a space-separated list of header files - -
Location	no		- - location where includes should go (either this or Phase should be set) - -
Phase	no		- - phase where includes should go (either this or Location should be set) - -
IsUser	no	false	- - "User" or <system> includes? - -
Location	no		- - location where includes should go (either this or Phase should be set) - -
Phase	no		- - phase where includes should go (either this or Location should be set) - -
IsUser	no	false	- - "User" or <system> includes? - -

- - -

ResolvePhases

This macro fixes up phase -> location mappings on the current contributions, or optionally, another list.

The mappings are Phase=Location pairs separated by spaces.

This may be called multiple times.

Arguments

- - - - - - - - - - - - - - -

Argument	Req'd?	Default	Description
Mappings	yes		- - A space-separated list of Phase=Location mappings. - -
Mappings	yes		- - A space-separated list of Phase=Location mappings. - -
ContribsList	no	contribs	- - The array or list of IContribution upon which to apply the fixups. - -
ContribsList	no	contribs	- - The array or list of IContribution upon which to apply the fixups. - -

- -

- - +Help for Macros in FileAndClassMacros.inc

SourceFileTemplate

Defines the basic structure for a source file. This defines a file with system includes, user includes, and constants.

Arguments

Argument	Req'd?	Default	Description
Dir	no	${src}	Project-relative directory for file
FileName	no	${instanceName$title}.cpp	Filename, inside $(Dir), to create
HeaderFileName	no	${instanceName$title}.h	Filename of associated header to #include, or blank for no #include
LocationPrefix	no	SOURCE	String which is prefixed to the location ids defined by this macro.
InitialFileHeadContent	no		optional stock text for the source file (before system includes, user includes, constants). NOTE: one-time text, should not depend on modifiable properties NOTE: does not need to specify default source file template (comments), which is automatic.
RealizeSystemIncludes	no	true	flag that can be used to avoid generating the system includes section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no system includes ever defined, otherwise, the section will appear out of order when generated.
SystemIncludesRegionName	no	Generated System Includes	name of the generated section for system includes
InitialSystemIncludesContent	no		optional stock text for the system includes
RealizeUserIncludes	no	true	flag that can be used to avoid generating the user includes section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no user includes ever defined, otherwise, the section will appear out of order when generated.
UserIncludesRegionName	no	Generated User Includes	name of the generated section for user includes
InitialUserIncludesContent	no		optional stock text for the user includes
RealizeConstants	no	true	flag that can be used to avoid generating the constants section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no constants ever defined, otherwise, the section will appear out of order when generated.
ConstantsRegionName	no	Generated Constants	name of the generated section for constants
InitialConstantsContent	no		optional stock text for the constants
InitialFileTailContent	no		optional stock text for the source file (after system includes, user includes, constants) which appears at the very end of the file. NOTE: one-time text, should not depend on modifiable properties NOTE: this really comes at the very end during initial file generation (unless you emit other templates with mode="at-end"), so if you simply want content after these sections but before other templates you add, just create templates for location="$(LocationPrefix)_FILE".
Dir	no	${src}	Project-relative directory for file
FileName	no	${instanceName$title}.cpp	Filename, inside $(Dir), to create
HeaderFileName	no	${instanceName$title}.h	Filename of associated header to #include, or blank for no #include
LocationPrefix	no	SOURCE	String which is prefixed to the location ids defined by this macro.
InitialFileHeadContent	no		optional stock text for the source file (before system includes, user includes, constants). NOTE: one-time text, should not depend on modifiable properties NOTE: does not need to specify default source file template (comments), which is automatic.
RealizeSystemIncludes	no	true	flag that can be used to avoid generating the system includes section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no system includes ever defined, otherwise, the section will appear out of order when generated.
SystemIncludesRegionName	no	Generated System Includes	name of the generated section for system includes
InitialSystemIncludesContent	no		optional stock text for the system includes
RealizeUserIncludes	no	true	flag that can be used to avoid generating the user includes section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no user includes ever defined, otherwise, the section will appear out of order when generated.
UserIncludesRegionName	no	Generated User Includes	name of the generated section for user includes
InitialUserIncludesContent	no		optional stock text for the user includes
RealizeConstants	no	true	flag that can be used to avoid generating the constants section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no constants ever defined, otherwise, the section will appear out of order when generated.
ConstantsRegionName	no	Generated Constants	name of the generated section for constants
InitialConstantsContent	no		optional stock text for the constants
InitialFileTailContent	no		optional stock text for the source file (after system includes, user includes, constants) which appears at the very end of the file. NOTE: one-time text, should not depend on modifiable properties NOTE: this really comes at the very end during initial file generation (unless you emit other templates with mode="at-end"), so if you simply want content after these sections but before other templates you add, just create templates for location="$(LocationPrefix)_FILE".

HeaderFileTemplate

Defines the basic structure for a header file.

This defines a file with an include guard, system includes, user includes, event handler includes (non-owned but modifiable), constants, and forward declarations.

Arguments

Argument	Req'd?	Default	Description
Dir	no	${inc}	Project-relative directory for file
FileName	no	${instanceName$title}.h	Filename, inside $(Dir), to create
IncludeGuardMacro	no	${instanceName$upper}_H	Include guard macro (#ifndef ...) to use
LocationPrefix	no	HEADER	String which is prefixed to the location ids defined by this macro.
InitialFileHeadContent	no		optional stock text for the top of the header file. NOTE: one-time text, should not depend on modifiable properties NOTE: does not need to specify header file template (comments) or #ifdef guards.
RealizeEventHandlerIncludes	no	true	flag that can be used to avoid generating the section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no event handler includes ever defined, otherwise, the section will appear out of order when generated.
InitialEventHandlerIncludesContent	no		optional stock text for the event handler includes. NOTE: one-time text, should not depend on modifiable properties
RealizeOwnedSystemIncludes	no	true	flag that can be used to avoid generating the system includes section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no system includes ever defined, otherwise, the section will appear out of order when generated.
OwnedSystemIncludesRegionName	no	Generated System Includes	name of the generated section for system includes
RealizeOwnedUserIncludes	no	true	flag that can be used to avoid generating the user includes section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no user includes ever defined, otherwise, the section will appear out of order when generated.
OwnedUserIncludesRegionName	no	Generated User Includes	name of the generated section for user includes
InitialOwnedSystemIncludesContent	no		optional stock text for the added system includes
InitialOwnedUserIncludesContent	no		optional stock text for the user includes.
RealizeOwnedConstants	no	true	flag that can be used to avoid generating the constants section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no constants ever defined, otherwise, the section will appear out of order when generated.
InitialOwnedConstantsContent	no		optional stock text for the constants
RealizeOwnedForwardDeclarations	no	true	flag that can be used to avoid generating the forward declarations section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no forward decls ever defined, otherwise, the section will appear out of order when generated.
InitialOwnedForwardDeclarationsContent	no		optional stock text for the forward declarations
RealizeOwnedTypedefs	no	true	flag that can be used to avoid generating the typedefs section unless it is used. NOTE: due to issues with the source generator, this should't be set 'false' unless you really expect there to be no typedefs ever defined, otherwise, the section will appear out of order when generated.
OwnedTypedefsRegionName	no	Generated Typedefs	name of the generated section for owned typedefs
InitialOwnedTypedefsContent	no		optional stock text for the initial typedefs
InitialFileTailContent	no		optional stock text for the end of the header file. NOTE: one-time text, should not depend on modifiable properties NOTE: this really comes at the very end during initial file generation (unless you emit other templates with mode="at-end"), so if you simply want content after these sections but before other templates you add, just create templates for location="$(LocationPrefix)HEADER_FILE".
Dir	no	${inc}	Project-relative directory for file
FileName	no	${instanceName$title}.h	Filename, inside $(Dir), to create
IncludeGuardMacro	no	${instanceName$upper}_H	Include guard macro (#ifndef ...) to use
LocationPrefix	no	HEADER	String which is prefixed to the location ids defined by this macro.
InitialFileHeadContent	no		optional stock text for the top of the header file. NOTE: one-time text, should not depend on modifiable properties NOTE: does not need to specify header file template (comments) or #ifdef guards.
RealizeEventHandlerIncludes	no	true	flag that can be used to avoid generating the section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no event handler includes ever defined, otherwise, the section will appear out of order when generated.
InitialEventHandlerIncludesContent	no		optional stock text for the event handler includes. NOTE: one-time text, should not depend on modifiable properties
RealizeOwnedSystemIncludes	no	true	flag that can be used to avoid generating the system includes section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no system includes ever defined, otherwise, the section will appear out of order when generated.
OwnedSystemIncludesRegionName	no	Generated System Includes	name of the generated section for system includes
RealizeOwnedUserIncludes	no	true	flag that can be used to avoid generating the user includes section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no user includes ever defined, otherwise, the section will appear out of order when generated.
OwnedUserIncludesRegionName	no	Generated User Includes	name of the generated section for user includes
InitialOwnedSystemIncludesContent	no		optional stock text for the added system includes
InitialOwnedUserIncludesContent	no		optional stock text for the user includes.
RealizeOwnedConstants	no	true	flag that can be used to avoid generating the constants section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no constants ever defined, otherwise, the section will appear out of order when generated.
InitialOwnedConstantsContent	no		optional stock text for the constants
RealizeOwnedForwardDeclarations	no	true	flag that can be used to avoid generating the forward declarations section unless it is used. NOTE: due to issues with the source generator, this shouldn't be set 'false' unless you really expect there to be no forward decls ever defined, otherwise, the section will appear out of order when generated.
InitialOwnedForwardDeclarationsContent	no		optional stock text for the forward declarations
RealizeOwnedTypedefs	no	true	flag that can be used to avoid generating the typedefs section unless it is used. NOTE: due to issues with the source generator, this should't be set 'false' unless you really expect there to be no typedefs ever defined, otherwise, the section will appear out of order when generated.
OwnedTypedefsRegionName	no	Generated Typedefs	name of the generated section for owned typedefs
InitialOwnedTypedefsContent	no		optional stock text for the initial typedefs
InitialFileTailContent	no		optional stock text for the end of the header file. NOTE: one-time text, should not depend on modifiable properties NOTE: this really comes at the very end during initial file generation (unless you emit other templates with mode="at-end"), so if you simply want content after these sections but before other templates you add, just create templates for location="$(LocationPrefix)HEADER_FILE".

ClassTemplate

Defines the basic structure for a class with public, protected, and private regions, with owned sections therein for common purposes.

Arguments

Argument	Req'd?	Default	Description
BaseClassName	yes		name of the base class, from which this class derives
BaseClassName	yes		name of the base class, from which this class derives
LocationPrefix	no		String which is prefixed to the location ids defined by this macro. Useful when one component defines multiple files.
BaseLocation	no	HEADER_FILE	name of the base location in which to place the class, defaults to HEADER_FILE
ClassName	no	${className}	name of the class to generate
BaseClassAccessor	no	public	accessor for the base class, from which this class derives
ExtraBaseClasses	no		extra interface classes, separated by commas
ClassComment	no		optional text for the class comment
InitialClassHeadContent	no		optional text for the start of the class NOTE: one-time code, should not depend on modifiable properties
InitialPublicHeadContent	no		optional text for the start of the public section (follows "public:") NOTE: one-time code, should not depend on modifiable properties
RealizePublicOwnedTypes	no	true	flag that can be used to avoid generating the public types section unless it is used. NOTE: if InitialPublicOwnedTypesContent is set, this flag is ignored.
InitialPublicOwnedTypesContent	no		optional text for the public owned types section
RealizePublicOwnedMethods	no	true	flag that can be used to avoid generating the public owned methods section unless it is used. NOTE: if InitialPublicOwnedMethodsContent is set, this flag is ignored.
InitialPublicOwnedMethodsContent	no		optional text for the public owned methods section
InitialPublicTailContent	no		optional text for the end of the public section (follows "public:") NOTE: one-time code, should not depend on modifiable properties NOTE: content appears at the end of all initially generated public content.
InitialProtectedHeadContent	no		optional text for the start of the protected section (follows "protected:") NOTE: one-time code, should not depend on modifiable properties
RealizeProtectedOverriddenMethods	no	true	flag that can be used to avoid generating the protected overridden methods section unless it is used.
InitialProtectedOverriddenMethodsContent	no		optional text for the the protected overridden methods section
RealizeProtectedUserHandlers	no	true	flag that can be used to avoid generating the protected user handlers section unless it is used. This is used for the prototypes for the user-editable event handler methods.
InitialProtectedUserHandlersContent	no		optional text for the protected user handlers section
InitialProtectedTailContent	no		optional text for the end of the protected section NOTE: one-time code, should not depend on modifiable properties NOTE: content appears at the end of all initially generated protected content.
InitialPrivateHeadContent	no		optional text for the start of the private section (follows "private:") NOTE: one-time code, should not depend on modifiable properties
RealizePrivateOwnedTypes	no	true	flag that can be used to avoid generating the private owned types section unless it is used. NOTE: if InitialPrivateOwnedTypesContent is set, this flag is ignored.
InitialPrivateOwnedTypesContent	no		optional text for the the private types section
RealizePrivateOwnedInstanceVariables	no	true	flag that can be used to avoid generating the private instance variables section unless it is used.
InitialPrivateOwnedInstanceVariablesContent	no		optional text for the the private instance variables section
RealizePrivateOwnedMethods	no	true	flag that can be used to avoid generating the private owned methods section unless it is used.
InitialPrivateOwnedMethodsContent	no		optional text for the the private methods section
InitialPrivateTailContent	no		optional text for the end of the private section NOTE: one-time code, should not depend on modifiable properties NOTE: content appears at the end of all initially generated private content.
InitialClassTailContent	no		optional text for the end of the class NOTE: one-time code, should not depend on modifiable properties
LocationPrefix	no		String which is prefixed to the location ids defined by this macro. Useful when one component defines multiple files.
BaseLocation	no	HEADER_FILE	name of the base location in which to place the class, defaults to HEADER_FILE
ClassName	no	${className}	name of the class to generate
BaseClassAccessor	no	public	accessor for the base class, from which this class derives
ExtraBaseClasses	no		extra interface classes, separated by commas
ClassComment	no		optional text for the class comment
InitialClassHeadContent	no		optional text for the start of the class NOTE: one-time code, should not depend on modifiable properties
InitialPublicHeadContent	no		optional text for the start of the public section (follows "public:") NOTE: one-time code, should not depend on modifiable properties
RealizePublicOwnedTypes	no	true	flag that can be used to avoid generating the public types section unless it is used. NOTE: if InitialPublicOwnedTypesContent is set, this flag is ignored.
InitialPublicOwnedTypesContent	no		optional text for the public owned types section
RealizePublicOwnedMethods	no	true	flag that can be used to avoid generating the public owned methods section unless it is used. NOTE: if InitialPublicOwnedMethodsContent is set, this flag is ignored.
InitialPublicOwnedMethodsContent	no		optional text for the public owned methods section
InitialPublicTailContent	no		optional text for the end of the public section (follows "public:") NOTE: one-time code, should not depend on modifiable properties NOTE: content appears at the end of all initially generated public content.
InitialProtectedHeadContent	no		optional text for the start of the protected section (follows "protected:") NOTE: one-time code, should not depend on modifiable properties
RealizeProtectedOverriddenMethods	no	true	flag that can be used to avoid generating the protected overridden methods section unless it is used.
InitialProtectedOverriddenMethodsContent	no		optional text for the the protected overridden methods section
RealizeProtectedUserHandlers	no	true	flag that can be used to avoid generating the protected user handlers section unless it is used. This is used for the prototypes for the user-editable event handler methods.
InitialProtectedUserHandlersContent	no		optional text for the protected user handlers section
InitialProtectedTailContent	no		optional text for the end of the protected section NOTE: one-time code, should not depend on modifiable properties NOTE: content appears at the end of all initially generated protected content.
InitialPrivateHeadContent	no		optional text for the start of the private section (follows "private:") NOTE: one-time code, should not depend on modifiable properties
RealizePrivateOwnedTypes	no	true	flag that can be used to avoid generating the private owned types section unless it is used. NOTE: if InitialPrivateOwnedTypesContent is set, this flag is ignored.
InitialPrivateOwnedTypesContent	no		optional text for the the private types section
RealizePrivateOwnedInstanceVariables	no	true	flag that can be used to avoid generating the private instance variables section unless it is used.
InitialPrivateOwnedInstanceVariablesContent	no		optional text for the the private instance variables section
RealizePrivateOwnedMethods	no	true	flag that can be used to avoid generating the private owned methods section unless it is used.
InitialPrivateOwnedMethodsContent	no		optional text for the the private methods section
InitialPrivateTailContent	no		optional text for the end of the private section NOTE: one-time code, should not depend on modifiable properties NOTE: content appears at the end of all initially generated private content.
InitialClassTailContent	no		optional text for the end of the class NOTE: one-time code, should not depend on modifiable properties

AddCppIncludes

Generate #includes for a space-separated list of headers.

Note: you cannot use variable substitution, script escapes, etc. in the list. Instead, just write explicit contributions for the include, e.g. <template location="MAIN_OWNED_SYSTEM_INCLUDES"> ...

Arguments

Argument	Req'd?	Default	Description
Headers	yes		a space-separated list of header files
Headers	yes		a space-separated list of header files
Location	no		location where includes should go (either this or Phase should be set)
Phase	no		phase where includes should go (either this or Location should be set)
IsUser	no	false	"User" or <system> includes?
Location	no		location where includes should go (either this or Phase should be set)
Phase	no		phase where includes should go (either this or Location should be set)
IsUser	no	false	"User" or <system> includes?

ResolvePhases

This macro fixes up phase -> location mappings on the current contributions, or optionally, another list.

The mappings are Phase=Location pairs separated by spaces.

This may be called multiple times.

Arguments

Argument	Req'd?	Default	Description
Mappings	yes		A space-separated list of Phase=Location mappings.
Mappings	yes		A space-separated list of Phase=Location mappings.
ContribsList	no	contribs	The array or list of IContribution upon which to apply the fixups.
ContribsList	no	contribs	The array or list of IContribution upon which to apply the fixups.

\ No newline at end of file