Compiler file

From CodeBlocks
Revision as of 22:02, 23 July 2012 by Alpha (Talk | contribs) (Started documenting format.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Proposed format for defining compiler interfaces using only XML (in conjunction with Compiler options files). See: XML based compilers.

svn checkout svn://

<CodeBlocks_compiler name="Digital Mars Compiler"

I am a Code::Blocks compiler file.


  • <txt> is the descriptive name that will be shown to the user for this compiler.


  • Lowercase sequence of letters, numbers, underscores, and/or hyphens (it must, however, start with a letter) which is used internally to represent this compiler.

weight="<num>" (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).

platform="<os>" (optional). Only load this compiler if the current operating system is <os>. <os> is one of:

  • windows
  • macosx
  • linux
  • freebsd
  • netbsd
  • openbsd
  • darwin
  • solaris
  • unix

<Path type="master">

type="<tp>" Determines what variable the results of the contained detection routine(s) will be stored in. <tp> is one of:

  • master
  • extra
  • include
  • resource
  • lib

<Search envVar="PATH"

Searches all paths in the given environment variable.

  • If for is not specified, any path that exists will be added to the current <Path type="...">.
  • If for is given, the corresponding executable name will be replaced (if applicable; see <if exec="..."></if> 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 master, any trailing bin directories will be stripped.)

<Search path="C:\MinGW"

Same functionality as <Search envVar="..."> except that this tests a hard-coded path.

<Search registry="HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\SDCC"

Read a Windows registry key. If value is found in the registry key, and it is a valid folder, it will be added to the current <Path type="...">.

<Fallback path="/usr/local"/>

If the current <Path type="..."> is empty, add this path to it.