Importing the SDK example and leavescan plug-ins

# HG changeset patch # User fturovic # Date 1240934867 18000 # Node ID 740c114ee263fb249cb4773a565007400add181f # Parent d13aa008da3366981effd8bcfc7c676cf941952d bug 8806 revision for 2.0.4 diff -r d13aa008da33 -r 740c114ee263 carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/import_examples.htm --- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/import_examples.htm Mon Apr 27 15:10:32 2009 -0500 +++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/import_examples.htm Tue Apr 28 11:07:47 2009 -0500 @@ -1,42 +1,42 @@ - - - - -Importing the SDK example and leavescan plug-ins - - - - - -

Importing the SDK Example

You can import any of the plug-ins in Carbide.c++ and examine the source code. However, the SDK provides a plug-in you can import and examine as an example of Carbide.c++ API usage.

The Examples plugin (com.nokia.carbide.cpp.sdk.examples) is part of the Carbide.c++ Development Kit (CDK). It -provides examples of installing items in the Carbide menu, creating new projects programatically, and accessing -project and Symbian build information. See below for instructions on how to enable the example menu -commands inside carbide.

You can import this and other plugins into your workspace and view/debug all the source to get a better understanding of the -Carbide.c++ APIs in a functional plugin. Plesae see the page on setting up your development environment for information on how to import a source project.

Note that the example plugins were built with JRE1.5, you will likely receive errors with JRE1.6. Select Window > Preferences > Java > Installed JREs to add currently installed JREs and select the JRE to use.

When you are done importing you should have new plugins in your workspace and be able to view the - sources for both plugin projects. Your workspace should look something like this:
-
-

Adding a Carbide menu

The menu items contributed by the Examples plugin are not visible by default in the Carbide.c++ program. To show the missing menu, follow these steps:

In Carbide.c++ (not in your Eclipse Java development SDK) choose Window > Customize Perspective...
Select the Commands tab
Select the checkbox for Carbide.c++ Examples Action Set
-
-

Click OK, and you should now see the Carbide menu in the menu bar. You can now examine the source code and run it in the debugger. See debugging a debugging a Carbide.c++ plug-in for information on setting up a plug-in debug session.

- - + + + + +Importing the SDK example and leavescan plug-ins + + + + + +

Importing the SDK Example

You can import any of the plug-ins in Carbide.c++ and examine the source code. However, the SDK provides a plug-in you can import and examine as an example of Carbide.c++ API usage.

The Examples plugin (com.nokia.carbide.cpp.sdk.examples) is part of the Carbide.c++ Development Kit (CDK). It +provides examples of installing items in the Carbide menu, creating new projects programatically, and accessing +project and Symbian build information. See below for instructions on how to enable the example menu +commands inside Carbide.

You can import this and other plugins into your workspace and view/debug all the source to get a better understanding of the +Carbide.c++ APIs in a functional plugin. Plesae see the page on setting up your development environment for information on how to import a source project.

+When you are done importing you should have new plugins in your workspace and be able to view the + sources for both plugin projects. Your workspace should look something like this:
+
+

Adding a Carbide menu

The menu items contributed by the Examples plugin are not visible by default in the Carbide.c++ program. To show the missing menu, follow these steps:

In Carbide.c++ (not in your Eclipse Java development SDK) choose Window > Customize Perspective...
Select the Commands tab
Select the checkbox for Carbide.c++ Examples Action Set
+
+

+ + \ No newline at end of file diff -r d13aa008da33 -r 740c114ee263 carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/tasks/sdkMainTopic.htm --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/tasks/sdkMainTopic.htm Tue Apr 28 11:07:47 2009 -0500 @@ -0,0 +1,35 @@ + + + + + + Carbide Plug-ins Overview + + + + +

Carbide Plug-ins Overview

+ +

Creating a Carbide tool plug-in requires some knowledge and understanding of the Eclipse plug-in environment. There are two methods of creating Carbibe plug-ins, including:

Importing an existing Carbide tool plug-in and modifying it
Creating a new Eclipse plug-in and adding Carbide API calls

Each has its advantages and disadvantages. Importing an existing Carbide plug-in provides a working plug-in that you can modify and add to easily to get something up and running quickly. However, the plug-in probably doesn't include the API interaction you want to implement and includes a lot of resources you probably don't need or want. Creating a new plug-in from scratch has the advantage of giving you a clean slate upon which to add your own code. It doesn't include any basic Carbide support like menu items and preference panel calls that nearly every tool requires, forcing you to add them on your own.

Which one you choose depends on the type of plug-in you want to develop and how much support you need to get up and running. In either case, both methods will require access to Carbide projects to allow them to interact with the active project.

Accessing Carbide Project Information

