KiCad PCB EDA Suite
eeschema.cpp File Reference
#include <fctsys.h>
#include <pgm_base.h>
#include <kiface_i.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 <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]
 

Macro Definition Documentation

◆ CLR

#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:158
Configuration parameter - SetColor Class.

Function Documentation

◆ cfg_params()

static PARAM_CFG_ARRAY& cfg_params ( )
static

Definition at line 181 of file eeschema.cpp.

182 {
183  static PARAM_CFG_ARRAY ca;
184 
185  if( !ca.size() )
186  {
187  // These are KIFACE specific, they need to be loaded once when the
188  // eeschema KIFACE comes in.
189 
190 #define CLR(x, y, z)\
191  ca.push_back( new PARAM_CFG_SETCOLOR( true, wxT( x ),\
192  &s_layerColor[( y )], z ) );
193 
194  CLR( "Color4DWireEx", LAYER_WIRE, COLOR4D( GREEN ) )
195  CLR( "Color4DBusEx", LAYER_BUS, COLOR4D( BLUE ) )
196  CLR( "Color4DConnEx", LAYER_JUNCTION, COLOR4D( GREEN ) )
197  CLR( "Color4DLLabelEx", LAYER_LOCLABEL, COLOR4D( BLACK ) )
198  CLR( "Color4DHLabelEx", LAYER_HIERLABEL, COLOR4D( BROWN ) )
199  CLR( "Color4DGLabelEx", LAYER_GLOBLABEL, COLOR4D( RED ) )
200  CLR( "Color4DPinNumEx", LAYER_PINNUM, COLOR4D( RED ) )
201  CLR( "Color4DPinNameEx", LAYER_PINNAM, COLOR4D( CYAN ) )
202  CLR( "Color4DFieldEx", LAYER_FIELDS, COLOR4D( MAGENTA ) )
203  CLR( "Color4DReferenceEx", LAYER_REFERENCEPART, COLOR4D( CYAN ) )
204  CLR( "Color4DValueEx", LAYER_VALUEPART, COLOR4D( CYAN ) )
205  CLR( "Color4DNoteEx", LAYER_NOTES, COLOR4D( LIGHTBLUE ) )
206  CLR( "Color4DBodyEx", LAYER_DEVICE, COLOR4D( RED ) )
207  CLR( "Color4DBodyBgEx", LAYER_DEVICE_BACKGROUND, COLOR4D( LIGHTYELLOW ) )
208  CLR( "Color4DNetNameEx", LAYER_NETNAM, COLOR4D( DARKGRAY ) )
209  CLR( "Color4DPinEx", LAYER_PIN, COLOR4D( RED ) )
210  CLR( "Color4DSheetEx", LAYER_SHEET, COLOR4D( MAGENTA ) )
211  CLR( "Color4DSheetFileNameEx", LAYER_SHEETFILENAME, COLOR4D( BROWN ) )
212  CLR( "Color4DSheetNameEx", LAYER_SHEETNAME, COLOR4D( CYAN ) )
213  CLR( "Color4DSheetLabelEx", LAYER_SHEETLABEL, COLOR4D( BROWN ) )
214  CLR( "Color4DNoConnectEx", LAYER_NOCONNECT, COLOR4D( BLUE ) )
215  CLR( "Color4DErcWEx", LAYER_ERC_WARN, COLOR4D( GREEN ).WithAlpha(0.8 ) )
216  CLR( "Color4DErcEEx", LAYER_ERC_ERR, COLOR4D( RED ).WithAlpha(0.8 ) )
217  CLR( "Color4DGridEx", LAYER_SCHEMATIC_GRID, COLOR4D( DARKGRAY ) )
218  CLR( "Color4DBgCanvasEx", LAYER_SCHEMATIC_BACKGROUND, COLOR4D( WHITE ) )
219  CLR( "Color4DCursorEx", LAYER_SCHEMATIC_CURSOR, COLOR4D( BLACK ) )
220  CLR( "Color4DBrightenedEx", LAYER_BRIGHTENED, COLOR4D( PUREMAGENTA ) )
221  CLR( "Color4DHiddenEx", LAYER_HIDDEN, COLOR4D( LIGHTGRAY ) )
222  CLR( "Color4DWorksheetEx", LAYER_WORKSHEET, COLOR4D( RED ) )
223  }
224 
225  return ca;
226 }
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

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().

◆ CreateWindow()

wxWindow* kiface::CreateWindow ( wxWindow *  aParent,
int  aClassId,
KIWAY aKiway,
int  aCtlBits = 0 
)
override

Definition at line 294 of file eeschema.cpp.

◆ GetLayerColor()

COLOR4D GetLayerColor ( SCH_LAYER_ID  aLayer)

Definition at line 160 of file eeschema.cpp.

161 {
162  unsigned layer = ( aLayer );
163  wxASSERT( layer < arrayDim( s_layerColor ) );
164  return s_layerColor[layer];
165 }
static COLOR4D s_layerColor[LAYER_ID_COUNT]
Definition: eeschema.cpp:158
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108

References arrayDim(), and s_layerColor.

