KiCad PCB EDA Suite
eeschema.cpp File Reference

the main file More...

#include <fctsys.h>
#include <pgm_base.h>
#include <kiface_i.h>
#include <class_drawpanel.h>
#include <confirm.h>
#include <gestfich.h>
#include <eda_dde.h>
#include <sch_edit_frame.h>
#include <lib_edit_frame.h>
#include <viewlib_frame.h>
#include <eda_text.h>
#include <general.h>
#include <class_libentry.h>
#include <hotkeys.h>
#include <transform.h>
#include <wildcards_and_files_ext.h>
#include <symbol_lib_table.h>
#include <dialogs/dialog_global_sym_lib_table_config.h>
#include <dialogs/panel_sym_lib_table.h>
#include <kiway.h>
#include <sim/sim_plot_frame.h>

Go to the source code of this file.

Classes

struct  SCH::IFACE
 

Namespaces

 SCH
 

Macros

#define CLR(x, y, z)
 

Functions

SCH::IFACE KIFACE_I SCH::kiface ("eeschema", KIWAY::FACE_SCH)
 
 IFACE (const char *aName, KIWAY::FACE_T aType)
 
bool OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override
 
void OnKifaceEnd () override
 
wxWindow * CreateWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
 
void * IfaceOrAddress (int aDataId) override
 Function IfaceOrAddress return a pointer to the requested object. More...
 
KIFACE_IKiface ()
 Global KIFACE_I "get" accessor. More...
 
 MY_API (KIFACE *) KIFACE_GETTER(int *aKIFACEversion
 
PGM_BASEPgm ()
 The global Program "get" accessor. More...
 
COLOR4D GetLayerColor (SCH_LAYER_ID aLayer)
 
void SetLayerColor (COLOR4D aColor, SCH_LAYER_ID aLayer)
 
static PARAM_CFG_ARRAYcfg_params ()
 

Variables

SCH_SHEETg_RootSheet = NULL
 
TRANSFORM DefaultTransform = TRANSFORM( 1, 0, 0, -1 )
 
static PGM_BASEprocess
 
int aKiwayVersion
 
int PGM_BASEaProgram
 
return & kiface
 
static COLOR4D s_layerColor [LAYER_ID_COUNT]
 

Detailed Description

the main file

Definition in file eeschema.cpp.

Macro Definition Documentation

#define CLR (   x,
  y,
 
)
Value:
ca.push_back( new PARAM_CFG_SETCOLOR( true, wxT( x ),\
&s_layerColor[( y )], z ) );
static COLOR4D s_layerColor[LAYER_ID_COUNT]
Definition: eeschema.cpp:172
Configuration parameter - SetColor Class.

Referenced by cfg_params().

Function Documentation

static PARAM_CFG_ARRAY& cfg_params ( )
static

Definition at line 195 of file eeschema.cpp.

References BLACK, BLUE, BROWN, CLR, CYAN, DARKGRAY, GREEN, LAYER_BRIGHTENED, LAYER_BUS, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_ERC_ERR, LAYER_ERC_WARN, LAYER_FIELDS, LAYER_GLOBLABEL, LAYER_HIDDEN, LAYER_HIERLABEL, LAYER_JUNCTION, LAYER_LOCLABEL, LAYER_NETNAM, LAYER_NOCONNECT, LAYER_NOTES, LAYER_PIN, LAYER_PINNAM, LAYER_PINNUM, LAYER_REFERENCEPART, LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_CURSOR, LAYER_SCHEMATIC_GRID, LAYER_SHEET, LAYER_SHEETFILENAME, LAYER_SHEETLABEL, LAYER_SHEETNAME, LAYER_VALUEPART, LAYER_WIRE, LAYER_WORKSHEET, LIGHTBLUE, LIGHTGRAY, LIGHTYELLOW, MAGENTA, PUREMAGENTA, RED, and WHITE.

Referenced by SCH::IFACE::OnKifaceEnd(), and SCH::IFACE::OnKifaceStart().