The following pages describe how to access specific Carbide project information for use in your own tool plug-ins.

Related information

Simple Plug-in Example (Platform Plug-in Developer Guide)
Creating Carbide Plug-ins
Plug-in Development Environment Guide

+ + + \ No newline at end of file diff -r d13aa008da33 -r 740c114ee263 carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/tasks/sdk_getprojinfo.htm --- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/tasks/sdk_getprojinfo.htm Mon Apr 27 15:10:32 2009 -0500 +++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/tasks/sdk_getprojinfo.htm Tue Apr 28 11:07:47 2009 -0500 @@ -1,69 +1,69 @@ - - - - -Getting Carbide Project Information - - - - -

Getting Carbide Project Information

The following example code fragment demonstrates the use of Carbide.c++ APIs to access Carbide project information.

NOTE There are two perspective IDs that may be useful when using the Carbide APIs. The perspective ID for the Carbide.c++ perspective is com.nokia.carbide.cpp.CarbideCppPerspective and for the Debug view it is org.eclipse.debug.ui.DebugPerspective.

Retrieving Carbide.c++ project information starts with knowing your org.eclipse.core.resources.IProject resource and retrieving the com.nokia.carbide.cdt.builder.ICarbideBuildManager instance:

ICarbideBuildManager buildMgr = ICarbideBuilderPlugin.getBuildManager();

Now with your IProject resource you can grab the actual Carbide project in com.nokia.carbide.cdt.builder.ICarbideProjectInfo:

// Assumes IProject (project) is known.
- ICarbideProjectInfo cpi = null;
- if (buildMgr.isCarbideProject(project)){
- // check to make sure this is a Carbide project
- cpi = buildMgr.getProjectInfo(project);
-}

Once you get the ICarbideProjectInfo object you can access all the project data, such as environment variables and SIS builder information via the com.nokia.carbide.cdt.builder.ICarbideBuildConfiguration interface. You can retrieve either the default configuration or the full list:

// Get the default build configuration
- ICarbideBuildConfiguration defaultConfig = cpi.getDefaultConfiguration();
-// Get all configurations for this project.
-List<ICarbideBuildConfiguration> configList = cpi.getBuildConfigurations();

It is important to note that the data retrieved by the ICarbideBuildConfiguration object is what you see in the project properties pages under the Carbide.c++ group. This is separate from the data in the INF and MMP files.

Retrieving INF/MMP Project Information

All Carbide build stages, with the exception of the post-link SIS Builder stage get their data from INF and MMP files. So naturally Carbide needs a way to retrieve and store this data for doing things like setting up the source indexer and displaying the visual INF and MMP editors. The com.nokia.carbide.cdt.builder.EpocEngineHelper class is a good first stop to retrieve this information. For example, if you want to get all the source files in the first MMP file:

- -

// ...assumes ICarbideProjectInformation (cpi) is known.
-List<IPath> mmpPaths = EpocEngineHelper.getMMPFilesForProject(cpi);
-// array length check omitted for brevity....
-List<IPath> srcFilesTest = EpocEngineHelper.getSourceFilesForConfiguration(defultConfig, mmpPaths.get(0));

SDK Management

Each SDK entry in devices.xml is analogous to a com.nokia.carbide.cpp.sdk.core.ISymbianSDK object. If you want to get the entire list of ISymbianSDK objects (same list and properties from the SDK Preferences page) you simply invoke:

- -

ISDKManager sdkMgr = SDKCorePlugin.getSDKManager();
-List<ISymbianSDK> sdkList = sdkMgr.getSDKList();

- -

Now you can iterate the list and get whatever information you want out of the installed SDKs. For example, using Java 5 iterators we can get the EPOCROOT values of all the SDKs:

- -

for (ISymbianSDK currSDK : sdkList){
-   String epocRootStr = currSDK.getEPOCROOT();
-}

- -

Reading MMP Statements with the EpocEngine and IMMPData

This topic demonstrates how you can read the MMP data for any build configuration (ICarbideBuildConfiguration). The main interface for retrieving MMP data is com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPData. Once you get access to this interface you can learn anything you want about a particular MMP file.

Prerequisite: All MMP and bld.inf parsing requires a dependency to the plugin com.nokia.carbide.cpp.epoc.engine.

Typically most keywords of interest are either single string settings (TARGETTYPE, TARGET, EPOCSTACKSIZE) or list of settings (MACRO, CAPABILITY, LANG). Other types can be directly retrieved from IMMPData routines. Check the API documentation for specifics.

The example provided simply iterates through all the MMP files of a particular build configuration and grabs a list value and single item setting. You'll need to get the particular MMP file you are interested in. Play around with the IMMPData object in the run method and you can quickly get the idea.