Referenced by WIDGET_EESCHEMA_COLOR_CONFIG::CreateControls(), SCH_LINE::GetDefaultColor(), LIB_FIELD::GetDefaultColor(), LIB_ITEM::GetDefaultColor(), SCH_LINE::GetLineColor(), LIB_RECTANGLE::Plot(), LIB_CIRCLE::Plot(), LIB_BEZIER::Plot(), LIB_ARC::Plot(), SCH_JUNCTION::Plot(), LIB_POLYLINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), SCH_LINE::Plot(), LIB_PART::Plot(), SCH_SHEET::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), LIB_PART::PlotLibFields(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), LIB_PIN::PlotPinTexts(), LIB_PIN::PlotSymbol(), LIB_POLYLINE::print(), LIB_CIRCLE::print(), LIB_RECTANGLE::print(), LIB_BEZIER::print(), SCH_MARKER::Print(), LIB_ARC::print(), SCH_JUNCTION::Print(), SCH_NO_CONNECT::Print(), SCH_BUS_ENTRY_BASE::Print(), SCH_TEXT::Print(), SCH_LINE::Print(), SCH_FIELD::Print(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_SHEET::Print(), SCH_PRINTOUT::PrintPage(), LIB_PIN::PrintPinElectricalTypeName(), LIB_PIN::PrintPinSymbol(), LIB_PIN::PrintPinTexts(), and SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL().

◆ IFACE()

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

Definition at line 286 of file eeschema.cpp.

◆ IfaceOrAddress()

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 352 of file eeschema.cpp.

◆ Kiface()

KIFACE_I& Kiface ( )

Global KIFACE_I "get" accessor.

Definition at line 139 of file eeschema.cpp.

139 { return kiface; }
return & kiface
Definition: eeschema.cpp:147

References SCH::kiface().

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

◆ MY_API()

MY_API ( KIFACE )

◆ OnKifaceEnd()

void kiface::OnKifaceEnd ( )
override

◆ OnKifaceStart()

bool kiface::OnKifaceStart ( PGM_BASE aProgram,
int  aCtlBits 
)
override

◆ Pgm()

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 151 of file eeschema.cpp.

152 {
153  wxASSERT( process ); // KIFACE_GETTER has already been called.
154  return *process;
155 }
static PGM_BASE * process
Definition: eeschema.cpp:136

References process.

◆ SetLayerColor()

void SetLayerColor ( COLOR4D  aColor,
SCH_LAYER_ID  aLayer 
)

Definition at line 167 of file eeschema.cpp.

168 {
169  // Do not allow non-background layers to be completely white.
170  // This ensures the BW printing recognizes that the colors should be
171  // printed black.
172  if( aColor == COLOR4D::WHITE && aLayer != LAYER_SCHEMATIC_BACKGROUND )
173  aColor.Darken( 0.01 );
174 
175  unsigned layer = aLayer;
176  wxASSERT( layer < arrayDim( s_layerColor ) );
177  s_layerColor[layer] = aColor;
178 }
static COLOR4D s_layerColor[LAYER_ID_COUNT]
Definition: eeschema.cpp:158
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108
COLOR4D & Darken(double aFactor)
Function Darken Makes the color darker by a given factor.
Definition: color4d.h:163
Definition: colors.h:49

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

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

Variable Documentation

◆ aKiwayVersion

int aKiwayVersion

Definition at line 144 of file eeschema.cpp.

◆ aProgram

int PGM_BASE* aProgram
Initial value:
{
int PGM_BASE * aProgram
Definition: eeschema.cpp:145
static PGM_BASE * process
Definition: eeschema.cpp:136

Definition at line 145 of file eeschema.cpp.

◆ DefaultTransform

◆ g_RootSheet

SCH_SHEET* g_RootSheet = NULL

Definition at line 47 of file eeschema.cpp.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDITOR_CONTROL::BackAnnotateFootprints(), SCH_SCREENS::BuildClientSheetPathList(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_EDIT_FRAME::BuildNetListBase(), SCH_SHEET_LIST::BuildSheetList(), SCH_EDIT_FRAME::CheckAnnotate(), SCH_EDIT_FRAME::checkSheetForRecursion(), SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), 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_TOOL::Duplicate(), SCH_EDIT_FRAME::EditSheet(), NETLIST_EXPORTER::findAllUnitsOfComponent(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), SCH_EDIT_FRAME::FixupJunctions(), SCH_SCREEN::GetBusAlias(), SCH_PRINTOUT::GetPageInfo(), GetRescueLibraryFileName(), SCH_PRINTOUT::HasPage(), HIERARCHY_NAVIG_DLG::HIERARCHY_NAVIG_DLG(), SCH_EDIT_FRAME::importFile(), SCH_DRAWING_TOOLS::Init(), EE_SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), DIALOG_EDIT_COMPONENTS_LIBID::initDlg(), SCH_EDIT_FRAME::isAutoSaveRequired(), SCH_SCREEN::IsBusAlias(), SCH_EDIT_FRAME::KiwayMailIn(), SCH_EDITOR_CONTROL::LeaveSheet(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_GENERIC::makeComponents(), NETLIST_EXPORTER_GENERIC::makeDesignHeader(), mapExistingAnnotation(), SCH_EDIT_FRAME::NormalizeSchematicOnFirstLoad(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_ERC::OnLeftClickMarkersList(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), SCH_PRINTOUT::OnPrintPage(), DIALOG_BOM::OnRunGenerator(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::prepareForNetlist(), SCH_EDIT_FRAME::Print(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_EDIT_FRAME::ReCreateMenuBar(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), SCH_SCREENS::SCH_SCREENS(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), SCH_EDIT_FRAME::SyncToolbars(), DIALOG_ERC::TestErc(), SCH_SHEET_PATH::TestForRecursion(), SCH_SHEET_LIST::TestForRecursion(), DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow(), DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_BUS_MANAGER::TransferDataToWindow(), NETLIST_EXPORTER_PSPICE::UpdateDirectives(), WriteDiagnosticERC(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ kiface

return& kiface

Definition at line 147 of file eeschema.cpp.

◆ process

PGM_BASE* process
static

Definition at line 136 of file eeschema.cpp.

Referenced by Pgm().

◆ s_layerColor

COLOR4D s_layerColor[LAYER_ID_COUNT]
static

Definition at line 158 of file eeschema.cpp.

Referenced by GetLayerColor(), and SetLayerColor().