interface xdc.tools.product.IProduct

metaonly interface xdc.tools.product.IProduct

Interface specifying product details

This interface allows products describe themselves for the benefit of development tools such as IDE's. For example, a tool can read the information provided by a product that implements this interface and generate an eclipse plugin that leverages the product's "resources". [ more ... ]

XDCspec summary sourced in xdc/tools/product/IProduct.xdc

metaonly interface IProduct { ...

XDCspec declarations sourced in xdc/tools/product/IProduct.xdc

package xdc.tools.product;

metaonly interface IProduct {

module-wide constants & types

metaonly struct HelpToc// Help table of contents (TOC) element {

String label// Help element description;

String filePath// Path to help doc;

Bool tocFile// Indicates whether element is a TOC file;

};

metaonly struct MacroDescriptor// Macro Descriptor structure {

String name// Macro name;

String desc// Macro description;

};

metaonly struct PluginDescriptor// Plugin Descriptor structure {

String id// Plugin id;

String version// Plugin version;

String path// Plugin path;

};

metaonly struct Target// Structure containing information on RTSC targets {

String deviceNamePattern// Device name regex eg. MSP430*;

String deviceFamilyPattern// Device family regex eg. C6*;

String packageName// Package containing RTSC target;

String baseTargetName// Name of RTSC target module;

};

metaonly struct UrlDescriptor// URL Descriptor structure {

String url// Uniform Resource Locator(URL);

String text// Summary text for the URL;

String targetText// (optional) Summary for target portion;

};

module-wide config parameters

config String bundleName// Product bundle name;

config String companyName// Name of company releasing product;

config String copyRightNotice// Copyright notice for product;

config String docsLocArr// Directories containing documents in the product[];

config Bool exclusive// This product is a singlton = false;

config IProduct.PluginDescriptor externalPlugins// External plugins delivered with the product[];

config String externalRequirements// External plugins required by this product[];

config IProduct.HelpToc helpTocArr// Array of table of contents elements in product[];

config String id// A unique product id;

config IProduct.UrlDescriptor licenseDescriptor// License information for product;

config IProduct.MacroDescriptor macro// Macro associated with the product;

config String name// Product name;

config String otherFiles// Array of paths to files that describe the product[];

config IProduct.UrlDescriptor productDescriptor// Product description;

config String productViewModule// Name of module implementing xdc.tools.product.IProductView;

config String repositoryArr// Repositories contained in product[];

config IProduct.Target targetArr// RTSC target modules contained in product[];

config String templateModule// Name of module implementing xdc.tools.product.IProductTemplate;

config String tocIndexFile// Top level index file referred in table of contents;

config IProduct.UrlDescriptor updateSite// Update site for product;

config String version// Product version;

}

DETAILS

By expressing the product's information in this interface, a product can be delivered into multiple development tools without explicit knowledge of these tools. For example, an online "product repository" can extract sufficient information from this interface to enable it to provide a searchable catalog of interesting products.

This is an experimental interface and is subject to change

struct IProduct.HelpToc