libais-dev-cvs Mailing List for Alien Internet Services Library

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/libais/libaisutil/include/aisutil/config
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14591/include/aisutil/config

Added Files:
	config.h definitions.h errors.h handler.h seg-handler.h 
	var-handler.h 
Removed Files:
	data.h parser.h 
Log Message:
Initial updates for the new configuration parser - WILL NOT COMPLETELY
BUILD!! Major architectural changes here!!

Yes, it's new years -- HAPPY NEW 2005!!! :)


--- NEW FILE: config.h ---
/* $Id: config.h,v 1.1 2004/12/31 22:58:06 pickle Exp $
 *
 * Copyright (c) 2002,2003,2004 Alien Internet Services
 *
 * This file is a part of LibAISutil.
 * 
 * LibAISutil is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * LibAISutil is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LibAISutil; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _INCLUDE_LIBAISUTIL_CONFIG_DATA_H_
# define _INCLUDE_LIBAISUTIL_CONFIG_DATA_H_ 1

# include <aisutil/config/definitions.h>
# include <aisutil/config/errors.h>

namespace AIS {
   namespace Util {
      namespace Config {
	 /*!
	  * \brief Configuration data class
	  * 
	  * This is the configuration data class, used to store your
	  * configuration data for use primarily during program run-time.
	  */
	 class Config {
	  private:
	    //! Definitions table, which is bound to data held in this class
	    const defTable_ptr definitions;

	    //! Error reporting mechanism
	    ErrorReporter* const errorReporter;
	    
	    
	  protected:
	    /*!
	     * \brief Default constructor
	     * 
	     */
	    Config(const defTable_ptr _definitions,
		   ErrorReporter* const _errorReporter = 0)
	      : definitions(_definitions),
	        errorReporter(_errorReporter)
	      {};


	  public:
	    //! Destructor
	    virtual ~Config(void)
	      {};
	 }; // class Config
      }; // namespace Config
   }; // namespace Util
}; // namespace AIS

#endif // _INCLUDE_LIBAISUTIL_CONFIG_DATA_H_

--- NEW FILE: var-handler.h ---
/* $Id: var-handler.h,v 1.1 2004/12/31 22:58:06 pickle Exp $
 *
 * Copyright (c) 2004 Alien Internet Services
 *
 * This file is a part of LibAISutil.
 * 
 * LibAISutil is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * LibAISutil is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LibAISutil; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _INCLUDE_LIBAISUTIL_CONFIG_VAR_HANDLER_H_
# define _INCLUDE_LIBAISUTIL_CONFIG_VAR_HANDLER_H_ 1

# include <aisutil/config/handler.h>

namespace AIS {
   namespace Util {
      namespace Config {
	 /*!
	  * \brief Configuration data variable handler functoid base class
	  *
	  * This functoid is designed for variables. If you have a particular
	  * type of data in your data class that this library does not have
	  * a handler for, you will be wanting to create your own handler by
	  * making a new functoid class inheriting from this base class.
	  * 
	  * When the configuration parser hits a definition it recognises,
	  * it gathers up the data defined in the configuration file and
	  * passes it on to the handling functoid defined in the definition
	  * tables for that particular configuration segment.
	  * 
	  * Armed with all the information you need to process the data
	  * given in the configuration file, you can do what you need with
	  * it (convert it, munge it, send it to extraterrestrial life forms
	  * for probing) and feed the appropriate value into the variable
	  * pointed to by the variable pointer.
	  */
	 class VariableHandler : public Handler {
	  protected:
	    //! Default constructor
	    VariableHandler(void)
	      {};

	  public:
	    //! Destructor
	    virtual ~VariableHandler(void)
	      {};

	  private:
	    //! Process function
	    virtual const bool process(void) = 0;
	    
	    //! Validity function
	    virtual const bool check(void) const
	      { return true; /* Presume OK */ };
	    
	  public:
	    //! The handler
	    virtual const bool handle(void)
	      { return false; /* !!! */ };
	 }; // class VariableHandler
      }; // namespace Config
   }; // namespace Util
}; // namespace AIS

#endif // _INCLUDE_LIBAISUTIL_CONFIG_VAR_HANDLER_H_

