Panda3D
Public Types | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes

CVSCopy Class Reference

This is the base class for a family of programs that copy files, typically model files like .flt files and their associated textures, into a CVS-controlled source tree. More...

#include "cvsCopy.h"

Inheritance diagram for CVSCopy:
ProgramBase FltCopy MayaCopy TestCopy

List of all members.

Public Types

typedef pdeque< string > Args

Public Member Functions

bool continue_after_error ()
 Prompts the user (unless -f was specified) if he wants to continue the copy operation after some error has occurred.
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.
CVSSourceTree::FilePath import (const Filename &source, void *extra_data, CVSSourceDirectory *suggested_dir)
 Checks for the given filename somewhere in the directory hierarchy, and chooses a place to import it.
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 &prefix, int indent_width, string text)
 Formats the indicated text and its prefix for output to stderr with the known _terminal_width.
void show_text (const string &text)
 Formats the indicated text 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 pmap< string,
CVSSourceTree::FilePath
CopiedFiles
typedef bool(* OptionDispatchFunction )(const string &opt, const string &parm, void *data)
typedef bool(* OptionDispatchMethod )(ProgramBase *self, const string &opt, const string &parm, void *data)
typedef pvector< FilenameSourceFiles

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)
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.
bool copy_binary_file (Filename source, Filename dest)
 Copies a file without modifying it or scanning it in any way.
virtual bool copy_file (const Filename &source, const Filename &dest, CVSSourceDirectory *dest_dir, void *extra_data, bool new_file)=0
bool cvs_add (const Filename &filename)
 Invokes CVS to add the indicated filename to the repository, if the user so requested.
virtual string filter_filename (const string &source)
 Given a source filename (including the basename only, without a dirname), return the appropriate corresponding filename within the source directory.
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().
bool verify_binary_file (Filename source, Filename dest)
 Verifies that the file is identical and does not need to be recopied.
virtual bool verify_file (const Filename &source, const Filename &dest, CVSSourceDirectory *dest_dir, void *extra_data)
 Verifies that the file is identical and does not need to be recopied.

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.
static string protect_from_shell (const string &source)
 Inserts escape characters into the indicated source string to protect it from the shell, so that it may be given on the command line.

Protected Attributes

CopiedFiles _copied_files
string _cvs_binary
bool _force
bool _got_map_dirname
bool _got_model_dirname
bool _got_path_directory
bool _got_path_store
bool _got_root_dirname
bool _interactive
Filename _key_filename
CVSSourceDirectory_map_dir
Filename _map_dirname
CVSSourceDirectory_model_dir
Filename _model_dirname
bool _no_cvs
Filename _root_dirname
SourceFiles _source_files
CVSSourceTree _tree
bool _user_aborted

Detailed Description

This is the base class for a family of programs that copy files, typically model files like .flt files and their associated textures, into a CVS-controlled source tree.

Definition at line 33 of file cvsCopy.h.


Member Function Documentation

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, inherited]

Adds (or redefines) a command line option.

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 *.

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.

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 535 of file programBase.cxx.

Referenced by SomethingToEgg::add_animation_options(), EggReader::add_delod_options(), SomethingToEgg::add_merge_externals_options(), EggBase::add_normals_options(), ProgramBase::add_path_replace_options(), ProgramBase::add_path_store_options(), EggReader::add_texture_options(), EggBase::add_transform_options(), SomethingToEgg::add_units_options(), EggToSomething::add_units_options(), EggWriter::EggWriter(), ImageWriter::ImageWriter(), and SomethingToEgg::SomethingToEgg().

void ProgramBase::add_path_replace_options ( ) [protected, inherited]

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 642 of file programBase.cxx.

References ProgramBase::add_option(), ProgramBase::dispatch_path_replace(), and ProgramBase::dispatch_search_path().

void ProgramBase::add_path_store_options ( ) [protected, inherited]

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 683 of file programBase.cxx.

References ProgramBase::add_option(), ProgramBase::dispatch_filename(), and ProgramBase::dispatch_path_store().

void ProgramBase::add_runline ( const string &  runline) [protected, inherited]

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 487 of file programBase.cxx.

Referenced by EggToSomething::EggToSomething(), EggWriter::EggWriter(), ImageWriter::ImageWriter(), and SomethingToEgg::SomethingToEgg().

void ProgramBase::clear_options ( ) [protected, inherited]

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 501 of file programBase.cxx.

void ProgramBase::clear_runlines ( ) [protected, inherited]

Removes all of the runlines that were previously added, presumably before adding some new ones.

Definition at line 469 of file programBase.cxx.

