1 .TH compiler 1 "October 2014" "Ericsson Telecom AB" "TTCN-3 Tools"
3 compiler \- TTCN-3 and ASN.1 to C++ translator
6 .RB "[\| " \-abcdEfgijlLMnpqrRsStuwxXyY " \|]"
8 .IR " verb_level" " \|]"
16 .IR " top_level_pdu" " \|] ..."
20 .IR "none|type" " \|] "
25 [\| \- module.ttcn ... module.asn ... \|]
34 .B compiler \-\-ttcn2json
35 .RB "[\| " \-jf " \|]"
44 This manual page is a quick reference for the TTCN-3 and ASN.1 to C++ (or JSON schema)
45 compiler of the TTCN-3 Test Executor. It only summarizes the meaning of
46 all command line options. For more details please consult the
47 .B Programmer's Technical Reference for TITAN TTCN-3 Test Executor.
49 The following options are supported (in alphabetical order):
52 Forces the interpretation of
56 It is useful when automatic module type detection fails
57 due to some strange language constructs. The option takes exactly one file
58 name as argument. The option must be repeated when used with multiple files.
68 Disables the generation of
70 encoder/decoder routines for all ASN.1 types.
73 Allows the selected field in a union value to be unbound, when setting module
74 parameters (legacy behavior). A warning is displayed whenever a union value
75 receives an unbound selected field and when a union with an unbound selected field
86 fields with DEFAULT values as
91 Instructs the variant attribute parser to display warnings instead of errors
92 for unrecognized/erroneous attributes.
95 Forces the compiler to
97 the output files even if they exist or are unchanged.
100 The compiler error/warning messages will contain only the starting
101 line number and column, in a format compatible with th GNU compiler (gcc).
103 takes precedence over
105 if both are specified.
108 The compiler error/warning messages
109 will contain only the
111 the column numbers will remain hidden. This option provides backward
112 compatibility with the error message format of earlier versions.
115 Disables JSON encoder/decoder functions.
118 Enables selective code coverage.
121 Instructs the compiler to generate source file and line information (i.e.
123 directives) into the output C++ code so that the C++ compiler error
124 messages refer back to the lines of original TTCN-3 input module.
128 and will be removed in future versions as the
129 compiler does not generate erroneous C++ code because of the full
133 Instructs the compiler to add source file and line
137 information into the generated code to be included in the
141 This option is only a prerequisite for logging the source code information.
146 have also to be set appropriately in section
148 of the run-time configuration file.
150 Usage of this option a bit enlarges the size of the generated code and slightly
151 reduces execution speed. This flag is not recommended when the TTCN-3 test
152 suite is used for load generation.
155 Allows the use of the value
157 in template lists and complemented template lists (legacy behavior).
158 If set, an omitted field will match a template list, if the value
160 appears in the list, and it will match a complemented template list, if
162 is not in the list (the
164 attribute can still be used for matching omitted fields). This also affects the
168 template restriction accordingly.
171 Activates the debugger and generates extra code for storing debug information.
174 The output files (including Test Port skeletons) will be placed into
175 the directory specified by
177 The current working directory is the default otherwise.
180 Instructs the compiler only to
182 the given TTCN-3 and ASN.1 modules. This will detect only the syntax errors
183 because semantic checkings are
185 performed. The presence of all imported modules is not necessary thus it is
186 allowed (and recommended) to parse the modules one-by-one.
188 All options that influence the code generation are silently ignored when used
193 This option includes complete syntax checks for TTCN-3 modules, but in ASN.1
194 there are some special constructs (e.g. the user-defined syntaxes) that cannot
195 be even parsed without semantic analysis. So there is no guarantee that an ASN.1
196 module is free of syntax errors if it was analyzed with compiler using the
200 .BI \-P " top_level_pdu" ...
201 Defines a top-level pdu.
203 must have the following format:
204 .I modulename.identifier.
205 If this switch is used, then only the defined top-level PDU(s) and the
206 referenced assignments are checked and included in code generation, the
207 other ASN.1 assignments are skipped.
211 mode. Equivalent with
221 Disables the generation of
223 encoder/decoder routines for all TTCN-3 types.
226 Use function test runtime (TITAN_RUNTIME_2). The compiler will generate source
227 code for use with function test runtime.
230 Instructs the compiler to parse the given TTCN-3 and ASN.1 modules and perform
234 to generate C++ output. The list of given modules shall be complete so it is
235 not allowed to import from a module that is not in the list. All options that
236 influence the code generation are silently ignored when used together with
246 skeleton header and source files for all port types that can be found in
247 TTCN-3 modules. Existing Test Port files will not be overwritten unless the
252 Forces the interpretation of
260 Forces the compiler to do
261 .I duplicate underscore
262 characters in all output file names. This option turns on the
263 compatibility mode with versions 1.1 or earlier.
266 Selects code splitting mode for the generated C++ code.
271 and license key information and exits.
273 .BI \-V " verb_level"
274 Sets the verbosity bit-mask directly to
278 is a decimal value between 0 and 65535).
287 "NOT SUPPORTED" messages.
298 The debug-bits act like a 3-bits-length number, so the debug level has
299 a value between 0 and 7. It is useful in case of abnormal program termination.
307 messages. Equivalent with
311 Disables the generation of
313 encoder/decoder routines for all TTCN-3 types.
318 encoder/decoder functions
326 Enforces legacy behaviour of the "out" function parameters (see refguide).
329 Enables profiling and code coverage in the selected TTCN-3 files. The
331 argument contains a list of TTCN-3 files separated by new lines. Each TTCN-3 file must be among the compiler's TTCN-3 file arguments.
334 The single dash character as command line argument controls the
335 .I selective code generation
337 After the list of all TTCN-3 and ASN.1 modules a subset of these files can
338 be given separated by a dash. This option instructs the compiler to parse all
339 modules, perform the semantic analysis on the entire module hierarchy, but
342 for those modules that are listed after the dash again.
344 It is not allowed to specify a file name after the dash that was not present
345 in the list before the dash. If the single dash is not present in the command
346 line the compiler will generate code for
351 Generates a JSON schema from the types defined in the specified TTCN-3 and ASN.1 modules.
352 Must always be the first compiler option. From the previously listed options only
356 can be used, instead the JSON schema generator has options of its own:
359 Only types that have JSON coding enabled are included in the schema.
362 The schema only validates types that have a JSON encoding or decoding method declared.
365 The single dash character as command line argument specifies the name of the generated
366 JSON schema file. If it is not present, then the schema file name is generated from
367 the name of the first input file (by replacing its suffix with
371 to the end of the file).
373 The compiler exits with a status of zero when no errors were encountered
374 during its operation. A status of one will be returned if syntax or
375 semantic errors were detected in the input modules.
376 .SH ENVIRONMENT VARIABLES
380 The installation directory where the uncompressed binary package of
381 TTCN-3 Test Executor can be found.
385 It shall point to the
389 to its directory) that contains the personalized license key for the
390 current user or host.
392 The compiler does not support all constructs of TTCN-3 Core Language and ASN.1.
393 It reports an error when encountering an unsupported language element.
394 The detailed list of deficiencies and language extensions can be found in the
395 referenced documentation.
397 For trouble reporting use the tool
399 For TR writers guide please visit the web page:
400 .I http://ttcn.ericsson.se.
404 Ericsson document 2/198 17-CRL 113 200 Uen:
405 .B Programmer's Technical Reference for TITAN TTCN-3 Test Executor
408 ETSI Standard ES 201-873-1:
409 .B Testing and Test Control Notation: TTCN-3 Core Language
412 ITU-T Recommendations X.680-683:
413 .B Abstract Syntax Notation One (ASN.1)
415 This manpage is written by Janos Zoltan Szabo, Ericsson Telecom AB
417 Copyright (c) 2000-2016 Ericsson Telecom AB
419 All rights reserved. This program and the accompanying materials
420 are made available under the terms of the Eclipse Public License v1.0
421 which accompanies this distribution, and is available at
423 http://www.eclipse.org/legal/epl-v10.html