Difference between revisions of "Preprocessor Defines"

From ROBOTC API Guide
Jump to: navigation, search
Line 15: Line 15:
  
 
The predefined symbols can be used in include files ad user programs for conditionally compiling code based on features. The preprocessor defines include:
 
The predefined symbols can be used in include files ad user programs for conditionally compiling code based on features. The preprocessor defines include:
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:center; font-size:100%; border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000;" cellpadding="5%"
+
  {| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:center; font-size:100%; border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000;" cellpadding="5%"
 
   ! style="border-style: solid; border-width: 0px 0px 0px 0px"|''Symbol Name''
 
   ! style="border-style: solid; border-width: 0px 0px 0px 0px"|''Symbol Name''
 
   ! style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Usage / Comments
 
   ! style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Usage / Comments
 
   |-
 
   |-
 
   | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|ROBOTC
 
   | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|ROBOTC
   | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Signed decimal integer
+
   | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Indicates that the ROBOTC compiler was used.
 
   |-
 
   |-
|}
+
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|_DEBUG, _RELEASE, _CUSTOM
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Compiler optimization selection.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|_TARGET
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Contains the type of debugger target. One of the following
 +
values: “Robot”, “Emulator” or “VirtWorld”.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|NXT, TETRIX, VEX, VEX20, ARDUINO
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|The currently selected platform.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|firmwareVersion
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Contains the numerical firmware version; e.g. 852.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|IFI
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|When IFI platform is selected.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|TETRIX
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|When TETRIX features are active.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|FTC
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|When FTC features are active.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|Algebra
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|When robot algebra option is enabled.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|MultiRobotSupport
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|When multi-robot option is enabled.
 +
  |-
 +
  |}
 +
 
 +
 
 +
ROBOTC also supports the standard C preprocessor symbols below:
 +
  {| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:center; font-size:100%; border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #000;" cellpadding="5%"
 +
  ! style="border-style: solid; border-width: 0px 0px 0px 0px"|''Symbol Name''
 +
  ! style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Usage / Comments
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|__FILE__
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Current filename.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|__LINE__
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Current line number.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|__DATE__
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Date “mmm dd yyyy” of the current compilation.
 +
  |-
 +
  | style="font-family: Courier New, Courier, monospace; text-align:left; color:#8b0000; border-style: solid; border-width: 0px 0px 0px 0px"|__TIME__
 +
  | style="text-align:left; border-style: solid; border-width: 0px 0px 0px 0px"|Time “hh:mm:ss” of the current compilation.
 +
  |-
 +
  |}
 
|}
 
|}

Revision as of 22:24, 4 January 2012

Main >> Preprocessor Defines




The ROBOTC Compiler supports several different preprocessor defines that contain information about the compile time environment. Recently added are defines that indicate which features are enabled in the IDE.

The predefined symbols can be used in include files ad user programs for conditionally compiling code based on features. The preprocessor defines include:

Symbol Name Usage / Comments
ROBOTC Indicates that the ROBOTC compiler was used.
_DEBUG, _RELEASE, _CUSTOM Compiler optimization selection.
_TARGET Contains the type of debugger target. One of the following

values: “Robot”, “Emulator” or “VirtWorld”.

NXT, TETRIX, VEX, VEX20, ARDUINO The currently selected platform.
firmwareVersion Contains the numerical firmware version; e.g. 852.
IFI When IFI platform is selected.
TETRIX When TETRIX features are active.
FTC When FTC features are active.
Algebra When robot algebra option is enabled.
MultiRobotSupport When multi-robot option is enabled.


ROBOTC also supports the standard C preprocessor symbols below:

Symbol Name Usage / Comments
__FILE__ Current filename.
__LINE__ Current line number.
__DATE__ Date “mmm dd yyyy” of the current compilation.
__TIME__ Time “hh:mm:ss” of the current compilation.