OpenGATE
C/C++ project development area

OpenGATE | Apps | gatecli

GATE Command Line Interface

Description:

gatecli fulfills two purposes:

  1. It is a unit-test and debugging tool for the C code in the GATE framework.
  2. And it can be compared to a pocketknife for some special features that the GATE framework provides.

gatecli contains several functions that are grouped into logical modules. The file module for example contains functions to copy, move or delete files in the local filesystem.

The program is in most cases controlled by command line arguments. The first argument always names the module and the second one always identifies the function that is going to be executed.

Further arguments depend on the select function. But there exists a guideline for them:

  1. Most function arguments come in key and value pair. The former argument names the key and following one states the value.
  2. A single argument value that contain spaces (like in file paths) MUST be quoted in the command line by a double-quotation mark to ensure that they are not misinterpreted as two or more separate arguments.
  3. One exception to guideline (1) are boolean flags, which will only consist of the key name but MUST NOT have a value. The presence of a boolean flag key name defines that the value is already true, while omitting the argument sets the internal parameter value to false.
  4. Some argument key & value pairs are optional while others are mandatory, which depends on the executed module and function.
  5. The process exit code of the application is ZERO, if the executed function did succeed. Otherwise the exit code is set to a mapped value of the internal GATE framework result or error code.
  6. Some functions may generate data output.
    • Regular output is always directed to the primary console output stream (STDOUT)
    • Error messages are written to the console error stream (STDERR)

#Status: Pre-alpha, ongoing development

gatecli has a special state of all other GATE products.
At each compilation it contains the current state of all GATE labraries and it is

License

This product is published under the terms of the BSD-2 license.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Download

Currently are no downloads available.

© 2022 OpenGATE