SetupDesignGuide.pdf - Firmware Encoding Index

Setup Design Guide
DRAFT
4.2 VFR Programming Keywords
The keywords described in the following section compose the working set of commands for the VFR
language. Each description is followed by an example to better help the programmer understand what a
sample line of VFR code would look like using that particular keyword.
4.2.1 // (comment marker)
Allows a programmer to leave comments in the VFR file and has no effect on the IFR binary that is
generated.
Example: // This is a typical comment marker
4.2.2 #define
Used to assign a meaningful name to a constant. Very similar in function to the ‘C’ style #define
keyword.
Example: #define FORMSET_GUID “CAED85D9-F30C-4ed3-B7A6-83EE32A1C604”
#define GUID FORMSET_GUID
4.2.3 #include
This command tells the VFR compiler to use the contents of a file as part of the source to compile.
Example: #include “C:\Source\SourceFile.ifr”
4.2.4 #strlang
This command is used to assign the ISO-639-2 three letter language abbreviation to its corresponding
printable language name.
This command will be used in an included header file which has a Unicode format. It will be an error
condition which will be detected by the compiler if this is used in a non-Unicode formatted file.
Example: #strlang SPA “Español”;
#strlang FRA “Français”;
#strlang ENG “English”;
#strlang HEB ‏”עברית“‏ RIGHT_TO_LEFT;
Notice how the 4 th example shows a RIGHT_TO_LEFT flag is turned on. This information will be
passed on to the attributes for strings that are defined under the HEB (Hebrew) language. Strings that
normally were left-justified in the default situation would now be right justified with this flag turned on.
Additionally, user input will move from right to left. Instead of the column location of the cursor
incrementing as a user types, it will decrement.
4.2.5 #strdef
This command is used to define a string and which language it belongs to.
This command will be used in a separate Unicode header file. It will be an error condition which will
be detected by the compiler if this is used in a non-Unicode formatted file.
Example: #strdef ENG STR_SUBTITLE_TEXT “My subtitle text”
#strdef FRA STR_SUBTITLE_TEXT “Mon texte de sous-titre”
29