diff options
Diffstat (limited to 'doc/org.eclipse.cdt.doc.isv/guide/projectTemplateEngine/exampletemplate.html')
-rw-r--r-- | doc/org.eclipse.cdt.doc.isv/guide/projectTemplateEngine/exampletemplate.html | 251 |
1 files changed, 247 insertions, 4 deletions
diff --git a/doc/org.eclipse.cdt.doc.isv/guide/projectTemplateEngine/exampletemplate.html b/doc/org.eclipse.cdt.doc.isv/guide/projectTemplateEngine/exampletemplate.html index 0f916442609..dd644908d85 100644 --- a/doc/org.eclipse.cdt.doc.isv/guide/projectTemplateEngine/exampletemplate.html +++ b/doc/org.eclipse.cdt.doc.isv/guide/projectTemplateEngine/exampletemplate.html @@ -35,16 +35,259 @@ The following is an example template to create a simple Symbian OS <code class="filename">EXE</code> project: </p> -<p class="CodeBlock"><code><?xml version="1.0" encoding="ISO-8859-1"?><br><template type="ProjTempl" version="1.0" supplier="Symbian" revision="1.0" author="Bala Torati"<br> id="EXE" label="Simple EXE" description="A skeletal Symbian OS EXE project. Creates a folder for sources and another for include."<br> help="help.html"><br><br> <property-group id="basics" label="Basic Settings" description="Basic properties of a project" type="PAGES-ONLY" help="help.html"><br> <br><property id="uid2"<br> label="UID 2"<br> description="UID 2"<br> default="0x00000000"<br> type="input"<br> pattern="0x[0-9a-fA-F]{8}"<br> hidden="false"<br> mandatory="true"<br> persist="true"/><br> <br><property id="uid3"<br> label="UID 3"<br> description="UID 3"<br> default="0x00000000"<br> type="input"<br> pattern="0x[0-9a-fA-F]{8}"<br> hidden="false"<br> mandatory="false"<br> persist="true"/><br><br><property id="vid"<br> label="Vendor ID"<br> description="Vendor ID"<br> default="0x00000000"<br> type="input"<br> pattern="0x[0-9a-fA-F]{8}"<br> hidden="false"<br> mandatory="true"<br> persist="true"/><br><br><property id="author"<br> label="Author"<br> description="Name of the author"<br> type="input"<br> pattern=".*"<br> default=""<br> hidden="false"<br> persist="true"/><br><br><property id="copyright"<br> label="Copyright notice"<br> description="Your copyright notice"<br> type="input"<br> pattern=".*"<br> default="Your copyright notice"<br> hidden="false"<br> persist="true"/><br><br><property id="targetType"<br> label="Target Type"<br> description="Select the target type"<br> type="select"<br> hidden="false"<br> mandatory="true"<br> persist="true"><br> <item label="APP" selected="true" name="app"/><br> <item label="LIB" selected="false" name="lib"/><br> <item label="DLL" selected="false" name="dll"/><br> <item label="EXE" selected="false" name="exe"/><br> <item label="EXEDLL" selected="false" name="exedll"/><br> </property><br> </property-group><br><br> <property-group id="directories" label="Project Directories" description="Generated files will be copied to the specified directories under the project root directory" type="PAGES-ONLY" help="help.html"><br> <property id="incDir"<br> label="Include"<br> description="Directory for C++ header files"<br> type="input"<br> default="inc"<br> pattern="[a-zA-Z0-9]+"<br> mandatory="true"<br> persist="true"/><br><br> <property id="sourceDir"<br> label="Source"<br> description="Directory for C++ source files"<br> type="input"<br> default="src"<br> pattern="[a-zA-Z0-9]+"<br> mandatory="true"<br> persist="true"/><br> </property-group><br> <br> <process type="org.eclipse.cdt.templates.NewSymbianProject"><br> <simple name="name" value="$(projectName)"/><br> <simple name="targetType" value="$(targetType)"/><br> <simple name="uid2" value="$(uid2)"/><br> <simple name="uid3" value="$(uid3)"/><br> <simple name="vid" value="$(vid)"/><br> </process><br><br> <process type="org.eclipse.cdt.core.templateengine.process.processes.CreateSourceFolder"><br> <simple name="projectName" value="$(projectName)"/><br> <simple name="path" value="$(sourceDir)"/><br> </process><br><br> <process type="org.eclipse.cdt.managedbuilder.templateengine.processes.CreateIncludeFolder"><br> <simple name="projectName" value="$(projectName)"/><br> <simple name="path" value="$(incDir)"/><br> </process><br><br> <process type="org.eclipse.cdt.core.templateengine.process.processes.AddFiles"><br> <simple name="projectName" value="$(projectName)"/><br> <complex-array name="files"><br> <element><br> <simple name="source" value="inc/Basename.h"/><br> <simple name="target" value="$(incDir)/$(baseName).h"/><br> <simple name="replaceable" value="true"/><br> </element><br> <element><br> <simple name="source" value="src/Basename.cpp"/><br> <simple name="target" value="$(sourceDir)/$(baseName).cpp"/><br> <simple name="replaceable" value="true"/><br> </element><br> </complex-array><br> </process><br><br> <process type="org.eclipse.cdt.managedbuilder.templateengine.processes.AppendToMBSStringListOptionValues"><br> <simple -name="projectName" value= "$(projectName)"/> <br> <complex-array name="resourcePaths"><br> <element><br> <simple name="id" value=".*linker\.libraries\.libraries.*" /><br> <simple-array name="values"><br> <element value="euser.lib" /><br> </simple-array><br> <simple name="path" value="" /><br> </element><br> </complex-array><br> </process><br></template></code></p> +<p class="CodeBlock"><code><?xml version="1.0" encoding="ISO-8859-1"?><br> +<template type="ProjTempl" version="1.0" supplier="Symbian" revision="1.0" author="Bala Torati"<br> + id="EXE" label="Simple EXE" description="A skeletal Symbian OS EXE project. Creates a folder for sources and another for include."<br> + help="help.html"><br> +<br> + <property-group id="basics" label="Basic Settings" description="Basic properties of a project" type="PAGES-ONLY" help="help.html"><br> + <br> +<property id="uid2"<br> + label="UID 2"<br> + description="UID 2"<br> + default="0x00000000"<br> + type="input"<br> + pattern="0x[0-9a-fA-F]{8}"<br> + hidden="false"<br> + mandatory="true"<br> + persist="true"/><br> + <br> +<property id="uid3"<br> + label="UID 3"<br> + description="UID 3"<br> + default="0x00000000"<br> + type="input"<br> + pattern="0x[0-9a-fA-F]{8}"<br> + hidden="false"<br> + mandatory="false"<br> + persist="true"/><br> +<br> +<property id="vid"<br> + label="Vendor ID"<br> + description="Vendor ID"<br> + default="0x00000000"<br> + type="input"<br> + pattern="0x[0-9a-fA-F]{8}"<br> + hidden="false"<br> + mandatory="true"<br> + persist="true"/><br> +<br> +<property id="author"<br> + label="Author"<br> + description="Name of the author"<br> + type="input"<br> + pattern=".*"<br> + default=""<br> + hidden="false"<br> + persist="true"/><br> +<br> +<property id="copyright"<br> + label="Copyright notice"<br> + description="Your copyright notice"<br> + type="input"<br> + pattern=".*"<br> + default="Your copyright notice"<br> + hidden="false"<br> + persist="true"/><br> +<br> +<property id="targetType"<br> + label="Target Type"<br> + description="Select the target type"<br> + type="select"<br> + hidden="false"<br> + mandatory="true"<br> + persist="true"><br> + <item label="APP" selected="true" name="app"/><br> + <item label="LIB" selected="false" name="lib"/><br> + <item label="DLL" selected="false" name="dll"/><br> + <item label="EXE" selected="false" name="exe"/><br> + <item label="EXEDLL" selected="false" name="exedll"/><br> + </property><br> + </property-group><br> +<br> + <property-group id="directories" label="Project Directories" description="Generated files will be copied to the specified directories under the project root directory" type="PAGES-ONLY" help="help.html"><br> + <property id="incDir"<br> + label="Include"<br> + description="Directory for C++ header files"<br> + type="input"<br> + default="inc"<br> + pattern="[a-zA-Z0-9]+"<br> + mandatory="true"<br> + persist="true"/><br> +<br> + <property id="sourceDir"<br> + label="Source"<br> + description="Directory for C++ source files"<br> + type="input"<br> + default="src"<br> + pattern="[a-zA-Z0-9]+"<br> + mandatory="true"<br> + persist="true"/><br> + </property-group><br> + <br> + <process type="org.eclipse.cdt.managedbuilder.core.NewManagedProject"><br> + <simple name="name" value="$(projectName)"/><br> + <simple name="targetType" value="$(targetType)"/><br> + <simple name="uid2" value="$(uid2)"/><br> + <simple name="uid3" value="$(uid3)"/><br> + <simple name="vid" value="$(vid)"/><br> + </process><br> +<br> + <process type="org.eclipse.cdt.core.CreateSourceFolder"><br> + <simple name="projectName" value="$(projectName)"/><br> + <simple name="path" value="$(sourceDir)"/><br> + </process><br> +<br> + <process type="org.eclipse.cdt.managedbuilder.core.CreateIncludeFolder"><br> + <simple name="projectName" value="$(projectName)"/><br> + <simple name="path" value="$(incDir)"/><br> + </process><br> +<br> + <process type="org.eclipse.cdt.core.AddFiles"><br> + <simple name="projectName" value="$(projectName)"/><br> + <complex-array name="files"><br> + <element><br> + <simple name="source" value="inc/Basename.h"/><br> + <simple name="target" value="$(incDir)/$(baseName).h"/><br> + <simple name="replaceable" value="true"/><br> + </element><br> + <element><br> + <simple name="source" value="src/Basename.cpp"/><br> + <simple name="target" value="$(sourceDir)/$(baseName).cpp"/><br> + <simple name="replaceable" value="true"/><br> + </element><br> + </complex-array><br> + </process><br> +<br> + <process type="org.eclipse.cdt.managedbuilder.core.AppendToMBSStringListOptionValues"><br> + <simple +name="projectName" value= "$(projectName)"/> <br> + <complex-array name="resourcePaths"><br> + <element><br> + <simple name="id" value=".*linker\.libraries\.libraries.*" /><br> + <simple-array name="values"><br> + <element value="euser.lib" /><br> + </simple-array><br> + <simple name="path" value="" /><br> + </element><br> + </complex-array><br> + </process><br> +</template></code></p> <p> The above given template copies the following source (<code class="filename">.cpp</code>) and header (<code class="filename">.h</code>) files in the <code>src</code> and <code>inc</code> folders respectively. These files uses a set of macros to get the values specified by the developer for file name, author name, copyright etc. </p> -<p class="CodeBlock"><code>/*<br>============================================================================<br> Name : $(baseName).cpp<br> Author : $(author)<br> Version :<br> Copyright : $(copyright)<br> Description : Exe source file<br>============================================================================<br>*/<br><br>// Include Files <br><br>#include "$(baseName).h"<br>#include <e32base.h><br>#include <e32std.h><br>#include <e32cons.h> // Console<br><br><br>// Constants<br><br>_LIT(KTextConsoleTitle, "Console");<br>_LIT(KTextFailed, " failed, leave code = %d");<br>_LIT(KTextPressAnyKey, " [press any key]\n");<br><br><br>// Global Variables<br><br>LOCAL_D CConsoleBase* console; // write all messages to this<br><br><br>// Local Functions<br><br>LOCAL_C void MainL(const TDesC& aArgs)<br> {<br> //<br> // add your program code here, example code below<br> //<br> console->Write(_L("Hello, world!\n"));<br> console->Printf(_L("Command line args: \"%S\"\n"), &aArgs);<br> }<br><br><br>LOCAL_C void DoStartL()<br> {<br> // Create active scheduler (to run active objects)<br> CActiveScheduler* scheduler = new (ELeave) CActiveScheduler();<br> CleanupStack::PushL(scheduler);<br> CActiveScheduler::Install(scheduler);<br><br> // Call main function with command line<br> TBuf<256> cmdLine;<br> RProcess().CommandLine(cmdLine);<br> MainL(cmdLine);<br><br> // Delete active scheduler<br> CleanupStack::PopAndDestroy(scheduler);<br> }<br><br><br>// Global Functions<br><br>GLDEF_C TInt E32Main()<br> {<br> // Create cleanup stack<br> __UHEAP_MARK;<br> CTrapCleanup* cleanup = CTrapCleanup::New();<br><br> // Create output console<br> TRAPD(createError, console = Console::NewL(KTextConsoleTitle, TSize(KConsFullScreen,KConsFullScreen)));<br> if (createError)<br> return createError;<br><br> // Run application code inside TRAP harness, wait keypress when terminated<br> TRAPD(mainError, DoStartL());<br> if (mainError)<br> console->Printf(KTextFailed, mainError);<br> console->Printf(KTextPressAnyKey);<br> console->Getch();<br> <br> delete console;<br> delete cleanup;<br> __UHEAP_MARKEND;<br> return KErrNone;<br> }</code></p> -<p class="CodeBlock"><code>/*<br>============================================================================<br> Name : $(baseName).h<br> Author : $(author)<br> Version :<br> Copyright : $(copyright)<br> Description : Exe header file<br>============================================================================<br>*/<br><br>#ifndef __$(baseName)_H__<br>#define __$(baseName)_H__<br><br><br>// Include Files<br><br>#include <e32base.h><br><br><br>// Function Prototypes<br><br>GLDEF_C TInt E32Main();<br><br><br>#endif // __$(baseName)_H__</code></p> +<p class="CodeBlock"><code>/*<br> +============================================================================<br> + Name : $(baseName).cpp<br> + Author : $(author)<br> + Version :<br> + Copyright : $(copyright)<br> + Description : Exe source file<br> +============================================================================<br> +*/<br> +<br> +// Include Files <br> +<br> +#include "$(baseName).h"<br> +#include <e32base.h><br> +#include <e32std.h><br> +#include <e32cons.h> // Console<br> +<br> +<br> +// Constants<br> +<br> +_LIT(KTextConsoleTitle, "Console");<br> +_LIT(KTextFailed, " failed, leave code = %d");<br> +_LIT(KTextPressAnyKey, " [press any key]\n");<br> +<br> +<br> +// Global Variables<br> +<br> +LOCAL_D CConsoleBase* console; // write all messages to this<br> +<br> +<br> +// Local Functions<br> +<br> +LOCAL_C void MainL(const TDesC& aArgs)<br> + {<br> + //<br> + // add your program code here, example code below<br> + //<br> + console->Write(_L("Hello, world!\n"));<br> + console->Printf(_L("Command line args: \"%S\"\n"), &aArgs);<br> + }<br> +<br> +<br> +LOCAL_C void DoStartL()<br> + {<br> + // Create active scheduler (to run active objects)<br> + CActiveScheduler* scheduler = new (ELeave) CActiveScheduler();<br> + CleanupStack::PushL(scheduler);<br> + CActiveScheduler::Install(scheduler);<br> +<br> + // Call main function with command line<br> + TBuf<256> cmdLine;<br> + RProcess().CommandLine(cmdLine);<br> + MainL(cmdLine);<br> +<br> + // Delete active scheduler<br> + CleanupStack::PopAndDestroy(scheduler);<br> + }<br> +<br> +<br> +// Global Functions<br> +<br> +GLDEF_C TInt E32Main()<br> + {<br> + // Create cleanup stack<br> + __UHEAP_MARK;<br> + CTrapCleanup* cleanup = CTrapCleanup::New();<br> +<br> + // Create output console<br> + TRAPD(createError, console = Console::NewL(KTextConsoleTitle, TSize(KConsFullScreen,KConsFullScreen)));<br> + if (createError)<br> + return createError;<br> +<br> + // Run application code inside TRAP harness, wait keypress when terminated<br> + TRAPD(mainError, DoStartL());<br> + if (mainError)<br> + console->Printf(KTextFailed, mainError);<br> + console->Printf(KTextPressAnyKey);<br> + console->Getch();<br> + <br> + delete console;<br> + delete cleanup;<br> + __UHEAP_MARKEND;<br> + return KErrNone;<br> + }</code></p> +<p class="CodeBlock"><code>/*<br> +============================================================================<br> + Name : $(baseName).h<br> + Author : $(author)<br> + Version :<br> + Copyright : $(copyright)<br> + Description : Exe header file<br> +============================================================================<br> +*/<br> +<br> +#ifndef __$(baseName)_H__<br> +#define __$(baseName)_H__<br> +<br> +<br> +// Include Files<br> +<br> +#include <e32base.h><br> +<br> +<br> +// Function Prototypes<br> +<br> +GLDEF_C TInt E32Main();<br> +<br> +<br> +#endif // __$(baseName)_H__</code></p> <p> When the developer chooses the above template in the New Project wizard, the following wizard pages are generated: |