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...
 
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 375 of file common.h.

#define USE_KICAD_WXPOINT_LESS
#define USE_KICAD_WXSTRING_HASH
#define USE_KICAD_WXSTRING_HASH

Definition at line 363 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 416 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().

419 {
420  wxString msg;
421  wxString baseFilePath = wxFileName( aBaseFilename ).GetPath();
422 
423  // make aTargetFullFileName path, which is relative to aBaseFilename path (if it is not
424  // already an absolute path) absolute:
425  if( !aTargetFullFileName->MakeAbsolute( baseFilePath ) )
426  {
427  if( aReporter )
428  {
429  msg.Printf( _( "Cannot make path \"%s\" absolute with respect to \"%s\"." ),
430  GetChars( aTargetFullFileName->GetPath() ),
431  GetChars( baseFilePath ) );
432  aReporter->Report( msg, REPORTER::RPT_ERROR );
433  }
434 
435  return false;
436  }
437 
438  // Ensure the path of aTargetFullFileName exists, and create it if needed:
439  wxString outputPath( aTargetFullFileName->GetPath() );
440 
441  if( !wxFileName::DirExists( outputPath ) )
442  {
443  if( wxMkdir( outputPath ) )
444  {
445  if( aReporter )
446  {
447  msg.Printf( _( "Output directory \"%s\" created.\n" ), GetChars( outputPath ) );
448  aReporter->Report( msg, REPORTER::RPT_INFO );
449  return true;
450  }
451  }
452  else
453  {
454  if( aReporter )
455  {
456  msg.Printf( _( "Cannot create output directory \"%s\".\n" ),
457  GetChars( outputPath ) );
458  aReporter->Report( msg, REPORTER::RPT_ERROR );
459  }
460 
461  return false;
462  }
463  }
464 
465  return true;
466 }
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 101 of file common.cpp.

References GetTextSize().

Referenced by GERBVIEW_FRAME::UpdateTitleAndInfo().

102 {
103  wxWindow* window = aCtrl->GetParent();
104 
105  if( !window )
106  window = aCtrl;
107 
108  wxString ctrlText;
109 
110  if( !aString )
111  {
112  ctrlText = aCtrl->GetValue();
113  aString = &ctrlText;
114  }
115 
116  wxSize textz = GetTextSize( *aString, window );
117  wxSize ctrlz = aCtrl->GetSize();
118 
119  if( ctrlz.GetWidth() < textz.GetWidth() + 10 )
120  {
121  ctrlz.SetWidth( textz.GetWidth() + 10 );
122  aCtrl->SetSizeHints( ctrlz );
123  return true;
124  }
125 
126  return false;
127 }
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:86
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 389 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(), FILENAME_RESOLVER::ResolvePath(), ResolveUriByEnvVars(), FILENAME_RESOLVER::Set3DConfigDir(), S3D_CACHE::Set3DConfigDir(), FILENAME_RESOLVER::SetProjectDir(), and FILENAME_RESOLVER::ShortenPath().

390 {
391  // wxGetenv( wchar_t* ) is not re-entrant on linux.
392  // Put a lock on multithreaded use of wxGetenv( wchar_t* ), called from wxEpandEnvVars(),
393  static MUTEX getenv_mutex;
394 
395  MUTLOCK lock( getenv_mutex );
396 
397  // We reserve the right to do this another way, by providing our own member
398  // function.
399  return KIwxExpandEnvVars( aString );
400 }
wxString KIwxExpandEnvVars(const wxString &str)
Definition: common.cpp:268
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 210 of file common.cpp.

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

211 {
212  wxFileName cfgpath;
213 
214  // http://docs.wxwidgets.org/3.0/classwx_standard_paths.html#a7c7cf595d94d29147360d031647476b0
215  cfgpath.AssignDir( wxStandardPaths::Get().GetUserConfigDir() );
216 
217  // GetUserConfigDir() does not default to ~/.config which is the current standard
218  // configuration file location on Linux. This has been fixed in later versions of wxWidgets.
219 #if !defined( __WXMSW__ ) && !defined( __WXMAC__ )
220  wxArrayString dirs = cfgpath.GetDirs();
221 
222  if( dirs.Last() != ".config" )
223  cfgpath.AppendDir( ".config" );
224 #endif
225 
226  wxString envstr;
227 
228  // This shouldn't cause any issues on Windows or MacOS.
229  if( wxGetEnv( wxT( "XDG_CONFIG_HOME" ), &envstr ) && !envstr.IsEmpty() )
230  {
231  // Override the assignment above with XDG_CONFIG_HOME
232  cfgpath.AssignDir( envstr );
233  }
234 
235  cfgpath.AppendDir( wxT( "kicad" ) );
236 
237  // Use KICAD_CONFIG_HOME to allow the user to force a specific configuration path.
238  if( wxGetEnv( wxT( "KICAD_CONFIG_HOME" ), &envstr ) && !envstr.IsEmpty() )
239  {
240  // Override the assignment above with KICAD_CONFIG_HOME
241  cfgpath.AssignDir( envstr );
242  }
243 
244  if( !cfgpath.DirExists() )
245  {
246  cfgpath.Mkdir( wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL );
247  }
248 
249  return cfgpath.GetPath();
250 }
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 198 of file common.cpp.

