KiCad PCB EDA Suite
common.h File Reference

The common library. More...

#include <vector>
#include <wx/wx.h>
#include <wx/confbase.h>
#include <wx/fileconf.h>
#include <wx/dir.h>
#include <richio.h>
#include <gal/color4d.h>
#include <atomic>
#include "make_unique.h"

Go to the source code of this file.

Classes

class  LOCALE_IO
 Instantiate the current locale within a scope in which you are expecting exceptions to be thrown. More...
 
struct  std::hash< wxString >
 
struct  std::less< wxPoint >
 
class  WX_FILENAME
 A wrapper around a wxFileName which is much more performant with a subset of the API. More...
 

Namespaces

 std
 

Template specialization to enable wxStrings for certain containers (e.g. unordered_map)


 

Macros

#define INCLUDE__COMMON_H_
 
#define EDA_KEY_C   UINT32_C
 
#define GR_KB_RIGHTSHIFT   ( EDA_KEY_C( 0x01000000 ) )
 
#define GR_KB_LEFTSHIFT   ( EDA_KEY_C( 0x02000000 ) )
 
#define GR_KB_CTRL   ( EDA_KEY_C( 0x04000000 ) )
 
#define GR_KB_ALT   ( EDA_KEY_C( 0x08000000 ) )
 
#define GR_KB_SHIFT   ( GR_KB_LEFTSHIFT | GR_KB_RIGHTSHIFT )
 
#define GR_KB_SHIFTCTRL   ( GR_KB_SHIFT | GR_KB_CTRL )
 
#define MOUSE_MIDDLE   ( EDA_KEY_C( 0x10000000 ) )
 
#define GR_KEY_INVALID   ( EDA_KEY_C( 0x80000000 ) )
 
#define GR_KEY_NONE   ( EDA_KEY_C( 0 ) )
 
#define NAMELESS_PROJECT   wxT( "noname" )
 
#define ESC   27
 
#define TEXT_ANGLE_HORIZ   0
 
#define TEXT_ANGLE_VERT   900
 
#define KIROUND(v)   int( (v) < 0 ? (v) - 0.5 : (v) + 0.5 )
 
#define USE_KICAD_WXSTRING_HASH
 
#define USE_KICAD_WXPOINT_LESS
 
#define EDA_KEY_C   UINT32_C
 
#define GR_KB_RIGHTSHIFT   ( EDA_KEY_C( 0x01000000 ) )
 
#define GR_KB_LEFTSHIFT   ( EDA_KEY_C( 0x02000000 ) )
 
#define GR_KB_CTRL   ( EDA_KEY_C( 0x04000000 ) )
 
#define GR_KB_ALT   ( EDA_KEY_C( 0x08000000 ) )
 
#define GR_KB_SHIFT   ( GR_KB_LEFTSHIFT | GR_KB_RIGHTSHIFT )
 
#define GR_KB_SHIFTCTRL   ( GR_KB_SHIFT | GR_KB_CTRL )
 
#define MOUSE_MIDDLE   ( EDA_KEY_C( 0x10000000 ) )
 
#define GR_KEY_INVALID   ( EDA_KEY_C( 0x80000000 ) )
 
#define GR_KEY_NONE   ( EDA_KEY_C( 0 ) )
 
#define NAMELESS_PROJECT   wxT( "noname" )
 default name for nameless projects More...
 
#define ESC   27
 
#define TEXT_ANGLE_HORIZ   0
 Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to degrees eventually. More...
 
#define TEXT_ANGLE_VERT   900
 
#define KIROUND(v)   int( (v) < 0 ? (v) - 0.5 : (v) + 0.5 )
 KIROUND: a macro so compiler can pre-compute constants. More...
 
#define USE_KICAD_WXSTRING_HASH
 
#define USE_KICAD_WXPOINT_LESS
 Required to use wxPoint as key type in maps. More...
 

Typedefs

typedef long timestamp_t
 timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the timestamp when they were created. More...
 
typedef uint32_t EDA_KEY
 

Enumerations

enum  pseudokeys {
  EDA_PANNING_UP_KEY = 1, EDA_PANNING_DOWN_KEY, EDA_PANNING_LEFT_KEY, EDA_PANNING_RIGHT_KEY,
  EDA_ZOOM_IN_FROM_MOUSE, EDA_ZOOM_OUT_FROM_MOUSE, EDA_ZOOM_CENTER_FROM_MOUSE
}
 Pseudo key codes for command panning. More...
 
enum  EDA_UNITS_T { INCHES = 0, MILLIMETRES = 1, UNSCALED_UNITS = 2, DEGREES = 3 }
 

Functions

static int KiROUND (double v)
 Round a floating point number to an integer using "round halfway cases away from zero". More...
 
wxSize GetTextSize (const wxString &aSingleLine, wxWindow *aWindow)
 Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currently set in that window. More...
 
bool EnsureTextCtrlWidth (wxTextCtrl *aCtrl, const wxString *aString=NULL)
 Set the minimum pixel width on a text control in order to make a text string be fully visible within it. More...
 
void SelectReferenceNumber (wxTextEntry *aTextEntry)
 Select the number (or "?") in a reference for ease of editing. More...
 
int ProcessExecute (const wxString &aCommandLine, int aFlags=wxEXEC_ASYNC, wxProcess *callback=NULL)
 Run a command in a child process. More...
 
timestamp_t GetNewTimeStamp ()
 
int GetCommandOptions (const int argc, const char **argv, const char *stringtst, const char **optarg, int *optind)
 
double RoundTo0 (double x, double precision)
 Round to the nearest precision. More...
 