Referenced by EggToSomething::EggToSomething(), EggWriter::EggWriter(), ImageWriter::ImageWriter(), and SomethingToEgg::SomethingToEgg().

bool CVSCopy::continue_after_error ( )

Prompts the user (unless -f was specified) if he wants to continue the copy operation after some error has occurred.

Returns true to continue, false otherwise.

Definition at line 168 of file cvsCopy.cxx.

Referenced by import().

bool CVSCopy::copy_binary_file ( Filename  source,
Filename  dest 
) [protected]

Copies a file without modifying it or scanning it in any way.

This is particularly useful for copying textures. This is provided as a convenience function for derived programs because so many model file formats will also require copying textures or other black-box files.

Definition at line 337 of file cvsCopy.cxx.

References Filename::open_read(), Filename::open_write(), Filename::set_binary(), and Filename::unlink().

Referenced by TestCopy::copy_file().

bool CVSCopy::cvs_add ( const Filename filename) [protected]

Invokes CVS to add the indicated filename to the repository, if the user so requested.

Returns true if successful, false if there is an error.

Definition at line 385 of file cvsCopy.cxx.

References Filename::get_basename(), Filename::get_dirname(), protect_from_shell(), CVSSourceTree::restore_cwd(), and CVSSourceTree::temp_chdir().

Referenced by import().

bool ProgramBase::dispatch_color ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 Colorf.

Definition at line 953 of file programBase.cxx.

bool ProgramBase::dispatch_coordinate_system ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 1114 of file programBase.cxx.

bool ProgramBase::dispatch_count ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 775 of file programBase.cxx.

bool ProgramBase::dispatch_double ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 840 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, inherited]

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 860 of file programBase.cxx.

bool ProgramBase::dispatch_double_quad ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 921 of file programBase.cxx.

bool ProgramBase::dispatch_double_triple ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 890 of file programBase.cxx.

bool ProgramBase::dispatch_false ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 759 of file programBase.cxx.

bool ProgramBase::dispatch_filename ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 1070 of file programBase.cxx.

References Filename::from_os_specific().

Referenced by ProgramBase::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, inherited]

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 1159 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, inherited]

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 790 of file programBase.cxx.

bool ProgramBase::dispatch_int_pair ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 810 of file programBase.cxx.

bool ProgramBase::dispatch_none ( const string &  opt,
const string &  arg,
void *   
) [static, protected, inherited]

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 725 of file programBase.cxx.

Referenced by SomethingToEgg::add_merge_externals_options(), EggBase::add_normals_options(), and SomethingToEgg::SomethingToEgg().

bool ProgramBase::dispatch_path_replace ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 1185 of file programBase.cxx.

References PathReplace::add_pattern().

Referenced by ProgramBase::add_path_replace_options().

bool ProgramBase::dispatch_path_store ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 1207 of file programBase.cxx.

Referenced by ProgramBase::add_path_store_options().

bool ProgramBase::dispatch_search_path ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 1093 of file programBase.cxx.

References DSearchPath::append_directory(), and Filename::from_os_specific().

Referenced by ProgramBase::add_path_replace_options().

bool ProgramBase::dispatch_string ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 1011 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, inherited]

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 741 of file programBase.cxx.

bool ProgramBase::dispatch_units ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 1137 of file programBase.cxx.

Referenced by SomethingToEgg::add_units_options(), and EggToSomething::add_units_options().

bool ProgramBase::dispatch_vector_string ( const string &  opt,
const string &  arg,
void *  var 
) [static, protected, inherited]

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 1031 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, inherited]

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 1048 of file programBase.cxx.

string CVSCopy::filter_filename ( const string &  source) [protected, virtual]

Given a source filename (including the basename only, without a dirname), return the appropriate corresponding filename within the source directory.

This may be used by derived classes to, for instance, strip a version number from the filename.

Reimplemented in MayaCopy.

Definition at line 462 of file cvsCopy.cxx.

Referenced by import().

void ProgramBase::format_text ( ostream &  out,
bool &  last_newline,
const string &  prefix,
int  indent_width,
const string &  text,
int  line_width 
) [static, protected, inherited]

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 1263 of file programBase.cxx.

Referenced by ProgramBase::show_text().

string ProgramBase::get_exec_command ( ) const [inherited]

Returns the command that invoked this program, as a shell-friendly string, suitable for pasting into the comments of output files.

Definition at line 367 of file programBase.cxx.

References Filename::get_basename_wo_extension().

Referenced by EggBase::append_command_comment().