References GetKicadConfigPath().

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

199 {
200  wxConfigBase* cfg = 0;
201  wxFileName configname;
202  configname.AssignDir( GetKicadConfigPath() );
203  configname.SetFullName( aProgName );
204 
205  cfg = new wxFileConfig( wxT( "" ), wxT( "" ), configname.GetFullPath() );
206  return cfg;
207 }
wxString GetKicadConfigPath()
Return the user configuration path used to store KiCad&#39;s configuration files.
Definition: common.cpp:210
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 86 of file common.cpp.

Referenced by PCB_EDIT_FRAME::CreateTextePcb(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), EnsureTextCtrlWidth(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::recalculateColumns(), PL_EDITOR_FRAME::ReCreateHToolbar(), BOARD_DESIGN_SETTINGS::SetBoardThickness(), ZONE_SETTINGS::SetupLayersList(), and TEXTE_PCB::TransformShapeWithClearanceToPolygonSet().

87 {
88  wxCoord width;
89  wxCoord height;
90 
91  {
92  wxClientDC dc( aWindow );
93  dc.SetFont( aWindow->GetFont() );
94  dc.GetTextExtent( aSingleLine, &width, &height );
95  }
96 
97  return wxSize( width, height );
98 }
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(), EDA_DRAW_FRAME::AdjustScrollBars(), 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(), SHAPE_POLY_SET::chamferFilletPolygon(), DRC::checkClearancePadToPad(), Clamp_Text_PenSize(), ClipAndDrawPoly(), Collect_TrackSegmentsToDrag(), ConfigureHPGLPenSizes(), AM_PRIMITIVE::ConvertShapeToPolygon(), PCAD2KICAD::CorrectTextPosition(), PCB_EDIT_FRAME::Create_MuWaveComponent(), PCB_EDIT_FRAME::Create_MuWavePolygonShape(), SCH_GLOBALLABEL::CreateGraphicShape(), BOARD::CreateLockPoint(), MWAVE::CreateMicrowaveInductor(), CreateThermalReliefPadPolygon(), CPolyLine::Distance(), EDGE_MODULE::Draw(), DRAWSEGMENT::Draw(), GERBER_DRAW_ITEM::Draw(), AM_PRIMITIVE::DrawBasicShape(), BITMAP_BASE::DrawBitmap(), KIGFX::OPENGL_GAL::DrawGrid(), EDA_DRAW_PANEL::DrawGrid(), KIGFX::GAL::DrawGrid(), BOARD_PRINTOUT_CONTROLLER::DrawPage(), 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(), GetArcToSegmentCount(), LIB_PIN::GetBoundingBox(), SCH_SHEET::GetBoundingBox(), GetClearanceBetweenSegments(), BASE_SCREEN::getCrossHairScreenPosition(), DIALOG_PAGES_SETTINGS::GetCustomSizeMilsFromDialog(), 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(), 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(), 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(), EDIT_TOOL::MeasureTool(), Mils2mm(), Mm2mils(), EDA_DRAW_PANEL::OnMouseEvent(), EDA_DRAW_PANEL::OnMouseWheel(), 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(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotDrawSegment(), SHAPE_LINE_CHAIN::PointOnEdge(), 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(), EDA_3D_VIEWER::Set3DColorFromUser(), EDA_DRAW_PANEL::SetClipBox(), 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(), TraceCircle(), 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 153 of file common.cpp.

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

154 {
155  return wxExecute( aCommandLine, aFlags, callback );
156 }
const wxString ResolveUriByEnvVars ( const wxString &  aUri)

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

Definition at line 403 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::Process_Special_Functions().

404 {
405  // URL-like URI: return as is.
406  wxURL url( aUri );
407  if( url.GetError() == wxURL_NOERR )
408  return aUri;
409 
410  // Otherwise, the path points to a local file. Resolve environment
411  // variables if any.
412  return ExpandEnvVarSubstitutions( aUri );
413 }
const wxString ExpandEnvVarSubstitutions(const wxString &aString)
Replace any environment variable references with their values.
Definition: common.cpp:389
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 175 of file common.cpp.

References KiROUND().

Referenced by SCH_BASE_FRAME::UpdateStatusBar().

176 {
177  assert( precision != 0 );
178 
179  long long ix = KiROUND( x * precision );
180 
181  if ( x < 0.0 )
182  ix = -ix;
183 
184  int remainder = ix % 10; // remainder is in precision mm
185 
186  if( remainder <= 2 )
187  ix -= remainder; // truncate to the near number
188  else if( remainder >= 8 )
189  ix += 10 - remainder; // round to near number
190 
191  if ( x < 0 )
192  ix = -ix;
193 
194  return (double) ix / precision;
195 }
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 66 of file searchhelpfilefullpath.cpp.

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

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

References matchWild().

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

752 {
753  long long timestamp = 0;
754 
755 #if defined(__WIN32__)
756  // Win32 version.
757  // Save time by not searching for each path twice: once in wxDir.GetNext() and once in
758  // wxFileName.GetModificationTime(). Also cuts out wxWidgets' string-matching and case
759  // conversion by staying on the MSW side of things.
760  std::wstring filespec( aDirPath.t_str() );
761  filespec += '\\';
762  filespec += aFilespec.t_str();
763 
764  WIN32_FIND_DATA findData;
765  wxDateTime lastModDate;
766 
767  HANDLE fileHandle = ::FindFirstFile( filespec.data(), &findData );
768 
769  if( fileHandle != INVALID_HANDLE_VALUE )
770  {
771  do
772  {
773  ConvertFileTimeToWx( &lastModDate, findData.ftLastWriteTime );
774  timestamp += lastModDate.GetValue().GetValue();
775  }
776  while ( FindNextFile( fileHandle, &findData ) != 0);
777  }
778 
779  FindClose( fileHandle );
780 #else
781  // POSIX version.
782  // Save time by not converting between encodings -- do everything on the file-system side.
783  std::string filespec( aFilespec.fn_str() );
784  std::string dir_path( aDirPath.fn_str() );
785 
786  DIR* dir = opendir( dir_path.c_str() );
787 
788  if( dir )
789  {
790  for( dirent* dir_entry = readdir( dir ); dir_entry; dir_entry = readdir( dir ) )
791  {
792  if( !matchWild( filespec.c_str(), dir_entry->d_name, true ) )
793  continue;
794 
795  std::string entry_path = dir_path + '/' + dir_entry->d_name;
796  struct stat entry_stat;
797 
798  wxCRT_Lstat( entry_path.c_str(), &entry_stat );
799 
800  // Timestamp the source file, not the symlink
801  if( S_ISLNK( entry_stat.st_mode ) ) // wxFILE_EXISTS_SYMLINK
802  {
803  char buffer[ PATH_MAX + 1 ];
804  ssize_t pathLen = readlink( entry_path.c_str(), buffer, PATH_MAX );
805 
806  if( pathLen > 0 )
807  {
808  buffer[ pathLen ] = '\0';
809  entry_path = dir_path + buffer;
810 
811  wxCRT_Lstat( entry_path.c_str(), &entry_stat );
812  }
813  }
814 
815  if( S_ISREG( entry_stat.st_mode ) ) // wxFileExists()
816  timestamp += entry_stat.st_mtime * 1000;
817  }
818  }
819 #endif
820 
821  return timestamp;
822 }
bool matchWild(const char *pat, const char *text, bool dot_special)
A copy of wxMatchWild(), which wxWidgets attributes to Douglas A.
Definition: common.cpp:615
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 130 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().

131 {
132  wxString tmp;
133 
134  for( unsigned ii = 0; ii < aText.Length(); ii++ )
135  {
136  if( aText[ii] == aSplitter )
137  {
138  aStrings.Add( tmp );
139  tmp.Clear();
140  }
141 
142  else
143  tmp << aText[ii];
144  }
145 
146  if( !tmp.IsEmpty() )
147  {
148  aStrings.Add( tmp );
149  }
150 }

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 SCH_EDIT_FRAME::ConvertPart(), DrawMovingBlockOutlines(), DrawMovingItems(), SCH_EDIT_FRAME::OnSelectUnit(), and EDA_DRAW_PANEL::ReDraw().