Compiler file - Revision history

Mgimenez: /* See also */ Make link absolute

2023-05-26T09:53:33Z

AndrewCot: Add note that you need " ← Older revision Revision as of 10:41, 23 February 2022 Line 61: Line 61:
* If <tt>for</tt> is not specified, any path that exists will be added to the current <tt><Path type="..."></tt>.

* If <tt>for</tt> is not specified, any path that exists will be added to the current <tt><Path type="..."></tt>.

* If <tt>for</tt> is given, the corresponding executable name will be replaced (if applicable; see <tt><if exec="..."></if></tt> blocks). If the specified file exists on any of the paths in the environment variable, those path(s) will be added.

* If <tt>for</tt> is given, the corresponding executable name will be replaced (if applicable; see <tt><if exec="..."></if></tt> blocks). If the specified file exists on any of the paths in the environment variable, those path(s) will be added.
+
If you do not have a <Search envVar= then the compiler auto detection code will not set the masterpath and cause compiler issues.

(If the current path type is <tt>master</tt>, any trailing <tt>bin</tt> directories will be stripped.)

(If the current path type is <tt>master</tt>, any trailing <tt>bin</tt> directories will be stripped.)

Alpha: XML branch merged.

2012-12-19T15:40:56Z

XML branch merged.

Alpha: Added category.

2012-08-04T13:34:36Z

Added category.

Alpha: More documentation.

2012-08-03T01:29:19Z

Alpha: Started documenting format.

2012-07-23T20:02:14Z

Started documenting format.

New page

Proposed format for defining compiler interfaces using only XML (in conjunction with [[Compiler options file]]s). See: [/index.php/topic,16463.0.html XML based compilers].
{{Layout_box2|1=
<tt>svn checkout <nowiki>svn://svn.berlios.de/codeblocks/branches/xml_compiler</nowiki></tt>
}}

<source lang="xml" enclose="div">
<CodeBlocks_compiler name="Digital Mars Compiler"
id="dmc"
weight="24"
platform="windows">
[...]
</CodeBlocks_compiler>
</source>
I am a Code::Blocks compiler file.

<tt>name="</tt><txt><tt>"</tt>
* <txt> is the descriptive name that will be shown to the user for this compiler.

<tt>id="</tt><id><tt>"</tt>
* Lowercase sequence of letters, numbers, underscores, and/or hyphens (it must, however, start with a letter) which is used internally to represent this compiler.

<tt>weight="</tt><num><tt>"</tt> (optional)
* Determines the order in the compiler drop-down menu that this compiler will be listed; lower numbers are listed sooner (try to keep <num> between 0 and 100).

<tt>platform="</tt><os><tt>"</tt> (optional). Only load this compiler if the current operating system is <os>. <os> is one of:
* <tt>windows
* macosx
* linux
* freebsd
* netbsd
* openbsd
* darwin
* solaris
* unix</tt>

<source lang="xml" enclose="div">
<Path type="master">
[...]
</Path>
</source>
<tt>type="</tt><tp><tt>"</tt> Determines what variable the results of the contained detection routine(s) will be stored in. <tp> is one of:
* <tt>master
* extra
* include
* resource
* lib</tt>

<source lang="xml" enclose="div">
<Search envVar="PATH"
for="C"/>
</source>
Searches all paths in the given environment variable.
* If <tt>for</tt> is not specified, any path that exists will be added to the current <tt><Path type="..."></tt>.
* If <tt>for</tt> is given, the corresponding executable name will be replaced (if applicable; see <tt><if exec="..."></if></tt> blocks). If the specified file exists on any of the paths in the environment variable, those path(s) will be added.

(If the current path type is <tt>master</tt>, any trailing <tt>bin</tt> directories will be stripped.)

<source lang="xml" enclose="div">
<Search path="C:\MinGW"
for="C"/>
</source>
Same functionality as <tt><Search envVar="..."></tt> except that this tests a hard-coded path.

<source lang="xml" enclose="div">
<Search registry="HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\SDCC"
value="InstallLocation"/>
</source>
Read a Windows registry key. If <tt>value</tt> is found in the registry key, and it is a valid folder, it will be added to the current <tt><Path type="..."></tt>.

<source lang="xml" enclose="div">
<Fallback path="/usr/local"/>
</source>
If the current <tt><Path type="..."></tt> is empty, add this path to it.

@@ Line 114: / Line 114: @@
 ==See also==
 * [[Compiler options file]]
-* [/index.php/topic,16463.0.html XML based compilers]
+* [https://forums.codeblocks.org/index.php/topic,16463.0.html XML based compilers]

@@ Line 1: / Line 1: @@
 [[Category:Code::Blocks Documentation]]
 [[Category:Developer Documentation]]
-Proposed format for defining compiler interfaces using only XML (in conjunction with [[Compiler options file]]s). See: [/index.php/topic,16463.0.html XML based compilers].
+Format for defining compiler interfaces using only XML (in conjunction with [[Compiler options file]]s).
@@ Line 113: / Line 110: @@
 </source>
 Add a library.

@@ Line 1: / Line 1: @@
 Proposed format for defining compiler interfaces using only XML (in conjunction with [[Compiler options file]]s). See: [/index.php/topic,16463.0.html XML based compilers].
 {{Layout_box2|1=
@@ Line 34: / Line 36: @@
 * solaris
 * unix</tt>

@@ Line 22: / Line 22: @@
 <tt>weight="</tt><num><tt>"</tt> (optional)
-* Determines the order in the compiler drop-down menu that this compiler will be listed; lower numbers are listed sooner (try to keep <num> between 0 and 100).
+* Determines the order in the compiler drop-down menu that this compiler will be listed; lower numbers are listed sooner (keep <num> between 0 and 100).
 <tt>platform="</tt><os><tt>"</tt> (optional). Only load this compiler if the current operating system is <os>. <os> is one of:
@@ Line 64: / Line 64: @@
 </source>
 Same functionality as <tt><Search envVar="..."></tt> except that this tests a hard-coded path.
 <source lang="xml" enclose="div">
@@ Line 76: / Line 81: @@
 </source>
 If the current <tt><Path type="..."></tt> is empty, add this path to it.