Merge pull request #3 from saurabhb17/master

secondary files

1 files changed, 317 insertions, 0 deletions

diff --git a/common/footprint_info.cpp b/common/footprint_info.cpp
new file mode 100644
index 0000000..3f5e64b
--- /dev/null
+++ b/common/footprint_info.cpp
@@ -0,0 +1,317 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2011 Jean-Pierre Charras, <jp.charras@wanadoo.fr>
+ * Copyright (C) 2013-2016 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
+ * Copyright (C) 1992-2017 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
+ */
+
+/**
+ * @file footprint_info.cpp
+ */
+
+
+/**
+    No. concurrent threads doing "http(s) GET". More than 6 is not significantly
+    faster, less than 6 is likely slower. Main thread is in this count, so if
+    set to 1 then no temp threads are created.
+*/
+#define READER_THREADS      6
+
+/*
+ * Functions to read footprint libraries and fill m_footprints by available footprints names
+ * and their documentation (comments and keywords)
+ */
+
+#include <fctsys.h>
+#include <common.h>
+#include <macros.h>
+#include <pgm_base.h>
+#include <wildcards_and_files_ext.h>
+#include <footprint_info.h>
+#include <io_mgr.h>
+#include <fp_lib_table.h>
+#include <fpid.h>
+#include <class_module.h>
+#include <boost/thread.hpp>
+#include <html_messagebox.h>
+
+
+/*
+static wxString ToHTMLFragment( const IO_ERROR* aDerivative )
+{
+    @todo
+
+    1)  change up IO_ERROR so it keeps linenumbers, source file name and
+        error message in separate strings.
+
+    2)  Add a summarizing virtual member like
+            virtual wxString What()
+        to combine all portions of an IO_ERROR's text into a single wxString.
+
+    3)  Do same for PARSE_ERROR.
+
+    4)  Add a "reason or error category" to IO_ERROR and thereby also PARSE_ERROR?
+
+    msg += "
+
+    for( int i=0; i<aCount; ++i )
+    {
+
+
+        wxArrayString* sl = wxStringSplit( aList, wxChar( '\n' ) );
+
+
+        delete sl;
+    }
+
+    wxString msg = wxT( "<ul>" );
+
+    for ( unsigned ii = 0; ii < strings_list->GetCount(); ii++ )
+    {
+        msg += wxT( "<li>" );
+        msg += strings_list->Item( ii ) + wxT( "</li>" );
+    }
+
+    msg += wxT( "</ul>" );
+
+    m_htmlWindow->AppendToPage( msg );
+
+    delete strings_list;
+}
+*/
+
+
+void FOOTPRINT_INFO::load()
+{
+    FP_LIB_TABLE*   fptable = m_owner->GetTable();
+
+    wxASSERT( fptable );
+
+    std::auto_ptr<MODULE> m( fptable->FootprintLoad( m_nickname, m_fpname ) );
+
+    if( m.get() == NULL )    // Should happen only with malformed/broken libraries
+    {
+        m_pad_count = 0;
+        m_unique_pad_count = 0;
+    }
+    else
+    {
+        m_pad_count = m->GetPadCount( DO_NOT_INCLUDE_NPTH );
+        m_unique_pad_count = m->GetUniquePadCount( DO_NOT_INCLUDE_NPTH );
+        m_keywords  = m->GetKeywords();
+        m_doc       = m->GetDescription();
+
+        // tell ensure_loaded() I'm loaded.
+        m_loaded = true;
+    }
+}
+
+
+void FOOTPRINT_LIST::loader_job( const wxString* aNicknameList, int aJobZ )
+{
+    for( int i=0; i<aJobZ; ++i )
+    {
+        const wxString& nickname = aNicknameList[i];
+
+        try
+        {
+            wxArrayString fpnames = m_lib_table->FootprintEnumerate( nickname );
+
+            for( unsigned ni=0;  ni<fpnames.GetCount();  ++ni )
+            {
+                FOOTPRINT_INFO* fpinfo = new FOOTPRINT_INFO( this, nickname, fpnames[ni] );
+
+                addItem( fpinfo );
+            }
+        }
+        catch( const PARSE_ERROR& pe )
+        {
+            // m_errors.push_back is not thread safe, lock its MUTEX.
+            MUTLOCK lock( m_errors_lock );
+
+            ++m_error_count;        // modify only under lock
+            m_errors.push_back( new IO_ERROR( pe ) );
+        }
+        catch( const IO_ERROR& ioe )
+        {
+            MUTLOCK lock( m_errors_lock );
+
+            ++m_error_count;
+            m_errors.push_back( new IO_ERROR( ioe ) );
+        }
+
+        // Catch anything unexpected and map it into the expected.
+        // Likely even more important since this function runs on GUI-less
+        // worker threads.
+        catch( const std::exception& se )
+        {
+            // This is a round about way to do this, but who knows what THROW_IO_ERROR()
+            // may be tricked out to do someday, keep it in the game.
+            try
+            {
+                THROW_IO_ERROR( se.what() );
+            }
+            catch( const IO_ERROR& ioe )
+            {
+                MUTLOCK lock( m_errors_lock );
+
+                ++m_error_count;
+                m_errors.push_back( new IO_ERROR( ioe ) );
+            }
+        }
+    }
+}
+
+
+bool FOOTPRINT_LIST::ReadFootprintFiles( FP_LIB_TABLE* aTable, const wxString* aNickname )
+{
+    bool retv = true;
+
+    m_lib_table = aTable;
+
+    // Clear data before reading files
+    m_error_count = 0;
+    m_errors.clear();
+    m_list.clear();
+
+    if( aNickname )
+        // single footprint
+        loader_job( aNickname, 1 );
+    else
+    {
+        std::vector< wxString > nicknames;
+
+        // do all of them
+        nicknames = aTable->GetLogicalLibs();
+
+        // Even though the PLUGIN API implementation is the place for the
+        // locale toggling, in order to keep LOCAL_IO::C_count at 1 or greater
+        // for the duration of all helper threads, we increment by one here via instantiation.
+        // Only done here because of the multi-threaded nature of this code.
+        // Without this C_count skips in and out of "equal to zero" and causes
+        // needless locale toggling among the threads, based on which of them
+        // are in a PLUGIN::FootprintLoad() function.  And that is occasionally
+        // none of them.
+        LOCALE_IO   top_most_nesting;
+
+        // Something which will not invoke a thread copy constructor, one of many ways obviously:
+        typedef boost::ptr_vector< boost::thread >  MYTHREADS;
+
+        MYTHREADS threads;
+
+        unsigned jobz = (nicknames.size() + READER_THREADS - 1) / READER_THREADS;
+
+        // Give each thread JOBZ nicknames to process.  The last portion of, or if the entire
+        // size() is small, I'll do myself.
+        for( unsigned i=0; i<nicknames.size();  )
+        {
+            if( i + jobz >= nicknames.size() )  // on the last iteration of this for(;;)
+            {
+                jobz = nicknames.size() - i;
+
+                // Only a little bit to do, I'll do it myself on current thread.
+                // I am part of the READER_THREADS count.
+                loader_job( &nicknames[i], jobz );
+            }
+            else
+            {
+                // Delegate the job to a temporary thread created here.
+                threads.push_back( new boost::thread( &FOOTPRINT_LIST::loader_job,
+                        this, &nicknames[i], jobz ) );
+            }
+
+            i += jobz;
+        }
+
+        // Wait for all the worker threads to complete, it does not matter in what order
+        // we wait for them as long as a full sweep is made.  Think of the great race,
+        // everyone must finish.
+        for( unsigned i=0;  i<threads.size();  ++i )
+        {
+            threads[i].join();
+        }
+
+        m_list.sort();
+    }
+
+    // The result of this function can be a blend of successes and failures, whose
+    // mix is given by the Count()s of the two lists.  The return value indicates whether
+    // an abort occurred, even true does not necessarily mean full success, although
+    // false definitely means failure.
+
+    return retv;
+}
+
+
+FOOTPRINT_INFO* FOOTPRINT_LIST::GetModuleInfo( const wxString& aFootprintName )
+{
+    if( aFootprintName.IsEmpty() )
+        return NULL;
+
+    BOOST_FOREACH( FOOTPRINT_INFO& fp, m_list )
+    {
+        FPID fpid;
+
+        wxCHECK_MSG( fpid.Parse( aFootprintName ) < 0, NULL,
+                     wxString::Format( wxT( "'%s' is not a valid FPID." ),
+                                       GetChars( aFootprintName ) ) );
+
+        wxString libNickname   = fpid.GetLibNickname();
+        wxString footprintName = fpid.GetFootprintName();
+
+        if( libNickname == fp.GetNickname() && footprintName == fp.GetFootprintName() )
+            return &fp;
+    }
+
+    return NULL;
+}
+
+
+bool FOOTPRINT_INFO::InLibrary( const wxString& aLibrary ) const
+{
+    return aLibrary == m_nickname;
+}
+
+
+void FOOTPRINT_LIST::DisplayErrors( wxTopLevelWindow* aWindow )
+{
+    // @todo: go to a more HTML !<table>! ? centric output, possibly with
+    // recommendations for remedy of errors.  Add numeric error codes
+    // to PARSE_ERROR, and switch on them for remedies, etc.  Full
+    // access is provided to everything in every exception!
+
+    HTML_MESSAGE_BOX dlg( aWindow, _( "Load Error" ) );
+
+    dlg.MessageSet( _( "Errors were encountered loading footprints:" ) );
+
+    wxString msg;
+
+    for( unsigned i = 0; i<m_errors.size();  ++i )
+    {
+        msg += wxT( "<p>" ) + m_errors[i].errorText + wxT( "</p>" );
+    }
+
+    // Preserve new lines in error messages so queued errors don't run together.
+    msg.Replace( "\n", "<BR>" );
+    dlg.AddHTML_Text( msg );
+
+    dlg.ShowModal();
+}