xini.h

Go to the documentation of this file.

/*
 *              xini.h
 *
 *      Copyright 2009 - 2017 Brenton Ross
 *
 *      This file is part of SASSY.
 *
 *   SASSY 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.
 *
 *   SASSY 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 SASSY.  If not, see <http://www.gnu.org/licenses/>.
 */

/*
Ini file, XML format, loaded by looking in the following locations:

        P = path provided on the command line.
        E = path provided in the environment
        C = the current working directory
        H = the user's home directory
        D = directories as listed

Containing application must provide a string containing the
keys for the above search locations: eg
const string ini::config = "PECHD:-i:QM_CONF:qmd.xml:.qmd.xml:/etc/qmd/qmd.xml";

The above will first look for a command line parameter following -i,
then it will look in the environment for a variable QM_CONF,
then in the current directory for a file called qmd.xml,
then for a file $HOME/.qmd.xml, and finally for /etc/qmd/qmd.xml

Any further paths added at the end are checked in sequence.
*/

#ifndef CFI_XINI_H
#define CFI_XINI_H

#include "xml.h"

class XiniTestCase;

namespace SASSY
{

namespace cfi
{


class XINI : private Xml
{
        friend class ::XiniTestCase;
protected:
        // static XINI *me;                     ///< pointer to single instance of class.
        static int argc;                        
        static char ** argv;            
        static Path configFile;         
        XINI();         

        static const std::string config;

private:

        SASSY::Path searchConfigPath( csr conf);

public:

        static void configure(const Path &p);


        static void configure( int c, char ** v );

        static XINI & instance();


        bool getVal( const std::string & xpath_expression, std::string &val );


        int getVals( const std::string & xpath_expr, std::vector< std::string > &results );


        void getPath( const std::string & xpath_expr, SASSY::Path &path );


        const Path & getConfigFilename() const;
};

} // namespace cfi
} // end namespce SASSY


#endif /* XINI_H_ */