The common library. More...

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

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 >

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

Macros
#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 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...

Variables
EDA_UNITS_T	g_UserUnit
	display units More...

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

Definition at line 60 of file common.h.

Referenced by FOOTPRINT_EDIT_FRAME::BlockCommand(), and LIB_EDIT_FRAME::BlockCommand().

#define ESC 27

Definition at line 87 of file common.h.

Referenced by getOptimalModulePlacement().

#define GR_KB_ALT ( EDA_KEY_C( 0x08000000 ) )

Definition at line 65 of file common.h.

Referenced by PL_EDITOR_FRAME::BlockCommand(), FOOTPRINT_EDIT_FRAME::BlockCommand(), GERBVIEW_FRAME::BlockCommand(), LIB_EDIT_FRAME::BlockCommand(), PCB_EDIT_FRAME::BlockCommand(), SCH_EDIT_FRAME::BlockCommand(), DISPLAY_FOOTPRINTS_FRAME::GeneralControl(), KeyCodeFromKeyName(), KeyNameFromKeyCode(), WIDGET_HOTKEY_LIST::MapKeypressToKeycode(), EDA_3D_CANVAS::OnKeyEvent(), EDA_DRAW_PANEL::OnKeyEvent(), EDA_DRAW_PANEL::OnMouseEvent(), and ACTION_MANAGER::processHotKey().

#define GR_KB_CTRL ( EDA_KEY_C( 0x04000000 ) )

Definition at line 64 of file common.h.

Referenced by PL_EDITOR_FRAME::BlockCommand(), FOOTPRINT_EDIT_FRAME::BlockCommand(), GERBVIEW_FRAME::BlockCommand(), LIB_EDIT_FRAME::BlockCommand(), PCB_EDIT_FRAME::BlockCommand(), SCH_EDIT_FRAME::BlockCommand(), EDA_DRAW_FRAME::GeneralControlKeyMovement(), KeyCodeFromKeyName(), KeyNameFromKeyCode(), WIDGET_HOTKEY_LIST::MapKeypressToKeycode(), EDA_3D_CANVAS::OnKeyEvent(), EDA_DRAW_PANEL::OnKeyEvent(), EDA_DRAW_PANEL::OnMouseEvent(), and ACTION_MANAGER::processHotKey().

#define GR_KB_LEFTSHIFT ( EDA_KEY_C( 0x02000000 ) )

Definition at line 63 of file common.h.

#define GR_KB_RIGHTSHIFT ( EDA_KEY_C( 0x01000000 ) )

Definition at line 62 of file common.h.

#define GR_KB_SHIFTCTRL ( GR_KB_SHIFT | GR_KB_CTRL )

Definition at line 67 of file common.h.

Referenced by PL_EDITOR_FRAME::BlockCommand(), FOOTPRINT_EDIT_FRAME::BlockCommand(), GERBVIEW_FRAME::BlockCommand(), LIB_EDIT_FRAME::BlockCommand(), PCB_EDIT_FRAME::BlockCommand(), and SCH_EDIT_FRAME::BlockCommand().

#define GR_KEY_INVALID ( EDA_KEY_C( 0x80000000 ) )

Definition at line 69 of file common.h.

Referenced by FOOTPRINT_EDIT_FRAME::BlockCommand(), and LIB_EDIT_FRAME::BlockCommand().

#define GR_KEY_NONE ( EDA_KEY_C( 0 ) )

Definition at line 70 of file common.h.

Referenced by LIB_EDIT_FRAME::BlockCommand().

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

#define MOUSE_MIDDLE ( EDA_KEY_C( 0x10000000 ) )

Definition at line 68 of file common.h.

Referenced by PL_EDITOR_FRAME::BlockCommand(), FOOTPRINT_EDIT_FRAME::BlockCommand(), GERBVIEW_FRAME::BlockCommand(), LIB_EDIT_FRAME::BlockCommand(), PCB_EDIT_FRAME::BlockCommand(), and SCH_EDIT_FRAME::BlockCommand().

