Difference between revisions of "Recommended global variables"

From Code::Blocks
(Wiki syntax. ;))
Line 4: Line 4:
 
However, if you wish to maximise the benefit of using global user variables, then you better make sure that the same name always means the same thing!
 
However, if you wish to maximise the benefit of using global user variables, then you better make sure that the same name always means the same thing!
  
−
<u>Example:</u><br />
+
'''Example:'''
 +
 
 
If you call the location of your wxWidgets installation <tt>#wx</tt>, and two other developers call them <tt>#wxwin</tt> and <tt>#wxwidgets</tt> in their projects, then somebody compiling all three projects will be promted three times for the same thing. This is obviously less than optimal.
 
If you call the location of your wxWidgets installation <tt>#wx</tt>, and two other developers call them <tt>#wxwin</tt> and <tt>#wxwidgets</tt> in their projects, then somebody compiling all three projects will be promted three times for the same thing. This is obviously less than optimal.
  
 
This list is provided as a guideline and in no way authoritative. However, if you use the names in this list, chances are good that people trying to compile your projects will be a lot happier.
 
This list is provided as a guideline and in no way authoritative. However, if you use the names in this list, chances are good that people trying to compile your projects will be a lot happier.
  
 +
{| border="1" cellpadding="5" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
 +
 +
|+ List of names for [[global user variables]]
 +
 +
|- style="background: #ececec; border: 1px solid gray; text-align: center;"
 +
! Variable
 +
! Meaning
 +
|-
 +
 +
|-
 +
| cb || Base directory of the Code::Blocks SDK
 +
|-
 +
 +
|-
 +
| cs || Base directory of Crystal Space
 +
|-
 +
 +
|-
 +
| dm || Base directory of Digital Mars
 +
|-
 +
 +
|-
 +
| dx || Base directory of the DirectX SDK
 +
|-
 +
 +
|-
 +
| fl || Base directory of FLTK
 +
|-
 +
 +
|-
 +
| ft || Base directory of FreeType
 +
|-
 +
 +
|-
 +
| genesis || Base directory of Genesis 3D
 +
|-
 +
 +
|-
 +
| gcc || Base directory of GCC/MinGW
 +
|-
 +
 +
|-
 +
| glfw || Base directory of GLFW
 +
|-
 +
 +
|-
 +
| glut || Base directory of GLUT
 +
|-
 +
 +
|-
 +
| g3d || Base directory of Graphics 3D
 +
|-
 +
 +
|-
 +
| irr || Base directory of Irrlicht
 +
|-
 +
 +
|-
 +
| msvc || Base directory of MSVC
 +
|-
 +
 +
|-
 +
| ogre || Base directory of Ogre 3D
 +
|-
 +
 +
|-
 +
| openal || Base directory of OpenAL
 +
|-
 +
 +
|-
 +
| psdk || Base directory of the Microsoft Platform SDK
 +
|-
 +
 +
|-
 +
| sdl || Base directory of SDL
 +
|-
 +
 +
|-
 +
| sw || Base directory of SmartWin
 +
|-
 +
 +
|-
 +
| qt || Base directory of Qt
 +
|-
 +
 +
|-
 +
| wx || Base directory of wxWidgets
 +
|-
 +
 +
|-
 +
| zlib || Base directory of zlib
 +
|-
  
−
<table border=1 cellpadding=0>
+
|}
−
<caption>List of "well known" names for [[global user variables]]</caption>
 
−
<tr><th colspan=2>IDE and compilers</th></tr>
 
−
<tr><td width=72 align=center>cb</td><td>Location of the <i>development</i> version of Code::Blocks.
 
−
If you have the sources, this is the dir with the Code::Blocks project file.
 
−
If you have the Code::Blocks SDK, this is the dir where you unpacked it.</td></tr>
 
−
<tr><td width=72 align=center>gcc</td><td>Base directory of your gcc or MinGW installation</td></tr>
 
−
<tr><td width=72 align=center>msvc</td><td>Base directory of your MSVC toolkit installation</td></tr>
 
−
<tr><td width=72 align=center>psdk</td><td>Location of the Microsoft platform SDK (base dir)</td></tr>
 
−
<tr><td width=72 align=center>dm</td><td>Base directory of your Digital Mars installation</td></tr>
 
−
<tr><th colspan=2>GUI toolkits</th></tr>
 
−
<tr><td width=72 align=center>wx</td><td>Base directory of wxWidgets</td></tr>
 
−
<tr><td width=72 align=center>fl</td><td>Base directory of FLTK</td></tr>
 
−
<tr><td width=72 align=center>qt</td><td>Base directory of Qt</td></tr>
 
−
<tr><td width=72 align=center>sw</td><td>Base directory of SmartWin</td></tr>
 
−
<tr><th colspan=2>Graphics toolkits</th></tr>
 
−
<tr><td width=72 align=center>sdl</td><td>Base directory of SDL</td></tr>
 
−
<tr><td width=72 align=center>ft</td><td>Base directory of freetype</td></tr>
 
−
<tr><td width=72 align=center>ogre</td><td>Base directory of Ogre 3D</td></tr>
 
−
<tr><td width=72 align=center>g3d</td><td>Base directory of Graphics 3D</td></tr>
 
−
<tr><td width=72 align=center>genesis</td><td>Base directory of Genesis 3D</td></tr>
 
−
<tr><td width=72 align=center>cs</td><td>Base directory of Crystal Space</td></tr>
 
−
<tr><td width=72 align=center>irr</td><td>Base directory of Irrlicht</td></tr>
 
−
<tr><td width=72 align=center>glut</td><td>Base directory of GLUT (an extension to OpenGL)</td></tr>
 
−
<tr><td width=72 align=center>glfw</td><td>Base directory of GLFW (an extension to OpenGL)</td></tr>
 
−
<tr><td width=72 align=center>dx</td><td>Base directory of Direct/X SDK</td></tr>
 
−
<tr><th colspan=2>Other packages</th></tr>
 
−
<tr><td width=72 align=center>openal</td><td>Base directory of OpenAL</td></tr>
 
−
<tr><td width=72 align=center>zlib</td><td>Base directory of zlib</td></tr>
 
−
</table>
 

Revision as of 22:47, 18 April 2006

Technically, it does not matter how you name your global user variables. However, if you wish to maximise the benefit of using global user variables, then you better make sure that the same name always means the same thing!

Example:

If you call the location of your wxWidgets installation #wx, and two other developers call them #wxwin and #wxwidgets in their projects, then somebody compiling all three projects will be promted three times for the same thing. This is obviously less than optimal.

This list is provided as a guideline and in no way authoritative. However, if you use the names in this list, chances are good that people trying to compile your projects will be a lot happier.

List of names for global user variables
Variable Meaning
cb Base directory of the Code::Blocks SDK
cs Base directory of Crystal Space
dm Base directory of Digital Mars
dx Base directory of the DirectX SDK
fl Base directory of FLTK
ft Base directory of FreeType
genesis Base directory of Genesis 3D
gcc Base directory of GCC/MinGW
glfw Base directory of GLFW
glut Base directory of GLUT
g3d Base directory of Graphics 3D
irr Base directory of Irrlicht
msvc Base directory of MSVC
ogre Base directory of Ogre 3D
openal Base directory of OpenAL
psdk Base directory of the Microsoft Platform SDK
sdl Base directory of SDL
sw Base directory of SmartWin
qt Base directory of Qt
wx Base directory of wxWidgets
zlib Base directory of zlib
Retrieved from "https://wiki.codeblocks.org/index.php?title=Recommended_global_variables&oldid=2841"