metaonly module xdc.tools.product.plugingen.Main
index URL

Command implementation

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 ... ]
XDCscript usage meta-domain sourced in xdc/tools/product/plugingen/Main.xdc
var Main = xdc.useModule('xdc.tools.product.plugingen.Main');
module-wide config parameters
    Main.usage// Usage for this command = String[] [
        '[-p product_root_directory]',
        ' -m module',
        '[-o outdir]',
        '[-f pluginFragment]',
        '[--suppress_product_type_info]',
        '[--disable_repo_search]'
    ];
module-wide functions
    Main.exec// 'xs' script entry point(Any args) returns Any
    Main.main// 'xs' shell entry point(Any args) returns Any
per-instance config parameters
    var params = new Main.Params// Instance config-params object;
        params.generationFormat// Plugin generation format = String null;
        params.outputDir// Output directory in which the plugin will be generated = String null;
        params.pluginFragment// Text file containing plugin fragment = String null;
        params.productDir// Product root directory = String "./";
        params.productModule// Input description of the plug-in to be specified = String undefined;
        params.suppressProductTypeInfo// Suppress generation of product type information = Bool false;
        params.suppressSearch// Suppress search of product repositories = Bool false;
per-instance functions
    inst.run// Underlying implementation(Cmdr.Instance cmdr, String[] args) returns Any
 
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
 
config Main.usage  // module-wide
index URL

Usage for this command

XDCscript usage meta-domain
Main.usage = String[] [
    '[-p product_root_directory]',
    ' -m module',
    '[-o outdir]',
    '[-f pluginFragment]',
    '[--suppress_product_type_info]',
    '[--disable_repo_search]'
];
 
 
Main.exec()  // module-wide
index URL

'xs' script entry point

XDCscript usage meta-domain
Main.exec(Any args) returns Any
 
 
Main.main()  // module-wide
index URL

'xs' shell entry point

XDCscript usage meta-domain
Main.main(Any args) returns Any
 
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new Main.Params;
// Instance config-params object
    params.generationFormat = String null;
    // Plugin generation format
    params.outputDir = String null;
    // Output directory in which the plugin will be generated
    params.pluginFragment = String null;
    // Text file containing plugin fragment
    params.productDir = String "./";
    // Product root directory
    params.productModule = String undefined;
    // Input description of the plug-in to be specified
    params.suppressProductTypeInfo = Bool false;
    // Suppress generation of product type information
    params.suppressSearch = Bool false;
    // Suppress search of product repositories
 
config Main.generationFormat  // instance
index URL

Plugin generation format

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.generationFormat = String null;
 
 
config Main.outputDir  // instance
index URL

Output directory in which the plugin will be generated

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.outputDir = String null;
 
DETAILS
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.
 
config Main.pluginFragment  // instance
index URL

Text file containing plugin fragment

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.pluginFragment = String null;
 
DETAILS
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.
 
config Main.productDir  // instance
index URL

Product root directory

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.productDir = String "./";
 
DETAILS
This option names the product root directory that is used by the tool to generate the plugin. For example, its 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 ./.
 
config Main.productModule  // instance
index URL

Input description of the plug-in to be specified

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.productModule = String undefined;
 
DETAILS
This required option names a module that implements xdc.tools.product.IProduct.
 
config Main.suppressProductTypeInfo  // instance
index URL

Suppress generation of product type information

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.suppressProductTypeInfo = Bool false;
 
DETAILS
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.
 
config Main.suppressSearch  // instance
index URL

Suppress search of product repositories

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.suppressSearch = Bool false;
 
DETAILS
If this option is specified the tool does not search the product repositories for RTSC platforms.
 
Main.run()  // instance
index URL

Underlying implementation

XDCscript usage meta-domain
inst.run(Cmdr.Instance cmdr, String[] args) returns Any
 
generated on Thu, 27 Sep 2012 23:21:16 GMT