DynamicProperty.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (c) 2009 Werner Mayer <wmayer[at]users.sourceforge.net>     *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Library General Public           *
 *   License as published by the Free Software Foundation; either          *
 *   version 2 of the License, or (at your option) any later version.      *
 *                                                                         *
 *   This library  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 this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/


#pragma once

#include <Base/Persistence.h>
#include <map>
#include <vector>
#include <string>

namespace Base {
class Writer;
class XMLWriter;
}

namespace Core
{
class Property;
class PropertyContainer;
class DynamicPropertyP;

struct CStringHasher {
    inline std::size_t operator()(const char *s) const {
        if(!s) return 0;
        return boost::hash_range(s,s+std::strlen(s));
    }
    inline bool operator()(const char *a, const char *b) const {
        if(!a) return !b;
        if(!b) return false;
        return std::strcmp(a,b)==0;
    }
};

class LX_CORE_EXPORT DynamicProperty
{
public:
    DynamicProperty();
    virtual ~DynamicProperty();

    void getPropertyList(std::vector<Property*> &List) const;
    void getPropertyMap(std::map<std::string,Property*> &Map) const;
    Property *getDynamicPropertyByName(const char* name) const;
    Property* addDynamicProperty(PropertyContainer &pc, const char* type, const char* name=0, const char* group=0,
                                 const char* doc=0, short attr=0, bool ro=false, bool hidden=false);
    bool addProperty(Property *prop);
    bool removeDynamicProperty(const char* name);
    bool removeProperty(const Property *prop);
    std::vector<std::string> getDynamicPropertyNames() const;
    const char* getPropertyName(const Property* prop) const;

    short getPropertyType(const Property* prop) const;
    short getPropertyType(const char *name) const;
    const char* getPropertyGroup(const Property* prop) const;
    const char* getPropertyGroup(const char *name) const;
    const char* getPropertyDocumentation(const Property* prop) const;
    const char* getPropertyDocumentation(const char *name) const;

    void clear();

    size_t size() const;

    void save(const Property *prop, Base::AbstractWriter& writer, Base::PersistenceVersion& version);

    Property *restore(PropertyContainer &pc, 
        const char *PropName, const char *TypeName, Base::AbstractXMLReader& reader, Base::PersistenceVersion& version);

#ifndef SWIG
    struct PropData {
        Property* property;
        std::string name;
        const char *pName;
        std::string group;
        std::string doc;
        short attr;
        bool readonly;
        bool hidden;

        PropData(Property *prop=0, std::string &&n=std::string(), const char *pn=0,
                const char *g=0, const char *d=0, short a=0, bool ro=false, bool h=false)
            :property(prop),name(std::move(n)),pName(pn)
            ,group(g?g:""),doc(d?d:""),attr(a),readonly(ro),hidden(h)
        {}

        const char *getName() const {
            return pName?pName:name.c_str();
        }
    };

    PropData getDynamicPropertyData(const Property* prop) const;
#endif
private:
    std::string getUniquePropertyName(PropertyContainer &pc, const char *Name) const;

private:
    std::unique_ptr<DynamicPropertyP> mPimpl;    
};

} // namespace Core