From 2c44d8175fc825eceb63fe19af1793a1fb516dd2 Mon Sep 17 00:00:00 2001 From: Dick Hollenbeck Date: Sat, 7 Aug 2010 10:25:18 -0500 Subject: [PATCH 1/2] add XNODE and XATTR classes --- common/CMakeLists.txt | 1 + common/xnode.cpp | 70 +++++++++++++++++++++++++ eeschema/netform.cpp | 119 ++++++++++++++++++++++++++---------------- include/xnode.h | 119 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 263 insertions(+), 46 deletions(-) create mode 100644 common/xnode.cpp create mode 100644 include/xnode.h diff --git a/common/CMakeLists.txt b/common/CMakeLists.txt index 6f0ac1a57c..3402525ac8 100644 --- a/common/CMakeLists.txt +++ b/common/CMakeLists.txt @@ -53,6 +53,7 @@ set(COMMON_SRCS trigo.cpp worksheet.cpp wxwineda.cpp + xnode.cpp zoom.cpp ) diff --git a/common/xnode.cpp b/common/xnode.cpp new file mode 100644 index 0000000000..3bfb55b08d --- /dev/null +++ b/common/xnode.cpp @@ -0,0 +1,70 @@ +/* + * This program source code file is part of KICAD, a free EDA CAD application. + * + * Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck + * Copyright (C) 1992-2010 Kicad Developers, see change_log.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 + */ + + +#include "xnode.h" + +void XNODE::Format( OUTPUTFORMATTER* out, int nestLevel ) throw( IOError ) +{ + // output attributes first if they exist + + // output children if they exist. + + // output "contents" if it exists. Use quote need checker to wrap contents if needed. + + // A good XML element will not have both children AND contents, usually one or the other. + // children != attributes in the above statement. + +// for( XNODE*... +} + + +void XNODE::FormatContents( OUTPUTFORMATTER* out, int nestLevel ) throw( IOError ) +{ + // overridden in ELEM_HOLDER +} + + +void XATTR::Format( OUTPUTFORMATTER* out, int nestLevel ) throw( IOError ) +{ + // output attributes first if they exist + + // output children if they exist. + + // output "contents" if it exists. Use quote need checker to wrap contents if needed. + + // A good XML element will not have both children AND contents, usually one or the other. + // children != attributes in the above statement. + +// for( XNODE*... +} + + +void XATTR::FormatContents( OUTPUTFORMATTER* out, int nestLevel ) throw( IOError ) +{ + // overridden in ELEM_HOLDER +} + + +// EOF diff --git a/eeschema/netform.cpp b/eeschema/netform.cpp index b58ce30e9b..4ea7c3f856 100644 --- a/eeschema/netform.cpp +++ b/eeschema/netform.cpp @@ -30,7 +30,6 @@ #include "fctsys.h" -#include #include "gr_basic.h" #include "common.h" @@ -46,6 +45,8 @@ #include "class_library.h" #include "class_pin.h" +#include "xnode.h" // also nests: + #include "build_version.h" #include @@ -189,6 +190,21 @@ class EXPORT_HELP */ void writeListOfNetsCADSTAR( FILE* f, NETLIST_OBJECT_LIST& aObjectsList ); + + /** + * Function makeGenericRoot + * builds the entire document tree for the generic export. This is factored + * out here so we can write the tree in either S-expression file format + * or in XML if we put the tree built here into a wxXmlDocument. + */ + wxXmlNode* makeGenericRoot(); + + /** + * Function makeGenericComponents + * returns a sub-tree holding all the schematic components. + */ + wxXmlNode* makeGenericComponents(); + /** * Function makeGenericDesignHeader * fills out a project "design" header into an XML node. @@ -219,11 +235,11 @@ class EXPORT_HELP public: /** - * Function Write_GENERIC_NetList + * Function WriteGENERICNetList * creates a generic netlist, now in XML. * @return bool - true if there were no errors, else false. */ - bool Write_GENERIC_NetList( WinEDA_SchematicFrame* frame, const wxString& aOutFileName ); + bool WriteGENERICNetList( WinEDA_SchematicFrame* frame, const wxString& aOutFileName ); /** * Function WriteNetListPCBNEW @@ -337,7 +353,7 @@ bool WinEDA_SchematicFrame::WriteNetListFile( int aFormat, const wxString& aFull wxFileName tmpFile = aFullFileName; tmpFile.SetExt( wxT( "tmp" ) ); - ret = helper.Write_GENERIC_NetList( this, tmpFile.GetFullPath() ); + ret = helper.WriteGENERICNetList( this, tmpFile.GetFullPath() ); if( !ret ) break; @@ -795,57 +811,63 @@ wxXmlNode* EXPORT_HELP::makeGenericListOfNets() } -bool EXPORT_HELP::Write_GENERIC_NetList( WinEDA_SchematicFrame* frame, const wxString& aOutFileName ) +wxXmlNode* EXPORT_HELP::makeGenericRoot() { -#if 1 - // output the XML format netlist. - wxXmlDocument xdoc; + wxXmlNode* xroot = node( wxT( "export" ) ); - // tree markers or walkers - wxXmlNode* xroot; // root node - wxXmlNode* xcomps; // start of components + xroot->AddProperty( wxT( "version" ), wxT( "D" ) ); + + // add the "design" header + xroot->AddChild( makeGenericDesignHeader() ); + + xroot->AddChild( makeGenericComponents() ); + + xroot->AddChild( makeGenericLibParts() ); + + // must follow makeGenericLibParts() + xroot->AddChild( makeGenericLibraries() ); + + xroot->AddChild( makeGenericListOfNets() ); + + return xroot; +} + + +wxXmlNode* EXPORT_HELP::makeGenericComponents() +{ + wxXmlNode* xcomps = node( wxT( "components" ) ); + + wxString timeStamp; // some strings we need many times, but don't want to construct more // than once for performance. These are used within loops so the // enclosing wxString constructor would fire on each loop iteration if // they were in a nested scope. - wxString timeStamp; - wxString logicalLibName; - - // these are actually constructor invocations, not assignments as it appears: - const wxString sFields = wxT( "fields" ); - const wxString sField = wxT( "field" ); - const wxString sComponent = wxT( "comp" ); // use "part" ? - const wxString sName = wxT( "name" ); - const wxString sRef = wxT( "ref" ); - const wxString sPins = wxT( "pins" ); - const wxString sPin = wxT( "pin" ); - const wxString sValue = wxT( "value" ); - const wxString sSheetPath = wxT( "sheetpath" ); - const wxString sFootprint = wxT( "footprint" ); - const wxString sDatasheet = wxT( "datasheet" ); - const wxString sTStamp = wxT( "tstamp" ); - const wxString sTStamps = wxT( "tstamps" ); - const wxString sTSFmt = wxT( "%8.8lX" ); // comp->m_TimeStamp - const wxString sLibSource = wxT( "libsource" ); - const wxString sLibPart = wxT( "libpart" ); - const wxString sLib = wxT( "lib" ); - const wxString sPart = wxT( "part" ); - const wxString sNames = wxT( "names" ); + wxString sFields = wxT( "fields" ); + wxString sField = wxT( "field" ); + wxString sComponent = wxT( "comp" ); // use "part" ? + wxString sName = wxT( "name" ); + wxString sRef = wxT( "ref" ); + wxString sPins = wxT( "pins" ); + wxString sPin = wxT( "pin" ); + wxString sValue = wxT( "value" ); + wxString sSheetPath = wxT( "sheetpath" ); + wxString sFootprint = wxT( "footprint" ); + wxString sDatasheet = wxT( "datasheet" ); + wxString sTStamp = wxT( "tstamp" ); + wxString sTStamps = wxT( "tstamps" ); + wxString sTSFmt = wxT( "%8.8lX" ); // comp->m_TimeStamp + wxString sLibSource = wxT( "libsource" ); + wxString sLibPart = wxT( "libpart" ); + wxString sLib = wxT( "lib" ); + wxString sPart = wxT( "part" ); + wxString sNames = wxT( "names" ); m_ReferencesAlreadyFound.Clear(); - xdoc.SetRoot( xroot = node( wxT( "export" ) ) ); - xroot->AddProperty( wxT( "version" ), wxT( "D" ) ); - - // add the "design" header - xroot->AddChild( makeGenericDesignHeader() ); - - xroot->AddChild( xcomps = node( wxT( "components" ) ) ); - SCH_SHEET_LIST sheetList; // Output is xml, so there is no reason to remove spaces from the field values. @@ -922,12 +944,17 @@ bool EXPORT_HELP::Write_GENERIC_NetList( WinEDA_SchematicFrame* frame, const wxS } } - xroot->AddChild( makeGenericLibParts() ); + return xcomps; +} - // must follow makeGenericLibParts() - xroot->AddChild( makeGenericLibraries() ); - xroot->AddChild( makeGenericListOfNets() ); +bool EXPORT_HELP::WriteGENERICNetList( WinEDA_SchematicFrame* frame, const wxString& aOutFileName ) +{ +#if 1 + // output the XML format netlist. + wxXmlDocument xdoc; + + xdoc.SetRoot( makeGenericRoot() ); return xdoc.Save( aOutFileName, 2 /* indent bug, today was ignored by wxXml lib */ ); diff --git a/include/xnode.h b/include/xnode.h new file mode 100644 index 0000000000..b77a71fae3 --- /dev/null +++ b/include/xnode.h @@ -0,0 +1,119 @@ +#ifndef _XATTR_H_ +#define _XATTR_H_ + +/* + * This program source code file is part of KICAD, a free EDA CAD application. + * + * Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck + * Copyright (C) 1992-2010 Kicad Developers, see change_log.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 + */ + + +#include "richio.h" + +#include + +// These are classes for eXporting document trees, and thus have names +// starting with X. They can export either in XML or S-expression format. + + +/** + * Class XATTR + * holds an XML or S-expression attribute/child value. It is used for eXporting + * a document tree in EITHER XML or S-expression. + */ +class XATTR : public wxXmlProperty // use wxXmlAttribute for wx >= 2.9 +{ +public: + XATTR() : + wxXmlProperty() + { + } + + XATTR( const wxString& aName, const wxString& aValue ) : + wxXmlProperty( aName, aValue ) + { + } + + + /** + * Function Format + * writes this object as UTF8 out to an OUTPUTFORMATTER as an S-expression + * @param out The formatter to write to. + * @param nestLevel A multiple of the number of spaces to preceed the output with. + * @throw IOError if a system error writing the output, such as a full disk. + */ + virtual void Format( OUTPUTFORMATTER* out, int nestLevel ) throw( IOError ); + + + /** + * Function FormatContents + * writes the contents of object as UTF8 out to an OUTPUTFORMATTER as an S-expression + * This is the same as Format() except that the outer wrapper is not included. + * @param out The formatter to write to. + * @param nestLevel A multiple of the number of spaces to preceed the output with. + * @throw IOError if a system error writing the output, such as a full disk. + */ + virtual void FormatContents( OUTPUTFORMATTER* out, int nestLevel ) throw( IOError ); +}; + + +/** + * Class XNODE + * holds an XML or S-expression element. It is used for eXporting + * a document tree in EITHER XML or S-expression. + */ +class XNODE : public wxXmlNode +{ +public: + XNODE() : + wxXmlNode() + { + } + + + XNODE( wxXmlNodeType aType, const wxString& aName, const wxString& aContent = wxEmptyString ) : + wxXmlNode( NULL, aType, aName, aContent ) + { + } + + + /** + * Function Format + * writes this object as UTF8 out to an OUTPUTFORMATTER as an S-expression + * @param out The formatter to write to. + * @param nestLevel A multiple of the number of spaces to preceed the output with. + * @throw IOError if a system error writing the output, such as a full disk. + */ + virtual void Format( OUTPUTFORMATTER* out, int nestLevel ) throw( IOError ); + + + /** + * Function FormatContents + * writes the contents of object as UTF8 out to an OUTPUTFORMATTER as an S-expression + * This is the same as Format() except that the outer wrapper is not included. + * @param out The formatter to write to. + * @param nestLevel A multiple of the number of spaces to preceed the output with. + * @throw IOError if a system error writing the output, such as a full disk. + */ + virtual void FormatContents( OUTPUTFORMATTER* out, int nestLevel ) throw( IOError ); +}; + +#endif // _XATTR_H_ From b615939120d39f7040408f5e84b7ccdec9c1b97c Mon Sep 17 00:00:00 2001 From: Dick Hollenbeck Date: Sat, 7 Aug 2010 10:31:32 -0500 Subject: [PATCH 2/2] change to XNODE and XATTR classes --- eeschema/netform.cpp | 75 ++++++++++++++++++++++---------------------- 1 file changed, 37 insertions(+), 38 deletions(-) diff --git a/eeschema/netform.cpp b/eeschema/netform.cpp index 4ea7c3f856..1df1cffe97 100644 --- a/eeschema/netform.cpp +++ b/eeschema/netform.cpp @@ -197,39 +197,39 @@ class EXPORT_HELP * out here so we can write the tree in either S-expression file format * or in XML if we put the tree built here into a wxXmlDocument. */ - wxXmlNode* makeGenericRoot(); + XNODE* makeGenericRoot(); /** * Function makeGenericComponents * returns a sub-tree holding all the schematic components. */ - wxXmlNode* makeGenericComponents(); + XNODE* makeGenericComponents(); /** * Function makeGenericDesignHeader * fills out a project "design" header into an XML node. - * @return wxXmlNode* - the design header + * @return XNODE* - the design header */ - wxXmlNode* makeGenericDesignHeader(); + XNODE* makeGenericDesignHeader(); /** * Function makeGenericLibParts * fills out an XML node with the unique library parts and returns it. */ - wxXmlNode* makeGenericLibParts(); + XNODE* makeGenericLibParts(); /** * Function makeGenericListOfNets * fills out an XML node with a list of nets and returns it. */ - wxXmlNode* makeGenericListOfNets(); + XNODE* makeGenericListOfNets(); /** * Function makeGenericLibraries * fills out an XML node with a list of used libraries and returns it. * Must have called makeGenericLibParts() before this function. */ - wxXmlNode* makeGenericLibraries(); + XNODE* makeGenericLibraries(); public: @@ -557,28 +557,27 @@ SCH_COMPONENT* EXPORT_HELP::findNextComponentAndCreatPinList( /** * Function node - * is a convenience function that creates a new wxXmlNode with an optional textual child. - * It also provides some insulation from a possible change in XML library. Compiler - * may or may not decide to inline this, its choice. + * is a convenience function that creates a new XNODE with an optional textual child. + * It also provides some insulation from a possible change in XML library. * * @param aName is the name to associate with a new node of type wxXML_ELEMENT_NODE. * @param aContent is optional, and if given is the text to include in a child * of the returned node, and has type wxXML_TEXT_NODE. */ -static wxXmlNode* node( const wxString& aName, const wxString& aTextualContent = wxEmptyString ) +static XNODE* node( const wxString& aName, const wxString& aTextualContent = wxEmptyString ) { - wxXmlNode* n = new wxXmlNode( 0, wxXML_ELEMENT_NODE, aName ); + XNODE* n = new XNODE( wxXML_ELEMENT_NODE, aName ); if( aTextualContent.Len() > 0 ) // excludes wxEmptyString, the parameter's default value - n->AddChild( new wxXmlNode( 0, wxXML_TEXT_NODE, wxEmptyString, aTextualContent ) ); + n->AddChild( new XNODE( wxXML_TEXT_NODE, wxEmptyString, aTextualContent ) ); return n; } -wxXmlNode* EXPORT_HELP::makeGenericDesignHeader() +XNODE* EXPORT_HELP::makeGenericDesignHeader() { - wxXmlNode* xdesign = node( wxT("design") ); + XNODE* xdesign = node( wxT("design") ); char date[128]; DateAndTime( date ); @@ -617,14 +616,14 @@ wxXmlNode* EXPORT_HELP::makeGenericDesignHeader() } -wxXmlNode* EXPORT_HELP::makeGenericLibraries() +XNODE* EXPORT_HELP::makeGenericLibraries() { - wxXmlNode* xlibs = node( wxT( "libraries" ) ); // auto_ptr + XNODE* xlibs = node( wxT( "libraries" ) ); // auto_ptr for( std::set::iterator it = m_Libraries.begin(); it!=m_Libraries.end(); ++it ) { CMP_LIBRARY* lib = (CMP_LIBRARY*) *it; - wxXmlNode* xlibrary; + XNODE* xlibrary; xlibs->AddChild( xlibrary = node( wxT( "library" ) ) ); xlibrary->AddProperty( wxT( "logical" ), lib->GetLogicalName() ); @@ -637,9 +636,9 @@ wxXmlNode* EXPORT_HELP::makeGenericLibraries() } -wxXmlNode* EXPORT_HELP::makeGenericLibParts() +XNODE* EXPORT_HELP::makeGenericLibParts() { - wxXmlNode* xlibparts = node( wxT( "libparts" ) ); // auto_ptr + XNODE* xlibparts = node( wxT( "libparts" ) ); // auto_ptr wxString sLibpart = wxT( "libpart" ); wxString sLib = wxT( "lib" ); wxString sPart = wxT( "part" ); @@ -665,7 +664,7 @@ wxXmlNode* EXPORT_HELP::makeGenericLibParts() m_Libraries.insert( library ); // inserts component's library iff unique - wxXmlNode* xlibpart; + XNODE* xlibpart; xlibparts->AddChild( xlibpart = node( sLibpart ) ); xlibpart->AddProperty( sLib, library->GetLogicalName() ); xlibpart->AddProperty( sPart, lcomp->GetName() ); @@ -685,14 +684,14 @@ wxXmlNode* EXPORT_HELP::makeGenericLibParts() fieldList.clear(); lcomp->GetFields( fieldList ); - wxXmlNode* xfields; + XNODE* xfields; xlibpart->AddChild( xfields = node( sFields ) ); for( unsigned i=0; iAddChild( xfield = node( sField, fieldList[i].m_Text ) ); xfield->AddProperty( sName, fieldList[i].m_Name ); } @@ -706,12 +705,12 @@ wxXmlNode* EXPORT_HELP::makeGenericLibParts() if( pinList.size() ) { - wxXmlNode* pins; + XNODE* pins; xlibpart->AddChild( pins = node( sPins ) ); for( unsigned i=0; iAddChild( pin = node( sPin ) ); pin->AddProperty( sNum, pinList[i]->GetNumber() ); @@ -725,9 +724,9 @@ wxXmlNode* EXPORT_HELP::makeGenericLibParts() } -wxXmlNode* EXPORT_HELP::makeGenericListOfNets() +XNODE* EXPORT_HELP::makeGenericListOfNets() { - wxXmlNode* xnets = node( wxT( "nets" ) ); // auto_ptr if exceptions ever get used. + XNODE* xnets = node( wxT( "nets" ) ); // auto_ptr if exceptions ever get used. wxString netCodeTxt; wxString netName; wxString ref; @@ -740,7 +739,7 @@ wxXmlNode* EXPORT_HELP::makeGenericListOfNets() wxString sNode = wxT( "node" ); wxString sFmtd = wxT( "%d" ); - wxXmlNode* xnet = 0; + XNODE* xnet = 0; int netCode; int lastNetCode = -1; int sameNetcodeCount = 0; @@ -801,7 +800,7 @@ wxXmlNode* EXPORT_HELP::makeGenericListOfNets() xnet->AddProperty( sName, netName ); } - wxXmlNode* xnode; + XNODE* xnode; xnet->AddChild( xnode = node( sNode ) ); xnode->AddProperty( sRef, ref ); xnode->AddProperty( sPin, nitem->GetPinNumText() ); @@ -811,9 +810,9 @@ wxXmlNode* EXPORT_HELP::makeGenericListOfNets() } -wxXmlNode* EXPORT_HELP::makeGenericRoot() +XNODE* EXPORT_HELP::makeGenericRoot() { - wxXmlNode* xroot = node( wxT( "export" ) ); + XNODE* xroot = node( wxT( "export" ) ); xroot->AddProperty( wxT( "version" ), wxT( "D" ) ); @@ -833,9 +832,9 @@ wxXmlNode* EXPORT_HELP::makeGenericRoot() } -wxXmlNode* EXPORT_HELP::makeGenericComponents() +XNODE* EXPORT_HELP::makeGenericComponents() { - wxXmlNode* xcomps = node( wxT( "components" ) ); + XNODE* xcomps = node( wxT( "components" ) ); wxString timeStamp; @@ -883,7 +882,7 @@ wxXmlNode* EXPORT_HELP::makeGenericComponents() schItem = comp; - wxXmlNode* xcomp; // current component being constructed + XNODE* xcomp; // current component being constructed // Output the component's elments in order of expected access frequency. // This may not always look best, but it will allow faster execution @@ -906,7 +905,7 @@ wxXmlNode* EXPORT_HELP::makeGenericComponents() // container element if there are any s. if( comp->GetFieldCount() > MANDATORY_FIELDS ) { - wxXmlNode* xfields; + XNODE* xfields; xcomp->AddChild( xfields = node( sFields ) ); for( int fldNdx = MANDATORY_FIELDS; fldNdx < comp->GetFieldCount(); ++fldNdx ) @@ -916,14 +915,14 @@ wxXmlNode* EXPORT_HELP::makeGenericComponents() // only output a field if non empty if( !f->m_Text.IsEmpty() ) { - wxXmlNode* xfield; + XNODE* xfield; xfields->AddChild( xfield = node( sField, f->m_Text ) ); xfield->AddProperty( sName, f->m_Name ); } } } - wxXmlNode* xlibsource; + XNODE* xlibsource; xcomp->AddChild( xlibsource = node( sLibSource ) ); // "logical" library name, which is in anticipation of a better search @@ -934,7 +933,7 @@ wxXmlNode* EXPORT_HELP::makeGenericComponents() xlibsource->AddProperty( sLib, entry->GetLibrary()->GetLogicalName() ); xlibsource->AddProperty( sPart, comp->m_ChipName ); - wxXmlNode* xsheetpath; + XNODE* xsheetpath; xcomp->AddChild( xsheetpath = node( sSheetPath ) ); xsheetpath->AddProperty( sNames, path->PathHumanReadable() ); xsheetpath->AddProperty( sTStamps, path->Path() );