# HG changeset patch # User timkelly # Date 1238168177 18000 # Node ID 6b79ffb176c54eb8f5163bddaf001ddf45c1f203 # Parent f330c1e8a4f31b436cbcfea734415740d6ae08f7 Update to describe how SFO CDK works diff -r f330c1e8a4f3 -r 6b79ffb176c5 carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/background.htm --- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/background.htm Wed Mar 25 11:55:19 2009 -0500 +++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/background.htm Fri Mar 27 10:36:17 2009 -0500 @@ -12,7 +12,7 @@

Carbide.c++ is built on the Eclipse platform. The Eclipse components used are:

diff -r f330c1e8a4f3 -r 6b79ffb176c5 carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/env_setup.htm --- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/env_setup.htm Wed Mar 25 11:55:19 2009 -0500 +++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/env_setup.htm Fri Mar 27 10:36:17 2009 -0500 @@ -16,26 +16,25 @@

This section will describe how to set up a basic Eclipse development environment to develop a plugin against the Carbide.c++ development environment.

-

Download the Eclipse 3.4 SDK

-

Carbide.c++ is developed against the Eclipse 3.4 release build. You can download the build -here. Carbide.c++ is only tested and supported on the Windows platform.

-

You can extract the Eclipse platform anywhere you like.

-

NOTE When you launch eclipse, choose a workspace location without spaces. This will help to prevent build issues later on with Symbian SDKs.

-

Set-up the Target Platform

+

Download the Carbide.c++ Development Kit (CDK)

+

Carbide.c++ is developed against the Eclipse 3.4 release build which includes the Java Development Tools (JDT) and Plug-in Development Environment (PDE). You will need these items as well as the Carbide.c++/CDT source code to develop Eclipse/Carbide.c++ plug-ins. If you want to install the CDK you will need to run the Software Updates under the Help menu to update your installation to include the CDK.

+

For more information on running the Software Updater please see the page Updating Carbide.c++.

+

Importing source projects

-

Once you have your Eclipse environment extracted and launched, you can set up your Target Platform to have your fresh installation reference all the Carbide.c++/CDT/Eclipse plugins.

-

The Eclipse Target Platform feature allows you to compile and run against a different Eclipse installation than the -one you're using for development. In this case you'll be targeting the Carbide.c++ installation. The Target Platform is a workspace-wide setting, so you may want to dedicate a separate workspace for your Carbide.c++ plugin development.

- +

Once you have your Carbide environment updated to include the CDK, you can create new Eclipse plug-in projects and debug the Carbide.c++ sources. How to create eclipse plug-ins is beyond the scope of this demonstration. If you want to debug any of the Carbide.c++ or Ecilpse platform source follow these steps to verify your CDK isntallation:

    -
  1. Choose Window > Preferences > Plug-in Development > Target Platform.
    2. -
  2. Browse for the Location of your Carbide.c++ installation. This is the location that contains the Carbide.c++.exe and plugins folder. When you have chosen the new location eclipse will load the plugins found in Carbide.c++ installation you will work against. Your Target Platform preference should look something like this:
    -
    -
    3. -
  3. Select OK.
    4. +
  4. Switch to the Plug-in Development perspective.
    5. +
  5. Select the Plug-ins view.
    6. +
  6. Select the binary plug-in you want view the source of. Don't select the *source feature.
    7. +
  7. Right-click on the plug-in you want to import and select Import As > Source Project. For example, the com.nokia.carbide.cpp.leavescan plug-in as shown below.
    +
    +
    8. +
  8. Now you can return to the Package Explorer view and navigate the source files for the imported plug-in. It should look like a normal plug-in project:
    +
    +
    +
    + You can now create a launch configuration and debug Carbide.
-

You are now ready to import or create new projects into your Eclipse workspace.

- diff -r f330c1e8a4f3 -r 6b79ffb176c5 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 Wed Mar 25 11:55:19 2009 -0500 +++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/import_examples.htm Fri Mar 27 10:36:17 2009 -0500 @@ -12,43 +12,22 @@ -

Importing the SDK example and leavescan plug-ins

-

There are two example plugins you can import and examine as examples of Carbide.c++ API usage.

+

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.

-

You can import these plugins into your workspace and view/debug all the source to get a better understanding of the -Carbide.c++ APIs in a functional plugin.

+

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.

