Panda3D
|
This is intended to be the base class for most general-purpose utility programs in the PANDATOOL tree. More...
#include "programBase.h"
Classes | |
class | Option |
class | SortOptionsByIndex |
Public Types | |
typedef pdeque< string > | Args |
Public Member Functions | |
string | get_exec_command () const |
Returns the command that invoked this program, as a shell-friendly string, suitable for pasting into the comments of output files. | |
virtual void | parse_command_line (int argc, char **argv) |
Dispatches on each of the options on the command line, and passes the remaining parameters to handle_args(). | |
void | show_description () |
Writes the program description to stderr. | |
void | show_options () |
Describes each of the available options to stderr. | |
void | show_text (const string &text) |
Formats the indicated text to stderr with the known _terminal_width. | |
void | show_text (const string &prefix, int indent_width, string text) |
Formats the indicated text and its prefix for output to stderr with the known _terminal_width. | |
void | show_usage () |
Writes the usage line(s) to stderr. | |
Public Attributes | |
Args | _program_args |
Filename | _program_name |
Protected Types | |
typedef bool(* | OptionDispatchFunction )(const string &opt, const string &parm, void *data) |
typedef bool(* | OptionDispatchMethod )(ProgramBase *self, const string &opt, const string &parm, void *data) |
Protected Member Functions | |
void | add_option (const string &option, const string &parm_name, int index_group, const string &description, OptionDispatchFunction option_function, bool *bool_var=(bool *) NULL, void *option_data=(void *) NULL) |
Adds (or redefines) a command line option. | |
void | add_option (const string &option, const string &parm_name, int index_group, const string &description, OptionDispatchMethod option_method, bool *bool_var=(bool *) NULL, void *option_data=(void *) NULL) |
This is another variant on add_option(), above, except that it receives a pointer to a "method", which is really just another static (or global) function, whose first parameter is a ProgramBase *. | |
void | add_path_replace_options () |
Adds -pr etc. | |
void | add_path_store_options () |
Adds -ps etc. | |
void | add_runline (const string &runline) |
Adds an additional line to the list of lines that will be displayed to describe briefly how the program is to be run. | |
void | clear_options () |
Removes all of the options that were previously added, presumably before adding some new ones. | |
void | clear_runlines () |
Removes all of the runlines that were previously added, presumably before adding some new ones. | |
virtual bool | handle_args (Args &args) |
Does something with the additional arguments on the command line (after all the -options have been parsed). | |
virtual bool | post_command_line () |
This is called after the command line has been completely processed, and it gives the program a chance to do some last-minute processing and validation of the options and arguments. | |
PT (PathReplace) _path_replace | |
bool | redescribe_option (const string &option, const string &description) |
Changes the description associated with a previously-defined option. | |
bool | remove_option (const string &option) |
Removes a previously-defined option. | |
void | set_program_description (const string &description) |
Sets the description of the program that will be reported by show_usage(). | |
Static Protected Member Functions | |
static bool | dispatch_color (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes a color, as l or l,a or r,g,b or r,g,b,a. | |
static bool | dispatch_coordinate_system (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a coordinate system string. | |
static bool | dispatch_count (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes no parameters, but whose presence on the command line increments an integer counter for each time it appears. | |
static bool | dispatch_double (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a double. | |
static bool | dispatch_double_pair (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes a pair of double parameters. | |
static bool | dispatch_double_quad (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes a quad of double parameters. | |
static bool | dispatch_double_triple (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes a triple of double parameters. | |
static bool | dispatch_false (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes no parameters, and when it is present sets a bool variable to the 'false' value. | |
static bool | dispatch_filename (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a filename. | |
static bool | dispatch_image_type (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to indicate an image file type, like rgb, bmp, jpg, etc. | |
static bool | dispatch_int (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as an integer. | |
static bool | dispatch_int_pair (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes a pair of integer parameters. | |
static bool | dispatch_none (const string &opt, const string &arg, void *) |
Standard dispatch function for an option that takes no parameters, and does nothing special. | |
static bool | dispatch_path_replace (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a single component of a path replace request. | |
static bool | dispatch_path_store (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a path store string. | |
static bool | dispatch_search_path (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a single directory name to add to a search path. | |
static bool | dispatch_string (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a string. | |
static bool | dispatch_true (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes no parameters, and when it is present sets a bool variable to the 'true' value. | |
static bool | dispatch_units (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a unit of distance measurement. | |
static bool | dispatch_vector_string (const string &opt, const string &arg, void *var) |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a string. | |
static bool | dispatch_vector_string_comma (const string &opt, const string &arg, void *var) |
Similar to dispatch_vector_string, but a comma is allowed to separate multiple tokens in one argument, without having to repeat the argument for each token. | |
static void | format_text (ostream &out, bool &last_newline, const string &prefix, int indent_width, const string &text, int line_width) |
Word-wraps the indicated text to the indicated output stream. | |
static bool | handle_help_option (const string &opt, const string &arg, void *) |
Called when the user enters '-h', this describes how to use the program and then exits. | |
Protected Attributes | |
bool | _got_path_directory |
bool | _got_path_store |
This is intended to be the base class for most general-purpose utility programs in the PANDATOOL tree.
It automatically handles things like command-line arguments in a portable way.
Definition at line 37 of file programBase.h.
void ProgramBase::add_option | ( | const string & | option, |
const string & | parm_name, | ||
int | index_group, | ||
const string & | description, | ||
OptionDispatchFunction | option_function, | ||
bool * | bool_var = (bool *)NULL , |
||
void * | option_data = (void *)NULL |
||
) | [protected] |
Adds (or redefines) a command line option.
When parse_command_line() is executed it will look for these options (followed by a hyphen) on the command line; when a particular option is found it will call the indicated option_function, supplying the provided option_data. This allows the user to define a function that does some special behavior for any given option, or to use any of a number of generic pre-defined functions to fill in data for each option.
Each option may or may not take a parameter. If parm_name is nonempty, it is assumed that the option does take a parameter (and parm_name contains the name that will be printed by show_options()). This parameter will be supplied as the second parameter to the dispatch function. If parm_name is empty, it is assumed that the option does not take a parameter. There is no provision for optional parameters.
The options are listed first in order by their index_group number, and then in the order that add_option() was called. This provides a mechanism for listing the options defined in derived classes before those of the base classes.
Definition at line 528 of file programBase.cxx.
Referenced by SomethingToEgg::add_animation_options(), EggReader::add_delod_options(), SomethingToEgg::add_merge_externals_options(), EggBase::add_normals_options(), add_path_replace_options(), add_path_store_options(), EggBase::add_points_options(), EggReader::add_texture_options(), EggBase::add_transform_options(), PfmTrans::add_transform_options(), EggToSomething::add_units_options(), SomethingToEgg::add_units_options(), EggWriter::EggWriter(), ImageWriter::ImageWriter(), and SomethingToEgg::SomethingToEgg().
void ProgramBase::add_option | ( | const string & | option, |
const string & | parm_name, | ||
int | index_group, | ||
const string & | description, | ||
OptionDispatchMethod | option_method, | ||
bool * | bool_var = (bool *)NULL , |
||
void * | option_data = (void *)NULL |
||
) | [protected] |
This is another variant on add_option(), above, except that it receives a pointer to a "method", which is really just another static (or global) function, whose first parameter is a ProgramBase *.
We can't easily add a variant that accepts a real method, because the C++ syntax for methods requires us to know exactly what class object the method is defined for, and we want to support adding pointers for methods that are defined in other classes. So we have this hacky thing, which requires the "method" to be declared static, and receive its this pointer explicitly, as the first argument.
Definition at line 569 of file programBase.cxx.
void ProgramBase::add_path_replace_options | ( | ) | [protected] |
Adds -pr etc.
as valid options for this program. These are appropriate for a model converter or model reader type program, and specify how to locate possibly-invalid pathnames in the source model file.
Definition at line 635 of file programBase.cxx.
References add_option(), dispatch_path_replace(), and dispatch_search_path().
void ProgramBase::add_path_store_options | ( | ) | [protected] |
Adds -ps etc.
as valid options for this program. These are appropriate for a model converter type program, and specify how to represent filenames in the output file.
Definition at line 676 of file programBase.cxx.
References add_option(), dispatch_filename(), and dispatch_path_store().
void ProgramBase::add_runline | ( | const string & | runline | ) | [protected] |
Adds an additional line to the list of lines that will be displayed to describe briefly how the program is to be run.
Each line should be something like "[opts] arg1 arg2", that is, it does *not* include the name of the program, but it includes everything that should be printed after the name of the program.
Normally there is only one runline for a given program, but it is possible to define more than one.
Definition at line 480 of file programBase.cxx.
Referenced by EggToSomething::EggToSomething(), EggWriter::EggWriter(), ImageWriter::ImageWriter(), and SomethingToEgg::SomethingToEgg().
void ProgramBase::clear_options | ( | ) | [protected] |
Removes all of the options that were previously added, presumably before adding some new ones.
Normally you wouldn't want to do this unless you want to completely replace all of the options defined by base classes.
Definition at line 494 of file programBase.cxx.
void ProgramBase::clear_runlines | ( | ) | [protected] |
Removes all of the runlines that were previously added, presumably before adding some new ones.
Definition at line 462 of file programBase.cxx.
Referenced by EggToSomething::EggToSomething(), EggWriter::EggWriter(), ImageWriter::ImageWriter(), and SomethingToEgg::SomethingToEgg().
bool ProgramBase::dispatch_color | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes a color, as l or l,a or r,g,b or r,g,b,a.
The data pointer is to an array of four floats, e.g. a LColor.
Definition at line 954 of file programBase.cxx.
bool ProgramBase::dispatch_coordinate_system | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a coordinate system string.
The data pointer is to a CoordinateSystem variable.
Definition at line 1115 of file programBase.cxx.
bool ProgramBase::dispatch_count | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes no parameters, but whose presence on the command line increments an integer counter for each time it appears.
-v is often an option that works this way. The data pointer is to an int counter variable.
Definition at line 776 of file programBase.cxx.
bool ProgramBase::dispatch_double | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a double.
The data pointer is to an double variable.
Definition at line 841 of file programBase.cxx.
Referenced by SomethingToEgg::add_animation_options(), and EggReader::add_delod_options().
bool ProgramBase::dispatch_double_pair | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes a pair of double parameters.
The data pointer is to an array of two doubles.
Definition at line 861 of file programBase.cxx.
bool ProgramBase::dispatch_double_quad | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes a quad of double parameters.
The data pointer is to an array of four doubles.
Definition at line 922 of file programBase.cxx.
bool ProgramBase::dispatch_double_triple | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes a triple of double parameters.
The data pointer is to an array of three doubles.
Definition at line 891 of file programBase.cxx.
bool ProgramBase::dispatch_false | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes no parameters, and when it is present sets a bool variable to the 'false' value.
This is another way to handle a boolean flag. See also dispatch_none() and dispatch_true().
The data pointer is to a bool variable.
Definition at line 760 of file programBase.cxx.
bool ProgramBase::dispatch_filename | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a filename.
The data pointer is to a Filename variable.
Definition at line 1071 of file programBase.cxx.
References Filename::from_os_specific().
Referenced by add_path_store_options(), EggReader::add_texture_options(), EggWriter::EggWriter(), and ImageWriter::ImageWriter().
bool ProgramBase::dispatch_image_type | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to indicate an image file type, like rgb, bmp, jpg, etc.
The data pointer is to a PNMFileType pointer.
Definition at line 1160 of file programBase.cxx.
References PNMFileTypeRegistry::get_global_ptr(), PNMFileTypeRegistry::get_type_from_extension(), and PNMFileTypeRegistry::write().
Referenced by EggReader::add_texture_options().
bool ProgramBase::dispatch_int | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as an integer.
The data pointer is to an int variable.
Definition at line 791 of file programBase.cxx.
bool ProgramBase::dispatch_int_pair | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes a pair of integer parameters.
The data pointer is to an array of two integers.
Definition at line 811 of file programBase.cxx.
bool ProgramBase::dispatch_none | ( | const string & | opt, |
const string & | arg, | ||
void * | |||
) | [static, protected] |
Standard dispatch function for an option that takes no parameters, and does nothing special.
Typically this would be used for a boolean flag, whose presence means something and whose absence means something else. Use the bool_var parameter to add_option() to determine whether the option appears on the command line or not.
Definition at line 726 of file programBase.cxx.
Referenced by SomethingToEgg::add_merge_externals_options(), EggBase::add_normals_options(), EggBase::add_points_options(), and SomethingToEgg::SomethingToEgg().
bool ProgramBase::dispatch_path_replace | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a single component of a path replace request.
The data pointer is to a PathReplace variable.
Definition at line 1186 of file programBase.cxx.
References PathReplace::add_pattern().
Referenced by add_path_replace_options().
bool ProgramBase::dispatch_path_store | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a path store string.
The data pointer is to a PathStore variable.
Definition at line 1208 of file programBase.cxx.
Referenced by add_path_store_options().
bool ProgramBase::dispatch_search_path | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a single directory name to add to a search path.
The data pointer is to a DSearchPath variable. This kind of option may appear multiple times on the command line; each time, the new directory is appended.
Definition at line 1094 of file programBase.cxx.
References DSearchPath::append_directory(), and Filename::from_os_specific().
Referenced by add_path_replace_options().
bool ProgramBase::dispatch_string | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a string.
The data pointer is to a string variable.
Definition at line 1012 of file programBase.cxx.
Referenced by SomethingToEgg::add_animation_options(), and EggReader::add_texture_options().
bool ProgramBase::dispatch_true | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes no parameters, and when it is present sets a bool variable to the 'true' value.
This is another way to handle a boolean flag. See also dispatch_none() and dispatch_false().
The data pointer is to a bool variable.
Definition at line 742 of file programBase.cxx.
bool ProgramBase::dispatch_units | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a unit of distance measurement.
The data pointer is to a DistanceUnit variable.
Definition at line 1138 of file programBase.cxx.
Referenced by EggToSomething::add_units_options(), and SomethingToEgg::add_units_options().
bool ProgramBase::dispatch_vector_string | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Standard dispatch function for an option that takes one parameter, which is to be interpreted as a string.
This is different from dispatch_string in that the parameter may be repeated multiple times, and each time the string value is appended to a vector.
The data pointer is to a vector_string variable.
Definition at line 1032 of file programBase.cxx.
Referenced by EggBase::add_normals_options().
bool ProgramBase::dispatch_vector_string_comma | ( | const string & | opt, |
const string & | arg, | ||
void * | var | ||
) | [static, protected] |
Similar to dispatch_vector_string, but a comma is allowed to separate multiple tokens in one argument, without having to repeat the argument for each token.
The data pointer is to a vector_string variable.
Definition at line 1049 of file programBase.cxx.
void ProgramBase::format_text | ( | ostream & | out, |
bool & | last_newline, | ||
const string & | prefix, | ||
int | indent_width, | ||
const string & | text, | ||
int | line_width | ||
) | [static, protected] |
Word-wraps the indicated text to the indicated output stream.
The first line is prefixed with the indicated prefix, then tabbed over to indent_width where the text actually begins. A newline is inserted at or before column line_width. Each subsequent line begins with indent_width spaces.
An embedded newline character ('
') forces a line break, while an embedded carriage-return character (''), or two or more consecutive newlines, marks a paragraph break, which is usually printed as a blank line. Redundant newline and carriage-return characters are generally ignored.
The flag last_newline should be initialized to false for the first call to format_text, and then preserved for future calls; it tracks the state of trailing newline characters between calls so we can correctly identify doubled newlines.
Definition at line 1264 of file programBase.cxx.
Referenced by show_text().
string ProgramBase::get_exec_command | ( | ) | const |
Returns the command that invoked this program, as a shell-friendly string, suitable for pasting into the comments of output files.
Definition at line 360 of file programBase.cxx.
References Filename::get_basename_wo_extension().
Referenced by EggBase::append_command_comment().
bool ProgramBase::handle_args | ( | ProgramBase::Args & | args | ) | [protected, virtual] |
Does something with the additional arguments on the command line (after all the -options have been parsed).
Returns true if the arguments are good, false otherwise.
Reimplemented in EggOptchar, EggMakeFont, SomethingToEgg, CVSCopy, ImageTransformColors, BamInfo, EggToBam, EggReader, EggToSomething, PfmTrans, EggWriter, EggTextureCards, PfmBba, DXFPoints, EggQtess, ImageWriter, BinToC, FltInfo, FltTrans, VRMLTrans, XFileTrans, ImageInfo, EggFilter, ImageFilter, EggMultiFilter, LwoScan, EggPalettize, and ImageReader.
Definition at line 412 of file programBase.cxx.
Referenced by parse_command_line().
bool ProgramBase::handle_help_option | ( | const string & | opt, |
const string & | arg, | ||
void * | data | ||
) | [static, protected] |
Called when the user enters '-h', this describes how to use the program and then exits.
Definition at line 1229 of file programBase.cxx.
References show_description(), show_options(), and show_usage().
void ProgramBase::parse_command_line | ( | int | argc, |
char ** | argv | ||
) | [virtual] |
Dispatches on each of the options on the command line, and passes the remaining parameters to handle_args().
If an error on the command line is detected, will automatically call show_usage() and exit(1).
Definition at line 202 of file programBase.cxx.
References Filename::from_os_specific(), handle_args(), post_command_line(), and show_usage().
Referenced by MayaToEggServer::poll().
bool ProgramBase::post_command_line | ( | ) | [protected, virtual] |
This is called after the command line has been completely processed, and it gives the program a chance to do some last-minute processing and validation of the options and arguments.
It should return true if everything is fine, false if there is an error.
Reimplemented in EggSingleBase, SomethingToEgg, CVSCopy, EggCharacterFilter, EggReader, EggWriter, ImageBase, EggFilter, EggMultiFilter, and EggCrop.
Definition at line 437 of file programBase.cxx.
Referenced by parse_command_line().
bool ProgramBase::redescribe_option | ( | const string & | option, |
const string & | description | ||
) | [protected] |
Changes the description associated with a previously-defined option.
Returns true if the option was changed, false if it hadn't been defined.
Definition at line 600 of file programBase.cxx.
Referenced by EggToSomething::EggToSomething(), EggWriter::EggWriter(), and SomethingToEgg::SomethingToEgg().
bool ProgramBase::remove_option | ( | const string & | option | ) | [protected] |
Removes a previously-defined option.
Returns true if the option was removed, false if it hadn't existed.
Definition at line 616 of file programBase.cxx.
Referenced by SomethingToEgg::SomethingToEgg().
void ProgramBase::set_program_description | ( | const string & | description | ) | [protected] |
Sets the description of the program that will be reported by show_usage().
The description should be one long string of text. Embedded newline characters are interpreted as paragraph breaks and printed as blank lines.
Definition at line 451 of file programBase.cxx.
void ProgramBase::show_description | ( | ) |
Writes the program description to stderr.
Definition at line 131 of file programBase.cxx.
Referenced by handle_help_option().
void ProgramBase::show_options | ( | ) |
Describes each of the available options to stderr.
Definition at line 158 of file programBase.cxx.
References show_text().
Referenced by handle_help_option().
void ProgramBase::show_text | ( | const string & | text | ) | [inline] |
Formats the indicated text to stderr with the known _terminal_width.
Definition at line 23 of file programBase.I.
Referenced by show_options(), and show_usage().
void ProgramBase::show_text | ( | const string & | prefix, |
int | indent_width, | ||
string | text | ||
) |
Formats the indicated text and its prefix for output to stderr with the known _terminal_width.
Definition at line 182 of file programBase.cxx.
References format_text().
void ProgramBase::show_usage | ( | ) |
Writes the usage line(s) to stderr.
Definition at line 141 of file programBase.cxx.
References Filename::get_basename_wo_extension(), and show_text().
Referenced by handle_help_option(), and parse_command_line().