EnvVars.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005 Novell, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Novell, Inc., nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS 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 Novell, Inc., OR THE 
* CONTRIBUTORS 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 BLOCXX_ENVVARS_HPP__
#define BLOCXX_ENVVARS_HPP__

#include "blocxx/BLOCXX_config.h"
#include "blocxx/Map.hpp"
#include "blocxx/String.hpp"
#include "blocxx/Cstr.hpp"

namespace BLOCXX_NAMESPACE
{

class BLOCXX_COMMON_API EnvVars
{
public:
   typedef Map<String, String>   EnvMap;
   typedef EnvMap::const_iterator   const_iterator;

   enum EEnvVarFlag
   {
      E_CURRENT_ENVIRONMENT,
      E_EMPTY_ENVIRONMENT
   };

   EnvVars(EEnvVarFlag flag=E_EMPTY_ENVIRONMENT);
   template <class InputIterator>
   inline EnvVars(EEnvVarFlag flag,
                  InputIterator first, InputIterator last)
      : m_envMap()
      , m_envp(0)
   {
      if( flag == E_CURRENT_ENVIRONMENT)
         fillEnvMap(m_envMap);
      for( ; first != last; ++first)
         setVar(first->first.c_str(), first->second.c_str());
   }
   EnvVars(const char* const envp[]);
   EnvVars(const EnvVars& arg);
   ~EnvVars();
   EnvVars& operator= (const EnvVars& arg);
   const char* const* getenvp() const;
   size_t size() const
   {
      return m_envMap.size();
   }
   String getValue(const String& key, const String& notFoundRetVal=String()) const;

   bool removeVar(const String& key);

   bool setVar(const String& keyValue);

   bool setVar(const String& key, const String& value);

   bool addVar(const String& name, const String& value);

   bool updateVar(const String& name, const String& value);

   const_iterator begin() const
   {
      return m_envMap.begin();
   }

   const_iterator end() const
   {
      return m_envMap.end();
   }

private:
   void deleteEnvp() const;
   static void fillEnvMap(EnvMap& envMap);
   static void fillEnvMap(const char* const envp[], EnvMap& envMap);

   EnvMap m_envMap;
   mutable char** m_envp;
};

namespace Cstr
{

template <>
struct CstrArr<EnvVars>
{
   char const * const * sarr;

   CstrArr(EnvVars const & ev)
   {
      sarr = ev.getenvp();
   }
};

} // namespace Cstr


}  // End of BLOCXX_NAMESPACE

#endif   // BLOCXX_ENVVARS_HPP__