Reactis Build Files

6. Reactis Build Files#

6.1. rcRsmOpen#

Open an existing .rsm file or create a new .rsm file.

6.1.1. Syntax#

rsmId = rcRsmOpen(rsmFileName)

6.1.2. Description#

rsmId = rcRsmOpen(rsmFileName): If file rsmFileName exists, rcRsmOpen opens the existing file. If file rsmFileName does not exist, this function creates an empty .rsm file which will be used to build a library.

rsmId is a scalar integer valued double that identifies the .rsm file when calling other rcRsm* API functions.

6.1.3. Examples#

rsm = rcRsmOpen('cruise_lib.rsm');

6.1.4. See Also#

rcRsmClose, rcRsmSave

6.2. rcRsmSave#

Save changes to an .rsm file.

6.2.1. Syntax#

rcRsmSave(rsmId)
rcRsmSave(rsmId, fileName)

6.2.2. Description#

rcRsmSave(rsmId): writes any changes made to the .rsm file to disk, using the same file name as used in the rcRsmOpen call that opened the file.
rcRsmSave(rsmId, fileName): writes any changes made to the .rsm file to disk, using file name fileName.

6.2.3. See Also#

rcRsmOpen, rcRsmClose

6.3. rcRsmClose#

Close an .rsm file.

6.3.1. Syntax#

rcRsmClose(rsmId)

6.3.2. Description#

rcRsmClose(rsmId): closes the file identified by rsmId. Any changes since the last call to rcRsmSave will be discarded.

6.3.3. See Also#

rcRsmOpen, rcRsmSave

6.4. rcRsmGetSourceFiles#

Get the list of source files contained in an .rsm file.

6.4.1. Syntax#

files = rcRsmGetSourceFiles(rsmId)

6.4.2. Description#

files = rcRsmGetSourceFiles(rsmId): returns a cell array containing the list of source files stored in the .rsm file identified by rsmId.

6.4.3. See Also#

rcRsmOpen, rcRsmSetSourceFiles

6.5. rcRsmGetIncludeSearchPath#

Get the included file search path contained in an .rsm file.

6.5.1. Syntax#

dirs = rcRsmGetIncludeSearchPath(rsmId)

6.5.2. Description#

dirs = rcRsmGetIncludeSearchPath(rsmId): returns a cell array containing the included file search path stored in the .rsm file identified by rsmId.

6.5.3. See Also#

rcRsmSetIncludeSearchPath

6.6. rcRsmGetLibraries#

Get the list of source files contained in an .rsm file.

6.6.1. Syntax#

names = rcRsmGetLibraries(rsmId)

6.6.2. Description#

names = rcRsmGetLibraries(rsmId): returns a cell array containing the list of libraries stored in the .rsm file identified by rsmId.

6.6.3. See Also#

rcRsmSetLibraries

6.7. rcRsmGetDefines#

Get the macro definitions contained in an .rsm file.

6.7.1. Syntax#

defs = rcRsmGetDefines(rsmId)

6.7.2. Description#

defs = rcRsmGetDefines(rsmId): returns a cell array containing the macro definitions stored in the .rsm file identified by rsmId.

6.7.3. See Also#

rcRsmSetDefines

6.8. rcRsmGetCoverageEnabled#

Query whether coverage tracking is enabled for .rsm file.

6.8.1. Syntax#

enabled = rcRsmGetCoverageEnabled(rsmId)

6.8.2. Description#

enabled = rcRsmGetCoverageEnabled(rsmId): returns a Boolean value which is true if coverage tracking is enabled for the .rsm file identified by rsmId and false otherwise.

6.8.3. See Also#

rcRsmSetCoverageEnabled

6.9. rcRsmGetParameterValue#

Get the value of a project-specific setting.

6.9.1. Syntax#

value = rcRsmGetParameterValue(rsmId, paramName)

6.9.2. Description#

value = rcRsmGetParameterValue(rsmId, paramName): returns the value of project-specific setting paramName from .rsm file rsmId. Parameters of any data type may be queried by rcRsmGetParameterValue. The return value is always a string. Valid parameter names are listed in Parameters.

6.9.3. Examples#

