xnode.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program 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 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef XNODE_H_
#define XNODE_H_
 
#include <variant>
 
// quiet the deprecated warnings with 3 lines:
#include <wx/defs.h>
#undef wxDEPRECATED
#define wxDEPRECATED(x) x
 
#include <wx/xml/xml.h>
#include <kicommon.h>
 
class OUTPUTFORMATTER;
class KIID;
 

class KICOMMON_API XATTR : public wxXmlAttribute
{
public:
    typedef std::variant<wxString, int, double> VALUE_TYPE;
 
    XATTR()
    {}
 
    XATTR( const wxString& aName, const VALUE_TYPE& aValue );
 
    void SetValue( const VALUE_TYPE& aValue ) { m_originalValue = aValue; }
 
    VALUE_TYPE GetValue() const { return m_originalValue; }
 
private:
    VALUE_TYPE m_originalValue;
};

class KICOMMON_API XNODE : public wxXmlNode
{
public:
    XNODE() :
        wxXmlNode()
    {
    }
 
    XNODE( wxXmlNodeType aType, const wxString& aName, const wxString& aContent = wxEmptyString ) :
        wxXmlNode( nullptr, aType, aName, aContent )
    {
    }
 
    XNODE( XNODE* aParent, wxXmlNodeType aType, const wxString& aName,
           const wxString& aContent = wxEmptyString, XATTR* aProperties = nullptr ) :
        wxXmlNode( aParent, aType, aName, aContent, aProperties )
    {
    }
 
    void AddAttribute( const wxString& aName, const wxString& aValue ) override;
 
    void AddAttribute( const wxString& aName, int aValue );
 
    void AddAttribute( const wxString& aName, double aValue );
 
    void AddAttribute( wxXmlAttribute* aAttr ) override
    {
        wxASSERT_MSG( dynamic_cast<XATTR*>( aAttr ), "use XATTR instead of wxXmlAttribute!" );
        return wxXmlNode::AddAttribute( aAttr );
    }
 
    XNODE* GetChildren() const
    {
        return static_cast<XNODE*>( wxXmlNode::GetChildren() );
    }
 
    XNODE* GetNext() const
    {
        return static_cast<XNODE*>( wxXmlNode::GetNext() );
    }
 
    XNODE* GetParent() const
    {
        return static_cast<XNODE*>( wxXmlNode::GetParent() );
    }
 
    void AddBool( const wxString& aKey, bool aValue );

    void Format( OUTPUTFORMATTER* out ) const;

    void FormatContents( OUTPUTFORMATTER* out ) const;

    wxString Format() const;
 
};
 
#endif  // XNODE_H_