Initializing help system before first use

XPRMcompmod, XPRMcompmodsec

XPRMcompmod, XPRMcompmodsec

Purpose
Compile a model source file.
Synopsis
int XPRMcompmod(const char *options, const char *srcfile, const char *dstfile, const char *userc);
int XPRMcompmodsec(const char *options, const char *srcfile, const char *dstfile, const char *userc, const char *passfile, const char *privkey, const char *kfile);
Arguments
options 
Compilation options (may be NULL, options may be separated by spaces or '-' symbols):
"g" 
Include debugging information: in the case of a run time error during the execution of the model the location of the error in the source file may be indicated and private symbols are included in the BIM file (they are by default not saved)
"G" 
Include tracing information: with this option the model can be run through the debugger for an execution step by step
"p" 
parse only: stop after the syntax analysis of the source file, do not compile (no file generated)
"x" 
extract messages for translation (generation of a POT file in place of a BIM file)
"wi" 
Emit a warning message each time a symbol is implicitly declared
"D" 
Generate and record documentation annotations
"bx=prefix" 
Package prefix (can be quoted with single or double quotes)
"ix=prefix" 
Include source prefix (can be quoted with single or double quotes)
"S" 
Sign the BIM file
"E" 
Encrypt the BIM file
"F" 
The argument pass is a file name (not the password itself)
"V" 
Accept to load signed packages only if their signature can be verified
"T" 
Accept to load only signed packages with a valid signature
scrfile 
Name of the source file
dstfile 
Name of the destination file (may be NULL)
userc 
Commentary text that will be saved as is at the beginning of the output file (may be NULL)
passfile 
Password or password file (for encryption with a password)
privkey 
Private key file (for BIM file signing)
kfile 
File of public keys (for encryption with public keys)
Return value
0 
Function executed sucessfully
1 
Parsing phase has failed (syntax error or file access error)
2 
Error in compilation phase (a semantic error has been detected)
3 
Error writing the output file
4 
License error (compiler not authorized)
Further information
1. This function compiles a given model source file into a binary model file (BIM file) that is required as input to function XPRMloadmod for executing the model. The second form of the function will be used to generate encrypted and/or signed BIM files.
2. The source file name may contain environment variable references using the notation ${varname} (for example, ` ${XPRESSDIR}/examples/mymodel') that are expanded to generate the actual name. If no destination file name is provided, the output file takes the same name as the source file with the extension .bim. Note that the empty string ( i.e. "") is interpreted as the standard input for srcfile and as the standard output for dstfile.
3. The argument kfile is a list of public key files ( i.e. each line of the file is a key file name): when encrypting a file, the encryption is performed for each of the listed public keys such that the BIM file can be decrypted by any of the corresponding private keys.
4. When prefixes provided via bx or ix are quoted with double quotes, backslashes are interpreted such that special characters can be included in the string. It is therefore required to double this symbol when it has to be included ( e.g. 'bx="C:\\mydir"').
Related topics
XPRMloadmod, XPRMrunmod, XPRMdbg_runmod, XPRMsetbimprefix.

Parent Topic Compilation