cvpcb.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2007 Jean-Pierre Charras, jp..charras at wanadoo.fr
 * Copyright (C) 2014 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
 */
 
#include <confirm.h>
#include <fp_lib_table.h>
#include <footprint_info_impl.h>
#include <kiface_base.h>
#include <pgm_base.h>
#include <settings/settings_manager.h>
 
#include <cvpcb_mainframe.h>
#include <settings/cvpcb_settings.h>
#include <display_footprints_frame.h>
#include <kiface_ids.h>
#include <project_pcb.h>
 
namespace CV {
 
int testFootprintLink( const wxString& aFootprint, PROJECT* aProject )
{
    FP_LIB_TABLE*           libTable = PROJECT_PCB::PcbFootprintLibs( aProject );
    const FP_LIB_TABLE_ROW* libTableRow = nullptr;
    LIB_ID                  fpID;
 
    fpID.Parse( aFootprint );
 
    wxString libName = fpID.GetLibNickname();
    wxString fpName = fpID.GetLibItemName();
 
    try
    {
        libTableRow = libTable->FindRow( libName );
    }
    catch( const IO_ERROR& )
    {
        // Error state processed below
    }
 
    if( !libTableRow )
        return KIFACE_TEST_FOOTPRINT_LINK_NO_LIBRARY;
    else if( !libTable->HasLibrary( libName, true ) )
        return KIFACE_TEST_FOOTPRINT_LINK_LIBRARY_NOT_ENABLED;
    else if( !libTable->FootprintExists( libName, fpName ) )
        return KIFACE_TEST_FOOTPRINT_LINK_NO_FOOTPRINT;
    else
        return 0;
}
 
 
static struct IFACE : public KIFACE_BASE
{
    // Of course all are virtual overloads, implementations of the KIFACE.
 
    IFACE( const char* aName, KIWAY::FACE_T aType ) :
            KIFACE_BASE( aName, aType )
    {}
 
    bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits, KIWAY* aKiway ) override;
 
    void OnKifaceEnd() override;
 
    wxWindow* CreateKiWindow( wxWindow* aParent, int aClassId, KIWAY* aKiway,
                              int aCtlBits = 0 ) override
    {
        switch( aClassId )
        {
        case FRAME_CVPCB:         return new CVPCB_MAINFRAME( aKiway, aParent );
        case FRAME_CVPCB_DISPLAY: return new DISPLAY_FOOTPRINTS_FRAME( aKiway, aParent );
        default:                  return nullptr;
        }
    }
 
    void* IfaceOrAddress( int aDataId ) override
    {
        switch( aDataId )
        {
        // Return a pointer to the global instance of the footprint list.
        case KIFACE_FOOTPRINT_LIST:
            return (void*) &GFootprintList;
 
        // Return a new FP_LIB_TABLE with the global table installed as a fallback.
        case KIFACE_NEW_FOOTPRINT_TABLE:
            return (void*) new FP_LIB_TABLE( &GFootprintTable );
 
        // Return a pointer to the global instance of the global footprint table.
        case KIFACE_GLOBAL_FOOTPRINT_TABLE:
            return (void*) &GFootprintTable;
 
        case KIFACE_TEST_FOOTPRINT_LINK:
            return (void*) testFootprintLink;
 
        default:
            return nullptr;
        }
    }
 
} kiface( "cvpcb", KIWAY::FACE_CVPCB );
 
} // namespace
 
using namespace CV;
 
 
KIFACE_BASE& Kiface() { return kiface; }
 
 
// KIFACE_GETTER's actual spelling is a substitution macro found in kiway.h.
// KIFACE_GETTER will not have name mangling due to declaration in kiway.h.
KIFACE_API KIFACE* KIFACE_GETTER(  int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram )
{
    return &kiface;
}
 
 
FP_LIB_TABLE        GFootprintTable;
 
 
FOOTPRINT_LIST_IMPL GFootprintList;
 
 
 
// A short lived implementation.  cvpcb will get combine into Pcbnew shortly, so
// we skip setting KICAD7_FOOTPRINT_DIR here for now.  User should set the environment
// variable.
bool IFACE::OnKifaceStart( PGM_BASE* aProgram, int aCtlBits, KIWAY* aKiway )
{
    // This is process level, not project level, initialization of the DSO.
 
    // Do nothing in here pertinent to a project!
 
    InitSettings( new CVPCB_SETTINGS );
    aProgram->GetSettingsManager().RegisterSettings( KifaceSettings() );
 
    start_common( aCtlBits );
 
    /*  Now that there are no *.mod files in the standard library, this function
        has no utility.  User should simply set the variable manually.
        Looking for *.mod files which do not exist is fruitless.
 
    // SetFootprintLibTablePath();
    */
 
    try
    {
        // The global table is not related to a specific project.  All projects
        // will use the same global table.  So the KIFACE::OnKifaceStart() contract
        // of avoiding anything project specific is not violated here.
 
        if( !FP_LIB_TABLE::LoadGlobalTable( GFootprintTable ) )
        {
            DisplayInfoMessage( nullptr, _( "You have run CvPcb for the first time using the "
                                            "new footprint library table method for finding "
                                            "footprints.\nCvPcb has either copied the default "
                                            "table or created an empty table in your home "
                                            "folder.\nYou must first configure the library "
                                            "table to include all footprint libraries not "
                                            "included with KiCad.\nSee the \"Footprint Library "
                                            "Table\" section of the CvPcb documentation for "
                                            "more information." ) );
        }
    }
    catch( const IO_ERROR& ioe )
    {
        // we didnt get anywhere deregister the settings
        aProgram->GetSettingsManager().FlushAndRelease( KifaceSettings(), false );
 
        DisplayErrorMessage( nullptr, _( "An error occurred attempting to load the global "
                                         "footprint library table." ),
                             ioe.What() );
        return false;
    }
 
    return true;
}
 
 
void IFACE::OnKifaceEnd()
{
    end_common();
}