KiCad PCB EDA Suite
common.cpp File Reference
#include <fctsys.h>
#include <wxstruct.h>
#include <base_struct.h>
#include <common.h>
#include <macros.h>
#include <base_units.h>
#include <reporter.h>
#include <wx/process.h>
#include <wx/config.h>
#include <wx/utils.h>
#include <wx/stdpaths.h>
#include <pgm_base.h>
#include <ki_mutex.h>

Go to the source code of this file.

Functions

wxSize GetTextSize (const wxString &aSingleLine, wxWindow *aWindow)
 Function GetTextSize returns 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)
 Function EnsureTextCtrlWidth sets the minimum pixel width on a text control in order to make a text string be fully visible within it. More...
 
void wxStringSplit (const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
 Function wxStringSplit splits aString to a string list separated at aSplitter. More...
 
int ProcessExecute (const wxString &aCommandLine, int aFlags, wxProcess *callback)
 Function ProcessExecute runs a child process. More...
 
time_t GetNewTimeStamp ()
 
double RoundTo0 (double x, double precision)
 Round to the nearest precision. More...
 
wxConfigBase * GetNewConfig (const wxString &aProgName)
 Function GetNewConfig. More...
 
wxString GetKicadConfigPath ()
 Function GetKicadConfigPath. More...
 
const wxString ExpandEnvVarSubstitutions (const wxString &aString)
 Function ExpandEnvVarSubstitutions replaces any environment variable references with their values. More...
 
bool EnsureFileDirectoryExists (wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
 Helper function EnsureFileDirectoryExists make aTargetFullFileName absolute and creates the path of this file if it doesn't yet exist. More...
 

Variables

EDA_UNITS_T g_UserUnit
 Global variables definitions. More...
 
COLOR4D g_GhostColor
 Draw color for moving objects. More...
 

Function Documentation

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

Helper function EnsureFileDirectoryExists make aTargetFullFileName absolute and creates 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 267 of file common.cpp.

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

Referenced by DIALOG_GEN_MODULE_POSITION::CreateFiles(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SVG_PRINT::ExportSVGFile(), PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().

270 {
271  wxString msg;
272  wxString baseFilePath = wxFileName( aBaseFilename ).GetPath();
273 
274  // make aTargetFullFileName path, which is relative to aBaseFilename path (if it is not
275  // already an absolute path) absolute:
276  if( !aTargetFullFileName->MakeAbsolute( baseFilePath ) )
277  {
278  if( aReporter )
279  {
280  msg.Printf( _( "Cannot make path '%s' absolute with respect to '%s'." ),
281  GetChars( aTargetFullFileName->GetPath() ),
282  GetChars( baseFilePath ) );
283  aReporter->Report( msg, REPORTER::RPT_ERROR );
284  }
285 
286  return false;
287  }
288 
289  // Ensure the path of aTargetFullFileName exists, and create it if needed:
290  wxString outputPath( aTargetFullFileName->GetPath() );
291 
292  if( !wxFileName::DirExists( outputPath ) )
293  {
294  if( wxMkdir( outputPath ) )
295  {
296  if( aReporter )
297  {
298  msg.Printf( _( "Output directory '%s' created.\n" ), GetChars( outputPath ) );
299  aReporter->Report( msg, REPORTER::RPT_INFO );
300  return true;
301  }
302  }
303  else
304  {
305  if( aReporter )
306  {
307  msg.Printf( _( "Cannot create output directory '%s'.\n" ),
308  GetChars( outputPath ) );
309  aReporter->Report( msg, REPORTER::RPT_ERROR );
310  }
311 
312  return false;
313  }
314  }
315 
316  return true;
317 }
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 
)

Function EnsureTextCtrlWidth sets 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 108 of file common.cpp.

References GetTextSize().

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

109 {
110  wxWindow* window = aCtrl->GetParent();
111 
112  if( !window )
113  window = aCtrl;
114 
115  wxString ctrlText;
116 
117  if( !aString )
118  {
119  ctrlText = aCtrl->GetValue();
120  aString = &ctrlText;
121  }
122 
123  wxSize textz = GetTextSize( *aString, window );
124  wxSize ctrlz = aCtrl->GetSize();
125 
126  if( ctrlz.GetWidth() < textz.GetWidth() + 10 )
127  {
128  ctrlz.SetWidth( textz.GetWidth() + 10 );
129  aCtrl->SetSizeHints( ctrlz );
130  return true;
131  }
132 
133  return false;
134 }
wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Function GetTextSize returns the size of aSingleLine of text when it is rendered in aWindow using wha...
Definition: common.cpp:93
const wxString ExpandEnvVarSubstitutions ( const wxString &  aString)

Function ExpandEnvVarSubstitutions replaces 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 254 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(), S3D_FILENAME_RESOLVER::Set3DConfigDir(), S3D_CACHE::Set3DConfigDir(), S3D_FILENAME_RESOLVER::SetProjectDir(), S3D_FILENAME_RESOLVER::ShortenPath(), and DLG_3D_PATH_CONFIG::updateEnvVars().

255 {
256  // wxGetenv( wchar_t* ) is not re-entrant on linux.
257  // Put a lock on multithreaded use of wxGetenv( wchar_t* ), called from wxEpandEnvVars(),
258  static MUTEX getenv_mutex;
259 
260  MUTLOCK lock( getenv_mutex );
261 
262  // We reserve the right to do this another way, by providing our own member
263  // function.
264  return wxExpandEnvVars( aString );
265 }
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
wxString GetKicadConfigPath ( )

Function GetKicadConfigPath.

Returns
A wxString containing the config path for Kicad

Definition at line 217 of file common.cpp.

Referenced by FP_LIB_TABLE::GetGlobalTableFileName(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), and GetNewConfig().

218 {
219  wxFileName cfgpath;
220 
221  // From the wxWidgets wxStandardPaths::GetUserConfigDir() help:
222  // Unix: ~ (the home directory)
223  // Windows: "C:\Documents and Settings\username\Application Data"
224  // Mac: ~/Library/Preferences
225  cfgpath.AssignDir( wxStandardPaths::Get().GetUserConfigDir() );
226 
227 #if !defined( __WINDOWS__ ) && !defined( __WXMAC__ )
228  wxString envstr;
229 
230  if( !wxGetEnv( wxT( "XDG_CONFIG_HOME" ), &envstr ) || envstr.IsEmpty() )
231  {
232  // XDG_CONFIG_HOME is not set, so use the fallback
233  cfgpath.AppendDir( wxT( ".config" ) );
234  }
235  else
236  {
237  // Override the assignment above with XDG_CONFIG_HOME
238  cfgpath.AssignDir( envstr );
239  }
240 #endif
241 
242  cfgpath.AppendDir( wxT( "kicad" ) );
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)

Function GetNewConfig.

Use this function instead of creating a new wxConfig so we can put config 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 205 of file common.cpp.

References GetKicadConfigPath().

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

206 {
207  wxConfigBase* cfg = 0;
208  wxFileName configname;
209  configname.AssignDir( GetKicadConfigPath() );
210  configname.SetFullName( aProgName );
211 
212  cfg = new wxFileConfig( wxT( "" ), wxT( "" ), configname.GetFullPath() );
213  return cfg;
214 }
wxString GetKicadConfigPath()
Function GetKicadConfigPath.
Definition: common.cpp:217
wxSize GetTextSize ( const wxString &  aSingleLine,
wxWindow *  aWindow 
)

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

Definition at line 93 of file common.cpp.

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

94 {
95  wxCoord width;
96  wxCoord height;
97 
98  {
99  wxClientDC dc( aWindow );
100  dc.SetFont( aWindow->GetFont() );
101  dc.GetTextExtent( aSingleLine, &width, &height );
102  }
103 
104  return wxSize( width, height );
105 }
int ProcessExecute ( const wxString &  aCommandLine,
int  aFlags = wxEXEC_ASYNC,
wxProcess *  callback = NULL 
)

Function ProcessExecute runs 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 160 of file common.cpp.

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

161 {
162  return wxExecute( aCommandLine, aFlags, callback );
163 }
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 182 of file common.cpp.

References KiROUND().

Referenced by SCH_BASE_FRAME::UpdateStatusBar().

183 {
184  assert( precision != 0 );
185 
186  long long ix = KiROUND( x * precision );
187 
188  if ( x < 0.0 )
189  ix = -ix;
190 
191  int remainder = ix % 10; // remainder is in precision mm
192 
193  if( remainder <= 2 )
194  ix -= remainder; // truncate to the near number
195  else if( remainder >= 8 )
196  ix += 10 - remainder; // round to near number
197 
198  if ( x < 0 )
199  ix = -ix;
200 
201  return (double) ix / precision;
202 }
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
void wxStringSplit ( const wxString &  aText,
wxArrayString &  aStrings,
wxChar  aSplitter 
)

Function wxStringSplit splits 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 137 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().

138 {
139  wxString tmp;
140 
141  for( unsigned ii = 0; ii < aText.Length(); ii++ )
142  {
143  if( aText[ii] == aSplitter )
144  {
145  aStrings.Add( tmp );
146  tmp.Clear();
147  }
148 
149  else
150  tmp << aText[ii];
151  }
152 
153  if( !tmp.IsEmpty() )
154  {
155  aStrings.Add( tmp );
156  }
157 }

Variable Documentation

COLOR4D g_GhostColor
EDA_UNITS_T g_UserUnit

Global variables definitions.

display units

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

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), EDA_DRAW_FRAME::AddMenuZoomAndGrid(), Append_Track_Width_List(), TRACK_VIA_SIZE_MENU::AppendSizes(), DIALOG_PLOT::applyPlotSettings(), DIALOG_CREATE_ARRAY::calculateCircularArrayProperties(), class2gridRow(), DIALOG_DESIGN_RULES::CopyDimensionsListsToBoard(), 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(), PCB_EDIT_FRAME::Create_MuWaveComponent(), MWAVE::CreateMicrowaveInductor(), DIALOG_CREATE_ARRAY::DIALOG_CREATE_ARRAY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LAYERS_SETUP::DIALOG_LAYERS_SETUP(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_DRC_CONTROL::DisplayDRCValues(), GERBER_FILE_IMAGE::DisplayImageInfo(), EDA_DRAW_FRAME::DisplayUnitsMsg(), drawCursorStrings(), drawTicksAlongLine(), PCB_EDIT_FRAME::Edit_Gap(), LIB_EDIT_FRAME::EditGraphicSymbol(), SCH_EDIT_FRAME::EditSheet(), SCH_EDIT_FRAME::EditSheetPin(), FOOTPRINT_EDIT_FRAME::Enter_Edge_Width(), PCB_EDIT_FRAME::GenFootprintsReport(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), PL_EDITOR_FRAME::GetConfigurationSettings(), SCH_EDIT_FRAME::GetConfigurationSettings(), PCB_EDIT_FRAME::GetConfigurationSettings(), GERBVIEW_FRAME::GetConfigurationSettings(), DIALOG_PAGES_SETTINGS::GetCustomSizeMilsFromDialog(), DIALOG_SET_GRID::getGridOrigin(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), LIB_PIN::getMsgPanelInfoBase(), PANEL_PREV_3D::getOrientationVars(), getTickFormatForScale(), GRID_MENU::GRID_MENU(), DIALOG_GENERALOPTIONS::init(), DIALOG_NON_COPPER_ZONES_EDITOR::Init(), DIALOG_PLOT::Init_Dialog(), DIALOG_MODULE_BOARD_EDITOR::InitBoardProperties(), DIALOG_SVG_PRINT::initDialog(), DIALOG_GLOBAL_MODULES_FIELDS_EDITION::initDialog(), DIALOG_PAGES_SETTINGS::initDialog(), DIALOG_LABEL_EDITOR::InitDialog(), DIALOG_COPPER_ZONE::initDialog(), DIALOG_DESIGN_RULES::InitDimensionsLists(), DIALOG_LIB_EDIT_TEXT::initDlg(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_DESIGN_RULES::InitGlobalRules(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_DISPLAY_OPTIONS::initOptDialog(), DIALOG_MODEDIT_OPTIONS::initValues(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PRINT_USING_PRINTER::initValues(), LengthDoubleToString(), GERBVIEW_FRAME::Liste_D_Codes(), MWAVE_POLYGONAL_SHAPE_DLG::MWAVE_POLYGONAL_SHAPE_DLG(), DIALOG_PADS_MASK_CLEARANCE::myInit(), DIALOG_PAD_PROPERTIES::onCornerSizePercentChange(), DIALOG_COPPER_ZONE::OnCornerSmoothingModeChoice(), PANEL_PREV_3D::onDecrementOffset(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnFindDrcMarker(), FOOTPRINT_VIEWER_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), GERBVIEW_FRAME::OnHotKey(), PANEL_PREV_3D::onIncrementOffset(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnInitDialog(), PGE::IFACE::OnKifaceStart(), PANEL_PREV_3D::onMouseWheelOffset(), DIALOG_DISPLAY_OPTIONS::OnOKBUttonClick(), DIALOG_GENERALOPTIONS::OnOkClick(), DIALOG_LIB_EDIT_TEXT::OnOkClick(), DIALOG_NON_COPPER_ZONES_EDITOR::OnOkClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), DIALOG_DIMENSION_EDITOR::OnOKClick(), DIALOG_CREATE_ARRAY::OnOkClick(), SCH_EDIT_FRAME::OnPreferencesOptions(), DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), EDA_DRAW_FRAME::OnSelectUnits(), EDA_DRAW_FRAME::OnUpdateUnits(), PutValueInLocalUnits(), DIALOG_PAGES_SETTINGS::SavePageSettings(), DIALOG_DESIGN_RULES::SetDataValidators(), PANEL_PREV_3D::SetModelDataIdx(), DIALOG_SVG_PRINT::SetPenWidth(), DIALOG_PRINT_USING_PRINTER::SetPenWidth(), WX_UNIT_TEXT::SetUnits(), PCBNEW_CONTROL::SwitchUnits(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), DIALOG_DESIGN_RULES::TestDataValidity(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DialogEditModuleText::TransferDataFromWindow(), DIALOG_EDIT_ONE_FIELD::TransferDataFromWindow(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_MODEDIT_FP_BODY_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_ONE_FIELD::TransferDataToWindow(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_MOVE_EXACT::updateDlgTexts(), PCB_BASE_FRAME::updateGridSelectBox(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::updateNetInfo(), DIALOG_PAD_PROPERTIES::updateRoundRectCornerValues(), SCH_BASE_FRAME::UpdateStatusBar(), PL_EDITOR_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::updateTraceWidthSelectBox(), PCB_EDIT_FRAME::updateViaSizeSelectBox(), DIALOG_MODEDIT_FP_BODY_ITEM_PROPERTIES::Validate(), DIALOG_GRAPHIC_ITEM_PROPERTIES::Validate(), ValueFromString(), ValueFromTextCtrl(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), and WX_UNIT_TEXT::WX_UNIT_TEXT().