util/Property.h

Go to the documentation of this file.

/*----------------------------------------------------------------------------
Name:      Property.h
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment:   Class used to read, store & write (java) properties.
-----------------------------------------------------------------------------*/
#ifndef _UTIL_PROPERTY_H
#define _UTIL_PROPERTY_H

#include <util/xmlBlasterDef.h>
#include <map>
#include <string>

namespace org { namespace xmlBlaster {
namespace util {

   class Dll_Export Property {
      
      public: typedef std::map<std::string, std::string, std::less<std::string> > MapType;
  
   private:
      MapType properties_;
      
      std::string replaceVariable(const std::string &key, const std::string &value, bool env);

      bool setProperty_(const std::string &name, const std::string &value,
                       bool overwrite=true);

      void initializeDefaultProperties();

   protected:
      bool isComment(const std::string &line) const {
         if (line.length() == 0) return false;
         return (line.c_str()[0] == '#');
      }
      
      std::string filter(const std::string &line) const {
         std::string ret;
         for (std::string::size_type i=0; i<line.length(); i++) {
            if (line.c_str()[i] != ' ') ret += line.c_str()[i];
         }
         return ret;
      }

      
      std::pair<const std::string, std::string> getPair(const std::string &line) const {
         std::string::size_type pos = line.find("=");
         if ((pos < 2) || (pos >= line.length()) || (isComment(line)) ) {
            return std::pair<const std::string, std::string>("","");
         }
         std::string name, value;
         name.assign(line, 0, pos);
         value = line.substr(pos+1);
         return std::pair<const std::string, std::string>(filter(name), filter(value));
      }
      
      
   public:
      
      Property(int args=0, const char * const argv[]=0);

      Property(MapType propMap);

      /*
       * xmlBlaster.properties is searched in this sequence:
       * <ul>
       *    <li>the command line parameter '-propertyFile', e.g. "-propertyFile /tmp/xy.properties"</li>
       *    <li>the environment variable 'propertyFile', e.g. "propertyFile=/tmp/xy.properties"</li>
       *    <li>the local directory: ./xmlBlaster.properties</li>
       *    <li>in your home directory, HOME/xmlBlaster.properties</li>
       *    <li>in the $XMLBLASTER_HOME directory</li>
       * </ul>
       * Command line properties have precedence<p />
       * Environment variables are weakest
       */
      void loadPropertyFile();
      

      ~Property() {
         properties_.erase(properties_.begin(), properties_.end());
      }

      void replaceVariables(bool env);

      const MapType& getPropertyMap() const {
         return properties_;
      }

      int readPropertyFile(const std::string &filename, bool overwrite=true);
      

      int writePropertyFile(const char *filename) const ;


      std::string getProperty(const std::string &name, bool env=true);


      bool propertyExists(const std::string &name, bool env=true);


      int get(const std::string &name, int def) { return getIntProperty(name, def, false); }
      int getIntProperty(const std::string &name, int def, bool env=true);

      long get(const std::string &name, long def) { return getLongProperty(name, def, false); }
      long getLongProperty(const std::string &name, long def, bool env=true);

      org::xmlBlaster::util::Timestamp getTimestampProperty(const std::string &name, org::xmlBlaster::util::Timestamp def, bool env=true);

      bool get(const std::string &name, bool def) { return getBoolProperty(name, def, false); }
      bool getBoolProperty(const std::string &name, bool def, bool env=true);


      std::string get(const std::string &name, const char *def) { std::string defS=def; return getStringProperty(name, defS, false); }
      std::string get(const std::string &name, const std::string &def) { return getStringProperty(name, def, false); }
      std::string getStringProperty(const std::string &name, const std::string &def, 
                            bool env=true);

      bool getTypedProperty(const std::string& name, std::string& value, bool env=true);
      bool getTypedProperty(const std::string& name, int& value, bool env=true);
      bool getTypedProperty(const std::string& name, long& value, bool env=true);
      bool getTypedProperty(const std::string& name, bool& value, bool env=true);
#     if __LP64__
      // long === long long === 64 bit
#     else
      bool getTypedProperty(const std::string& name, org::xmlBlaster::util::Timestamp& value, bool env=true);
#     endif
        
       bool setProperty(const std::string &name, const std::string &value,
                       bool overwrite=true);
 
      int loadCommandLineProps(int args, const char * const argv[], const std::string &sep="-D", 
                    bool javaStyle=true);
      

      int findArgument(int args, const char * const argv[], const std::string &name) {
         for (int i=1; i < args; i++) {
            if (std::string(argv[i]) == name) return i;
         }
         return -1;
      }
      
      std::string toXml(const std::string& extraOffset="");

   }; // class Property

}}} // namespace

#endif // _UTIL_PROPERTY_H