package xdc.tools.product.plugingen
index URL

Command-line tool for generating eclipse plugins for RTSC content

The plugingen tool allows RTSC content producers to create eclipse plugins that allows their content to be integrated in the CCS4 environment. As input, the tool requires [ more ... ]
XDCspec declarations sourced in xdc/tools/product/plugingen/package.xdc
package xdc.tools.product.plugingen [1, 0, 0] {
 
    module Main;
    // Command implementation
}
USAGE
xs xdc.tools.product.plugingen [--help]
    [-p product_root_directory]
     -m module
    [-o outdir]
    [-f pluginFragment]
    [--suppress_product_type_info]
    [--disable_repo_search]
OPTIONS
-p
Product root directory

This option names the product root directory that is used by the tool to generate the plugin. For example, it's declared repositories are added to the package path and are searched for contributed platforms.

If the '-o' option is not specified, the tool generates the plugin in a sub-directory named eclipse in the product root directory.

If this option is not specified, the product root directory is assumed to be ./.

-m
Input description of the plug-in to be specified

This required option names a module that implements xdc.tools.product.IProduct.

-o
Output directory in which the plugin will be generated

This option names the directory in which the plugin will be generated in a sub-directory named eclipse. If this option is not specified the tool will generate the plugin in the product root directory specified with the '-p' option.

-f
Text file containing plugin fragment

This option names the text file containing a plugin fragment. This allows users to contribute extensions to the UI plugins generated by the tool.

The tool does not perform syntax checking of the contributed fragment. Users need to ensure the correctness of the contributed fragment. Note that syntactically incorrect fragments can disable the plugin completely in the eclipse platform.

--generation_format
Plugin generation format
--suppress_product_type_info
Suppress generation of product type information

This option generates eclipse plugin without the product type information. Should only be invoked to generate plugins whose product type information was hard coded into CCS 4.x prior to the creation of this tool.

This option should not be used by _any_ new products.

--disable_repo_search
Suppress search of product repositories

If this option is specified the tool does not search the product repositories for RTSC platforms.

DETAILS
The plugingen tool allows RTSC content producers to create eclipse plugins that allows their content to be integrated in the CCS4 environment. As input, the tool requires
Refer to ExampleProduct for an implementation of IProduct.
The tool may also be used to generate starter examples that will showup in the new project wizard. This is accomplished by implementing IProductTemplate and setting the templateModule configuration parameter of the IProduct implementation to the name of the implementation module. Refer to Examples for a sample implementation of IProductTemplate.
The XGCONF product view maybe developed by implementing IProductView and setting the productViewModule configuration parameter of the IProduct implementation to the name of the implementation module. Refer to ProductView.xdc and ProductView.xs for a sample implementation of IProductView.
The tool operates on a product that is either specified by the -p option or is present in the folder from which the tool is executed. The tool will create the plugin in a sub-folder named eclipse in the output directory specified with -o option. If the -o option is not specified the plugin is created in the product root directory. The tool will search the repositories specified in the module implementing xdc.tools.product.IProduct for RTSC platforms. This search can be disabled by specifying the--disable_repo_search option. The user needs to ensure that the repositories are installed in the product root directory before using the tool.
EXAMPLE
      xs xdc.tools.product.plugingen 
                      -p exampleprod_1_0_0_00
                      -m xdc.tools.product.plugingen.examples.ExampleProduct
generated on Thu, 23 Aug 2012 18:50:51 GMT