196 {
197  static PARAM_CFG_ARRAY ca;
198 
199  if( !ca.size() )
200  {
201  // These are KIFACE specific, they need to be loaded once when the
202  // eeschema KIFACE comes in.
203 
204 #define CLR(x, y, z)\
205  ca.push_back( new PARAM_CFG_SETCOLOR( true, wxT( x ),\
206  &s_layerColor[( y )], z ) );
207 
208  CLR( "Color4DWireEx", LAYER_WIRE, COLOR4D( GREEN ) )
209  CLR( "Color4DBusEx", LAYER_BUS, COLOR4D( BLUE ) )
210  CLR( "Color4DConnEx", LAYER_JUNCTION, COLOR4D( GREEN ) )
211  CLR( "Color4DLLabelEx", LAYER_LOCLABEL, COLOR4D( BLACK ) )
212  CLR( "Color4DHLabelEx", LAYER_HIERLABEL, COLOR4D( BROWN ) )
213  CLR( "Color4DGLabelEx", LAYER_GLOBLABEL, COLOR4D( RED ) )
214  CLR( "Color4DPinNumEx", LAYER_PINNUM, COLOR4D( RED ) )
215  CLR( "Color4DPinNameEx", LAYER_PINNAM, COLOR4D( CYAN ) )
216  CLR( "Color4DFieldEx", LAYER_FIELDS, COLOR4D( MAGENTA ) )
217  CLR( "Color4DReferenceEx", LAYER_REFERENCEPART, COLOR4D( CYAN ) )
218  CLR( "Color4DValueEx", LAYER_VALUEPART, COLOR4D( CYAN ) )
219  CLR( "Color4DNoteEx", LAYER_NOTES, COLOR4D( LIGHTBLUE ) )
220  CLR( "Color4DBodyEx", LAYER_DEVICE, COLOR4D( RED ) )
221  CLR( "Color4DBodyBgEx", LAYER_DEVICE_BACKGROUND, COLOR4D( LIGHTYELLOW ) )
222  CLR( "Color4DNetNameEx", LAYER_NETNAM, COLOR4D( DARKGRAY ) )
223  CLR( "Color4DPinEx", LAYER_PIN, COLOR4D( RED ) )
224  CLR( "Color4DSheetEx", LAYER_SHEET, COLOR4D( MAGENTA ) )
225  CLR( "Color4DSheetFileNameEx", LAYER_SHEETFILENAME, COLOR4D( BROWN ) )
226  CLR( "Color4DSheetNameEx", LAYER_SHEETNAME, COLOR4D( CYAN ) )
227  CLR( "Color4DSheetLabelEx", LAYER_SHEETLABEL, COLOR4D( BROWN ) )
228  CLR( "Color4DNoConnectEx", LAYER_NOCONNECT, COLOR4D( BLUE ) )
229  CLR( "Color4DErcWEx", LAYER_ERC_WARN, COLOR4D( GREEN ).WithAlpha(0.8 ) )
230  CLR( "Color4DErcEEx", LAYER_ERC_ERR, COLOR4D( RED ).WithAlpha(0.8 ) )
231  CLR( "Color4DGridEx", LAYER_SCHEMATIC_GRID, COLOR4D( DARKGRAY ) )
232  CLR( "Color4DBgCanvasEx", LAYER_SCHEMATIC_BACKGROUND, COLOR4D( WHITE ) )
233  CLR( "Color4DCursorEx", LAYER_SCHEMATIC_CURSOR, COLOR4D( BLACK ) )
234  CLR( "Color4DBrightenedEx", LAYER_BRIGHTENED, COLOR4D( PUREMAGENTA ) )
235  CLR( "Color4DHiddenEx", LAYER_HIDDEN, COLOR4D( LIGHTGRAY ) )
236  CLR( "Color4DWorksheetEx", LAYER_WORKSHEET, COLOR4D( RED ) )
237  }
238 
239  return ca;
240 }
Definition: colors.h:57
A list of parameters type.
Definition: colors.h:61
#define CLR(x, y, z)
Definition: colors.h:59
Definition: colors.h:60
Definition: colors.h:58
Definition: colors.h:49
Definition: colors.h:45
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
Definition: colors.h:62
wxWindow* kiface::CreateWindow ( wxWindow *  aParent,
int  aClassId,
KIWAY aKiway,
int  aCtlBits = 0 
)
override

Definition at line 312 of file eeschema.cpp.

kiface::IFACE ( const char *  aName,
KIWAY::FACE_T  aType 
)

Definition at line 304 of file eeschema.cpp.

void* kiface::IfaceOrAddress ( int  aDataId)
override

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.

Parameters
aDataIdidentifies which object you want the address of.
Returns
void* - and must be cast into the know type.

Definition at line 375 of file eeschema.cpp.

KIFACE_I& Kiface ( )

Global KIFACE_I "get" accessor.

Definition at line 153 of file eeschema.cpp.

References SCH::kiface().

Referenced by SCH::IFACE::CreateWindow().

153 { return kiface; }
return & kiface
Definition: eeschema.cpp:161
MY_API ( KIFACE )
void kiface::OnKifaceEnd ( )
override
bool kiface::OnKifaceStart ( PGM_BASE aProgram,
int  aCtlBits 
)
override
PGM_BASE& Pgm ( )

The global Program "get" accessor.

Implemented in: 1) common/single_top.cpp, 2) kicad/kicad.cpp, and 3) scripting/kiway.i

Definition at line 165 of file eeschema.cpp.

References process.

166 {
167  wxASSERT( process ); // KIFACE_GETTER has already been called.
168  return *process;
169 }
static PGM_BASE * process
Definition: eeschema.cpp:150
void SetLayerColor ( COLOR4D  aColor,
SCH_LAYER_ID  aLayer 
)

