metaonly module xdc.tools.product.plugingen.Main |
|
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 ... ]
var Main = xdc.useModule('xdc.tools.product.plugingen.Main');
module-wide config parameters
'[-p product_root_directory]',
' -m module',
'[-o outdir]',
'[--suppress_product_type_info]',
'[--disable_repo_search]'
];
module-wide functions
per-instance config parameters
per-instance functions
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 |
|
Usage for this command
XDCscript usage |
meta-domain |
Main.usage = String[] [
'[-p product_root_directory]',
' -m module',
'[-o outdir]',
'[--suppress_product_type_info]',
'[--disable_repo_search]'
];
Main.exec() // module-wide |
|
'xs' script entry point
XDCscript usage |
meta-domain |
Main.exec(Any args) returns Any
Main.main() // module-wide |
|
'xs' shell entry point
XDCscript usage |
meta-domain |
Main.main(Any args) returns Any
Instance Config Parameters |
|
XDCscript usage |
meta-domain |
var params = new Main.Params;
// Instance config-params object
params.outputDir = String null;
// Output directory in which the plugin will be generated
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 in the
generated plugin
params.suppressSearch = Bool false;
// Suppress search of product repositories
config Main.outputDir // instance |
|
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.productDir // instance |
|
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. If the '-o' option is not
specified the tool generates the plugin in a sub-directory
called eclipse in the product root directory.
config Main.productModule // instance |
|
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 |
|
Suppress generation of product type information in the
generated plugin
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 be invoked to generate plugins whose
product type is declared elsewhere
config Main.suppressSearch // instance |
|
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 |
|
Underlying implementation
XDCscript usage |
meta-domain |
generated on Tue, 24 Aug 2010 15:39:22 GMT