blob: 773b87aa85c83929055e9b64e0a4541e5ee31769 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Scanner Configuration Discovery Profile</title>
<style type="text/css">@import url("../../book.css");</style>
<style type="text/css">@import url("../../schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Scanner Configuration Discovery Profile</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.cdt.make.core.ScannerConfigurationDiscoveryProfile<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.0
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>A unified definition of a scanner configuration profile. Usually consists of <p>
- A make build output parser <p>
- A scanner info collector <p>
- An external scanner info generator <p>
- An external scanner info generator output parser <p><p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.scannerInfoCollector">scannerInfoCollector</a> , <a href="#e.buildOutputProvider">buildOutputProvider</a>? , <a href="#e.scannerInfoProvider">scannerInfoProvider</a>*)></p>
<p class="code SchemaDtd"><!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point CDATA #REQUIRED<p class="code SchemaDtdAttlist">id CDATA #REQUIRED<p class="code SchemaDtdAttlist">name CDATA #REQUIRED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
Definition of a profile:
- A scanner info collector
- A make build output parser
- A number of external scanner info providers</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - Profile id.</li>
<li><b>name</b> - The name of the profile will be presented to the user.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.scannerInfoCollector">scannerInfoCollector</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST scannerInfoCollector</p>
<p class="code SchemaDtdAttlist">class CDATA #REQUIRED<p class="code SchemaDtdAttlist">scope (project|file) ></p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - Java class that implements IScannerInfoCollector interface.</li>
<li><b>scope</b> - </li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.scannerInfoConsoleParser">scannerInfoConsoleParser</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST scannerInfoConsoleParser</p>
<p class="code SchemaDtdAttlist">class CDATA #REQUIRED<p class="code SchemaDtdAttlist">compilerCommands CDATA #IMPLIED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
Make build output or external scanner info provider output parser.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - Java class that implements IScannerInfoConsoleParser interface.</li>
<li><b>compilerCommands</b> - Comma separated list of compiler commands to use for detecting lines with preprocessor options.
Example: "gcc, g++, cc, c++"</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.buildOutputProvider">buildOutputProvider</a> (<a href="#e.open">open</a>? , <a href="#e.scannerInfoConsoleParser">scannerInfoConsoleParser</a>)></p>
<p></p>
<p class="ConfigMarkupElementDesc">
Build output provider is make build or/and build output file.</p>
<br><br>
<p class="code SchemaDtd"><!ELEMENT <a name="e.scannerInfoProvider">scannerInfoProvider</a> ((<a href="#e.run">run</a> | <a href="#e.open">open</a>) , <a href="#e.scannerInfoConsoleParser">scannerInfoConsoleParser</a>)></p>
<p class="code SchemaDtd"><!ATTLIST scannerInfoProvider</p>
<p class="code SchemaDtdAttlist">providerId CDATA #REQUIRED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
Either a command with arguments whose output will provide scanner information or a file that contains the scanner info.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>providerId</b> - An id of the specific provider.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.run">run</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST run</p>
<p class="code SchemaDtdAttlist">class CDATA #IMPLIED<p class="code SchemaDtdAttlist">command CDATA #IMPLIED<p class="code SchemaDtdAttlist">arguments CDATA #IMPLIED></p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - A fully qualified name of the Java class that implements <samp>org.eclipse.cdt.make.core.scannerconfig.IExternalScannerInfoProvider2</samp> interface.
If not specified then <samp>org.eclipse.cdt.make.internal.core.scannerconfig.DefaultExternalScannerInfoProvider</samp> is the default one used.</li>
<li><b>command</b> - A command to run. Example: <samp>gcc</samp>.</li>
<li><b>arguments</b> - Arguments for the command. Example: <samp>-E -P -v -dD</samp>.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.open">open</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST open</p>
<p class="code SchemaDtdAttlist">class CDATA #IMPLIED<p class="code SchemaDtdAttlist">file CDATA #IMPLIED></p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - A fully qualified name of the Java class that implements <samp>org.eclipse.cdt.make.core.scannerconfig.IExternalScannerInfoReader</samp> interface.
If not specified then <samp>org.eclipse.cdt.make.internal.core.scannerconfig.DefaultExternalScannerInfoReader</samp> is the default one used.</li>
<li><b>file</b> - A file containing a make build output or scanner information in some other form.</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>[Enter extension point usage example here.]
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6><samp>org.eclipse.cdt.make.core.GCCStandardMakePerProjectProfile</samp>
<p></p>
<br>
<p class="note SchemaCopyright">
</p>
</BODY>
</HTML>
|