osbcfgfile.h

Go to the documentation of this file.

// OSB library ************************************************ -*- C++ -*-
/*
  AUTHOR(S): Stephan Broennimann (vb)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.6 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file 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.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */
#ifndef _OSBCFGFILE_H_
#define _OSBCFGFILE_H_

// ************************************************************************
// included header files
// + standard includes
#include <fstream>
#include <string>

// + libraries

// + local headers

// + class declarations

// ************************************************************************
// namespace extensions
namespace OSB_LIB {

// ************************************************************************
// forward declarations

// ************************************************************************
// type definitions

// ************************************************************************
// class definitions
    class CfgFile {
    public:
        enum Flags {
            withComments   = 0x01,
            withEmptyLines = 0x02
        };

    public:
        static const std::string& sectionEnd();

        CfgFile();
        explicit CfgFile(const std::string& path);
        ~CfgFile();
    private:

        CfgFile(const CfgFile&);
        CfgFile& operator=(CfgFile&);

    public:
        bool open(const std::string& p);
        bool isOpen();
        void close();
        const std::ifstream& stream() const;
        bool rewind();

        int flags() const;
        void setFlags(int flags);
        bool comments() const;
        bool emptyLines() const;

        const std::string& curLine() const;
        size_t curLineNo() const;

        bool nextLine(bool applyFlags = true);
        bool gotoLine(size_t lineNo);

        bool getSection(
                  std::string& dest,
            const std::string& section,
                  size_t*      lineNo = 0
        );
        bool getValue(
                  std::string& dest,
            const std::string& section,
            const std::string& key
        );

        bool seekSection(const std::string& section);
        bool eoSection() const;
        bool seekKey(
            const std::string& section,
            const std::string& key
        );

        bool addKey(
            const std::string& section,
            const std::string& key,
            const std::string& value
        );
        bool delKey(
            const std::string& section,
            const std::string& key
        );

        void trimValue(
            std::string& value
        );

        const char* path() const;

    private:                            // data members
        std::ifstream is_;
        std::string   curLine_;
        size_t        curLineNo_;
        Flags         flags_;
        std::string   path_;

    private:                            // utility methods
        void delComment(std::string& line) const;
        bool wsOnly(const std::string& line) const;
        bool copy(
            std::ofstream& dest,
            size_t         first,
            size_t         last = (size_t)-1
        );
        bool replace(const std::string& replacePath);
    };                                  // class CfgFile
}                                       // namespace OSB_LIB

// ************************************************************************
// inline definitions
namespace OSB_LIB {
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _OSBCFGFILE_H_

---