Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Variant configuration file syntax


Purpose

A variant configuration file (.var) defines settings that are specific to a variant. It is used to modify certain aspects of an existing build platform.

[Top]


Syntax

KEYWORD [OPERATION] [VALUE]

A summary of keywords, operations and values is given below:


Keyword

Possible keywords are as follows:

VARIANT

Indicates that VALUE is the name of the variant configuration.

VIRTUAL

Indicates that the variant is meant only for grouping variants and not to be used as a build configuration.

EXTENDS

Indicates that the variant extends an existing variant configuration.

VARIANT_HRH

Specifies the pre-included header (.hrh) file that defines feature macros.

BUILD_INCLUDE

Specifies the location of the files to be included when building the binary.

ROM_INCLUDE

Specifies the location of the files to be included when building the ROM image containing the variant binary.

Note: If VARIANT_HRH keyword is not present, then /epoc32/include/variant/name.hrh is used.


operation

The possible operations are set, append and prepend. These operations provide the flexibility of extending the existing include paths within the .var file. The operations are applicable only to the BUILD_INCLUDE and ROM_INCLUDE keywords.

Example

# default.var
VARIANT default
BUILD_INCLUDE set         /epoc32/include
BUILD_INCLUDE append   /epoc32/include/variant
ROM_INCLUDE set        /epoc32/rom/include

# phone.var
VARIANT phone
EXTENDS default
BUILD_INCLUDE append   /epoc32/include/variant/phone
ROM_INCLUDE prepend    /epoc32/rom/phone

For the variant phone the include lists will be:

BUILD (/epoc32/include, /epoc32/include/variant, /epoc32/include/variant/phone)
ROM (/epoc32/rom/phone, /epoc32/rom/include)


value

Value can be a variant name, a file name or a directory name. for example, myphone or /epoc32/tools/variant/name.var.


Example

An example of a variant:

VARIANT     name
VIRTUAL
EXTENDS     parent
VARIANT_HRH /epoc32/include/variant/something.hrh
BUILD_INCLUDE   set      directoryA
BUILD_INCLUDE   append       directoryB
BUILD_INCLUDE   prepend  directoryC
ROM_INCLUDE set        directoryD
ROM_INCLUDE append     directoryE
ROM_INCLUDE prepend    directoryF


Notes

[Top]


See also