Home

C-Bits Package Documentation

Project Page

---

         

---

PropertyList.h

Go to the documentation of this file.

/* ====================================================================
 *              The CBITS Software License, Version 1.0
 *
 *               Copyright (c) 2002-2003 Bruce Lowery
 *                       All rights reserved
 *
 * Redistribution and use of this software, in source and binary forms, 
 * with or without modification, are permitted provided that the above 
 * copyright notice, this paragraph, and the following paragraph are 
 * retained in each source code file.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL BRUCE LOWERY OR OTHER CONTRIBUTORS 
 * TO THE CBITS LIBRARY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 */
#ifndef __PROPERTYLIST_H__
#define __PROPERTYLIST_H__

#include <map>
#include <string>
#include <vector>

namespace cbits
{

class PropertyList
{

public:

    static PropertyList& getPropertyList
    ( 
        const std::string& name 
    );


    static void removePropertyList
    ( 
        const std::string& name 
    );


    static void removeAll();


    static int getNumPropertyLists();


    static const bool exists
    ( 
        const std::string& name 
    );


    void setProperty
    ( 
        const std::string & property_name, 
        const std::string & property_value 
    );


    const char * getProperty
    ( 
        const std::string & property_name 
    );


    const bool isSet
    ( 
        const char* name 
    );


    const int getNumProperties() const;


    std::vector< std::string > & getValues( void );


    std::vector< std::string > & getKeys( void );


    void removeProperties();


    const bool readPropertyList
    ( 
        std::istream& prop_stream,
        const bool override  =  true,
        const char nv_delim  =  '=', 
        const char cmt_delim =  '#' 
    );


    const bool readFile
    ( 
        const char* const path, 
        const bool override  =  true,
        const char nv_delim  =  '=', 
        const char cmt_delim =  '#' 
    );


    const bool writePropertyList 
    (
        std::ostream& os,
        const char delim = '='
    ) const;


    const int readCommandLine
    (
        const int argc, 
        const char* const * argv,
        const bool override = true,
        const char delim = '='
    );


    static std::string trim
    ( 
        const std::string& line 
    );



private:

    std::map< std::string, std::string > _properties;
    std::vector< std::string > _values;
    std::vector< std::string > _keys;
protected: 

    PropertyList();

    static std::map< std::string, PropertyList* >& getSets();


private:

    /* Holds property sets */
    static std::map< std::string, PropertyList* > _sets;


    /* This iterator is used internally */
    typedef std::map<std::string,std::string>::const_iterator PITERATOR;
    PropertyList( const PropertyList& );
    PropertyList& operator=( const PropertyList& );
}; /* END OF CLASS PropertyList */


}; /* END OF NAMESPACE cbits */

#endif /* PropertyList_H */

/*
 * $Id: PropertyList.h,v 1.5 2002/10/16 02:47:20 brulow Exp $
 *
 * History: (Add nothing manually below)
 * -----------------------------------------------------------------------
 *
 * $Log: PropertyList.h,v $
 * Revision 1.5  2002/10/16 02:47:20  brulow
 * build libs with compiler instead of raw 'ld'.
 *
 * Revision 1.4  2002/10/09 02:02:26  brulow
 * Improve package documentation
 *
 * Revision 1.3  2002/10/08 17:11:20  brulow
 * Improve documentation
 *
 * Revision 1.2  2002/10/04 20:04:20  brulow
 * Enhance interface
 *
 * Revision 1.1  2002/10/03 16:04:47  brulow
 * Add
 *
 *
 */

---

Generated by

Hosted by