// Assumes buildConfig (ICarbideBuildConfiguration) is known
-for (IPath mmpPath : EpocEngineHelper.getMMPFilesForBuildConfiguration(buildConfig)) {
-     Object data = EpocEnginePlugin.runWithMMPData(mmpPath,  new
-                              DefaultMMPViewConfiguration(buildConfig.getCarbideProject().getProject(),
-                              buildConfig, new AcceptedNodesViewFilter()),  new MMPDataRunnableAdapter() {
-                        public Object run(IMMPData mmpData) {
-                          // Example, getting a keyword as a list of strings
-                          List macros = mmpData.getListArgumentSettings().get(EMMPStatement.MACRO);
-                          // The real return value, getting a single argument setting
-                         return mmpData.getSingleArgumentSettings().get(EMMPStatement.TARGETTYPE);
-		  	                }   
-      });
-// Make sure to test for and cast to proper Object type!
-String mmpStatement = (String)data;  // Now we should have the TARGETTYPE
-}

- - + + + + +Getting Carbide Project Information + + + + +

Getting Carbide Project Information

The following example code fragments demonstrate the use of Carbide.c++ APIs to access Carbide project information.

NOTE There are two perspective IDs that may be useful when using the Carbide APIs. The perspective ID for the Carbide.c++ perspective is com.nokia.carbide.cpp.CarbideCppPerspective and for the Debug view it is org.eclipse.debug.ui.DebugPerspective.

Retrieving Carbide.c++ project information starts with knowing your org.eclipse.core.resources.IProject resource and retrieving the com.nokia.carbide.cdt.builder.ICarbideBuildManager instance:

ICarbideBuildManager buildMgr = ICarbideBuilderPlugin.getBuildManager();

Now with your IProject resource you can grab the actual Carbide project in com.nokia.carbide.cdt.builder.ICarbideProjectInfo:

// Assumes IProject (project) is known.
+ ICarbideProjectInfo cpi = null;
+ if (buildMgr.isCarbideProject(project)){
+ // check to make sure this is a Carbide project
+ cpi = buildMgr.getProjectInfo(project);
+}

// Get the default build configuration
+ ICarbideBuildConfiguration defaultConfig = cpi.getDefaultConfiguration();
+// Get all configurations for this project.
+List<ICarbideBuildConfiguration> configList = cpi.getBuildConfigurations();

Retrieving INF/MMP Project Information

+ +

// ...assumes ICarbideProjectInformation (cpi) is known.
+List<IPath> mmpPaths = EpocEngineHelper.getMMPFilesForProject(cpi);
+// array length check omitted for brevity....
+List<IPath> srcFilesTest = EpocEngineHelper.getSourceFilesForConfiguration(defultConfig, mmpPaths.get(0));

SDK Management

+ +

ISDKManager sdkMgr = SDKCorePlugin.getSDKManager();
+List<ISymbianSDK> sdkList = sdkMgr.getSDKList();

+ +

Now you can iterate the list and get whatever information you want out of the installed SDKs. For example, using Java 5 iterators we can get the EPOCROOT values of all the SDKs:

+ +

for (ISymbianSDK currSDK : sdkList){
+   String epocRootStr = currSDK.getEPOCROOT();
+}

+ +

Reading MMP Statements with the EpocEngine and IMMPData

Prerequisite: All MMP and bld.inf parsing requires a dependency to the plugin com.nokia.carbide.cpp.epoc.engine.

// Assumes buildConfig (ICarbideBuildConfiguration) is known
+for (IPath mmpPath : EpocEngineHelper.getMMPFilesForBuildConfiguration(buildConfig)) {
+     Object data = EpocEnginePlugin.runWithMMPData(mmpPath,  new
+                              DefaultMMPViewConfiguration(buildConfig.getCarbideProject().getProject(),
+                              buildConfig, new AcceptedNodesViewFilter()),  new MMPDataRunnableAdapter() {
+                        public Object run(IMMPData mmpData) {
+                          // Example, getting a keyword as a list of strings
+                          List macros = mmpData.getListArgumentSettings().get(EMMPStatement.MACRO);
+                          // The real return value, getting a single argument setting
+                         return mmpData.getSingleArgumentSettings().get(EMMPStatement.TARGETTYPE);
+		  	                }   
+      });
+// Make sure to test for and cast to proper Object type!
+String mmpStatement = (String)data;  // Now we should have the TARGETTYPE
+}

+ + \ No newline at end of file diff -r d13aa008da33 -r 740c114ee263 carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/tocTasks.xml --- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/tocTasks.xml Mon Apr 27 15:10:32 2009 -0500 +++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/tocTasks.xml Tue Apr 28 11:07:47 2009 -0500 @@ -1,14 +1,14 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + \ No newline at end of file