Definition at line 181 of file eeschema.cpp.

References KIGFX::COLOR4D::Darken(), DIM, LAYER_SCHEMATIC_BACKGROUND, and WHITE.

Referenced by SCH::IFACE::OnKifaceStart(), and WIDGET_EESCHEMA_COLOR_CONFIG::TransferDataFromControl().

182 {
183  // Do not allow non-background layers to be completely white.
184  // This ensures the BW printing recognizes that the colors should be
185  // printed black.
186  if( aColor == COLOR4D::WHITE && aLayer != LAYER_SCHEMATIC_BACKGROUND )
187  aColor.Darken( 0.01 );
188 
189  unsigned layer = aLayer;
190  wxASSERT( layer < DIM( s_layerColor ) );
191  s_layerColor[layer] = aColor;
192 }
#define DIM(x)
of elements in an array
Definition: macros.h:98
static COLOR4D s_layerColor[LAYER_ID_COUNT]
Definition: eeschema.cpp:172
COLOR4D & Darken(double aFactor)
Function Darken Makes the color darker by a given factor.
Definition: color4d.h:165
Definition: colors.h:49

Variable Documentation

int aKiwayVersion

Definition at line 158 of file eeschema.cpp.

int PGM_BASE* aProgram
Initial value:
{
int PGM_BASE * aProgram
Definition: eeschema.cpp:159
static PGM_BASE * process
Definition: eeschema.cpp:150

Definition at line 159 of file eeschema.cpp.

Referenced by SCH::IFACE::IFACE().

SCH_SHEET* g_RootSheet = NULL

Definition at line 56 of file eeschema.cpp.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), SCH_EDIT_FRAME::addCurrentItemToScreen(), SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDIT_FRAME::AppendSchematic(), SCH_EDIT_FRAME::backAnnotateFootprints(), SCH_SCREENS::BuildClientSheetPathList(), SCH_EDIT_FRAME::BuildNetListBase(), SCH_SHEET_LIST::BuildSheetList(), SCH_EDIT_FRAME::CheckAnnotate(), SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), SCH_FIND_COLLECTOR::Collect(), SCH_EDIT_FRAME::CreateArchiveLibraryCacheFile(), DIALOG_PLOT_SCHEMATIC::CreateDXFFile(), DIALOG_PLOT_SCHEMATIC::createHPGLFile(), SCH_EDIT_FRAME::CreateNetlist(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPSFile(), SCH_EDIT_FRAME::CreateScreens(), DIALOG_PLOT_SCHEMATIC::createSVGFile(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_ERC::DisplayERC_MarkersList(), SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doUpdatePcb(), SCH_EDIT_FRAME::DuplicateItemsInList(), SCH_EDIT_FRAME::EditSheet(), NETLIST_EXPORTER::findAllUnitsOfComponent(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_DIALOG::GenNetlist(), SCH_PRINTOUT::GetPageInfo(), GetRescueLibraryFileName(), SCH_PRINTOUT::HasPage(), HIERARCHY_NAVIG_DLG::HIERARCHY_NAVIG_DLG(), SCH_EDIT_FRAME::importFile(), DIALOG_EDIT_COMPONENTS_LIBID::initDlg(), SCH_EDIT_FRAME::isAutoSaveRequired(), NETLIST_EXPORTER_GENERIC::makeComponents(), NETLIST_EXPORTER_GENERIC::makeDesignHeader(), mapExistingAnnotation(), SCH_EDIT_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnEditItem(), SCH_EDIT_FRAME::OnFindDrcMarker(), SCH_EDIT_FRAME::OnFindReplace(), SCH_EDIT_FRAME::OnFindSchematicItem(), DIALOG_ERC::OnLeftClickMarkersList(), NETLIST_DIALOG::OnNetlistTypeSelection(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), SCH_EDIT_FRAME::OnPrint(), SCH_PRINTOUT::OnPrintPage(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), SCH_EDIT_FRAME::OnUpdateHierarchySheet(), SCH_EDIT_FRAME::OnUpdateSave(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), SCH_EDIT_FRAME::prepareForNetlist(), SCH_EDIT_FRAME::Process_Config(), SCH_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), NETLIST_DIALOG::RunSimulator(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), SCH_SCREENS::SCH_SCREENS(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), DIALOG_ERC::TestErc(), SCH_SHEET_PATH::TestForRecursion(), SCH_SHEET_LIST::TestForRecursion(), DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow(), NETLIST_EXPORTER_PSPICE::UpdateDirectives(), SCH_EDIT_FRAME::updateFindReplaceView(), WriteDiagnosticERC(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

return& kiface

Definition at line 161 of file eeschema.cpp.

PGM_BASE* process
static

Definition at line 150 of file eeschema.cpp.

Referenced by Pgm().

COLOR4D s_layerColor[LAYER_ID_COUNT]
static

Definition at line 172 of file eeschema.cpp.