void wxStringSplit (const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
 Split aString to a string list separated at aSplitter. More...
 
wxString SearchHelpFileFullPath (const SEARCH_STACK &aSearchStack, const wxString &aBaseName)
 Return the help file's full path. More...
 
bool EnsureFileDirectoryExists (wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter=NULL)
 Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist. More...
 
const wxString PrePendPath (const wxString &aEnvVar, const wxString &aPriorityPath)
 Put aPriorityPath in front of all paths in the value of aEnvVar. More...
 
wxConfigBase * GetNewConfig (const wxString &aProgName)
 Create a new wxConfig so we can put configuration files in a more proper place for each platform. More...
 
wxString GetKicadConfigPath ()
 Return the user configuration path used to store KiCad's configuration files. More...
 
const wxString ExpandEnvVarSubstitutions (const wxString &aString)
 Replace any environment variable references with their values. More...
 
const wxString ResolveUriByEnvVars (const wxString &aUri)
 Replace any environment variables in file-path uris (leaving network-path URIs alone). More...
 
long long TimestampDir (const wxString &aDirPath, const wxString &aFilespec)
 A copy of ConvertFileTimeToWx() because wxWidgets left it as a static function private to src/common/filename.cpp. More...
 

Variables

KIGFX::COLOR4D g_GhostColor
 Draw color for moving objects. More...
 

Detailed Description

The common library.

Definition in file common.h.

Macro Definition Documentation

#define EDA_KEY_C   UINT32_C
#define EDA_KEY_C   UINT32_C

Definition at line 74 of file common.h.

#define ESC   27
#define ESC   27

Definition at line 101 of file common.h.

#define GR_KB_ALT   ( EDA_KEY_C( 0x08000000 ) )

Definition at line 79 of file common.h.

#define GR_KB_CTRL   ( EDA_KEY_C( 0x04000000 ) )

Definition at line 78 of file common.h.

#define GR_KB_LEFTSHIFT   ( EDA_KEY_C( 0x02000000 ) )

Definition at line 77 of file common.h.

#define GR_KB_LEFTSHIFT   ( EDA_KEY_C( 0x02000000 ) )
#define GR_KB_RIGHTSHIFT   ( EDA_KEY_C( 0x01000000 ) )

Definition at line 76 of file common.h.

#define GR_KB_RIGHTSHIFT   ( EDA_KEY_C( 0x01000000 ) )
#define GR_KB_SHIFT   ( GR_KB_LEFTSHIFT | GR_KB_RIGHTSHIFT )

Definition at line 80 of file common.h.

#define GR_KB_SHIFTCTRL   ( GR_KB_SHIFT | GR_KB_CTRL )

Definition at line 81 of file common.h.

#define GR_KEY_INVALID   ( EDA_KEY_C( 0x80000000 ) )
#define GR_KEY_INVALID   ( EDA_KEY_C( 0x80000000 ) )

Definition at line 83 of file common.h.

#define GR_KEY_NONE   ( EDA_KEY_C( 0 ) )
#define GR_KEY_NONE   ( EDA_KEY_C( 0 ) )

Definition at line 84 of file common.h.

#define INCLUDE__COMMON_H_

Definition at line 34 of file numeric_evaluator.cpp.

#define KIROUND (   v)    int( (v) < 0 ? (v) - 0.5 : (v) + 0.5 )
#define KIROUND (   v)    int( (v) < 0 ? (v) - 0.5 : (v) + 0.5 )

KIROUND: a macro so compiler can pre-compute constants.

Use this with compile time constants rather than the inline function above.

Definition at line 127 of file common.h.

#define MOUSE_MIDDLE   ( EDA_KEY_C( 0x10000000 ) )

Definition at line 82 of file common.h.

#define NAMELESS_PROJECT   wxT( "noname" )

default name for nameless projects

Definition at line 87 of file common.h.

#define NAMELESS_PROJECT   wxT( "noname" )
#define TEXT_ANGLE_HORIZ   0

Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to degrees eventually.

Definition at line 105 of file common.h.

#define TEXT_ANGLE_VERT   900

Definition at line 106 of file common.h.

#define USE_KICAD_WXPOINT_LESS

Required to use wxPoint as key type in maps.

Definition at line 378 of file common.h.

#define USE_KICAD_WXPOINT_LESS
#define USE_KICAD_WXSTRING_HASH
#define USE_KICAD_WXSTRING_HASH

Definition at line 366 of file common.h.

Typedef Documentation

typedef uint32_t EDA_KEY

Definition at line 73 of file common.h.

typedef long timestamp_t

timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the timestamp when they were created.

Long term, this type might be renamed to something like unique_id_t (and then rename all the methods from {Get,Set}TimeStamp() to {Get,Set}Id()) ?

The type should be at least 32 bit and simple to map via swig; swig does have issues with types such as 'int32_t', so we choose 'long'.

Definition at line 52 of file common.h.

Enumeration Type Documentation

Enumerator
INCHES 
MILLIMETRES 
UNSCALED_UNITS 
DEGREES 

Definition at line 159 of file common.h.

159  {
160  INCHES = 0,
161  MILLIMETRES = 1,
162  UNSCALED_UNITS = 2,
163  DEGREES = 3,
164 };
Definition: common.h:160
enum pseudokeys

Pseudo key codes for command panning.

Enumerator
EDA_PANNING_UP_KEY 
EDA_PANNING_DOWN_KEY 
EDA_PANNING_LEFT_KEY 
EDA_PANNING_RIGHT_KEY 
EDA_ZOOM_IN_FROM_MOUSE 
EDA_ZOOM_OUT_FROM_MOUSE 
EDA_ZOOM_CENTER_FROM_MOUSE 

Definition at line 91 of file common.h.

Function Documentation

bool EnsureFileDirectoryExists ( wxFileName *  aTargetFullFileName,
const wxString &  aBaseFilename,
REPORTER aReporter = NULL 
)

Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.

Parameters
aTargetFullFileNamethe wxFileName containing the full path and file name to modify. The path may be absolute or relative to aBaseFilename .
aBaseFilenamea full filename. Only its path is used to set the aTargetFullFileName path.
aReportera point to a REPORTER object use to show messages (can be NULL)
Returns
true if aOutputDir already exists or was successfully created.

Definition at line 469 of file common.cpp.

References GetChars(), REPORTER::Report(), REPORTER::RPT_ERROR, and REPORTER::RPT_INFO.

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::CreateFiles(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_EXPORT_SVG::ExportSVGFile(), DIALOG_GENDRILL::GenDrillAndMapFiles(), PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().

472 {
473  wxString msg;
474  wxString baseFilePath = wxFileName( aBaseFilename ).GetPath();
475 
476  // make aTargetFullFileName path, which is relative to aBaseFilename path (if it is not
477  // already an absolute path) absolute:
478  if( !aTargetFullFileName->MakeAbsolute( baseFilePath ) )
479  {
480  if( aReporter )
481  {
482  msg.Printf( _( "Cannot make path \"%s\" absolute with respect to \"%s\"." ),
483  GetChars( aTargetFullFileName->GetPath() ),
484  GetChars( baseFilePath ) );
485  aReporter->Report( msg, REPORTER::RPT_ERROR );
486  }
487 
488  return false;
489  }
490 
491  // Ensure the path of aTargetFullFileName exists, and create it if needed:
492  wxString outputPath( aTargetFullFileName->GetPath() );
493 
494  if( !wxFileName::DirExists( outputPath ) )
495  {
496  if( wxMkdir( outputPath ) )
497  {
498  if( aReporter )
499  {
500  msg.Printf( _( "Output directory \"%s\" created.\n" ), GetChars( outputPath ) );
501  aReporter->Report( msg, REPORTER::RPT_INFO );
502  return true;
503  }
504  }
505  else
506  {
507  if( aReporter )
508  {
509  msg.Printf( _( "Cannot create output directory \"%s\".\n" ),
510  GetChars( outputPath ) );
511  aReporter->Report( msg, REPORTER::RPT_ERROR );
512  }
513 
514  return false;
515  }
516  }
517 
518  return true;
519 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
bool EnsureTextCtrlWidth ( wxTextCtrl *  aCtrl,
const wxString *  aString = NULL 
)

Set the minimum pixel width on a text control in order to make a text string be fully visible within it.

The current font within the text control is considered. The text can come either from the control or be given as an argument. If the text control is larger than needed, then nothing is done.

Parameters
aCtrlthe text control to potentially make wider.
aStringthe text that is used in sizing the control's pixel width. If NULL, then the text already within the control is used.
Returns
bool - true if the aCtrl had its size changed, else false.

Definition at line 126 of file common.cpp.

References GetTextSize().

Referenced by GERBVIEW_FRAME::UpdateTitleAndInfo().

127 {
128  wxWindow* window = aCtrl->GetParent();
129 
130  if( !window )
131  window = aCtrl;
132 
133  wxString ctrlText;
134 
135  if( !aString )
136  {
137  ctrlText = aCtrl->GetValue();
138  aString = &ctrlText;
139  }
140 
141  wxSize textz = GetTextSize( *aString, window );
142  wxSize ctrlz = aCtrl->GetSize();
143 
144  if( ctrlz.GetWidth() < textz.GetWidth() + 10 )
145  {
146  ctrlz.SetWidth( textz.GetWidth() + 10 );
147  aCtrl->SetSizeHints( ctrlz );
148  return true;
149  }
150 
151  return false;
152 }
wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: common.cpp:111
const wxString ExpandEnvVarSubstitutions ( const wxString &  aString)

Replace any environment variable references with their values.

Parameters
aString= a string containing (perhaps) references to env var
Returns
a string where env var are replaced by their value

Definition at line 442 of file common.cpp.

References KIwxExpandEnvVars().

Referenced by FILENAME_RESOLVER::addPath(), FILENAME_RESOLVER::checkEnvVarPath(), S3D_PLUGIN_MANAGER::checkPluginName(), S3D_PLUGIN_MANAGER::checkPluginPath(), FILENAME_RESOLVER::createPathList(), LIB_TABLE::ExpandSubstitutions(), S3D_CACHE::Get3DConfigDir(), WORKSHEET_LAYOUT::MakeFullFileName(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), FILENAME_RESOLVER::ResolvePath(), ResolveUriByEnvVars(), FILENAME_RESOLVER::Set3DConfigDir(), S3D_CACHE::Set3DConfigDir(), FILENAME_RESOLVER::SetProjectDir(), and FILENAME_RESOLVER::ShortenPath().

443 {
444  // wxGetenv( wchar_t* ) is not re-entrant on linux.
445  // Put a lock on multithreaded use of wxGetenv( wchar_t* ), called from wxEpandEnvVars(),
446  static MUTEX getenv_mutex;
447 
448  MUTLOCK lock( getenv_mutex );
449 
450  // We reserve the right to do this another way, by providing our own member
451  // function.
452  return KIwxExpandEnvVars( aString );
453 }
wxString KIwxExpandEnvVars(const wxString &str)
Definition: common.cpp:321
boost::interprocess::interprocess_mutex MUTEX
Establish KiCad MUTEX choices here in this file: typedef MUTEX and typedef MUTLOCK.
Definition: ki_mutex.h:42
boost::interprocess::scoped_lock< MUTEX > MUTLOCK
Definition: ki_mutex.h:43
int GetCommandOptions ( const int  argc,
const char **  argv,
const char *  stringtst,
const char **  optarg,
int *  optind 
)
wxString GetKicadConfigPath ( )

Return the user configuration path used to store KiCad's configuration files.

The configuration path order of precedence is determined by the following criteria:

  • The value of the KICAD_CONFIG_HOME environment variable
  • The value of the XDG_CONFIG_HOME environment variable.
  • The result of the call to wxStandardPaths::GetUserConfigDir() with ".config" appended as required on Linux builds.
Returns
A wxString containing the config path for Kicad

Definition at line 263 of file common.cpp.

Referenced by SYMBOL_LIB_TABLE::GetGlobalTableFileName(), FP_LIB_TABLE::GetGlobalTableFileName(), GetNewConfig(), ReadHotkeyConfigFile(), EDA_BASE_FRAME::WriteHotkeyConfig(), and CACHE_WRAPPER::~CACHE_WRAPPER().

264 {
265  wxFileName cfgpath;
266 
267  // http://docs.wxwidgets.org/3.0/classwx_standard_paths.html#a7c7cf595d94d29147360d031647476b0
268  cfgpath.AssignDir( wxStandardPaths::Get().GetUserConfigDir() );
269 
270  // GetUserConfigDir() does not default to ~/.config which is the current standard
271  // configuration file location on Linux. This has been fixed in later versions of wxWidgets.
272 #if !defined( __WXMSW__ ) && !defined( __WXMAC__ )
273  wxArrayString dirs = cfgpath.GetDirs();
274 
275  if( dirs.Last() != ".config" )
276  cfgpath.AppendDir( ".config" );
277 #endif
278 
279  wxString envstr;
280 
281  // This shouldn't cause any issues on Windows or MacOS.
282  if( wxGetEnv( wxT( "XDG_CONFIG_HOME" ), &envstr ) && !envstr.IsEmpty() )
283  {
284  // Override the assignment above with XDG_CONFIG_HOME
285  cfgpath.AssignDir( envstr );
286  }
287 
288  cfgpath.AppendDir( wxT( "kicad" ) );
289 
290  // Use KICAD_CONFIG_HOME to allow the user to force a specific configuration path.
291  if( wxGetEnv( wxT( "KICAD_CONFIG_HOME" ), &envstr ) && !envstr.IsEmpty() )
292  {
293  // Override the assignment above with KICAD_CONFIG_HOME
294  cfgpath.AssignDir( envstr );
295  }
296 
297  if( !cfgpath.DirExists() )
298  {
299  cfgpath.Mkdir( wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL );
300  }
301 
302  return cfgpath.GetPath();
303 }
wxConfigBase* GetNewConfig ( const wxString &  aProgName)

Create a new wxConfig so we can put configuration files in a more proper place for each platform.

This is generally $HOME/.config/kicad/ in Linux according to the FreeDesktop specification at http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html The config object created here should be destroyed by the caller.

Parameters
aProgNameis the name of the program calling this function - can be obtained by calling Pgm().App().GetAppName(). This will be the actual file name of the config file.
Returns
A pointer to a new wxConfigBase derived object is returned. The caller is in charge of deleting it.

Definition at line 251 of file common.cpp.

References GetKicadConfigPath().

Referenced by BIN_MOD::Init(), PGM_BASE::InitPgm(), PGM_BASE::loadCommonSettings(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

252 {
253  wxConfigBase* cfg = 0;
254  wxFileName configname;
255  configname.AssignDir( GetKicadConfigPath() );
256  configname.SetFullName( aProgName );
257 
258  cfg = new wxFileConfig( wxT( "" ), wxT( "" ), configname.GetFullPath() );
259  return cfg;
260 }
wxString GetKicadConfigPath()
Return the user configuration path used to store KiCad&#39;s configuration files.
Definition: common.cpp:263
timestamp_t GetNewTimeStamp ( )
wxSize GetTextSize ( const wxString &  aSingleLine,
wxWindow *  aWindow 
)

Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currently set in that window.

Definition at line 111 of file common.cpp.

Referenced by DIALOG_EDIT_COMPONENTS_LIBID::AdjustGridColumns(), PCB_EDIT_FRAME::CreateTextePcb(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), EnsureTextCtrlWidth(), FIELDS_EDITOR_GRID_DATA_MODEL::GetDataWidth(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::recalculateColumns(), PL_EDITOR_FRAME::ReCreateHToolbar(), BOARD_DESIGN_SETTINGS::SetBoardThickness(), ZONE_SETTINGS::SetupLayersList(), TEXTE_PCB::TransformShapeWithClearanceToPolygonSet(), and NET_SELECTOR_COMBOPOPUP::updateSize().

112 {
113  wxCoord width;
114  wxCoord height;
115 
116  {
117  wxClientDC dc( aWindow );
118  dc.SetFont( aWindow->GetFont() );
119  dc.GetTextExtent( aSingleLine, &width, &height );
120  }
121 
122  return wxSize( width, height );
123 }
static int KiROUND ( double  v)
inlinestatic

Round a floating point number to an integer using "round halfway cases away from zero".

In Debug build an assert fires if will not fit into an int.KiROUND: a function so v is not evaluated twice. Unfortunately, compiler is unable to pre-compute constants using this.

Definition at line 120 of file common.h.

Referenced by PCB_EDIT_FRAME::Add45DegreeSegment(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), DIMENSION::AdjustDimensionDetails(), GRID_HELPER::Align(), GRID_HELPER::AlignToSegment(), CPolyLine::AppendArc(), EC_45DEGREE::Apply(), PLOTTER::Arc(), HPGL_PLOTTER::Arc(), PDF_PLOTTER::Arc(), GERBER_PLOTTER::Arc(), PCB_EDIT_FRAME::Begin_Zone(), LEGACY_PLUGIN::biuParse(), D_PAD::boundingRadius(), build_pad_testpoints(), BuildCornersList_S_Shape(), D_PAD::BuildPadPolygon(), ZONE_FILLER::buildUnconnectedThermalStubsPolygonList(), WS_DRAW_ITEM_LIST::BuildWorkSheetGraphicList(), ZONE_FILLER::buildZoneFeatureHoleList(), LIB_CIRCLE::CalcEdit(), LIB_ARC::CalcRadiusAngles(), PCAD2KICAD::CalculateTextLengthSize(), KIGFX::WX_VIEW_CONTROLS::CenterOnCursor(), CPolyLine::Chamfer(), DRC::checkClearancePadToPad(), Clamp_Text_PenSize(), ClipAndDrawPoly(), Collect_TrackSegmentsToDrag(), computeCenter(), ConfigureHPGLPenSizes(), AM_PRIMITIVE::ConvertShapeToPolygon(), PCAD2KICAD::CorrectTextPosition(), PCB_EDIT_FRAME::Create_MuWaveComponent(), PCB_EDIT_FRAME::Create_MuWavePolygonShape(), SCH_GLOBALLABEL::CreateGraphicShape(), BOARD::CreateLockPoint(), MWAVE::CreateMicrowaveInductor(), PCB_EDIT_FRAME::createPopUpMenuForZones(), CreateThermalReliefPadPolygon(), CPolyLine::Distance(), EDGE_MODULE::Draw(), KIGFX::SCH_PAINTER::draw(), DRAWSEGMENT::Draw(), GERBER_DRAW_ITEM::Draw(), AM_PRIMITIVE::DrawBasicShape(), BITMAP_BASE::DrawBitmap(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::GAL::DrawGrid(), TRACK::DrawShortNetname(), GERBER_PLOTTER::emitDcode(), GERBER_FILE_IMAGE::ExecuteRS274XCommand(), CPolyLine::Fillet(), FindBestGridPointOnTrack(), HPGL_PLOTTER::FlashPadCircle(), HPGL_PLOTTER::FlashPadOval(), HPGL_PLOTTER::FlashPadRect(), HPGL_PLOTTER::FlashPadRoundRect(), FootprintWriteShape(), DSN::SPECCTRA_DB::FromSESSION(), gen_arc(), GENDRILL_WRITER_BASE::genDrillMapFile(), PCB_EDIT_FRAME::GeneralControl(), EDA_DRAW_FRAME::GeneralControlKeyMovement(), C3D_RENDER_OGL_LEGACY::generate_new_3DGrid(), geom_transf(), GERBER_DRAW_ITEM::GetABPosition(), LIB_PIN::GetBoundingBox(), SCH_SHEET::GetBoundingBox(), GetClearanceBetweenSegments(), BASE_SCREEN::getCrossHairScreenPosition(), DIALOG_PAGES_SETTINGS::GetCustomSizeMilsFromDialog(), SCH_JUNCTION::GetEffectiveSymbolSize(), WORKSHEET_DATAITEM::GetEndPosUi(), SCH_SHEET::GetFileNamePosition(), GRID_HELPER::GetGrid(), KIGFX::GAL::GetGridPoint(), KIGFX::STROKE_FONT::getInterline(), EDA_TEXT::GetInterline(), WORKSHEET_DATAITEM::GetMarkerSizeUi(), BASE_SCREEN::getNearestGridPosition(), GetPenSizeForBold(), WORKSHEET_DATAITEM::GetPenSizeUi(), WORKSHEET_DATAITEM_POLYPOLYGON::GetPenSizeUi(), WORKSHEET_DATAITEM_TEXT::GetPenSizeUi(), DRAWSEGMENT::GetRadius(), SCH_SHEET::GetSheetNamePosition(), SCH_NO_CONNECT::GetSize(), BITMAP_BASE::GetSize(), D_PAD::GetSolderPasteMargin(), WORKSHEET_DATAITEM::GetStartPosUi(), EDA_TEXT::GetTextBox(), GERBER_DRAW_ITEM::GetXYPosition(), GraphicTextWidth(), GRArc1(), CPolyLine::Hatch(), ZONE_CONTAINER::Hatch(), LIB_CIRCLE::HitTest(), LIB_ARC::HitTest(), DRAWSEGMENT::HitTest(), D_PAD::HitTest(), CPolyLine::HitTestForEdge(), DIALOG_PLOT::init_Dialog(), initializePlotter(), GENERAL_COLLECTOR::Inspect(), TRACK::IsPointOnEnds(), iu_to_d356(), Join(), EDA_TEXT::LenSize(), EAGLE_PLUGIN::Load(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), TRANSFORM::MapAngles(), PLOTTER::markerSquare(), Mils2mm(), GERBVIEW_PRINTOUT::milsToIU(), PCBNEW_PRINTOUT::milsToIU(), Mm2mils(), EDA_DRAW_PANEL::OnMouseEvent(), EDA_DRAW_PANEL::OnMouseWheel(), EDA_DRAW_PANEL::OnPaint(), EDA_DRAW_PANEL::OnPan(), DIALOG_POSITION_RELATIVE::OnPolarChanged(), DIALOG_MOVE_EXACT::OnPolarChanged(), EDA_DRAW_PANEL::OnScroll(), EAGLE_PLUGIN::packagePad(), EAGLE_PLUGIN::packagePolygon(), PCB_PLOT_PARAMS_PARSER::Parse(), PCAD2KICAD::PCB_ARC::Parse(), PCB_PARSER::parseBoardUnits(), parseInt(), GPCB_FPL_CACHE::parseMODULE(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotDrawSegment(), PSLIKE_PLOTTER::postscriptOverlinePositions(), PushTrack(), GERBER_FILE_IMAGE::ReadIJCoord(), PARAM_CFG_INT_WITH_SCALE::ReadParam(), EXCELLON_IMAGE::readToolInformation(), GERBER_FILE_IMAGE::ReadXYCoord(), resizeSheetWithMouseCursor(), PSLIKE_PLOTTER::returnPostscriptTextWidth(), RotatePoint(), RoundTo0(), DSN::scale(), scaletoIU(), PLOTTER::segmentAsOval(), WORKSHEET_DATAITEM_TEXT::SetConstrainedTextSize(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), Show_Drag_Track_Segment_With_Cte_Slope(), ShowBoundingBoxMicroWaveInductor(), snapAngle(), PS_PLOTTER::StartPlot(), PCAD2KICAD::StrToInt1Units(), PCAD2KICAD::StrToIntUnits(), DRC::testDrilledHoles(), TestForIntersectionOfStraightLineSegments(), PS_PLOTTER::Text(), PDF_PLOTTER::Text(), TraceArc(), AR_MATRIX::traceArc(), TraceCircle(), AR_MATRIX::traceCircle(), AR_MATRIX::TraceFilledRectangle(), TraceFilledRectangle(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_TRANSFORM::Transform(), TransformOvalClearanceToPolygon(), TransformRoundedEndsSegmentToPolygon(), TRACK::TransformShapeWithClearanceToPolygon(), D_PAD::TransformShapeWithClearanceToPolygon(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), USCALE(), ValueFromString(), and EXCELLON_WRITER::writeCoordinates().

121 {
122  return int( v < 0 ? v - 0.5 : v + 0.5 );
123 }
const wxString PrePendPath ( const wxString &  aEnvVar,
const wxString &  aPriorityPath 
)

Put aPriorityPath in front of all paths in the value of aEnvVar.

Definition at line 32 of file prependpath.cpp.

33 {
34  wxPathList paths;
35 
36  paths.AddEnvList( aEnvVar );
37  paths.Insert( aPriorityPath, 0 );
38 
39  return wxJoin( paths, wxPATH_SEP[0] );
40 }
int ProcessExecute ( const wxString &  aCommandLine,
int  aFlags = wxEXEC_ASYNC,
wxProcess *  callback = NULL 
)

Run a command in a child process.

Parameters
aCommandLineThe process and any arguments to it all in a single string.
aFlagsThe same args as allowed for wxExecute()
callbackwxProcess implementing OnTerminate to be run when the child process finishes
Returns
int - pid of process, 0 in case of error (like return values of wxExecute())

Definition at line 206 of file common.cpp.

Referenced by ExecuteFile(), GetAssociatedDocument(), OpenFile(), OpenPDF(), and SCH_EDIT_FRAME::WriteNetListFile().

207 {
208  return wxExecute( aCommandLine, aFlags, callback );
209 }
const wxString ResolveUriByEnvVars ( const wxString &  aUri)

Replace any environment variables in file-path uris (leaving network-path URIs alone).

Definition at line 456 of file common.cpp.

References ExpandEnvVarSubstitutions().

Referenced by FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), TEXT_BUTTON_URL::OnButtonClick(), and SCH_EDIT_FRAME::OnEditItem().

457 {
458  // URL-like URI: return as is.
459  wxURL url( aUri );
460  if( url.GetError() == wxURL_NOERR )
461  return aUri;
462 
463  // Otherwise, the path points to a local file. Resolve environment
464  // variables if any.
465  return ExpandEnvVarSubstitutions( aUri );
466 }
const wxString ExpandEnvVarSubstitutions(const wxString &aString)
Replace any environment variable references with their values.
Definition: common.cpp:442
double RoundTo0 ( double  x,
double  precision 
)

Round to the nearest precision.

Try to approximate a coordinate using a given precision to prevent rounding errors when converting from inches to mm.

ie round the unit value to 0 if unit is 1 or 2, or 8 or 9

Definition at line 228 of file common.cpp.

References KiROUND().

Referenced by SCH_BASE_FRAME::UpdateStatusBar().

229 {
230  assert( precision != 0 );
231 
232  long long ix = KiROUND( x * precision );
233 
234  if ( x < 0.0 )
235  ix = -ix;
236 
237  int remainder = ix % 10; // remainder is in precision mm
238 
239  if( remainder <= 2 )
240  ix -= remainder; // truncate to the near number
241  else if( remainder >= 8 )
242  ix += 10 - remainder; // round to near number
243 
244  if ( x < 0 )
245  ix = -ix;
246 
247  return (double) ix / precision;
248 }
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:120
wxString SearchHelpFileFullPath ( const SEARCH_STACK aSearchStack,
const wxString &  aBaseName 
)

Return the help file's full path.

Return the KiCad help file with path and extension. Help files can be html (.html ext) or pdf (.pdf ext) files. A <BaseName>.html file is searched and if not found, <BaseName>.pdf file is searched in the same path. If the help file for the current locale is not found, an attempt to find the English version of the help file is made. Help file is searched in directories in this order: help/<canonical name> like help/en_GB help/<short name> like help/en help/en

Parameters
aSearchStackcontains some possible base dirs that may be above the the one actually holding aBaseName. These are starting points for nested searches.
aBaseNameis the name of the help file to search for,

without extension

.

Returns
wxEmptyString is returned if aBaseName is not found, else the full path & filename.

Definition at line 67 of file searchhelpfilefullpath.cpp.

References SEARCH_STACK::AddPaths(), FindFileInSearchPaths(), PGM_BASE::GetLocale(), Pgm(), and tracePathsAndFiles.

68 {
69  wxArrayString subdirs;
70  wxArrayString altsubdirs;
71  SEARCH_STACK ss = aSStack;
72 
73  // It might already be in aSStack, but why depend on other code
74  // far away when it's so easy to add it again (to our copy) as the first place to look.
75 
76  // This is CMAKE_INSTALL_PREFIX unless DEFAULT_INSTALL_PATH was defined during
77  // build configuration:
78  ss.AddPaths( wxT( DEFAULT_INSTALL_PATH ), 0 );
79 
80 #if defined(__WXMAC__)
81  ss.AddPaths( GetOSXKicadMachineDataDir() );
82  ss.AddPaths( Pgm().GetExecutablePath(), 0 );
83 
84  // OS X packages can have the help files in
85  // /Library/Application\ Support/kicad/help,
86  // and in Contents/SharedSupport/help inside the
87  // bundle.
88  // Below we account for an international subdirectory.
89  subdirs.Add( "help" );
90  altsubdirs.Add( "Contents" );
91  altsubdirs.Add( "SharedSupport" );
92  altsubdirs.Add( "help" );
93 #endif
94 
95 #if ! defined(__WXMAC__) // && defined(__linux__)
96  // This is the executable path minus the trailing bin directory used on Windows and Linux.
97  wxFileName tmp( Pgm().GetExecutablePath(), wxEmptyString );
98  wxArrayString binDirs = tmp.GetDirs();
99 
100  if( !binDirs.IsEmpty() && binDirs[ binDirs.GetCount() - 1 ].CmpNoCase( wxT( "bin" ) ) == 0 )
101  tmp.RemoveLastDir();
102 
103  ss.AddPaths( tmp.GetPath(), 0 );
104 
105  // Based on kicad-doc.bzr/CMakeLists.txt, line 20, the help files are
106  // installed into "<CMAKE_INSTALL_PREFIX>/share/doc/kicad/help" for linux.
107  // This is ${KICAD_HELP} var in that CMakeLists.txt file.
108  // Below we account for an international subdirectory.
109  subdirs.Add( "share" );
110  subdirs.Add( "doc" );
111  subdirs.Add( "kicad" );
112  subdirs.Add( "help" );
113 
114  // Based on kicad-doc.bzr/CMakeLists.txt, line 35, the help files are
115  // installed into "<CMAKE_INSTALL_PREFIX>/doc/help" for Windows.
116  // This is ${KICAD_HELP} var in that CMakeLists.txt file.
117  // Below we account for an international subdirectory.
118  altsubdirs.Add( "doc" );
119  altsubdirs.Add( "help" );
120 #endif
121 
122  // If there's a KICAD environment variable set, always use that guy's path first.
123  if( !Pgm().GetKicadEnvVariable().IsEmpty() )
124  ss.AddPaths( Pgm().GetKicadEnvVariable(), 0 );
125 
126  /* Search for a help file.
127  * we *must* find a help file.
128  * so help is searched in directories in this order:
129  * help/<canonical name> like help/en_GB
130  * help/<short name> like help/en
131  * help/en
132  */
133 
134  wxLocale* i18n = Pgm().GetLocale();
135 
136  // We try to find help file in help/<canonical name>
137  // If fails, try to find help file in help/<short canonical name>
138  // If fails, try to find help file in help/en
139  wxArrayString locale_name_dirs;
140  locale_name_dirs.Add( i18n->GetCanonicalName() ); // canonical name like fr_FR
141 
142  // wxLocale::GetName() does not return always the short name
143  locale_name_dirs.Add( i18n->GetName().BeforeLast( '_' ) ); // short canonical name like fr
144  locale_name_dirs.Add( "en" ); // default (en)
145 
146 #if defined(DEBUG) && 1
147  ss.Show( wxString( __func__ ) );
148  wxLogTrace( tracePathsAndFiles, "%s: m_help_file:'%s'", __func__, aBaseName );
149 #endif
150 
151  wxLogTrace( tracePathsAndFiles, "Checking SEARCH_STACK for file %s", aBaseName );
152 
153  // Help files can be html (.html ext) or pdf (.pdf ext) files.
154  // Therefore, <BaseName>.html file is searched and if not found,
155  // <BaseName>.pdf file is searched in the same paths
156  wxString fn;
157 
158  for( unsigned ii = 0; ii < locale_name_dirs.GetCount(); ii++ )
159  {
160  subdirs.Add( locale_name_dirs[ii] );
161  altsubdirs.Add( locale_name_dirs[ii] );
162 
163  fn = FindFileInSearchPaths( ss, aBaseName + wxT( ".html" ), &altsubdirs );
164 
165  if( !fn.IsEmpty() )
166  {
167  // Prepend URI protocol since we will open in a browser
168  fn = wxT( "file://" ) + fn;
169  break;
170  }
171 
172  fn = FindFileInSearchPaths( ss, aBaseName + wxT( ".pdf" ), &altsubdirs );
173 
174  if( !fn.IsEmpty() )
175  break;
176 
177  fn = FindFileInSearchPaths( ss, aBaseName + wxT( ".html" ), &subdirs );
178 
179  if( !fn.IsEmpty() )
180  {
181  // Prepend URI protocol since we will open in a browser
182  fn = wxT( "file://" ) + fn;
183  break;
184  }
185 
186  fn = FindFileInSearchPaths( ss, aBaseName + wxT( ".pdf" ), &subdirs );
187 
188  if( !fn.IsEmpty() )
189  break;
190 
191  subdirs.RemoveAt( subdirs.GetCount() - 1 );
192  altsubdirs.RemoveAt( altsubdirs.GetCount() - 1 );
193  }
194 
195  return fn;
196 }
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
Class SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
VTBL_ENTRY wxLocale * GetLocale()
Definition: pgm_base.h:217
wxString FindFileInSearchPaths(const SEARCH_STACK &aStack, const wxString &aFilename, const wxArrayString *aSubdirs)
Function FindFileInSearchPaths looks in "this" for aFilename, but first modifies every search path by...
void AddPaths(const wxString &aPaths, int aIndex=-1)
Function AddPaths insert or append path(s)
void SelectReferenceNumber ( wxTextEntry *  aTextEntry)

Select the number (or "?") in a reference for ease of editing.

Definition at line 155 of file common.cpp.

Referenced by DIALOG_EDIT_ONE_FIELD::OnSetFocusText(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnUpdateUI(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

156 {
157  wxString ref = aTextEntry->GetValue();
158 
159  if( ref.find_first_of( '?' ) != ref.npos )
160  {
161  aTextEntry->SetSelection( ref.find_first_of( '?' ), ref.find_last_of( '?' ) + 1 );
162  }
163  else
164  {
165  wxString num = ref;
166 
167  while( !num.IsEmpty() && ( !isdigit( num.Last() ) || !isdigit( num.GetChar( 0 ) ) ) )
168  {
169  if( !isdigit( num.Last() ) )
170  num.RemoveLast();
171  if( !isdigit( num.GetChar ( 0 ) ) )
172  num = num.Right( num.Length() - 1);
173  }
174 
175  aTextEntry->SetSelection( ref.Find( num ), ref.Find( num ) + num.Length() );
176 
177  if( num.IsEmpty() )
178  aTextEntry->SetSelection( -1, -1 );
179  }
180 }
long long TimestampDir ( const wxString &  aDirPath,
const wxString &  aFilespec 
)

A copy of ConvertFileTimeToWx() because wxWidgets left it as a static function private to src/common/filename.cpp.

TimestampDir

This routine offers SIGNIFICANT performance benefits over using wxWidgets to gather timestamps from matching files in a directory.

Parameters
aDirPaththe directory to search
aFilespeca (wildcarded) file spec to match against
Returns
a hash of the last-mod-dates of all matching files in the directory

Definition at line 804 of file common.cpp.

References matchWild().

Referenced by FP_CACHE::GetTimestamp(), and GPCB_FPL_CACHE::GetTimestamp().

805 {
806  long long timestamp = 0;
807 
808 #if defined(__WIN32__)
809  // Win32 version.
810  // Save time by not searching for each path twice: once in wxDir.GetNext() and once in
811  // wxFileName.GetModificationTime(). Also cuts out wxWidgets' string-matching and case
812  // conversion by staying on the MSW side of things.
813  std::wstring filespec( aDirPath.t_str() );
814  filespec += '\\';
815  filespec += aFilespec.t_str();
816 
817  WIN32_FIND_DATA findData;
818  wxDateTime lastModDate;
819 
820  HANDLE fileHandle = ::FindFirstFile( filespec.data(), &findData );
821 
822  if( fileHandle != INVALID_HANDLE_VALUE )
823  {
824  do
825  {
826  ConvertFileTimeToWx( &lastModDate, findData.ftLastWriteTime );
827  timestamp += lastModDate.GetValue().GetValue();
828  }
829  while ( FindNextFile( fileHandle, &findData ) != 0);
830  }
831 
832  FindClose( fileHandle );
833 #else
834  // POSIX version.
835  // Save time by not converting between encodings -- do everything on the file-system side.
836  std::string filespec( aFilespec.fn_str() );
837  std::string dir_path( aDirPath.fn_str() );
838 
839  DIR* dir = opendir( dir_path.c_str() );
840 
841  if( dir )
842  {
843  for( dirent* dir_entry = readdir( dir ); dir_entry; dir_entry = readdir( dir ) )
844  {
845  if( !matchWild( filespec.c_str(), dir_entry->d_name, true ) )
846  continue;
847 
848  std::string entry_path = dir_path + '/' + dir_entry->d_name;
849  struct stat entry_stat;
850 
851  wxCRT_Lstat( entry_path.c_str(), &entry_stat );
852 
853  // Timestamp the source file, not the symlink
854  if( S_ISLNK( entry_stat.st_mode ) ) // wxFILE_EXISTS_SYMLINK
855  {
856  char buffer[ PATH_MAX + 1 ];
857  ssize_t pathLen = readlink( entry_path.c_str(), buffer, PATH_MAX );
858 
859  if( pathLen > 0 )
860  {
861  buffer[ pathLen ] = '\0';
862  entry_path = dir_path + buffer;
863 
864  wxCRT_Lstat( entry_path.c_str(), &entry_stat );
865  }
866  }
867 
868  if( S_ISREG( entry_stat.st_mode ) ) // wxFileExists()
869  timestamp += entry_stat.st_mtime * 1000;
870  }
871 
872  closedir( dir );
873  }
874 #endif
875 
876  return timestamp;
877 }
bool matchWild(const char *pat, const char *text, bool dot_special)
A copy of wxMatchWild(), which wxWidgets attributes to Douglas A.
Definition: common.cpp:668
void wxStringSplit ( const wxString &  aText,
wxArrayString &  aStrings,
wxChar  aSplitter 
)

Split aString to a string list separated at aSplitter.

Parameters
aTextis the text to split
aStringswill contain the splitted lines
aSplitteris the 'split' character

Definition at line 183 of file common.cpp.

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), EDA_TEXT::Draw(), export_vrml_pcbtext(), EDA_TEXT::GetTextBox(), HTML_MESSAGE_BOX::ListSet(), DIALOG_FOOTPRINT_WIZARD_LIST::onShowTrace(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotTextePcb(), TEXTE_PCB::TransformShapeWithClearanceToPolygonSet(), and EDA_TEXT::TransformTextShapeToSegmentList().

184 {
185  wxString tmp;
186 
187  for( unsigned ii = 0; ii < aText.Length(); ii++ )
188  {
189  if( aText[ii] == aSplitter )
190  {
191  aStrings.Add( tmp );
192  tmp.Clear();
193  }
194 
195  else
196  tmp << aText[ii];
197  }
198 
199  if( !tmp.IsEmpty() )
200  {
201  aStrings.Add( tmp );
202  }
203 }

Variable Documentation

KIGFX::COLOR4D g_GhostColor

Draw color for moving objects.

Draw color for moving objects.

TODO: All of these variables should be moved into the class were they are defined and used. Most of them probably belong in the application class.

Definition at line 57 of file common.cpp.

Referenced by DrawMovingItems(), and EDA_DRAW_PANEL::OnPaint().