-
    -
  1. Choose File > Import
    2. -
  2. Choose Plug-in Development > Plug-ins and Fragments from the Import wizard page.
    -
    -
    -
    3. -
  3. On the Import Plug-ins and Fragments pages you select import options. In the Import As group, select Projects with source folders. - In addition, note that The target platform (as specified in the Preferences) - checkbox should be enabled. This should be the path you specified previously in the Target Preferences.
    -
    -
    -
    4. -
  4. Finally, select the plugins you want to import. Here you select the com.nokia.carbide.cpp.leavescan and - com.nokia.carbide.cpp.sdk.examples plugins.
    -
    -
    -
    5. -
  5. 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:
    -
    -
    6. -
-

Adding a Carbide menu

+

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:

  1. In Carbide.c++ (not in your Eclipse Java development SDK) choose Window > Customize Perspective...
    2. @@ -57,7 +36,7 @@
-

Click OK, and you should now see the Carbide menu in the menu bar.

+

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.

\ No newline at end of file diff -r f330c1e8a4f3 -r 6b79ffb176c5 carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/launchconfig.htm --- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/launchconfig.htm Wed Mar 25 11:55:19 2009 -0500 +++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/launchconfig.htm Fri Mar 27 10:36:17 2009 -0500 @@ -4,18 +4,26 @@ Debugging a Carbide.c++ plug-in +

Debugging a Carbide.c++ plug-in

In order to launch Carbide.c++ in debug mode you need to create an Eclipse runtime debug configuration. Follow these steps.

  1. Click the Debug icon () in the task bar or right click on a project and choose Debug As > Open Debug Dialog... You should see the Eclipse launch configuration dialog.
    2. -
  2. Choose Eclipse Application and then click on the New button. A new configuration is created. You should be able to take the default settings which should look like this:
    +
  3. Choose Eclipse Application and then click on the New button. A new configuration is created. You should be able to take the default settings which should look like this:

    -
    +
    4. -
  4. Click Debug and you should have a fully functional debug environment around Carbide.c++.
    -
    5. +
  5. Click Debug and the Carbide.c++ project will launch another instance under debug control. You can set breakpoints in any of the plug-ins you have imported or any sources in the stack crawl during a debug session.
    +
    +
    + TIP: Under the Arguments Tab, be sure to add theses VM Arguments for memory management: -Xms40m -Xmx1024m
    +
diff -r f330c1e8a4f3 -r 6b79ffb176c5 carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/sdk_help.htm --- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/sdk_help.htm Wed Mar 25 11:55:19 2009 -0500 +++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/sdk_help.htm Fri Mar 27 10:36:17 2009 -0500 @@ -7,64 +7,17 @@ -

Installing the Carbide.c++ Plug-in SDK help

+

Carbide.c++ Plug-in SDK help

If you're just getting started with creating a Carbide.c++ plug-in you're probably looking -at this help documentation from within Carbide.c++. But if you are setting up your development -environment as described in Setting up your development environment -you will find it much more useful to have the help available from within your plug-in development -environment.

- -

The following steps will show you how to install the latest version of the Carbide.c++ -Plugin SDK into your plug-in development environment. If your network requires a proxy to -access external Internet sites then follow the first two steps. Otherwise skip to step 3.

-
    -
  1. From the menu bar choose Window > Preferences.

    -
    -
    2. -
  2. Expand the General group and select Network Connections. Select Manual proxy configuration and enter your proxy information.
    -
    -
    -
    -
    3. -
  3. From the menu bar choose Help > Software Updates > Find and Install...
    -
    -
    -
    -
    4. -
  4. Select "Search for new features to install" and click Next.
    +at this help documentation from within Carbide.c++. Make sure you first follow the steps to import the Carbide Development Kit (CDK) as described in Setting up your development environment. The CDK contains all the non-internal APIs for you to browse for your convenience. The same documentation appears in the javadoc comments in the source code.

    -
    -
    -
    5. -
  5. On the Update sites to visit page, you will need to add the Carbide.c++ update site. Press the -"New Remote Site.." button.

    -
    -
    -
    6. -
  6. Fill in the update site information (http://tools.ext.nokia.com/updates/) with the latest major release version (carbide13) and press OK.
    -
    -
    -
    -
    7. -
  7. The new site should now appear in the list of update sites. Press the Finish button.

    -
    -
    -
    8. -
  8. Eclipse will connect to the Carbide.c++ update site and display the available updates. The -specific list may differ from the screenshot below, but the Carbide.c++ SDK item should -be present. Select it and press Next and proceed through the rest of the installation.
    -
    -
    -
    -
    9. -
  9. The SDK is now installed. You can import the latest version of the -Examples plugin. The SDK help is under the "Carbide.c++ Plug-in Developer Guide" entry in the Eclipse online + The SDK help is under the "Carbide.c++ Plug-in Developer Guide" entry in the Eclipse online help.

    -
    -
    10. -
+
+
+