Compiler file

2022-02-23T10:41:31Z

AndrewCot: Add note that you need "<Search envVar=" in order for masterpath to work.

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Format for defining compiler interfaces using only XML (in conjunction with [[Compiler options file]]s).

<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 (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>

All of the following routines are used during auto-detection.

Conditional <tt><if>[...]</if><else>[...]</else></tt> statements are available in the same form as in [[Compiler options file]]s.

<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 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.)

<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 path="C:\WinAVR*"/>
</source>
Wildcards are allowed in <tt><Search path="..."></tt>.

<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.

<source lang="xml" enclose="div">
<Add><master/><separator/>lib</Add>
</source>
Add a path to the current <tt><Path type="..."></tt>.
* <tt><master/></tt> is replaced by the contents of the master path.
* <tt><separator/></tt> is replaced by the system's native file path separator.

<source lang="xml" enclose="div">
<Add cFlag="-O"/>
</source>
Enable a compiler flag.

<source lang="xml" enclose="div">
<Add lFlag="-s"/>
</source>
Enable a linker flag.

<source lang="xml" enclose="div">
<Add lib="pthread"/>
</source>
Add a library.

==See also==
* [[Compiler options file]]
* [/index.php/topic,16463.0.html XML based compilers]

Code::Blocks - User contributions [en]

Compiler file