490 lines
15 KiB
C++
490 lines
15 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2012 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
|
|
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 1992-2012 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 pcbnew.cpp
|
|
* @brief Pcbnew main program.
|
|
*/
|
|
|
|
#ifdef KICAD_SCRIPTING
|
|
#include <python_scripting.h>
|
|
#include <pcbnew_scripting_helpers.h>
|
|
#endif
|
|
#include <fctsys.h>
|
|
#include <pgm_base.h>
|
|
#include <kiface_i.h>
|
|
#include <confirm.h>
|
|
#include <macros.h>
|
|
#include <class_drawpanel.h>
|
|
#include <wxPcbStruct.h>
|
|
#include <eda_dde.h>
|
|
#include <pcbcommon.h>
|
|
#include <colors_selection.h>
|
|
#include <gr_basic.h>
|
|
#include <3d_viewer.h>
|
|
#include <wx/stdpaths.h>
|
|
|
|
#include <wx/file.h>
|
|
#include <wx/snglinst.h>
|
|
#include <wx/dir.h>
|
|
#include <gestfich.h>
|
|
|
|
#include <pcbnew.h>
|
|
#include <protos.h>
|
|
#include <hotkeys.h>
|
|
#include <wildcards_and_files_ext.h>
|
|
#include <class_board.h>
|
|
#include <3d_viewer.h>
|
|
#include <fp_lib_table.h>
|
|
#include <module_editor_frame.h>
|
|
#include <modview_frame.h>
|
|
#include <footprint_wizard_frame.h>
|
|
|
|
|
|
// Colors for layers and items
|
|
COLORS_DESIGN_SETTINGS g_ColorsSettings;
|
|
|
|
bool g_Drc_On = true;
|
|
bool g_AutoDeleteOldTrack = true;
|
|
bool g_Show_Module_Ratsnest;
|
|
bool g_Raccord_45_Auto = true;
|
|
bool g_Alternate_Track_Posture = false;
|
|
bool g_Track_45_Only_Allowed = true; // True to allow horiz, vert. and 45deg only tracks
|
|
bool g_Segments_45_Only; // True to allow horiz, vert. and 45deg only graphic segments
|
|
bool g_TwoSegmentTrackBuild = true;
|
|
|
|
LAYER_ID g_Route_Layer_TOP;
|
|
LAYER_ID g_Route_Layer_BOTTOM;
|
|
int g_MaxLinksShowed;
|
|
int g_MagneticPadOption = capture_cursor_in_track_tool;
|
|
int g_MagneticTrackOption = capture_cursor_in_track_tool;
|
|
|
|
wxPoint g_Offset_Module; /* Distance to offset module trace when moving. */
|
|
|
|
/* Name of the document footprint list
|
|
* usually located in share/modules/footprints_doc
|
|
* this is of the responsibility to users to create this file
|
|
* if they want to have a list of footprints
|
|
*/
|
|
wxString g_DocModulesFileName = wxT( "footprints_doc/footprints.pdf" );
|
|
|
|
// wxWindow* DoPythonStuff(wxWindow* parent); // declaration
|
|
|
|
namespace PCB {
|
|
|
|
static struct IFACE : public KIFACE_I
|
|
{
|
|
// Of course all are virtual overloads, implementations of the KIFACE.
|
|
|
|
IFACE( const char* aName, KIWAY::FACE_T aType ) :
|
|
KIFACE_I( aName, aType )
|
|
{}
|
|
|
|
bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits );
|
|
|
|
void OnKifaceEnd();
|
|
|
|
wxWindow* CreateWindow( wxWindow* aParent, int aClassId, KIWAY* aKiway, int aCtlBits = 0 )
|
|
{
|
|
switch( aClassId )
|
|
{
|
|
case FRAME_PCB:
|
|
{
|
|
PCB_EDIT_FRAME* frame = new PCB_EDIT_FRAME( aKiway, aParent );
|
|
|
|
frame->Zoom_Automatique( true );
|
|
|
|
#if defined(KICAD_SCRIPTING)
|
|
// give the scripting helpers access to our frame
|
|
ScriptingSetPcbEditFrame( frame );
|
|
#endif
|
|
|
|
if( Kiface().IsSingle() )
|
|
{
|
|
// only run this under single_top, not under a project manager.
|
|
CreateServer( frame, KICAD_PCB_PORT_SERVICE_NUMBER );
|
|
}
|
|
return frame;
|
|
}
|
|
break;
|
|
|
|
case FRAME_PCB_MODULE_EDITOR:
|
|
{
|
|
FOOTPRINT_EDIT_FRAME* frame = new FOOTPRINT_EDIT_FRAME( aKiway, aParent );
|
|
|
|
frame->Zoom_Automatique( true );
|
|
|
|
/* Read a default config file in case no project given on command line.
|
|
frame->LoadProjectFile( wxEmptyString, true );
|
|
*/
|
|
return frame;
|
|
}
|
|
break;
|
|
|
|
case FRAME_PCB_MODULE_VIEWER:
|
|
case FRAME_PCB_MODULE_VIEWER_MODAL:
|
|
{
|
|
FOOTPRINT_VIEWER_FRAME* frame = new FOOTPRINT_VIEWER_FRAME(
|
|
aKiway, aParent, FRAME_T( aClassId ) );
|
|
|
|
frame->Zoom_Automatique( true );
|
|
|
|
/* Read a default config file in case no project given on command line.
|
|
frame->LoadProjectFile( wxEmptyString, true );
|
|
*/
|
|
return frame;
|
|
}
|
|
break;
|
|
|
|
case FRAME_PCB_FOOTPRINT_WIZARD_MODAL:
|
|
{
|
|
FOOTPRINT_WIZARD_FRAME* frame = new FOOTPRINT_WIZARD_FRAME(
|
|
aKiway, aParent, FRAME_T( aClassId ) );
|
|
|
|
return frame;
|
|
}
|
|
break;
|
|
|
|
default:
|
|
;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
* Function IfaceOrAddress
|
|
* return a pointer to the requested object. The safest way to use this
|
|
* is to retrieve a pointer to a static instance of an interface, similar to
|
|
* how the KIFACE interface is exported. But if you know what you are doing
|
|
* use it to retrieve anything you want.
|
|
*
|
|
* @param aDataId identifies which object you want the address of.
|
|
*
|
|
* @return void* - and must be cast into the know type.
|
|
*/
|
|
void* IfaceOrAddress( int aDataId )
|
|
{
|
|
return NULL;
|
|
}
|
|
|
|
} kiface( "pcbnew", KIWAY::FACE_PCB );
|
|
|
|
} // namespace
|
|
|
|
using namespace PCB;
|
|
|
|
|
|
static PGM_BASE* process;
|
|
|
|
|
|
KIFACE_I& 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.
|
|
MY_API( KIFACE* ) KIFACE_GETTER( int* aKIFACEversion, int aKiwayVersion, PGM_BASE* aProgram )
|
|
{
|
|
process = (PGM_BASE*) aProgram;
|
|
return &kiface;
|
|
}
|
|
|
|
#if defined(BUILD_KIWAY_DLL)
|
|
PGM_BASE& Pgm()
|
|
{
|
|
wxASSERT( process ); // KIFACE_GETTER has already been called.
|
|
return *process;
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* Function set3DShapesPath
|
|
* attempts to set the environment variable given by aKiSys3Dmod to a valid path.
|
|
* (typically "KISYS3DMOD" )
|
|
* If the environment variable is already set,
|
|
* then it left as is to respect the wishes of the user.
|
|
*
|
|
* The path is determined by attempting to find the path modules/packages3d
|
|
* files in kicad tree.
|
|
* This may or may not be the best path but it provides the best solution for
|
|
* backwards compatibility with the previous 3D shapes search path implementation.
|
|
*
|
|
* @note This must be called after #SetBinDir() is called at least on Windows.
|
|
* Otherwise, the kicad path is not known (Windows specific)
|
|
*
|
|
* @param aKiSys3Dmod = the value of environment variable, typically "KISYS3DMOD"
|
|
* @return false if the aKiSys3Dmod path is not valid.
|
|
*/
|
|
static bool set3DShapesPath( const wxString& aKiSys3Dmod )
|
|
{
|
|
wxString path;
|
|
|
|
// Set the KISYS3DMOD environment variable for the current process,
|
|
// if it is not already defined in the user's environment and valid.
|
|
if( wxGetEnv( aKiSys3Dmod, &path ) && wxFileName::DirExists( path ) )
|
|
return true;
|
|
|
|
// Attempt to determine where the 3D shape libraries were installed using the
|
|
// legacy path:
|
|
// on Unix: /usr/local/kicad/share/modules/packages3d
|
|
// or /usr/share/kicad/modules/packages3d
|
|
// On Windows: bin../share/modules/packages3d
|
|
wxString relpath( wxT( "modules/packages3d" ) );
|
|
|
|
// Apple MacOSx
|
|
#ifdef __WXMAC__
|
|
path = wxT("/Library/Application Support/kicad/modules/packages3d/");
|
|
|
|
if( wxFileName::DirExists( path ) )
|
|
{
|
|
wxSetEnv( aKiSys3Dmod, path );
|
|
return true;
|
|
}
|
|
|
|
path = wxString( wxGetenv( wxT( "HOME" ) ) ) + wxT("/Library/Application Support/kicad/modules/packages3d/");
|
|
|
|
if( wxFileName::DirExists( path ) )
|
|
{
|
|
wxSetEnv( aKiSys3Dmod, path );
|
|
return true;
|
|
}
|
|
|
|
#elif defined(__UNIX__) // Linux and non-Apple Unix
|
|
// Try the home directory:
|
|
path.Empty();
|
|
wxGetEnv( wxT("HOME"), &path );
|
|
path += wxT("/kicad/share/") + relpath;
|
|
|
|
if( wxFileName::DirExists( path ) )
|
|
{
|
|
wxSetEnv( aKiSys3Dmod, path );
|
|
return true;
|
|
}
|
|
|
|
// Try the standard install path:
|
|
path = wxT("/usr/local/kicad/share/") + relpath;
|
|
|
|
if( wxFileName::DirExists( path ) )
|
|
{
|
|
wxSetEnv( aKiSys3Dmod, path );
|
|
return true;
|
|
}
|
|
|
|
// Try the official distrib standard install path:
|
|
path = wxT("/usr/share/kicad/") + relpath;
|
|
|
|
if( wxFileName::DirExists( path ) )
|
|
{
|
|
wxSetEnv( aKiSys3Dmod, path );
|
|
return true;
|
|
}
|
|
|
|
#else // Windows
|
|
// On Windows, the install path is given by the path of executables
|
|
wxFileName fn;
|
|
fn.AssignDir( Pgm().GetExecutablePath() );
|
|
fn.RemoveLastDir();
|
|
path = fn.GetPathWithSep() + wxT("share/") + relpath;
|
|
|
|
if( wxFileName::DirExists( path ) )
|
|
{
|
|
wxSetEnv( aKiSys3Dmod, path );
|
|
return true;
|
|
}
|
|
#endif
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
#ifdef KICAD_SCRIPTING
|
|
static bool scriptingSetup()
|
|
{
|
|
wxString path_frag;
|
|
|
|
#ifdef __MINGW32__
|
|
// force python environment under Windows:
|
|
const wxString python_us( "python27_us" );
|
|
|
|
// Build our python path inside kicad
|
|
wxString kipython = FindKicadFile( python_us + wxT("/python.exe") );
|
|
|
|
//we need only the path:
|
|
wxFileName fn( kipython );
|
|
kipython = fn.GetPath();
|
|
|
|
// If our python install is existing inside kicad, use it
|
|
if( wxDirExists( kipython ) )
|
|
{
|
|
wxString ppath;
|
|
|
|
if( !wxGetEnv( wxT( "PYTHONPATH" ), &ppath ) || !ppath.Contains( python_us ) )
|
|
{
|
|
ppath << kipython << wxT("/pylib;");
|
|
ppath << kipython << wxT("/lib;");
|
|
ppath << kipython << wxT("/dll");
|
|
wxSetEnv( wxT( "PYTHONPATH" ), ppath );
|
|
DBG( std::cout << "set PYTHONPATH to " << TO_UTF8(ppath) << "\n"; )
|
|
|
|
// Add python executable path:
|
|
wxGetEnv( wxT( "PATH" ), &ppath );
|
|
if( !ppath.Contains( python_us ) )
|
|
{
|
|
kipython << wxT(";") << ppath;
|
|
wxSetEnv( wxT( "PATH" ), kipython );
|
|
DBG( std::cout << "set PATH to " << TO_UTF8(kipython) << "\n"; )
|
|
}
|
|
}
|
|
}
|
|
|
|
// TODO: make this path definable by the user, and set more than one path
|
|
// (and remove the fixed paths from <src>/scripting/kicadplugins.i)
|
|
|
|
// wizard plugins are stored in kicad/bin/plugins.
|
|
// so add this path to python scripting defualt search paths
|
|
// which are ( [KICAD_PATH] is an environment variable to define)
|
|
// [KICAD_PATH]/scripting/plugins
|
|
// Add this default search path:
|
|
path_frag = Pgm().GetExecutablePath() + wxT( "scripting/plugins" );
|
|
#else
|
|
// Add this default search path:
|
|
path_frag = wxT( "/usr/local/kicad/bin/scripting/plugins" );
|
|
|
|
#ifdef __WXMAC__
|
|
// OSX
|
|
// System Library first
|
|
// User Library then
|
|
// (TODO) Bundle package ? where to place ? Shared Support ?
|
|
path_frag = wxT( "/Library/Application Support/kicad/scripting" );
|
|
path_frag = wxString( wxGetenv("HOME") ) + wxT( "/Library/Application Support/kicad/scripting" );
|
|
|
|
// Get pcbnew.app/Contents directory
|
|
wxFileName bundledir( wxStandardPaths::Get().GetExecutablePath() ) ;
|
|
bundledir.RemoveLastDir();
|
|
|
|
// Prepend in PYTHONPATH the content of the bundle libraries !
|
|
wxSetEnv( "PYTHONPATH", ((wxGetenv("PYTHONPATH") != NULL ) ? (wxString(wxGetenv("PYTHONPATH")) + ":") : wxString("")) +
|
|
bundledir.GetPath() +
|
|
"/Frameworks/wxPython/lib/python2.6/site-packages/wx-3.0-osx_cocoa" + ":" +
|
|
"/Library/Application Support/kicad/" + ":" +
|
|
bundledir.GetPath() + "/PlugIns" + ":" +
|
|
wxString( wxGetenv("HOME") ) + "/Library/Application Support/kicad/"
|
|
);
|
|
#endif
|
|
#endif
|
|
|
|
// On linux and osx, 2 others paths are
|
|
// [HOME]/.kicad_plugins/
|
|
// [HOME]/.kicad/scripting/plugins/
|
|
if( !pcbnewInitPythonScripting( TO_UTF8( path_frag ) ) )
|
|
{
|
|
wxLogSysError( wxT( "pcbnewInitPythonScripting() failed." ) );
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
#endif // KICAD_SCRIPTING
|
|
|
|
|
|
/// The global footprint library table. This is not dynamically allocated because
|
|
/// in a multiple project environment we must keep its address constant (since it is
|
|
/// the fallback table for multiple projects).
|
|
FP_LIB_TABLE GFootprintTable;
|
|
|
|
|
|
bool IFACE::OnKifaceStart( PGM_BASE* aProgram, int aCtlBits )
|
|
{
|
|
// This is process level, not project level, initialization of the DSO.
|
|
|
|
// Do nothing in here pertinent to a project!
|
|
|
|
start_common( aCtlBits );
|
|
|
|
// Must be called before creating the main frame in order to
|
|
// display the real hotkeys in menus or tool tips
|
|
ReadHotkeyConfig( wxT( "PcbFrame" ), g_Board_Editor_Hokeys_Descr );
|
|
|
|
// Set 3D shape path from environment variable KISYS3DMOD
|
|
set3DShapesPath( wxT(KISYS3DMOD) );
|
|
|
|
/* 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( NULL, wxT(
|
|
"You have run Pcbnew for the first time using the "
|
|
"new footprint library table method for finding "
|
|
"footprints. Pcbnew has either copied the default "
|
|
"table or created an empty table in your home "
|
|
"folder. You must first configure the library "
|
|
"table to include all footprint libraries not "
|
|
"included with KiCad. See the \"Footprint Library "
|
|
"Table\" section of the CvPcb documentation for "
|
|
"more information." ) );
|
|
}
|
|
}
|
|
catch( const IO_ERROR& ioe )
|
|
{
|
|
wxString msg = wxString::Format( _(
|
|
"An error occurred attempting to load the global footprint library "
|
|
"table:\n\n%s" ),
|
|
GetChars( ioe.errorText )
|
|
);
|
|
DisplayError( NULL, msg );
|
|
return false;
|
|
}
|
|
|
|
#ifdef KICAD_SCRIPTING
|
|
scriptingSetup();
|
|
#endif
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void IFACE::OnKifaceEnd()
|
|
{
|
|
end_common();
|
|
|
|
#if KICAD_SCRIPTING_WXPYTHON
|
|
// Restore the thread state and tell Python to cleanup after itself.
|
|
// wxPython will do its own cleanup as part of that process.
|
|
// This should only be called if python was setup correctly.
|
|
|
|
pcbnewFinishPythonScripting();
|
|
#endif
|
|
}
|