Parameter.h

Go to the documentation of this file.

/***************************************************************************
 *   (c) Jürgen Riegel (juergen.riegel@web.de) 2002                        *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Library General Public License (LGPL)   *
 *   as published by the Free Software Foundation; either version 2 of     *
 *   the License, or (at your option) any later version.                   *
 *   for detail see the LICENCE text file.                                 *
 *                                                                         *
 *   FreeCAD 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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with FreeCAD; if not, write to the Free Software        *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
 *   USA                                                                   *
 *                                                                         *
 *   Juergen Riegel 2002                                                   *
 ***************************************************************************/


#ifndef BASE__PARAMETER_H
#define BASE__PARAMETER_H

// (re-)defined in pyconfig.h
#if defined (_POSIX_C_SOURCE)
#   undef    _POSIX_C_SOURCE
#endif
#if defined (_XOPEN_SOURCE)
#   undef    _XOPEN_SOURCE
#endif

// Include files
#include <Python.h>
#ifdef FC_OS_LINUX
#include <sstream>
#endif
#include <map>
#include <vector>
#include <xercesc/util/XercesDefs.hpp>

// Std. configurations
#include "Handle.h"
#include "Observer.h"

#ifdef _MSC_VER
#       pragma warning( disable : 4251 )
#       pragma warning( disable : 4503 )
#       pragma warning( disable : 4786 )  // specifier longer then 255 chars
#       pragma warning( disable : 4290 )  // not implemented throw specification
#       pragma warning( disable : 4275 )
#endif


XERCES_CPP_NAMESPACE_BEGIN
class DOMNode;
class DOMElement;
class DOMDocument;
XERCES_CPP_NAMESPACE_END

class ParameterManager;


class  BaseExport ParameterGrp  : public Base::Handled,public Base::Subject <const char*>
{


public:

    void copyTo(Base::Reference<ParameterGrp>);
    void insertTo(Base::Reference<ParameterGrp>);
    void exportTo(const char* FileName);
    void importFrom(const char* FileName);
    void insert(const char* FileName);


    Base::Reference<ParameterGrp> GetGroup(const char* Name);
    std::vector<Base::Reference<ParameterGrp> > GetGroups(void);
    bool IsEmpty(void) const;
    bool HasGroup(const char* Name) const;
    typedef Base::Reference<ParameterGrp> handle;
    void RemoveGrp(const char* Name);
    void Clear(void);


    bool GetBool(const char* Name, bool bPreset=false) const;
    void SetBool(const char* Name, bool bValue);
    std::vector<bool> GetBools(const char * sFilter = NULL) const;
    std::vector<std::pair<std::string,bool> > GetBoolMap(const char * sFilter = NULL) const;
    void RemoveBool(const char* Name);


    long GetInt(const char* Name, long lPreset=0) const;
    void SetInt(const char* Name, long lValue);
    std::vector<long> GetInts(const char * sFilter = NULL) const;
    std::vector<std::pair<std::string,long> > GetIntMap(const char * sFilter = NULL) const;
    void RemoveInt(const char* Name);


    unsigned long GetUnsigned(const char* Name, unsigned long lPreset=0) const;
    void SetUnsigned(const char* Name, unsigned long lValue);
    std::vector<unsigned long> GetUnsigneds(const char * sFilter = NULL) const;
    std::vector<std::pair<std::string,unsigned long> > GetUnsignedMap(const char * sFilter = NULL) const;
    void RemoveUnsigned(const char* Name);



    double GetFloat(const char* Name, double dPreset=0.0) const;
    void SetFloat(const char* Name, double dValue);
    std::vector<double> GetFloats(const char * sFilter = NULL) const;
    std::vector<std::pair<std::string,double> > GetFloatMap(const char * sFilter = NULL) const;
    void RemoveFloat(const char* Name);



    void  SetBlob(const char* Name, void *pValue, long lLength);
    void GetBlob(const char* Name, void * pBuf, long lMaxLength, void* pPreset=NULL) const;
    void RemoveBlob(const char* Name);




    void  SetASCII(const char* Name, const char *sValue);
    std::string GetASCII(const char* Name, const char * pPreset=NULL) const;
    void RemoveASCII(const char* Name);
    std::vector<std::string> GetASCIIs(const char * sFilter = NULL) const;
    std::vector<std::pair<std::string,std::string> > GetASCIIMap(const char * sFilter = NULL) const;

    static void Init(void);

    friend class ParameterManager;

    const char* GetGroupName(void) const {
        return _cName.c_str();
    }

    void NotifyAll();

protected:
    ParameterGrp(XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *GroupNode=0L,const char* sName=0L);
    ~ParameterGrp();
    Base::Reference<ParameterGrp> _GetGroup(const char* Name);

    XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *FindNextElement(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *Prev, const char* Type) const;

    XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *FindElement(XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *Start, const char* Type, const char* Name=0L) const;

    XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *FindOrCreateElement(XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *Start, const char* Type, const char* Name) const;


    XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *_pGroupNode;
    std::string _cName;
    std::map <std::string ,Base::Reference<ParameterGrp> > _GroupMap;

};


class BaseExport ParameterManager       : public ParameterGrp
{
public:
    ParameterManager();
    ~ParameterManager();
    static void Init(void);

    int   LoadDocument(const char* sFileName);

    bool  LoadOrCreateDocument(const char* sFileName);

    void  SaveDocument(const char* sFileName) const;

    void  CreateDocument(void);

    void  CheckDocument() const;

private:

    XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument   *_pDocument;

    bool          gDoNamespaces         ;
    bool          gDoSchema             ;
    bool          gSchemaFullChecking   ;
    bool          gDoCreate             ;


    const XMLCh*  gOutputEncoding       ;
    const XMLCh*  gMyEOLSequence        ;

    bool          gSplitCdataSections   ;
    bool          gDiscardDefaultContent;
    bool          gUseFilter            ;
    bool          gFormatPrettyPrint    ;

};

BaseExport PyObject* GetPyObject( const Base::Reference<ParameterGrp> &hcParamGrp);


#endif // BASE__PARAMETER_H