bool CVSCopy::handle_args ( 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 from ProgramBase.

Definition at line 202 of file cvsCopy.cxx.

References Filename::from_os_specific().

bool ProgramBase::handle_help_option ( const string &  opt,
const string &  arg,
void *  data 
) [static, protected, inherited]

Called when the user enters '-h', this describes how to use the program and then exits.

Definition at line 1228 of file programBase.cxx.

References ProgramBase::show_description(), ProgramBase::show_options(), and ProgramBase::show_usage().

CVSSourceTree::FilePath CVSCopy::import ( const Filename source,
void *  extra_data,
CVSSourceDirectory suggested_dir 
)

Checks for the given filename somewhere in the directory hierarchy, and chooses a place to import it.

Copies the file by calling copy_file().

Extra_data may be NULL or a pointer to some user-defined structure; CVSCopy simply passes it unchanged to copy_file(). It presumably gives the class a hint as to how the file should be copied. Suggested_dir is the suggested directory in which to copy the file, if it does not already exist elsewhere.

On success, returns the FilePath it was actually copied to. On failure, returns an invalid FilePath.

Definition at line 113 of file cvsCopy.cxx.

References CVSSourceTree::choose_directory(), continue_after_error(), cvs_add(), filter_filename(), Filename::get_basename(), Filename::get_fullpath(), and verify_file().

void ProgramBase::parse_command_line ( int  argc,
char *  argv[] 
) [virtual, inherited]

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 208 of file programBase.cxx.

References Filename::from_os_specific(), ProgramBase::handle_args(), ProgramBase::post_command_line(), and ProgramBase::show_usage().

Referenced by MayaToEggServer::poll().

bool CVSCopy::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 from ProgramBase.

Definition at line 227 of file cvsCopy.cxx.

References CVSSourceTree::find_directory(), CVSSourceTree::find_relpath(), and CVSSourceTree::get_root_dirname().

string CVSCopy::protect_from_shell ( const string &  source) [static, protected]

Inserts escape characters into the indicated source string to protect it from the shell, so that it may be given on the command line.

Returns the modified string.

Definition at line 418 of file cvsCopy.cxx.

Referenced by cvs_add().

bool ProgramBase::redescribe_option ( const string &  option,
const string &  description 
) [protected, inherited]

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 607 of file programBase.cxx.

Referenced by EggToSomething::EggToSomething(), EggWriter::EggWriter(), and SomethingToEgg::SomethingToEgg().

bool ProgramBase::remove_option ( const string &  option) [protected, inherited]

Removes a previously-defined option.

Returns true if the option was removed, false if it hadn't existed.

Definition at line 623 of file programBase.cxx.

Referenced by SomethingToEgg::SomethingToEgg().

void ProgramBase::set_program_description ( const string &  description) [protected, inherited]

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 458 of file programBase.cxx.

void ProgramBase::show_description ( ) [inherited]

Writes the program description to stderr.

Definition at line 137 of file programBase.cxx.

Referenced by ProgramBase::handle_help_option().

void ProgramBase::show_options ( ) [inherited]

Describes each of the available options to stderr.

Definition at line 164 of file programBase.cxx.

References ProgramBase::show_text().

Referenced by ProgramBase::handle_help_option().

void ProgramBase::show_text ( const string &  prefix,
int  indent_width,
string  text 
) [inherited]

Formats the indicated text and its prefix for output to stderr with the known _terminal_width.

Definition at line 188 of file programBase.cxx.

References ProgramBase::format_text().

void ProgramBase::show_text ( const string &  text) [inline, inherited]

Formats the indicated text to stderr with the known _terminal_width.

Definition at line 23 of file programBase.I.

Referenced by ProgramBase::show_options(), and ProgramBase::show_usage().

void ProgramBase::show_usage ( ) [inherited]

Writes the usage line(s) to stderr.

Definition at line 147 of file programBase.cxx.

References Filename::get_basename_wo_extension(), and ProgramBase::show_text().

Referenced by ProgramBase::handle_help_option(), and ProgramBase::parse_command_line().

bool CVSCopy::verify_binary_file ( Filename  source,
Filename  dest 
) [protected]

Verifies that the file is identical and does not need to be recopied.

Returns true if the files are identical, false if they differ.

Definition at line 283 of file cvsCopy.cxx.

References Filename::open_read(), and Filename::set_binary().

bool CVSCopy::verify_file ( const Filename source,
const Filename dest,
CVSSourceDirectory dest_dir,
void *  extra_data 
) [protected, virtual]

Verifies that the file is identical and does not need to be recopied.

Returns true if the files are identical, false if they differ.

Definition at line 270 of file cvsCopy.cxx.

Referenced by import().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations