1 /*
2 * Copyright (c) 2009 Texas Instruments and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
7 *
8 * Contributors:
9 * Texas Instruments - initial implementation
10 *
11 * */
12
13 /*!
14 * ======== IProduct ========
15 * Interface specifying product details.
16 *
17 * This interface allows products describe themselves for the benefit
18 * of development tools such as IDE's. For example, a tool
19 * can read the information provided by a product that implements this
20 * interface and generate an eclipse plugin that leverages the product's
21 * "resources".
22 *
23 * By expressing the product's information in this interface, a product
24 * can be delivered into multiple development tools without explicit
25 * knowledge of these tools. For example, an online "product repository"
26 * can extract sufficient information from this interface to enable it
27 * to provide a searchable catalog of interesting products.
28 *
29 * This is an experimental interface and is subject to change
30 */
31 metaonlyinterface IProduct
32 {
33 /*!
34 * ======== HelpToc ========
35 * Help table of contents (TOC) element
36 *
37 * A help element is a file inside the product that can be referenced
38 * from a global table of contents.
39 *
40 * @field(label) Summary description of help element
41 * @field(filePath) Path to help documentation relative to
42 * directory specified in {@link #docsLoc}
43 * @field(tocFile) Flag indicates whether the element is a
44 * table of content(TOC) file. Tools may
45 * process TOC files in a special way. For
46 * example a tool to generate eclipse plugins may
47 * want to copy the TOC file in the plugin folder
48 * for integrating with eclipse help.
49 */
50 struct HelpToc {
51 String label; /*! Help element description */
52 String filePath; /*! Path to help doc */
53 Bool tocFile; /*! Indicates whether element is a TOC file */
54 };
55
56 /*!
57 * ========= Target ==============
58 * Structure containing information on RTSC targets
59 *
60 * Products may specify RTSC target modules by associating
61 * them with device name and family regular expressions. This
62 * information is leveraged by tools to derive the RTSC target
63 * given a device name and family. Devices implement the
64 * {@link xdc.platform.ICpuDataSheet} interface. Devices can be
65 * grouped in a family and delivered as a package.
66 *
67 * For example, the device module TMS320DA830 in the package
68 * `ti.catalog.C6000` is associated with a RTSC target
69 * `ti.targets.C674` by setting `deviceNamePattern` to `TMS320DA8*`,
70 * `deviceFamilyPattern` to `C6*`, `packageName` to
71 * `ti.targets`, and `baseTargetName` to `C674`.
72 *
73 * @field(deviceNamePattern) A regular expression for device names
74 * @field(deviceFamilyPattern) A regular expression for device families
75 * @field(packageName) The name of a package containing a
76 * target module that can be used with
77 * the devices that match the
78 * device name and family patterns
79 * @field(baseTargetName) The name of the module
80 * (without the package prefix) in
81 * the package named by `packageName`.
82 */
83 struct Target {
84 String deviceNamePattern; /*! Device name regex eg. MSP430* */
85 String deviceFamilyPattern; /*! Device family regex eg. C6* */
86 String packageName; /*! Package containing RTSC target */
87 String baseTargetName; /*! Name of RTSC target module */
88 };
89
90 /*!
91 * ======== UrlDescriptor ========
92 * URL Descriptor structure
93 *
94 * @field(url) Uniform Resource Locator(URL)
95 * @field(text) Summary text for the URL
96 * @field(targetText) Optional summary text for any target content
97 * portion
98 */
99 struct UrlDescriptor {
100 String url; /*! Uniform Resource Locator(URL) */
101 String text; /*! Summary text for the URL */
102 String targetText; /*! (optional) Summary for target portion */
103 };
104
105 /*!
106 * ======== PluginDescriptor ========
107 * Plugin Descriptor structure
108 *
109 * @field(id) Plugin id
110 * @field(version) Plugin version
111 * @field(path) Path to plugin relative to `IProduct` implementation
112 */
113 struct PluginDescriptor {
114 String id; /*! Plugin id */
115 String version; /*! Plugin version */
116 String path; /*! Plugin path */
117 };
118
119 /*!
120 * ======== MacroDescriptor ========
121 * Macro Descriptor structure
122 */
123 struct MacroDescriptor {
124 String name; /*! Macro name */
125 String desc; /*! Macro description */
126 };
127
128 /*!
129 * ======== name ========
130 * Product name
131 *
132 * String containing product name eg. System BIOS
133 */
134 config String name;
135
136 /*!
137 * ======== id ========
138 * A unique product id
139 *
140 * For example, product developers may choose to follow namespace
141 * conventions for Java packages or Eclipse plugins to specify a
142 * unique id like `org.eclipse.rtsc.xdctools.product`.
143 */
144 config String id;
145
146 /*!
147 * ======== version ========
148 * Product version
149 *
150 * The product version should follow the format
151 * -`major.minor.service.qualifier` where
152 * `major`,`minor` and `service` are integers and
153 * `qualifier` is a string. Example - 3.16.02.31-eng.
154 *
155 * Products may specify their own guidelines for
156 * updating `major`,`minor`,`service` and `qualifier` portions of the
157 * version number as long as they are unique for the product.
158 * Products may also choose to follow popular versioning conventions
159 * like those followed for versioning Eclipse plugins.
160 */
161 config String version;
162
163 /*!
164 * ======== featureId ========
165 * A unique feature id
166 *
167 * Feature ids are used by a system to install product upgrades.
168 * Typically a system will look at various versions of a
169 * feature available in the system and allow the user to upgrade
170 * to the latest version. The product developer can use the `featureId`
171 * to manage the granularity of product upgrades in a system. For
172 * example the version `3.20.0.00` for product
173 * `org.eclipse.rtsc.xdctools.product` may have the `featureId`
174 * `org.eclipse.rtsc.xdctools.product_3.20`.
175 * The product developer may allow the upgrade system to pick up
176 * patch releases to `3.20.0.00` release by specifying different
177 * versions of the product (eg. 3.20.0.01) with `featureId`
178 * `org.eclipse.rtsc.xdctools.product_3.20`
179 */
180 config String featureId;
181
182 /*!
183 * ======== updateSite ========
184 * Update site for product
185 *
186 * @field(url) the `url` field should contain the URL containing
187 * product upgrades.
188 *
189 * @field(text) the `text` field should contain summary description of
190 * the update site
191 */
192 config UrlDescriptor updateSite;
193
194 /*!
195 * ======== companyName ========
196 * Name of company releasing product
197 *
198 * Example : "Texas Instruments"
199 */
200 config String companyName;
201
202 /*!
203 * ======== productDescriptor ========
204 * Product description
205 *
206 * @field(url) the `url` field should contain the URL of the organization
207 * releasing the product.
208 *
209 * @field(text) the `text` field should contain summary description of
210 * the target content portion of the product. Alternate text for the
211 * UI portion can be specified via {@link #productUIDescription}`.
212 }
213 */
214 config UrlDescriptor productDescriptor;
215
216 /*!
217 * ======== licenseDescriptor ========
218 * License information for product
219 *
220 * @field(url) field should contain the URL containing the
221 * license text.
222 *
223 * @field(text) field should contain a summary description of the license
224 */
225 config UrlDescriptor licenseDescriptor;
226
227 /*!
228 * ======== copyRightNotice ========
229 * Copyright notice for product
230 */
231 config String copyRightNotice;
232
233 /*!
234 * ======== repositoryArr ========
235 * Repositories contained in product
236 *
237 * Repositories are specified relative to the product installation
238 * directory.
239 */
240 config String repositoryArr[];
241
242 /*!
243 * ======== docsLoc ========
244 * Directories containing documents in the product
245 *
246 * Directories are specified relative to the product installation
247 * directory. These directories are searched when resolving URI links
248 * to specific pages within the docs.
249 */
250 config String docsLocArr[];
251
252 /*!
253 * ======== templateModule ========
254 * Name of module implementing {@link xdc.tools.product.IProductTemplate}
255 *
256 * Products that deliver examples provide a module that implements the
257 * {@link xdc.tools.product.IProductTemplate} interface. This module
258 * must be delivered in one of the repositories defined in
259 * {@link #repositoryArr}.
260 */
261 config String templateModule;
262
263 /*!
264 * ======== productViewModule ========
265 * Name of module implementing {@link xdc.tools.product.IProductView}
266 *
267 * Products must provide a module that implements the
268 * {@link xdc.tools.product.IProductView} interface. This
269 * module defines the "top-level" modules that are visible to the user
270 * and must be delivered in the repositories defined in
271 * {@link #repositoryArr}.
272 */
273 config String productViewModule;
274
275 /*!
276 * ======== bundleName ========
277 * Product bundle name
278 *
279 * Product bundle name is embedded in the top level folder name of
280 * the product. Example: The top level folder for XDCtools version
281 * 3.16.02.31-eng is `xdctools_3_16_02_31-eng`. In this case the
282 * bundle name is `xdctools`.
283 * The bundle name is used by tools to discover the product
284 * installed on a filesystem.
285 */
286 config String bundleName;
287
288 /*!
289 * ======== targetArr ========
290 * RTSC target modules contained in product
291 *
292 * The RTSC target modules should be delivered
293 * in the repositories defined in {@link #repositoryArr}
294 */
295 config Target targetArr[];
296
297 /*!
298 * ======== helpTocArr ========
299 * Array of table of contents elements in product
300 *
301 * Tools generating table of contents are required
302 * to preserve the order of elements specified in this array
303 */
304 config HelpToc helpTocArr[];
305
306 /*!
307 * ======== tocIndexFile ========
308 * Top level index file referred in table of contents
309 */
310 config String tocIndexFile;
311
312 /*!
313 * ======== exclusive ========
314 * This product is a singlton
315 *
316 * This flag indicates whether multiple versions of this product are
317 * accessable within the IDE or whether only the latest version is
318 * available.
319 *
320 * When flag is set to `true` it indicates that only one
321 * version of the product can be active in the system. Otherwise
322 * the system can handle multiple versions of the same product.
323 */
324 config Bool exclusive = false;
325
326 /*!
327 * ======== otherFiles ========
328 * Array of paths to files that describe the product
329 *
330 * A product may wish to supply files that describing certain aspects
331 * of itself. For example a product may provide text, images and video
332 * files that provide branding information for the product.
333 * These files may then be consumed by tools like IDE's via
334 * hooks defined in the IDE framework.
335 * The file path is defined relative to the directory containing the
336 * implementation of `IProduct`.
337 */
338 config String otherFiles[];
339
340 /*!
341 * ======== macro ========
342 * Macro associated with the product
343 *
344 * Product macros are often used in IDEs for providing
345 * portable build environments. A unique macro name should
346 * be selected for the product.
347 */
348 config MacroDescriptor macro;
349
350 /*!
351 * ======== externalPlugins ========
352 * External plugins delivered with the product
353 */
354 config PluginDescriptor externalPlugins[];
355 }
356 /*
357 * @(#) xdc.tools.product; 1, 0, 0,60; 8-23-2011 09:12:46; /db/ztree/library/trees/xdctools/xdctools-f02x/src/
358 */
359