#define NAMELESS_PROJECT wxT( "noname" )

default name for nameless projects

Definition at line 73 of file common.h.

Referenced by SCH_EDIT_FRAME::OnPrint(), TREE_PROJECT_FRAME::ReCreateTreePrj(), and SCH_EDIT_FRAME::SCH_EDIT_FRAME().

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

Referenced by LIB_TEXT::calcEdit(), LIB_FIELD::calcEdit(), AUTOPLACER::ComputeFBoxSize(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToSelectedField(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::copyPanelToSelectedField(), SCH_FIELD::Draw(), SCH_SHEET::Draw(), LIB_TEXT::drawGraphic(), LIB_PIN::DrawPinElectricalTypeName(), LIB_PIN::DrawPinTexts(), GERBER_DRAW_ITEM::GetTextD_CodePrms(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), LIB_FIELD::Init(), SCH_LEGACY_PLUGIN::loadComponent(), SCH_LEGACY_PLUGIN_CACHE::loadField(), DIALOG_LIB_EDIT_TEXT::OnOkClick(), LIB_TEXT::Plot(), SCH_FIELD::Plot(), LIB_FIELD::Plot(), SCH_SHEET::Plot(), LIB_PIN::PlotPinTexts(), LIB_TEXT::Rotate(), LIB_FIELD::Rotate(), SCH_EDIT_FRAME::RotateField(), SCH_LEGACY_PLUGIN::saveField(), SCH_TEXT::SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), and DIALOG_EDIT_ONE_FIELD::updateText().

#define TEXT_ANGLE_VERT 900

Definition at line 92 of file common.h.

Referenced by LIB_TEXT::calcEdit(), LIB_FIELD::calcEdit(), AUTOPLACER::ComputeFBoxSize(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToSelectedField(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::copyPanelToSelectedField(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copySelectedFieldToPanel(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::copySelectedFieldToPanel(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), SCH_FIELD::Draw(), SCH_SHEET::Draw(), LIB_TEXT::drawGraphic(), LIB_PIN::DrawPinElectricalTypeName(), LIB_PIN::DrawPinTexts(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), DIALOG_LIB_EDIT_TEXT::initDlg(), SCH_LEGACY_PLUGIN::loadComponent(), SCH_LEGACY_PLUGIN_CACHE::loadField(), DIALOG_LIB_EDIT_TEXT::OnOkClick(), LIB_TEXT::Plot(), SCH_FIELD::Plot(), LIB_FIELD::Plot(), SCH_SHEET::Plot(), LIB_PIN::PlotPinTexts(), LIB_TEXT::Rotate(), LIB_FIELD::Rotate(), SCH_EDIT_FRAME::RotateField(), SCH_TEXT::SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and DIALOG_EDIT_ONE_FIELD::updateText().

#define USE_KICAD_WXPOINT_LESS

Required to use wxPoint as key type in maps.

Definition at line 363 of file common.h.

#define USE_KICAD_WXSTRING_HASH

Definition at line 351 of file common.h.

Typedef Documentation

typedef uint32_t EDA_KEY

Definition at line 52 of file common.h.

Enumeration Type Documentation

enum EDA_UNITS_T

Enumerator
INCHES
MILLIMETRES
UNSCALED_UNITS
DEGREES

Definition at line 145 of file common.h.

                  {
     INCHES = 0,
     MILLIMETRES = 1,
     UNSCALED_UNITS = 2,
     DEGREES = 3,
 };

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

                 {
     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
 };

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

aTargetFullFileName	the wxFileName containing the full path and file name to modify. The path may be absolute or relative to aBaseFilename .
aBaseFilename	a full filename. Only its path is used to set the aTargetFullFileName path.
aReporter	a 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 282 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_SVG_PRINT::ExportSVGFile(), DIALOG_GENDRILL::GenDrillAndMapFiles(), PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().

 {
     wxString msg;
     wxString baseFilePath = wxFileName( aBaseFilename ).GetPath();
 
     // make aTargetFullFileName path, which is relative to aBaseFilename path (if it is not
     // already an absolute path) absolute:
     if( !aTargetFullFileName->MakeAbsolute( baseFilePath ) )
     {
         if( aReporter )
         {
             msg.Printf( _( "Cannot make path \"%s\" absolute with respect to \"%s\"." ),
                         GetChars( aTargetFullFileName->GetPath() ),
                         GetChars( baseFilePath ) );
             aReporter->Report( msg, REPORTER::RPT_ERROR );
         }
 
         return false;
     }
 
     // Ensure the path of aTargetFullFileName exists, and create it if needed:
     wxString outputPath( aTargetFullFileName->GetPath() );
 
     if( !wxFileName::DirExists( outputPath ) )
     {
         if( wxMkdir( outputPath ) )
         {
             if( aReporter )
             {
                 msg.Printf( _( "Output directory \"%s\" created.\n" ), GetChars( outputPath ) );
                 aReporter->Report( msg, REPORTER::RPT_INFO );
                 return true;
             }
         }
         else
         {
             if( aReporter )
             {
                 msg.Printf( _( "Cannot create output directory \"%s\".\n" ),
                             GetChars( outputPath ) );
                 aReporter->Report( msg, REPORTER::RPT_ERROR );
             }
 
             return false;
         }
     }
 
     return true;
 }

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

aCtrl	the text control to potentially make wider.
aString	the 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 102 of file common.cpp.

References GetTextSize().

Referenced by SCH_EDIT_FRAME::EditComponent(), DIALOG_LABEL_EDITOR::InitDialog(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

 {
     wxWindow* window = aCtrl->GetParent();
 
     if( !window )
         window = aCtrl;
 
     wxString ctrlText;
 
     if( !aString )
     {
         ctrlText = aCtrl->GetValue();
         aString  = &ctrlText;
     }
 
     wxSize  textz = GetTextSize( *aString, window );
     wxSize  ctrlz = aCtrl->GetSize();
 
     if( ctrlz.GetWidth() < textz.GetWidth() + 10 )
     {
         ctrlz.SetWidth( textz.GetWidth() + 10 );
         aCtrl->SetSizeHints( ctrlz );
         return true;
     }
 
     return false;
 }

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 255 of file common.cpp.

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

 {
     // wxGetenv( wchar_t* ) is not re-entrant on linux.
     // Put a lock on multithreaded use of wxGetenv( wchar_t* ), called from wxEpandEnvVars(),
     static MUTEX    getenv_mutex;
 
     MUTLOCK lock( getenv_mutex );
 
     // We reserve the right to do this another way, by providing our own member
     // function.
     return wxExpandEnvVars( aString );
 }

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

 {
     wxFileName cfgpath;
 
     // http://docs.wxwidgets.org/3.0/classwx_standard_paths.html#a7c7cf595d94d29147360d031647476b0
     cfgpath.AssignDir( wxStandardPaths::Get().GetUserConfigDir() );
 
     // GetUserConfigDir() does not default to ~/.config which is the current standard
     // configuration file location on Linux.  This has been fixed in later versions of wxWidgets.
 #if !defined( __WXMSW__ ) && !defined( __WXMAC__ )
     wxArrayString dirs = cfgpath.GetDirs();
 
     if( dirs.Last() != ".config" )
         cfgpath.AppendDir( ".config" );
 #endif
 
     wxString envstr;
 
     // This shouldn't cause any issues on Windows or MacOS.
     if( wxGetEnv( wxT( "XDG_CONFIG_HOME" ), &envstr ) && !envstr.IsEmpty() )
     {
         // Override the assignment above with XDG_CONFIG_HOME
         cfgpath.AssignDir( envstr );
     }
 
     cfgpath.AppendDir( wxT( "kicad" ) );
 
     // Use KICAD_CONFIG_HOME to allow the user to force a specific configuration path.
     if( wxGetEnv( wxT( "KICAD_CONFIG_HOME" ), &envstr ) && !envstr.IsEmpty() )
     {
         // Override the assignment above with KICAD_CONFIG_HOME
         cfgpath.AssignDir( envstr );
     }
 
     if( !cfgpath.DirExists() )
     {
         cfgpath.Mkdir( wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL );
     }
 
     return cfgpath.GetPath();
 }

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

aProgName is 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 199 of file common.cpp.

References GetKicadConfigPath().

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

 {
     wxConfigBase* cfg = 0;
     wxFileName configname;
     configname.AssignDir( GetKicadConfigPath() );
     configname.SetFullName( aProgName );
 
     cfg = new wxFileConfig( wxT( "" ), wxT( "" ), configname.GetFullPath() );
     return cfg;
 }

timestamp_t GetNewTimeStamp ( )

Returns: an unique time stamp that changes after each call

Definition at line 160 of file common.cpp.

Referenced by PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), DuplicateItemsInList(), EDIT_TOOL::editFootprintInFpEditor(), DIALOG_FOOTPRINT_BOARD_EDITOR::GotoModuleEditor(), BOARD::InsertArea(), COLLECTOR::IsSimilarPointAndTime(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), EDA_ITEM::operator=(), SCH_EDIT_FRAME::PasteListOfItems(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::RepeatDrawItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), COLLECTOR::SetTimeNow(), SimilarLabelsDiagnose(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), and TestMultiunitFootprints().

 {
     static timestamp_t oldTimeStamp;
     timestamp_t newTimeStamp;
 
     newTimeStamp = time( NULL );
 
     if( newTimeStamp <= oldTimeStamp )
         newTimeStamp = oldTimeStamp + 1;
 
     oldTimeStamp = newTimeStamp;
 
     return newTimeStamp;
 }

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 87 of file common.cpp.

Referenced by DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), EnsureTextCtrlWidth(), DIALOG_NON_COPPER_ZONES_EDITOR::Init(), DIALOG_KEEPOUT_AREA_PROPERTIES::initDialog(), DIALOG_COPPER_ZONE::initDialog(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::recalculateColumns(), PL_EDITOR_FRAME::ReCreateHToolbar(), and TEXTE_PCB::TransformShapeWithClearanceToPolygonSet().

 {
     wxCoord width;
     wxCoord height;
 
     {
         wxClientDC dc( aWindow );
         dc.SetFont( aWindow->GetFont() );
         dc.GetTextExtent( aSingleLine, &width, &height );
     }
 
     return wxSize( width, height );
 }

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 106 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(), DRAWING_TOOL::constrainDimension(), AM_PRIMITIVE::ConvertShapeToPolygon(), D_CODE::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(), GRID_HELPER::GetGrid(), DIALOG_SET_GRID::getGridOrigin(), KIGFX::GAL::GetGridPoint(), DIALOG_SET_GRID::getGridSize(), 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(), 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(), KIGFX::PREVIEW::TWO_POINT_GEOMETRY_MANAGER::SetEnd(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), Show_Drag_Track_Segment_With_Cte_Slope(), ShowBoundingBoxMicroWaveInductor(), snapAngle(), PS_PLOTTER::StartPlot(), PCAD2KICAD::StrToInt1Units(), PCAD2KICAD::StrToIntUnits(), TestForIntersectionOfStraightLineSegments(), PS_PLOTTER::Text(), PDF_PLOTTER::Text(), TraceArc(), TraceCircle(), TraceFilledRectangle(), DIALOG_EDIT_FPTEXT::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().

 {
     return int( v < 0 ? v - 0.5 : v + 0.5 );
 }

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.

 {
     wxPathList  paths;
 
     paths.AddEnvList( aEnvVar );
     paths.Insert( aPriorityPath, 0 );
 
     return wxJoin( paths, wxPATH_SEP[0] );
 }

int ProcessExecute	(	const wxString &	aCommandLine,
		int	aFlags = `wxEXEC_ASYNC`,
		wxProcess *	callback = `NULL`
	)

Run a command in a child process.

Parameters

aCommandLine	The process and any arguments to it all in a single string.
aFlags	The same args as allowed for wxExecute()
callback	wxProcess 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 154 of file common.cpp.

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

 {
     return wxExecute( aCommandLine, aFlags, callback );
 }

const wxString ResolveUriByEnvVars ( const wxString & aUri )

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

Definition at line 269 of file common.cpp.

References ExpandEnvVarSubstitutions().

Referenced by SCH_EDIT_FRAME::Process_Special_Functions(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler().

 {
     // URL-like URI: return as is.
     wxURL url( aUri );
     if( url.GetError() == wxURL_NOERR )
         return aUri;
 
     // Otherwise, the path points to a local file. Resolve environment
     // variables if any.
     return ExpandEnvVarSubstitutions( aUri );
 }

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 176 of file common.cpp.

References KiROUND().

Referenced by SCH_BASE_FRAME::UpdateStatusBar().

 {
     assert( precision != 0 );
 
     long long ix = KiROUND( x * precision );
 
     if ( x < 0.0 )
         ix = -ix;
 
     int remainder = ix % 10;   // remainder is in precision mm
 
     if( remainder <= 2 )
         ix -= remainder;       // truncate to the near number
     else if( remainder >= 8 )
         ix += 10 - remainder;  // round to near number
 
     if ( x < 0 )
         ix = -ix;
 
     return (double) ix / precision;
 }

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

aSearchStack	contains some possible base dirs that may be above the the one actually holding aBaseName. These are starting points for nested searches.
aBaseName	is 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().

Referenced by EDA_BASE_FRAME::GetKicadHelp().

 {
     wxArrayString   subdirs;
     wxArrayString   altsubdirs;
     SEARCH_STACK    ss = aSStack;
 
     // It might already be in aSStack, but why depend on other code
     // far away when it's so easy to add it again (to our copy) as the first place to look.
 
     // This is CMAKE_INSTALL_PREFIX unless DEFAULT_INSTALL_PATH was defined during
     // build configuration:
     ss.AddPaths( wxT( DEFAULT_INSTALL_PATH ), 0 );
 
 #if defined(__WXMAC__)
     ss.AddPaths( GetOSXKicadMachineDataDir() );
     ss.AddPaths( Pgm().GetExecutablePath(), 0 );
 
     // OS X packages can have the help files in
     // /Library/Application\ Support/kicad/help,
     // and in Contents/SharedSupport/help inside the
     // bundle.
     // Below we account for an international subdirectory.
     subdirs.Add( wxT( "help" ) );
     altsubdirs.Add( wxT( "Contents" ) );
     altsubdirs.Add( wxT( "SharedSupport" ) );
     altsubdirs.Add( wxT( "help" ) );
 #endif
 
 #if ! defined(__WXMAC__) // && defined(__linux__)
     // This is the executable path minus the trailing bin directory used on Windows and Linux.
     wxFileName tmp( Pgm().GetExecutablePath(), wxEmptyString );
     wxArrayString binDirs = tmp.GetDirs();
 
     if( !binDirs.IsEmpty() && binDirs[ binDirs.GetCount() - 1 ].CmpNoCase( wxT( "bin" ) ) == 0 )
         tmp.RemoveLastDir();
 
     ss.AddPaths( tmp.GetPath(), 0 );
 
     // Based on kicad-doc.bzr/CMakeLists.txt, line 20, the help files are
     // installed into "<CMAKE_INSTALL_PREFIX>/share/doc/kicad/help" for linux.
     // This is ${KICAD_HELP} var in that CMakeLists.txt file.
     // Below we account for an international subdirectory.
     subdirs.Add( wxT( "share" ) );
     subdirs.Add( wxT( "doc" ) );
     subdirs.Add( wxT( "kicad" ) );
     subdirs.Add( wxT( "help" ) );
 
     // Based on kicad-doc.bzr/CMakeLists.txt, line 35, the help files are
     // installed into "<CMAKE_INSTALL_PREFIX>/doc/help" for Windows.
     // This is ${KICAD_HELP} var in that CMakeLists.txt file.
     // Below we account for an international subdirectory.
     altsubdirs.Add( wxT( "doc" ) );
     altsubdirs.Add( wxT( "help" ) );
 #endif
 
     // If there's a KICAD environment variable set, always use that guy's path first.
     if( !Pgm().GetKicadEnvVariable().IsEmpty() )
         ss.AddPaths( Pgm().GetKicadEnvVariable(), 0 );
 
     /* Search for a help file.
      *  we *must* find a help file.
      *  so help is searched in directories in this order:
      *  help/<canonical name> like help/en_GB
      *  help/<short name> like help/en
      *  help/en
      */
 
     wxLocale* i18n = Pgm().GetLocale();
 
     // We try to find help file in help/<canonical name>
     // If fails, try to find help file in help/<short canonical name>
     // If fails, try to find help file in help/en
     wxArrayString locale_name_dirs;
     locale_name_dirs.Add( i18n->GetCanonicalName() );           // canonical name like fr_FR
 
     // wxLocale::GetName() does not return always the short name
     locale_name_dirs.Add( i18n->GetName().BeforeLast( '_' ) );  // short canonical name like fr
     locale_name_dirs.Add( wxT( "en" ) );                        // default (en)
 
 #if defined(DEBUG) && 1
     ss.Show( wxString( __func__ ) );
     wxLogDebug( wxT( "%s: m_help_file:'%s'" ), __func__, GetChars( aBaseName ) );
 #endif
 
     wxLogDebug( wxT( "Checking SEARCH_STACK for file %s" ), GetChars( aBaseName ) );
 
     // Help files can be html (.html ext) or pdf (.pdf ext) files.
     // Therefore, <BaseName>.html file is searched and if not found,
     // <BaseName>.pdf file is searched in the same paths
     wxString fn;
 
     for( unsigned ii = 0; ii < locale_name_dirs.GetCount(); ii++ )
     {
         subdirs.Add( locale_name_dirs[ii] );
         altsubdirs.Add( locale_name_dirs[ii] );
 
         fn = FindFileInSearchPaths( ss, aBaseName + wxT( ".html" ), &altsubdirs );
 
         if( !fn.IsEmpty() )
         {
             // Prepend URI protocol since we will open in a browser
             fn = wxT( "file://" ) + fn;
             break;
         }
 
         fn = FindFileInSearchPaths( ss, aBaseName + wxT( ".pdf" ), &altsubdirs );
 
         if( !fn.IsEmpty() )
             break;
 
         fn = FindFileInSearchPaths( ss, aBaseName + wxT( ".html" ), &subdirs );
 
         if( !fn.IsEmpty() )
         {
             // Prepend URI protocol since we will open in a browser
             fn = wxT( "file://" ) + fn;
             break;
         }
 
         fn = FindFileInSearchPaths( ss, aBaseName + wxT( ".pdf" ), &subdirs );
 
         if( !fn.IsEmpty() )
             break;
 
         subdirs.RemoveAt( subdirs.GetCount() - 1 );
         altsubdirs.RemoveAt( altsubdirs.GetCount() - 1 );
     }
 
     return fn;
 }

void wxStringSplit	(	const wxString &	aText,
		wxArrayString &	aStrings,
		wxChar	aSplitter
	)

Split aString to a string list separated at aSplitter.

Parameters

aText	is the text to split
aStrings	will contain the splitted lines
aSplitter	is the 'split' character

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

 {
     wxString tmp;
 
     for( unsigned ii = 0; ii < aText.Length(); ii++ )
     {
         if( aText[ii] == aSplitter )
         {
             aStrings.Add( tmp );
             tmp.Clear();
         }
 
         else
             tmp << aText[ii];
     }
 
     if( !tmp.IsEmpty() )
     {
         aStrings.Add( tmp );
     }
 }