KiCad PCB EDA Suite
cvpcb.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2007 Jean-Pierre Charras, jp..charras at wanadoo.fr
5  * Copyright (C) 2014 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2014 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
30 #include <fctsys.h>
31 #include <macros.h>
32 #include <fp_lib_table.h>
33 #include <kiface_i.h>
34 #include <pgm_base.h>
35 #include <wxstruct.h>
36 #include <confirm.h>
37 
38 #include <cvpcb.h>
39 #include <zones.h>
40 #include <cvpcb_mainframe.h>
41 #include <cvpcb_id.h>
42 
43 #include <build_version.h>
44 
45 #include <wx/snglinst.h>
46 
47 // Constant string definitions for CvPcb
48 const wxString EquFileExtension( wxT( "equ" ) );
49 
50 // Wildcard for schematic retroannotation (import footprint names in schematic):
51 const wxString EquFilesWildcard( _( "Component/footprint equ files (*.equ)|*.equ" ) );
52 
53 namespace CV {
54 
55 static struct IFACE : public KIFACE_I
56 {
57  // Of course all are virtual overloads, implementations of the KIFACE.
58 
59  IFACE( const char* aName, KIWAY::FACE_T aType ) :
60  KIFACE_I( aName, aType )
61  {}
62 
63  bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits ) override;
64 
65  void OnKifaceEnd() override;
66 
67  wxWindow* CreateWindow( wxWindow* aParent, int aClassId, KIWAY* aKiway, int aCtlBits = 0 ) override
68  {
69  switch( aClassId )
70  {
71  case FRAME_CVPCB:
72  {
73  CVPCB_MAINFRAME* frame = new CVPCB_MAINFRAME( aKiway, aParent );
74  return frame;
75  }
76  break;
77 
78  default:
79  ;
80  }
81 
82  return NULL;
83  }
84 
96  void* IfaceOrAddress( int aDataId ) override
97  {
98  return NULL;
99  }
100 
101 } kiface( "cvpcb", KIWAY::FACE_CVPCB );
102 
103 } // namespace
104 
105 using namespace CV;
106 
107 
109 
110 
111 KIFACE_I& Kiface() { return kiface; }
112 
113 
114 // KIFACE_GETTER's actual spelling is a substitution macro found in kiway.h.
115 // KIFACE_GETTER will not have name mangling due to declaration in kiway.h.
116 MY_API( KIFACE* ) KIFACE_GETTER( int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram )
117 {
118  process = (PGM_BASE*) aProgram;
119  return &kiface;
120 }
121 
122 
124 {
125  wxASSERT( process ); // KIFACE_GETTER has already been called.
126  return *process;
127 }
128 
129 
131 
133 
134 
135 // A short lived implementation. cvpcb will get combine into pcbnew shortly, so
136 // we skip setting KISYSMOD here for now. User should set the environment
137 // variable.
138 
139 bool IFACE::OnKifaceStart( PGM_BASE* aProgram, int aCtlBits )
140 {
141  // This is process level, not project level, initialization of the DSO.
142 
143  // Do nothing in here pertinent to a project!
144 
145  start_common( aCtlBits );
146 
147  /* Now that there are no *.mod files in the standard library, this function
148  has no utility. User should simply set the variable manually.
149  Looking for *.mod files which do not exist is fruitless.
150 
151  // SetFootprintLibTablePath();
152  */
153 
154  try
155  {
156  // The global table is not related to a specific project. All projects
157  // will use the same global table. So the KIFACE::OnKifaceStart() contract
158  // of avoiding anything project specific is not violated here.
159 
160  if( !FP_LIB_TABLE::LoadGlobalTable( GFootprintTable ) )
161  {
162  DisplayInfoMessage( NULL, _(
163  "You have run CvPcb for the first time using the "
164  "new footprint library table method for finding "
165  "footprints. CvPcb has either copied the default "
166  "table or created an empty table in your home "
167  "folder. You must first configure the library "
168  "table to include all footprint libraries not "
169  "included with KiCad. See the \"Footprint Library "
170  "Table\" section of the CvPcb documentation for "
171  "more information." ) );
172  }
173  }
174  catch( const IO_ERROR& ioe )
175  {
177  nullptr,
178  _( "An error occurred attempting to load the global footprint library table" ),
179  ioe.What() );
180  return false;
181  }
182 
183  return true;
184 }
185 
187 {
188  end_common();
189 }
static PGM_BASE * process
Definition: cvpcb.cpp:108
Class KIFACE_I is a KIFACE (I)mplementation, with some features useful for DSOs which implement a KIF...
Definition: kiface_i.h:37
bool start_common(int aCtlBits)
Common things to do for a top program module, during OnKifaceStart().
Definition: kiface_i.cpp:94
FP_LIB_TABLE GFootprintTable
!!!!!!!!!!!!!! This code is obsolete because of the merge into pcbnew, don't bother with it...
Definition: cvpcb.cpp:132
This file is part of the common library.
Class PGM_BASE keeps program (whole process) data for KiCad programs.
Definition: pgm_base.h:107
Definition: cvpcb.cpp:53
void * IfaceOrAddress(int aDataId) override
Function IfaceOrAddress return a pointer to the requested object.
Definition: cvpcb.cpp:96
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: cvpcb.cpp:111
This file contains miscellaneous commonly used macros and functions.
void OnKifaceEnd() override
Function OnKifaceEnd is called just once just before the DSO is to be unloaded.
Definition: cvpcb.cpp:186
const wxString EquFilesWildcard(_("Component/footprint equ files (*.equ)|*.equ"))
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString aExtraInfo)
Function DisplayErrorMessage displays an error message with aMessage.
Definition: confirm.cpp:85
KIFACE * KIFACE_GETTER(int *aKIFACEversion, int aKIWAYversion, PGM_BASE *aProgram)
No name mangling. Each KIFACE (DSO/DLL) will implement this once.
static bool LoadGlobalTable(FP_LIB_TABLE &aTable)
Function LoadGlobalTable loads the global footprint library table into aTable.
void end_common()
Common things to do for a top program module, during OnKifaceEnd();.
Definition: kiface_i.cpp:104
CV::IFACE KIFACE_I kiface("cvpcb", KIWAY::FACE_CVPCB)
Base window classes and related definitions.
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:257
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:102
FACE_T
Known KIFACE implementations.
Definition: kiway.h:263
int aKIWAYversion
Definition: cvpcb.cpp:116
bool OnKifaceStart(PGM_BASE *aProgram, int aCtlBits) override
Function OnKifaceStart is called just once shortly after the DSO is loaded.
Definition: cvpcb.cpp:139
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
see class PGM_BASE
IFACE(const char *aName, KIWAY::FACE_T aType)
Definition: cvpcb.cpp:59
Class KIFACE is used by a participant in the KIWAY alchemy.
Definition: kiway.h:150
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: cvpcb.cpp:123
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:47
MY_API(KIFACE *) KIFACE_GETTER(int *aKIFACEversion
const wxString EquFileExtension(wxT("equ"))
The CvPcb application main window.
int PGM_BASE * aProgram
Definition: pcbnew.cpp:195
wxWindow * CreateWindow(wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
Function CreateWindow creates a wxWindow for the current project.
Definition: cvpcb.cpp:67