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 <confirm.h>
31 #include <fp_lib_table.h>
32 #include <kiface_i.h>
33 #include <pgm_base.h>
34 
35 #include <cvpcb_mainframe.h>
37 
38 
39 namespace CV {
40 
41 static struct IFACE : public KIFACE_I
42 {
43  // Of course all are virtual overloads, implementations of the KIFACE.
44 
45  IFACE( const char* aName, KIWAY::FACE_T aType ) :
46  KIFACE_I( aName, aType )
47  {}
48 
49  bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits ) override;
50 
51  void OnKifaceEnd() override;
52 
53  wxWindow* CreateWindow( wxWindow* aParent, int aClassId, KIWAY* aKiway, int aCtlBits = 0 ) override
54  {
55  switch( aClassId )
56  {
57  case FRAME_CVPCB: return new CVPCB_MAINFRAME( aKiway, aParent );
58  case FRAME_CVPCB_DISPLAY: return new DISPLAY_FOOTPRINTS_FRAME( aKiway, aParent );
59  default: return NULL;
60  }
61  }
62 
74  void* IfaceOrAddress( int aDataId ) override
75  {
76  return NULL;
77  }
78 
79 } kiface( "cvpcb", KIWAY::FACE_CVPCB );
80 
81 } // namespace
82 
83 using namespace CV;
84 
85 
86 static PGM_BASE* process;
87 
88 
89 KIFACE_I& Kiface() { return kiface; }
90 
91 
92 // KIFACE_GETTER's actual spelling is a substitution macro found in kiway.h.
93 // KIFACE_GETTER will not have name mangling due to declaration in kiway.h.
94 MY_API( KIFACE* ) KIFACE_GETTER( int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram )
95 {
97  return &kiface;
98 }
99 
100 
102 {
103  wxASSERT( process ); // KIFACE_GETTER has already been called.
104  return *process;
105 }
106 
107 
108 // Similar to PGM_BASE& Pgm(), but return nullptr when a *.ki_face
109 // is run from a python script, mot from a Kicad application
111 {
112  return process;
113 }
114 
115 
117 
119 
120 
121 // A short lived implementation. cvpcb will get combine into pcbnew shortly, so
122 // we skip setting KISYSMOD here for now. User should set the environment
123 // variable.
124 
125 bool IFACE::OnKifaceStart( PGM_BASE* aProgram, int aCtlBits )
126 {
127  // This is process level, not project level, initialization of the DSO.
128 
129  // Do nothing in here pertinent to a project!
130 
131  start_common( aCtlBits );
132 
133  /* Now that there are no *.mod files in the standard library, this function
134  has no utility. User should simply set the variable manually.
135  Looking for *.mod files which do not exist is fruitless.
136 
137  // SetFootprintLibTablePath();
138  */
139 
140  try
141  {
142  // The global table is not related to a specific project. All projects
143  // will use the same global table. So the KIFACE::OnKifaceStart() contract
144  // of avoiding anything project specific is not violated here.
145 
147  {
148  DisplayInfoMessage( NULL, _(
149  "You have run CvPcb for the first time using the "
150  "new footprint library table method for finding "
151  "footprints.\nCvPcb has either copied the default "
152  "table or created an empty table in your home "
153  "folder.\nYou must first configure the library "
154  "table to include all footprint libraries not "
155  "included with KiCad.\nSee the \"Footprint Library "
156  "Table\" section of the CvPcb documentation for "
157  "more information." ) );
158  }
159  }
160  catch( const IO_ERROR& ioe )
161  {
163  nullptr,
164  _( "An error occurred attempting to load the global footprint library table" ),
165  ioe.What() );
166  return false;
167  }
168 
169  return true;
170 }
171 
173 {
174  end_common();
175 }
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:90
FP_LIB_TABLE GFootprintTable
!!!!!!!!!!!!!! This code is obsolete because of the merge into pcbnew, don't bother with it.
Definition: cvpcb.cpp:118
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:249
This file is part of the common library.
Class PGM_BASE keeps program (whole process) data for KiCad programs.
Definition: pgm_base.h:156
Definition: cvpcb.cpp:39
void * IfaceOrAddress(int aDataId) override
Function IfaceOrAddress return a pointer to the requested object.
Definition: cvpcb.cpp:74
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: cvpcb.cpp:89
Class DISPLAY_FOOTPRINTS_FRAME is used to display footprints.
void OnKifaceEnd() override
Function OnKifaceEnd is called just once just before the DSO is to be unloaded.
Definition: cvpcb.cpp:172
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
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:100
PGM_BASE * PgmOrNull()
similat to PGM_BASE& Pgm(), but return a reference that can be nullptr when running a shared lib from...
Definition: cvpcb.cpp:110
CV::IFACE KIFACE_I kiface("cvpcb", KIWAY::FACE_CVPCB)
static PGM_BASE * process
Definition: cvpcb.cpp:86
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:274
#define _(s)
FACE_T
Known KIFACE implementations.
Definition: kiway.h:280
int aKIWAYversion
Definition: cvpcb.cpp:94
bool OnKifaceStart(PGM_BASE *aProgram, int aCtlBits) override
Function OnKifaceStart is called just once shortly after the DSO is loaded.
Definition: cvpcb.cpp:125
see class PGM_BASE
IFACE(const char *aName, KIWAY::FACE_T aType)
Definition: cvpcb.cpp:45
Class KIFACE is used by a participant in the KIWAY alchemy.
Definition: kiway.h:151
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: cvpcb.cpp:101
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:264
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
MY_API(KIFACE *) KIFACE_GETTER(int *aKIFACEversion
int PGM_BASE * aProgram
Definition: cvpcb.cpp:95
The CvPcb application main window.
wxWindow * CreateWindow(wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
Function CreateWindow creates a wxWindow for the current project.
Definition: cvpcb.cpp:53