INIFile.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper 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 Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision: 6727 $                                                         *
 *   $Author: moebius $                                                      *
 *   $Date: 2009-08-05 08:03:50 +0200 (Mi, 05. Aug 2009) $                   *
 *                                                                           *
\*===========================================================================*/




#ifndef TOOLS_INIFILE_HH
#define TOOLS_INIFILE_HH

#include <OpenFlipper/common/GlobalDefines.hh>
#include <QString>
#include <QFile>
#include <map>
#include <vector>



class DLLEXPORT INIFile
{
public :

    INIFile();

    ~INIFile();

    bool connect( const QString& name,
                  const bool create );

    void disconnect();

    bool is_connected() const { return mf_isConnected; }

    const QString& name() const { return m_filename; }


    // ---------------------------------------- check if something is there


    bool section_exists(const QString & _section) const;

    bool entry_exists(const QString & _section, const QString & _key) const;

    bool entry_in_section(const QString & _section,
                          const QString & _key) const
        { return entry_exists( _section, _key ); }

    // ---------------------------------------- section manipulation


    /* \deprecated This function is not needed any more. New sections are
       implicitly created upon calls to add_entry().
    */
    void add_section(const QString & _sectionname);

    void add_entry( const QString & _section,
                    const QString & _key,
                    const QString & _value );

    void add_entry( const QString & _section,
                  const QString & _key,
                  const char * _value )
        { add_entry( _section, _key, QString(_value) ); }

    void add_entry( const QString & _section,
                    const QString & _key,
                    const double & _value);

    void add_entry( const QString & _section,
                    const QString & _key,
                    const float & _value);

    void add_entry( const QString & _section,
                    const QString & _key ,
                    const int & _value);

    void add_entry( const QString & _section,
                    const QString & _key ,
                    const unsigned int & _value);

    void add_entry( const QString & _section,
                    const QString & _key ,
                    const bool & _value);

    void add_entry( const QString & _section,
                    const QString & _key ,
                    const std::vector<float> & _value);

    void add_entry( const QString & _section,
                    const QString & _key ,
                    const std::vector<double> & _value);

    template < typename VectorT >
    void add_entryVec ( const QString & _section,
                        const QString & _key,
                        const VectorT  & _value);

    template < typename VectorT >
    void add_entryVec ( const QString & _section,
                        const QString & _key,
                        const std::vector< VectorT > & _value);

    void add_entry( const QString & _section,
          const QString & _key ,
          const std::vector<int> & _value);

    void add_entry( const QString & _section,
          const QString & _key ,
          const std::vector<QString> & _value);

    void add_entry( const QString & _section,
          const QString & _key ,
          const QStringList & _value);




    // -------------------- delete


    void delete_entry( const QString & _section, const QString & _key);

    void delete_section( const QString & _sectionname );




    // -------------------- retrieval


    bool get_entry( QString & _val,
                    const QString & _section,
                    const QString & _key ) const;

    bool get_entry( double & _val,
                    const QString & _section,
                    const QString & _key ) const;

    bool get_entry( float & _val,
                    const QString & _section,
                    const QString & _key ) const;

    bool get_entry( int & _val,
                    const QString & _section,
                    const QString & _key ) const;

    bool get_entry( unsigned int & _val,
                    const QString & _section,
                    const QString & _key ) const;

    bool get_entry( bool & _val,
                    const QString & _section,
                    const QString & _key) const;

    bool get_entry( std::vector<float> & _val,
                    const QString & _section,
                    const QString & _key) const;

    bool get_entry( std::vector<double> & _val,
                    const QString & _section,
                    const QString & _key) const;

    bool get_entry( std::vector<int> & _val,
          const QString & _section,
          const QString & _key) const;

    bool get_entry( std::vector<QString> & _val,
          const QString & _section,
          const QString & _key ) const;

    bool get_entry( QStringList & _val,
          const QString & _section,
          const QString & _key ) const;

    template < typename VectorT >
    bool get_entryVecd ( VectorT & _val ,
                         const QString & _section,
                         const QString & _key ) const;

    template < typename VectorT >
    bool get_entryVecf ( VectorT & _val ,
                         const QString & _section,
                         const QString & _key ) const;

    template < typename VectorT >
    bool get_entryVeci ( VectorT & _val ,
                         const QString & _section,
                         const QString & _key ) const;

    template < typename VectorT >
    bool get_entryVecd (std::vector< VectorT > & _val ,
                       const QString & _section,
                       const QString & _key ) const;

    template < typename VectorT >
        bool get_entryVecf (std::vector< VectorT > & _val ,
                           const QString & _section,
                           const QString & _key ) const;

    template < typename VectorT >
    bool get_entryVeci (std::vector< VectorT > & _val ,
                        const QString & _section,
                        const QString & _key ) const;


private: // data


    typedef std::map< QString, QString > EntryMap;


    typedef std::map< QString, EntryMap > SectionMap;



    bool parseFile( QFile & _inputStream );

    bool writeFile( void );

    QString m_filename;

    bool mf_isConnected;


    SectionMap m_iniData;
};


#if defined(INCLUDE_TEMPLATES) && !defined(INIFILE_C)
#define INIFILE_TEMPLATES
#include "INIFileT.cc"
#endif

#endif