v = rcRsmGetParameterValue(rsm, 'OnIntegerOverflow');

6.9.4. See Also#

rcRsmSetParameterValue Parameters

6.10. rcRsmSetSourceFiles#

Set the list of source files contained in an .rsm file.

6.10.1. Syntax#

name = rcRsmSetSourceFiles(rsmId,sourceFiles)

6.10.2. Description#

rcRsmSetSourceFiles(rsmId,sourceFiles): updates the list of source files stored in the .rsm file identified by rsmId. The changes are not saved until rcRsmSave is called.

6.10.3. See Also#

rcRsmGetSourceFiles

6.11. rcRsmSetIncludeSearchPath#

Set the included file search path contained in an .rsm file.

6.11.1. Syntax#

rcRsmSetIncludeSearchPath(rsmId,directories)

6.11.2. Description#

rcRsmSetIncludeSearchPath(rsmId,directories): sets the included file search path in the .rsm file identified by rsmId to equal the list of the directories stored in directories. The changes are not saved until rcRsmSave is called.

6.11.3. See Also#

rcRsmGetIncludeSearchPath

6.12. rcRsmSetLibraries#

Set the list of libraries contained in an .rsm file.

6.12.1. Syntax#

rcRsmSetLibraries(rsmId,libraries)

6.12.2. Description#

rcRsmSetLibraries(rsmId,libraries): updates the list of libraries stored in the .rsm file identified by rsmId to equal the contents of the cell array libraries. The changes are not saved until rcRsmSave is called.

6.12.3. See Also#

rcRsmGetLibraries

6.13. rcRsmSetDefines#

Set the macro definitions contained in an .rsm file.

6.13.1. Syntax#

rcRsmSetDefines(rsmId,defines)

6.13.2. Description#

rcRsmSetDefines(rsmId,defines): sets the list of macro definitions stored in the .rsm file identified by rsmId to equal the contents of the cell array defines. Changes are not saved until rcRsmSave is called.

6.13.3. See Also#

rcRsmGetDefines

6.14. rcRsmSetCoverageEnabled#

Enable or disable coverage tracking for .rsm file.

6.14.1. Syntax#

rcRsmSetCoverageEnabled(rsmId,enabled)

6.14.2. Description#

rcRsmSetCoverageEnabled(rsmId,enabled): enables coverage tracking for the .rsm file identified by rsmId if enabled is true and disables coverage tracking if enabled is false.

6.14.3. See Also#

rcRsmGetCoverageEnabled

6.15. rcRsmSetParameterValue#

Set the value of a build file parameter.

6.15.1. Syntax#

rcRsmSetParameterValue(rsmId, paramName, paramValue)

6.15.2. Description#

rcRsmSetParameterValue(rsmId, paramName, paramValue): sets project-specific setting paramName to paramValue in the .rsm file whose id matches rsmId. Valid parameter names are listed in Parameters.

Parameters of any data type may be set by rcRsmSetParameterValue but the paramValue argument must be given as a string.

6.15.3. See Also#

rcRsmGetParameterValue Parameters

6.16. rcRsmStub#

Generate a C source file containing stub definitions.

6.16.1. Syntax#

rcRsmStub(rsmId,cfile)

6.16.2. Description#

rcRsmStub(rsmId,cfile): generates a C source containing stub definitions for variables and functions which are referenced but not defined in the program constructed by the .rsm file identified by rsmId. The stub definitions are stored in the file cfile.

6.17. Parameters#

The following parameters can be accessed by rcRsmGetParameterValue and rcRsmSetParameterValue.

Parameter Name	Allowed Values	Description
`CArchitecture`	‘l32’, ‘b32’, ‘inherited’	Set the architecture (32-bit little endian or 32-bit big endian) used during compilation.
`ReactisForCFilesDir`	string	The directory where Reactis for C should store compiled code files. The value must be either (1) the empty string, or (2) a valid directory pathname. If set to the empty string, the value of this parameter will be inherited from either the parent .rsm file, or, if there is no parent .rsm file, the global parameter of the same name.
`SFunctionCoverage`	‘separate’, ‘cumulative’, ‘inherited’, ‘off’	Sets the default coverage for all source files and libraries.