--- NEW FILE: errors.h ---
/* $Id: errors.h,v 1.1 2004/12/31 22:58:06 pickle Exp $
 *
 * Copyright (c) 2004 Alien Internet Services
 *
 * This file is a part of LibAISutil.
 * 
 * LibAISutil is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * LibAISutil is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LibAISutil; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _INCLUDE_LIBAISUTIL_CONFIG_ERRORS_H_
# define _INCLUDE_LIBAISUTIL_CONFIG_ERRORS_H_ 1

# include <string>

namespace AIS {
   namespace Util {
      namespace Config {
	 //! List of errors
	 namespace Errors {
	    enum errorCode_type {
	       Informational	= 0x0000, //!< Informational notice (not error)
		 
	       OutOfRange	= 0x0100, //!< Out of range error
	       BelowRange	= 0x0101, //!< Out of range: Below minimum
	       AboveRange	= 0x0102, //!< Out of range: Above minimum
	    
	       UnknownError	= 0xFFFF  //!< Unknown error
	    };
	 };
	 
	 
	 /*!
	  * \brief Error handler functoid
	  * 
	  */
	 class ErrorReporter {
	  protected:
	    //! Default constructor
	    ErrorReporter(void)
	      {};

	  public:
	    //! Destructor
	    virtual ~ErrorReporter(void)
	      {};
	    
	    
	    //! Reporting mechanism
	    virtual void report(const unsigned int LineNumber,
				const Errors::errorCode_type errorCode,
				const std::string& report)
	      {};
	 }; // class ErrorReporter
      }; // namespace Config
   }; // namespace Util
}; // namespace AIS

#endif // _INCLUDE_LIBAISUTIL_CONFIG_ERRORS_H_

--- NEW FILE: handler.h ---
/* $Id: handler.h,v 1.1 2004/12/31 22:58:06 pickle Exp $
 *
 * Copyright (c) 2004 Alien Internet Services
 *
 * This file is a part of LibAISutil.
 * 
 * LibAISutil is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * LibAISutil is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LibAISutil; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _INCLUDE_LIBAISUTIL_CONFIG_HANDLER_H_
# define _INCLUDE_LIBAISUTIL_CONFIG_HANDLER_H_ 1

namespace AIS {
   namespace Util {
      namespace Config {
	 /*!
	  * \brief Configuration data handler functoid base class
	  * 
	  */
	 class Handler {
	  protected:
	    //! Default constructor
	    Handler(void)
	      {};

	  public:
	    //! Destructor
	    virtual ~Handler(void)
	      {};
	 }; // class Handler
      }; // namespace Config
   }; // namespace Util
}; // namespace AIS

#endif // _INCLUDE_LIBAISUTIL_CONFIG_HANDLER_H_

--- parser.h DELETED ---

--- data.h DELETED ---

