Properties.h

Go to the documentation of this file.

// -*- C++ -*-
#ifndef COIL_PROPERTIES_H
#define COIL_PROPERTIES_H


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


namespace coil
{
  class Properties
  {
  public:
    Properties(const char* key = "", const char* value = "");
    
    Properties(std::map<std::string, std::string>& defaults);
    
    Properties(const char* defaults[], long num = LONG_MAX);
    
    Properties(const Properties& prop);
    
    Properties& operator=(const Properties& prop);
    
    virtual ~Properties(void);
    
    //============================================================
    // public functions
    //============================================================
    
    inline const char* getName(void) const          {return name.c_str();}
    
    inline const char* getValue(void) const         {return value.c_str();}
    
    inline const char* getDefaultValue(void) const {return default_value.c_str();}
    
    inline const std::vector<Properties*>& getLeaf(void) const {return leaf;}
    
    inline const Properties* getRoot(void) const    {return root;}
    
    const std::string& getProperty(const std::string& key) const;
    
    const std::string& getProperty(const std::string& key,
                                   const std::string& def) const;
    
    const std::string& operator[](const std::string& key) const;
    
    std::string& operator[](const std::string& key);
    
    const std::string& getDefault(const std::string& key) const;
    
    std::string setProperty(const std::string& key, const std::string& value);
    
    std::string setDefault(const std::string& key, const std::string& value);
    
    void setDefaults(const char* defaults[], long num = LONG_MAX);
    
    //============================================================
    // load and save functions
    //============================================================
    void list(std::ostream& out);
    
    void load(std::istream& inStream);
    
    void save(std::ostream& out, const std::string& header);
    
    void store(std::ostream& out, const std::string& header);
    
    //============================================================
    // other util functions
    //============================================================
    std::vector<std::string> propertyNames(void) const;
    
    int size(void) const;
    
    Properties* const findNode(const std::string& key) const;
    Properties& getNode(const std::string& key);
    
    bool createNode(const std::string& key);
    
    Properties* removeNode(const char* leaf_name);
    
    Properties* hasKey(const char* key) const;
    
    void clear(void);
    
    Properties& operator<<(const Properties& prop);
    
  protected:
    static void splitKeyValue(const std::string& str, std::string& key,
                              std::string& value);
    
    static bool split(const std::string& str, const char delim,
                      std::vector<std::string>& value);
    
    static Properties* _getNode(std::vector<std::string>& keys,
                                std::vector<Properties*>::size_type index,
                                const Properties* curr);
    
    static void _propertiyNames(std::vector<std::string>& names,
                                std::string curr_name,
                                const Properties* curr);
    
    static void _store(std::ostream& out, std::string curr_name,
                       Properties* curr);
    
    static std::ostream& _dump(std::ostream& out, const Properties& curr,
                               int index);
    
    static std::string indent(int index);
    
  private:
    std::string name;
    std::string value;
    std::string default_value;
    Properties* root;
    std::vector<Properties*> leaf;
    const std::string m_empty;

    friend std::ostream& operator<<(std::ostream& lhs, const Properties& rhs);

  };   // class Properties
};     // namespace coil  
#endif // COIL_PROPERTIES_H