SARL Command-line Compiler
A command-line compiler is a tool that could be invoked from the command-line shell in order to compiler a language source file.
sarlc is the command-line compiler for the SARL language.
1. Note on the application classpath
The sarlc tool does not deal with the run-time classpath of the application. It means that it does not check if a SARL runtime environment is installed and used in your application.
For launching a SARL application, please refer to one of:
- Running an agent from the command-line shell
- Running an agent inside SARL Eclipse environment
- Running an agent from a Java program progammatically
2. Usage
The sarlc tool takes arguments:
sarlc [OPTIONS] <source folder>...
The sarlc tool takes at least one source folder from which the SARL files are read.
You could change the behavior of the sarlc compiler with the command-line options.
For obtaining a list of the options, type:
sarlc -h
3. Command-Line Options
The complete list of the options is:
| Option | Description |
|---|---|
| -b path –boot-classpath=path |
Cross-compiles against the specified set of boot classes. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives. |
| –classpath=path | Specifies where to find user class files, and source files. This class path overrides the user class path in the SARLC_CLASSPATH environment variable. If neither SARLC_CLASSPATH, –cp nor –classpath is specified, then the user class path is built upon the source folders, the generated file folders, and the standard SARL libraries. If a user class path is specified, it must contains the the user libraries and the standard SARL libraries. |
| –config=yaml_location | Specifies YAML config location, which can be a file path or a URL. |
| –cp=path | Specifies where to find user class files, and source files. This class path overrides the user class path in the SARLC_CLASSPATH environment variable. If neither SARLC_CLASSPATH, –cp nor –classpath is specified, then the user class path is built upon the source folders, the generated file folders, and the standard SARL libraries. If a user class path is specified, it must contains the the user libraries and the standard SARL libraries. |
| -d directory_name –directory=directory_name |
Sets the destination directory for Java source files that are generated from the SARL files. The directory must already exist because sarlc does not create it. If a SARL declaration is part of a package, then sarlc puts the Java source file in a subdirectory that reflects the package name and creates directories as needed. If the –directory option is not specified, then sarlc assumes src/main/generated-sources/sarl. |
| -e [encoding] –encoding[=encoding] |
Sets the source file encoding name, such as EUC-JP and UTF-8. If the –encoding option is not specified, then the platform default converter is used. |
| –generate-clones[=true|false] | Specifies if the clone functions should be generated; default is true. |
| –generate-equality-tests[=true|false] | Specifies if the equality tests should be generated; default is true. |
| –generate-inlines[=true|false] | Specifies if the @Inline annotations should be generated; default is false. |
| –generate-pures[=true|false] | Specifies if the @Pure annotations should be generated; default is true. |
| –generate-serials[=true|false] | Specifies if the serial identifiers should be generated; default is true. |
| –generate-tostring[=true|false] | Specifies if the toString functions should be generated; default is true. |
| –generatemarkdownconfighelp | Prints the configuration parameters using a Markdown table. |
| –generatemarkdownhelp | Prints the list of the command-line options using a Markdown table. |
| –generator=identifiers | Enables extra-language generators. The parameter is a list of identifiers of the generators to turn on, separated by ‘:’. See the option -G for printing out the list of the available generators. |
| -h –help |
Prints this message. |
| -H –help-config |
Prints information about application modules and their configuration options. |
| –java-compiler[=none|ecj|javac] | Specifies the Java compiler to be run; default is javac. |
| –java-source[=version] | Specifies the Java version of the Java source code that is accepted, and of the Java class files for targeting a specific release of the Java virtual machine. Java class files will run on the specified target and on later releases, but not on earlier releases of the Java virtual machine. Provided version must be greater than or equal to 17, and strictly lower than 18. |
| –json | When present, the output of the configuration has the Json format. |
| -l level –log=level |
Specifies the level of logging of the application. This log level could be also controlled by setting the environment variable LOG_LEVEL. If neither LOG_LEVEL nor –log is specified, then the default log level set to info is used. The accepted values are: off, error, warning, info, debug, trace, all. |
| -m path –modulepath=path |
Specifies where to find module class files, and source files. This module path overrides the user module path in the SARLC_MODULEPATH environment variable. If neither SARLC_MODULEPATH, –p nor –modulepath is specified, then the user module path is built upon the source folders, the generated file folders, and the standard SARL libraries. If a user module path is specified, it must contains the the user libraries and the standard SARL libraries. |
| -o directory_name –outputdir=directory_name |
Sets the destination directory for class files. The directory must already exist because sarlc does not create it. If a class is part of a package, then sarlc puts the class file in a subdirectory that reflects the package name and creates directories as needed. If the –outputdir option is not specified, then sarlc assumes target/classes. |
| -p path | Specifies where to find module class files, and source files. This module path overrides the user module path in the SARLC_MODULEPATH environment variable. If neither SARLC_MODULEPATH, –p nor –modulepath is specified, then the user module path is built upon the source folders, the generated file folders, and the standard SARL libraries. If a user module path is specified, it must contains the the user libraries and the standard SARL libraries. |
| -G –print-generators |
Prints the list of the available extra-language generators. |
| -C –printconfig |
Print the current configuration. The output format is Yaml by default. See –json for a Json output, and –xml for a XML output. |
| –progress[=true|false] | Prints the progress bar on the console. |
| -t directory_name –tempdir=directory_name |
Directory in which the temporary files will be generated during the compilation process. |
| -v –version |
Prints release information. |
| –wall | Specifies if all the warnings are printed out. |
| –werror | Terminates compilation when warnings occur. |
| –wnone | Specifies if all the warnings are ignored. |
| –write-storages[=true|false] | Specifies if the storage files should be generated; default is true. |
| –write-traces[=true|false] | Specifies if the trace files should be generated; default is true. |
| -x –xml |
When present, the output of the configuration has the XML format. |
4. Legal Notice
- Specification: SARL General-purpose Agent-Oriented Programming Language (“Specification”)
- Version: 0.14
- Status: Draft Release
- Release: 2023-09-26
Copyright © 2014-2023 SARL.io, the Original Authors and Main Authors.
Documentation text and medias are licensed under the Creative Common CC-BY-SA-4.0; you may not use this file except in compliance with CC-BY-SA-4.0. You may obtain a copy of CC-BY-4.0.
Examples of SARL code are licensed under the Apache License, Version 2.0; you may not use this file except in compliance with the Apache License. You may obtain a copy of the Apache License.
You are free to reproduce the content of this page on copyleft websites such as Wikipedia.
Generated with the translator docs.generator 0.14.0-SNAPSHOT.