by the routines contained in
\verb|main.cpp|, \verb|config.cpp| and \verb|tool.cpp|.
-Program configuration is capsuled into the class \verb|configuration_manager|,
+Program configuration is encapsulated into the class \verb|configuration_manager|,
used by the routines in \verb|config.cpp|.
\subsubsection{Program flow}
subroutine contained in \verb|config.cpp|. This contains parsing the command line,
reading a configuration file, and setting the global \verb|cfg_*| flags. The input and
output file descriptors \verb|in_fd| and \verb|out_fd| are assigned to 0 and 1 respective
-files as stated in the configuration (command line option or configuration file).
-The \verb|configuration_manager| is able to dynamically generate help output for all
-options.
+open files as determined by the configuration (command line option or configuration file).\\
The next call is \verb|read_tape()|, the data input routine. In \verb|read_tape()|,
the static factory method \verb|tape_block::gen_from_fd()| is used to create and
check blocks, taking data directly from the global file descriptor \verb|in_fd|.\\
At the end of \verb|read_tape()|, the vector \verb|tape| has been filled with
-pointers to instances of \verb|tape_block|.
+pointers to instances of \verb|tape_block|.\\
In the next step, the routine \verb|process_tape()| is called, in which
integrity checks on object level and splitting to files (if desired)
are accomplished. Every valid and complete object consist of either one
single \verb|eot_block| or a series of \verb|data_block|s, while the last block
-of each object must be one of the types which mark the end of an object.
+of each object must be one of the types which mark the end of an object.\\
After all that, \verb|process_symbols()| is called. This routine generates three vectors
containing symbol names: \verb|exported|, \verb|called|, and \verb|unsatisfied|.
The latter is the difference of \verb|called| and \verb|exported|.\\
If desired, those vectors are written out to \verb|out_fd|, one symbol per line.
-\subsubsection{Block factory}
-The software makes use of C++ virtual methods allowing for convinient processing of
+\subsubsection{Block factory}
+The software makes use of C++ virtual methods allowing for convenient processing of
multiple kinds of blocks without knowing much about the block type currently worked
on.\\
The block factory consists of the static factory method \verb|tape_block::gen_from_fd()|
*
* LDC2 source code
*
- * $Date: 2007/03/26 01:00:38 $
+ * $Date: 2007/03/26 04:05:37 $
* $Author: hachti $
*
* $Log: configuration_manager.cpp,v $
- * Revision 2.0 2007/03/26 01:00:38 hachti
+ * Revision 2.1 2007/03/26 04:05:37 hachti
+ * *** empty log message ***
+ *
+ * Revision 2.0 2007-03-26 01:00:38 hachti
* *** empty log message ***
*
*
*\param target Pointer to string to put the value in.
*\param placeholder A placeholder for the documentation.
* For example <filename> in -f<filename>
+ *\param allow_cmdline Specifies if this value may be specified on the
+ * command line.
+ *\param allow_conffile Specifies if this value may be specified in a
+ * configuration file.
+ *
*/
void configuration_manager::add_option_value (const string & shortname,
const string & longname,
/*!
- *\Read in the args passed to main().
+ *\brief Read in the args passed to main().
*\returns empty vector on success or the error messages to be output.
*/
vector<string> configuration_manager::read_args(int argc, char ** args){
projects / h316.git / commitdiff