--- NEW FILE: definitions.h ---
/* $Id: definitions.h,v 1.1 2004/12/31 22:58:06 pickle Exp $
 *
 * Copyright (c) 2002,2003,2004 Alien Internet Services
 *
 * This file is a part of LibAISutil.
 * 
 * LibAISutil is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * LibAISutil is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LibAISutil; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _INCLUDE_LIBAISUTIL_CONFIG_DEFINITIONS_H_
# define _INCLUDE_LIBAISUTIL_CONFIG_DEFINITIONS_H_ 1

# include <aisutil/config/var-handler.h>
# include <aisutil/config/seg-handler.h>

namespace AIS {
   namespace Util {
      namespace Config {
	 // Forward declaration of the Definition structure for typedefs
	 struct Definition;
	 
	 /*!
	  * \brief A table of definitions
	  * 
	  * This is a type definition for a table of configuration file
	  * definitions, used to provide a complete picture of which labels
	  * apply to what data within the data segment.
	  */
	 typedef Definition defTable_type[];
	 
	 //! A pointer to a table of definitions
	 typedef Definition* const defTable_ptr;

	 
	 /*! Definition table structure.
	  * 
	  * USAGE NOTE:
	  * 
	  * When defining a list of these structures (a definition table) you can
	  * tune your table to be easier for people to use by specifying an
	  * appropriate number of 'relevant characters' out of the name for
	  * scanning. For example the definition name "NICKNAME" could be
	  * written short-hand as "NICK" (4 relevant characters) as long as there
	  * aren't any other names in the definition table starting with "NICK".
	  * This can become a time-saver for users.
	  * 
	  * While using this structure a definition can be a segment or a variable, 
	  * or even both. Functionality is determined by which values are present 
	  * as dictated below.
	  * 
	  * If defTable is present (!= NULL) when called as a segment, the array 
	  * which it points to will be used. If the segmentHandler is also present, 
	  * it will be called prior to switching into that table. If the return
	  * value of the handler is false the switch into that table will not be 
	  * made.
	  * 
	  * If BOTH variableHandler are present (!= NULL) when called as a 
	  * variable, the handler will be called to 'handle' the given variable
	  * pointer. If the handler returns false, the parsing process will 
	  * continue but with a warning given to the user. Note that if you are 
	  * using a custom handler you will have to type-cast the void *.
	  * 
	  * When used within a table, the last entry must have a NULL for the name
	  * variable, however the other variables in this structure can be used 
	  * and will act like a 'default' entry, or 'if not found, use this' 
	  * entry for segments which are just lists, or have sub-segments which
	  * variable names etc.
	  */
	 struct Definition {
	    //! Name of definition
	    const char* const name;

	    //! Relevant chars in name
	    const unsigned int relevantChars;

	    
	    //! Data pointer
	    const void* variablePtr;

	    //! Handler (variable)
	    const VariableHandler* variableHandler;


	    //! Table (segment)
	    const defTable_ptr defTable;

	    //! Handler (segment)
	    const SegmentHandler* segmentHandler;
	 }; // struct Definition
      }; // namespace Config
   }; // namespace Util
}; // namespace AIS

#endif // _INCLUDE_LIBAISUTIL_CONFIG_DEFINITIONS_H_

--- NEW FILE: seg-handler.h ---
/* $Id: seg-handler.h,v 1.1 2004/12/31 22:58:06 pickle Exp $
 *
 * Copyright (c) 2004 Alien Internet Services
 *
 * This file is a part of LibAISutil.
 * 
 * LibAISutil is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * LibAISutil is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LibAISutil; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _INCLUDE_LIBAISUTIL_CONFIG_SEG_HANDLER_H_
# define _INCLUDE_LIBAISUTIL_CONFIG_SEG_HANDLER_H_ 1

# include <aisutil/config/handler.h>

namespace AIS {
   namespace Util {
      namespace Config {
	 /*!
	  * \brief Configuration data segment handler functoid base class
	  *
	  * This functiod is designed for handling transitions into (and
	  * subsequently out of) configuration segments.
	  * 
	  * Normally, you will not need to use one of these, because common
	  * segment handlers are provided by the library. However, there are
	  * instances where you need a fairly intuitive interface to a
	  * specific variable and a fake-segment with the data inside being
	  * processed in a specific way is often a great way do it from a
	  * user's perspective.
	  * 
	  * Segment handlers can serve two purposes:
	  *   - Initialisation of something (such as a variable) prior to
	  *     the configuration process continuing to load.
	  *   - The handling of the data within the two curly-braces that
	  *     contain that particular segment.
	  * 
	  * In the case of the latter, you must have a plan in effect for
	  * handling any nested segments (they are now your responsibility).
	  * 
	  * You must return with the position indicator pointing at the
	  * position of the terminating curly-brace ('}') of that segment.
	  */
	 class SegmentHandler : public Handler {
	  protected:
	    //! Default constructor
	    SegmentHandler(void)
	      {};

	  public:
	    //! Destructor
	    virtual ~SegmentHandler(void)
	      {};


	    //! The handler
	    virtual const bool handle(void)
	      { return false; /* !!! */ };
	 }; // class SegmentHandler
      }; // namespace Config
   }; // namespace Util
}; // namespace AIS

#endif // _INCLUDE_LIBAISUTIL_CONFIG_SEG_HANDLER_H_

2003	Jan	Feb	Mar (84)	Apr (41)	May (8)	Jun	Jul (85)	Aug (81)	Sep	Oct (4)	Nov (6)	Dec
2004	Jan	Feb	Mar	Apr	May	Jun	Jul (3)	Aug (8)	Sep	Oct	Nov	Dec (7)

libais-dev-cvs Mailing List for Alien Internet Services Library

libais-dev-cvs — LibAIS CVS commits