summaryrefslogtreecommitdiff
path: root/eeschema/backanno.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'eeschema/backanno.cpp')
-rw-r--r--eeschema/backanno.cpp264
1 files changed, 264 insertions, 0 deletions
diff --git a/eeschema/backanno.cpp b/eeschema/backanno.cpp
new file mode 100644
index 0000000..671f727
--- /dev/null
+++ b/eeschema/backanno.cpp
@@ -0,0 +1,264 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
+ * Copyright (C) 2008-2013 Wayne Stambaugh <stambaughw@verizon.net>
+ * Copyright (C) 2004-2015 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
+ */
+
+/**
+ * @file backanno.cpp
+ * @brief Functions for backannotating footprint information.
+ */
+
+#include <fctsys.h>
+#include <confirm.h>
+#include <kicad_string.h>
+#include <gestfich.h>
+#include <kiface_i.h>
+#include <schframe.h>
+#include <build_version.h>
+#include <wildcards_and_files_ext.h>
+
+#include <general.h>
+#include <sch_sheet_path.h>
+#include <sch_component.h>
+#include <sch_reference_list.h>
+
+#include <dsnlexer.h>
+#include <ptree.h>
+#include <boost/property_tree/ptree.hpp>
+#include <wx/choicdlg.h>
+
+
+void SCH_EDIT_FRAME::backAnnotateFootprints( const std::string& aChangedSetOfReferences )
+ throw( IO_ERROR, boost::bad_pointer )
+{
+ // Build a flat list of components in schematic:
+ SCH_REFERENCE_LIST refs;
+ SCH_SHEET_LIST sheets;
+ bool isChanged = false;
+
+ sheets.GetComponents( Prj().SchLibs(), refs, false );
+
+ DSNLEXER lexer( aChangedSetOfReferences, FROM_UTF8( __func__ ) );
+ PTREE doc;
+
+ try
+ {
+ Scan( &doc, &lexer );
+
+#if defined(DEBUG) && 0
+ STRING_FORMATTER sf;
+ Format( &sf, 0, 0, doc );
+ printf( "%s: '%s'\n", __func__, sf.GetString().c_str() );
+#endif
+
+ CPTREE& back_anno = doc.get_child( "back_annotation" );
+ wxString footprint;
+
+ for( PTREE::const_iterator ref = back_anno.begin(); ref != back_anno.end(); ++ref )
+ {
+ wxASSERT( ref->first == "ref" );
+
+ wxString reference = (UTF8&) ref->second.front().first;
+
+ // Ensure the "fpid" node contains a footprint name,
+ // and get it if exists
+ if( ref->second.get_child( "fpid" ).size() )
+ {
+ wxString tmp = (UTF8&) ref->second.get_child( "fpid" ).front().first;
+ footprint = tmp;
+ }
+ else
+ footprint.Empty();
+
+ // DBG( printf( "%s: ref:%s fpid:%s\n", __func__, TO_UTF8( reference ), TO_UTF8( footprint ) ); )
+
+ // Search the component in the flat list
+ for( unsigned ii = 0; ii < refs.GetCount(); ++ii )
+ {
+ if( Cmp_KEEPCASE( reference, refs[ii].GetRef() ) == 0 )
+ {
+ // We have found a candidate.
+ // Note: it can be not unique (multiple parts per package)
+ // So we *do not* stop the search here
+ SCH_COMPONENT* component = refs[ii].GetComp();
+ SCH_FIELD* fpfield = component->GetField( FOOTPRINT );
+ const wxString& oldfp = fpfield->GetText();
+
+ if( !oldfp && fpfield->IsVisible() )
+ {
+ fpfield->SetVisible( false );
+ }
+
+ // DBG( printf("%s: ref:%s fpid:%s\n", __func__, TO_UTF8( refs[ii].GetRef() ), TO_UTF8( footprint ) );)
+ if( oldfp != footprint )
+ isChanged = true;
+
+ fpfield->SetText( footprint );
+ }
+ }
+ }
+ }
+ catch( const PTREE_ERROR& ex )
+ {
+ // remap the exception to something the caller is likely to understand.
+ THROW_IO_ERROR( ex.what() );
+ }
+
+ if( isChanged )
+ OnModify();
+}
+
+
+bool SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile( const wxString& aFullFilename,
+ bool aForceVisibilityState,
+ bool aVisibilityState )
+{
+ // Build a flat list of components in schematic:
+ SCH_REFERENCE_LIST referencesList;
+ SCH_SHEET_LIST sheetList;
+
+ sheetList.GetComponents( Prj().SchLibs(), referencesList, false );
+
+ FILE* cmpFile = wxFopen( aFullFilename, wxT( "rt" ) );
+
+ if( cmpFile == NULL )
+ return false;
+
+ // cmpFileReader dtor will close cmpFile
+ FILE_LINE_READER cmpFileReader( cmpFile, aFullFilename );
+
+ // Now, for each component found in file,
+ // replace footprint field value by the new value:
+ wxString reference;
+ wxString footprint;
+ wxString buffer;
+ wxString value;
+
+ while( cmpFileReader.ReadLine() )
+ {
+ buffer = FROM_UTF8( cmpFileReader.Line() );
+
+ if( !buffer.StartsWith( wxT( "BeginCmp" ) ) )
+ continue;
+
+ // Begin component description.
+ reference.Empty();
+ footprint.Empty();
+
+ while( cmpFileReader.ReadLine() )
+ {
+ buffer = FROM_UTF8( cmpFileReader.Line() );
+
+ if( buffer.StartsWith( wxT( "EndCmp" ) ) )
+ break;
+
+ // store string value, stored between '=' and ';' delimiters.
+ value = buffer.AfterFirst( '=' );
+ value = value.BeforeLast( ';' );
+ value.Trim(true);
+ value.Trim(false);
+
+ if( buffer.StartsWith( wxT( "Reference" ) ) )
+ {
+ reference = value;
+ }
+ else if( buffer.StartsWith( wxT( "IdModule" ) ) )
+ {
+ footprint = value;
+ }
+ }
+
+ // A block is read: initialize the footprint field of the corresponding component
+ // if the footprint name is not empty
+ if( reference.IsEmpty() )
+ continue;
+
+ // Search the component in the flat list
+ for( unsigned ii = 0; ii < referencesList.GetCount(); ii++ )
+ {
+ if( Cmp_KEEPCASE( reference, referencesList[ii].GetRef() ) == 0 )
+ {
+ // We have found a candidate.
+ // Note: it can be not unique (multiple units per part)
+ // So we *do not* stop the search here
+ SCH_COMPONENT* component = referencesList[ii].GetComp();
+ SCH_FIELD* fpfield = component->GetField( FOOTPRINT );
+
+ fpfield->SetText( footprint );
+
+ if( aForceVisibilityState )
+ {
+ component->GetField( FOOTPRINT )->SetVisible( aVisibilityState );
+ }
+ }
+ }
+ }
+
+ return true;
+}
+
+
+bool SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile()
+{
+ wxString path = wxPathOnly( Prj().GetProjectFullName() );
+
+ wxFileDialog dlg( this, _( "Load Component Footprint Link File" ),
+ path, wxEmptyString,
+ ComponentFileExtensionWildcard,
+ wxFD_OPEN | wxFD_FILE_MUST_EXIST );
+
+ if( dlg.ShowModal() == wxID_CANCEL )
+ return false;
+
+ wxString filename = dlg.GetPath();
+ wxString title = wxT( "Eeschema " ) + GetBuildVersion() + wxT( ' ' ) + filename;
+
+ SetTitle( title );
+
+ wxArrayString choices;
+ choices.Add( _( "Keep existing footprint field visibility" ) );
+ choices.Add( _( "Show all footprint fields" ) );
+ choices.Add( _( "Hide all footprint fields" ) );
+
+ wxSingleChoiceDialog choiceDlg( this, _( "Select the footprint field visibility setting." ),
+ _( "Change Visibility" ), choices );
+
+
+ if( choiceDlg.ShowModal() == wxID_CANCEL )
+ return false;
+
+ bool forceVisibility = (choiceDlg.GetSelection() != 0 );
+ bool visibilityState = (choiceDlg.GetSelection() == 1 );
+
+ if( !ProcessCmpToFootprintLinkFile( filename, forceVisibility, visibilityState ) )
+ {
+ wxString msg = wxString::Format( _( "Failed to open component-footprint link file '%s'" ),
+ filename.GetData() );
+
+ DisplayError( this, msg );
+ return false;
+ }
+
+ OnModify();
+ return true;
+}
generated by cgit (git 2.34.1) at 2024-12-20 09:48:41 +0000