CConfigFile.h

Go to the documentation of this file.

/* +---------------------------------------------------------------------------+
   |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
   |                                                                           |
   |                       http://www.mrpt.org/                                |
   |                                                                           |
   |   Copyright (C) 2005-2012  University of Malaga                           |
   |                                                                           |
   |    This software was written by the Machine Perception and Intelligent    |
   |      Robotics Lab, University of Malaga (Spain).                          |
   |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
   |                                                                           |
   |  This file is part of the MRPT project.                                   |
   |                                                                           |
   |     MRPT 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 3 of the License, or     |
   |     (at your option) any later version.                                   |
   |                                                                           |
   |   MRPT 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 MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
   |                                                                           |
   +---------------------------------------------------------------------------+ */
#ifndef  CConfigFile_H
#define  CConfigFile_H

#include <mrpt/utils/utils_defs.h>
#include <mrpt/utils/CConfigFileBase.h>
#include <mrpt/utils/safe_pointers.h>

/*---------------------------------------------------------------
        Class
  ---------------------------------------------------------------*/
namespace mrpt
{
namespace utils
{
        /** This class allows loading and storing values and vectors of different types from ".ini" files easily.
          *  The contents of the file will be modified by "write" operations in memory, and will be saved back
          *   to the file at the destructor, and only if at least one write operation has been applied.
         * \ingroup mrpt_base_grp
          */
        class BASE_IMPEXP CConfigFile : public CConfigFileBase
        {
        private:
                /** The name of the file
                  */
                std::string             m_file;

                /** The interface to the file:
                  */
                void_ptr_noncopy m_ini;

                /** If modified since load.
                  */
                bool                    m_modified;

        protected:
                /** A virtual method to write a generic string.
                  */
                void  writeString(const std::string &section,const std::string &name, const std::string &str);

                /** A virtual method to read a generic string.
         * \exception std::exception If the key name is not found and "failIfNotFound" is true. Otherwise the "defaultValue" is returned.
                 */
                std::string  readString(
            const std::string &section,
            const std::string &name,
            const std::string &defaultStr,
            bool failIfNotFound = false) const;

        public:
                /** Constructor that opens a configuration file. */
                CConfigFile( const std::string &fileName );

                /** Constructor, does not open any file. You should call "setFileName" before reading or writting or otherwise nothing will be read and write operations will be eventually lost.
                  * However, it's perfectly right to use this object without an associated file, in which case it will behave as an "in-memory" file.
                  */
                CConfigFile();

        /** Associate this object with the given file, so future read/write operations will be applied to that file (it's synchronized at destruction).
          */
                void setFileName(const std::string &fil_path);

        /** Dumps the changes to the physical configuration file now, not waiting until destruction. */
                void writeNow();

        /** Returns the file currently open by this object.
          */
                std::string getAssociatedFile() const { return m_file; }

                /** Destructor
                  */
        virtual ~CConfigFile();

                /** Returns a list with all the section names.
                  */
                virtual void getAllSections( vector_string      &sections ) const;

                /** Returs a list with all the keys into a section.
                  */
                virtual void getAllKeys( const std::string section, vector_string       &keys ) const;

        }; // End of class def.

        } // End of namespace
} // end of namespace
#endif