CBMC
ms_link_cmdlinet Class Reference

#include <ms_link_cmdline.h>

+ Inheritance diagram for ms_link_cmdlinet:
+ Collaboration diagram for ms_link_cmdlinet:

Public Member Functions

virtual bool parse (int, const char **)
 parses the command line options into a cmdlinet More...
 
 ms_link_cmdlinet ()
 
virtual bool parse (int argc, const char **argv, const char *optstring)
 Parses a commandline according to a specification given in optstring. More...
 
- Public Member Functions inherited from goto_cc_cmdlinet
 ~goto_cc_cmdlinet ()
 
std::size_t get_optnr (const std::string &option)
 
void set (const std::string &opt, const char *value) override
 Set option option to value. More...
 
void set (const std::string &opt, const std::string &value) override
 
void set (const std::string &opt, bool value=true) override
 Set option option to value, or true if the value is omitted. More...
 
bool have_infile_arg () const
 
virtual bool parse (int argc, const char **argv, const char *optstring)
 Parses a commandline according to a specification given in optstring. More...
 
- Public Member Functions inherited from cmdlinet
virtual bool parse (int argc, const char **argv, const char *optstring)
 Parses a commandline according to a specification given in optstring. More...
 
std::string get_value (char option) const
 
std::string get_value (const char *option) const
 
std::optional< std::string > value_opt (char option) const
 
std::optional< std::string > value_opt (const char *option) const
 
const std::list< std::string > & get_values (const std::string &option) const
 
const std::list< std::string > & get_values (char option) const
 
std::list< std::string > get_comma_separated_values (const char *option) const
 Collect all occurrences of option option and split their values on each comma, merging them into a single list of values. More...
 
virtual bool isset (char option) const
 
virtual bool isset (const char *option) const
 
virtual void clear ()
 
bool has_option (const std::string &option) const
 
option_namest option_names () const
 Pseudo-object that can be used to iterate over options in this cmdlinet (should not outlive this) More...
 
 cmdlinet ()
 
virtual ~cmdlinet ()
 
std::vector< std::string > get_argument_suggestions (const std::string &unknown_argument)
 

Protected Member Functions

void process_non_link_option (const std::string &s)
 
void process_link_option (const std::string &s)
 
void process_response_file (const std::string &file)
 
void process_response_file_line (const std::string &line)
 
bool parse (const std::vector< std::string > &)
 
- Protected Member Functions inherited from goto_cc_cmdlinet
void add_arg (const std::string &arg)
 
void add_infile_arg (const std::string &arg)
 
- Protected Member Functions inherited from cmdlinet
void parse_optstring (const char *optstring)
 Parses an optstring and writes the result to cmdlinet::options. More...
 
bool parse_arguments (int argc, const char **argv)
 Parses a commandline according to a previously parsed optstring and writes the result to cmdlinet::options. More...
 
std::optional< std::size_t > getoptnr (char option) const
 
std::optional< std::size_t > getoptnr (const std::string &option) const
 

Additional Inherited Members

- Public Types inherited from goto_cc_cmdlinet
typedef std::list< argtparsed_argvt
 
- Public Types inherited from cmdlinet
typedef std::vector< std::string > argst
 
- Static Public Member Functions inherited from goto_cc_cmdlinet
static bool in_list (const char *option, const char **list)
 
- Public Attributes inherited from goto_cc_cmdlinet
parsed_argvt parsed_argv
 
std::string stdin_file
 
- Public Attributes inherited from cmdlinet
argst args
 
std::string unknown_arg
 
- Protected Attributes inherited from cmdlinet
std::vector< optiontoptions
 

Detailed Description

Definition at line 19 of file ms_link_cmdline.h.

Constructor & Destructor Documentation

◆ ms_link_cmdlinet()

ms_link_cmdlinet::ms_link_cmdlinet ( )
inline

Definition at line 25 of file ms_link_cmdline.h.

Member Function Documentation

◆ parse() [1/3]

bool ms_link_cmdlinet::parse ( const std::vector< std::string > &  arguments)
protected

Definition at line 28 of file ms_link_cmdline.cpp.

◆ parse() [2/3]

bool cmdlinet::parse

Parses a commandline according to a specification given in optstring.

Parameters
argcHow many arguments there are.
argvAn array of C strings. The 0th element is assumed to be the name of the command as it was invoked (e.g. /usr/bin/cmake) and is ignored. It is further assumed the array holds argc+1 elements with the C string at index argc being a terminating null pointer. This argument is parsed based on optstring.
optstringA specification of allowed command line options. This is a C string container any number of single characters other than '(', ')' or ':' signifying a "short" option consisting of just that character, or names consisting of any characters other than ')' surrounded by a matching pair of '(' and ')' signifying a "long" option with the name being the string between '(' and ')', both of which can be optionally followed by a single ':' indicating that the option takes a argument, if not present it does not. arguments must be in the next array element in argv , except for short options whose argument may also be concatenated directly on them.

Option names in argv must start with either '-' or "--", no distinction between long and short options is made here, although it is customary to use only one '-' for short options and "--" for long options.

All options are optional, if some are required it is up to the user to check that they are present.

Examples:

argc = 4 argv = {"name", "-V", "--name", "CProver", nullptr} opstring = "V(version)(name):"

here the argument to "name" would be "CProver", and "V" is a short option passed without arguments.

argc = 3 argv = {"other-name", "-fFilename", "--trace", nullptr} optstring = "f:(trace)(some-other-option):G"

here the argument to option "f" would be "Filename", "trace" is a long option with no argument, and "some-other-option" and "G" are both allowed options that don’t appear on the commandline (with and without argument respectively).

Returns
true if there was an error while parsing argv, false otherwise. If this failed due to an unknown option name being in argv, the public variable cmdlinet::unknown_arg will be non-empty and contain the name of that option.

Definition at line 74 of file cmdline.cpp.

◆ parse() [3/3]

bool ms_link_cmdlinet::parse ( int  argc,
const char **  argv 
)
virtual

parses the command line options into a cmdlinet

parameters: argument count, argument strings
Returns
none

Implements goto_cc_cmdlinet.

Definition at line 61 of file ms_link_cmdline.cpp.

◆ process_link_option()

void ms_link_cmdlinet::process_link_option ( const std::string &  s)
protected

Definition at line 320 of file ms_link_cmdline.cpp.

◆ process_non_link_option()

void ms_link_cmdlinet::process_non_link_option ( const std::string &  s)
protected

Definition at line 207 of file ms_link_cmdline.cpp.

◆ process_response_file()

void ms_link_cmdlinet::process_response_file ( const std::string &  file)
protected

Definition at line 109 of file ms_link_cmdline.cpp.

◆ process_response_file_line()

void ms_link_cmdlinet::process_response_file_line ( const std::string &  line)
protected

Definition at line 168 of file ms_link_cmdline.cpp.


The documentation for this class was generated from the following files: