KiCad PCB EDA Suite
common.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2014-2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2007-2015 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
7  * Copyright (C) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
32 #ifndef INCLUDE__COMMON_H_
33 #define INCLUDE__COMMON_H_
34 
35 #include <vector>
36 
37 #include <wx/wx.h>
38 #include <wx/confbase.h>
39 #include <wx/fileconf.h>
40 #include <wx/dir.h>
41 
42 #include <richio.h>
43 #include <gal/color4d.h>
44 
45 #include <atomic>
46 #include <memory>
47 
48 // C++11 "polyfill" for the C++14 std::make_unique function
49 #include "make_unique.h"
50 
51 class wxAboutDialogInfo;
52 class SEARCH_STACK;
53 class REPORTER;
54 
55 
67 typedef long timestamp_t;
68 
69 
70 // Flag for special keys
71 // This type could be extended to 64 bits to add room for more flags.
72 // For compatibility with old code, keep flag bits out of the least
73 // significant nibble (0xF).
74 typedef uint32_t EDA_KEY;
75 #define EDA_KEY_C UINT32_C
76 
77 #define GR_KB_RIGHTSHIFT ( EDA_KEY_C( 0x01000000 ) )
78 #define GR_KB_LEFTSHIFT ( EDA_KEY_C( 0x02000000 ) )
79 #define GR_KB_CTRL ( EDA_KEY_C( 0x04000000 ) )
80 #define GR_KB_ALT ( EDA_KEY_C( 0x08000000 ) )
81 #define GR_KB_SHIFT ( GR_KB_LEFTSHIFT | GR_KB_RIGHTSHIFT )
82 #define GR_KB_SHIFTCTRL ( GR_KB_SHIFT | GR_KB_CTRL )
83 #define MOUSE_MIDDLE ( EDA_KEY_C( 0x10000000 ) )
84 #define GR_KEY_INVALID ( EDA_KEY_C( 0x80000000 ) )
85 #define GR_KEY_NONE ( EDA_KEY_C( 0 ) )
86 
88 #define NAMELESS_PROJECT wxT( "noname" )
89 
90 
92 enum pseudokeys {
100 };
101 
102 #define ESC 27
103 
106 #define TEXT_ANGLE_HORIZ 0
107 #define TEXT_ANGLE_VERT 900
108 
109 //-----<KiROUND KIT>------------------------------------------------------------
110 
117 #if !defined( DEBUG )
118 
121 static inline int KiROUND( double v )
122 {
123  return int( v < 0 ? v - 0.5 : v + 0.5 );
124 }
125 
128 #define KIROUND( v ) int( (v) < 0 ? (v) - 0.5 : (v) + 0.5 )
129 
130 #else
131 
132 // DEBUG: KiROUND() is a macro to capture line and file, then calls this inline
133 
134 static inline int kiRound_( double v, int line, const char* filename )
135 {
136  v = v < 0 ? v - 0.5 : v + 0.5;
137  if( v > INT_MAX + 0.5 )
138  {
139  printf( "%s: in file %s on line %d, val: %.16g too ' > 0 ' for int\n",
140  __FUNCTION__, filename, line, v );
141  }
142  else if( v < INT_MIN - 0.5 )
143  {
144  printf( "%s: in file %s on line %d, val: %.16g too ' < 0 ' for int\n",
145  __FUNCTION__, filename, line, v );
146  }
147  return int( v );
148 }
149 
150 #define KiROUND( v ) kiRound_( v, __LINE__, __FILE__ )
151 
152 // in Debug build, use the overflow catcher since code size is immaterial
153 #define KIROUND( v ) KiROUND( v )
154 
155 #endif
156 
157 //-----</KiROUND KIT>-----------------------------------------------------------
158 
159 
161  INCHES = 0,
164  DEGREES = 3,
165 };
166 
167 
170 
171 
181 {
182 public:
183  LOCALE_IO();
184  ~LOCALE_IO();
185 
186 private:
187  // allow for nesting of LOCALE_IO instantiations
188  static std::atomic<unsigned int> m_c_count;
189 
190  // The locale in use before switching to the "C" locale
191  // (the locale can be set by user, and is not always the system locale)
192  std::string m_user_locale;
193 };
194 
199 wxSize GetTextSize( const wxString& aSingleLine, wxWindow* aWindow );
200 
215 bool EnsureTextCtrlWidth( wxTextCtrl* aCtrl, const wxString* aString = NULL );
216 
220 void SelectReferenceNumber( wxTextEntry* aTextEntry );
221 
233 int ProcessExecute( const wxString& aCommandLine, int aFlags = wxEXEC_ASYNC,
234  wxProcess *callback = NULL );
235 
240 
241 int GetCommandOptions( const int argc, const char** argv,
242  const char* stringtst, const char** optarg,
243  int* optind );
244 
253 double RoundTo0( double x, double precision );
254 
262 void wxStringSplit( const wxString& aText, wxArrayString& aStrings, wxChar aSplitter );
263 
283 wxString SearchHelpFileFullPath( const SEARCH_STACK& aSearchStack, const wxString& aBaseName );
284 
294 bool EnsureFileDirectoryExists( wxFileName* aTargetFullFileName,
295  const wxString& aBaseFilename,
296  REPORTER* aReporter = NULL );
297 
299 const wxString PrePendPath( const wxString& aEnvVar, const wxString& aPriorityPath );
300 
314 std::unique_ptr<wxConfigBase> GetNewConfig( const wxString& aProgName );
315 
328 wxString GetKicadConfigPath();
329 
336 const wxString ExpandEnvVarSubstitutions( const wxString& aString );
337 
341 const wxString ResolveUriByEnvVars( const wxString& aUri );
342 
343 
344 #ifdef __WXMAC__
345 
349 wxString GetOSXKicadUserDataDir();
350 
355 wxString GetOSXKicadMachineDataDir();
356 
361 wxString GetOSXKicadDataDir();
362 #endif
363 
364 // Some wxWidgets versions (for instance before 3.1.0) do not include
365 // this function, so add it if missing
366 #if !wxCHECK_VERSION( 3, 1, 0 )
367 #define USE_KICAD_WXSTRING_HASH // for common.cpp
368 namespace std
370 {
371  template<> struct hash<wxString>
372  {
373  size_t operator()( const wxString& s ) const;
374  };
375 }
376 #endif
377 
379 #define USE_KICAD_WXPOINT_LESS // for common.cpp
380 namespace std
381 {
382  template<> struct less<wxPoint>
383  {
384  bool operator()( const wxPoint& aA, const wxPoint& aB ) const;
385  };
386 }
387 
388 
393 {
394 public:
395  WX_FILENAME( const wxString& aPath, const wxString& aFilename );
396 
397  void SetFullName( const wxString& aFileNameAndExtension );
398 
399  wxString GetName() const;
400  wxString GetFullName() const;
401  wxString GetPath() const;
402  wxString GetFullPath() const;
403 
404  // Avoid multiple calls to stat() on POSIX kernels.
405  long long GetTimestamp();
406 
407 private:
408  // Write cached values to the wrapped wxFileName. MUST be called before using m_fn.
409  void resolve();
410 
411  wxFileName m_fn;
412  wxString m_path;
413  wxString m_fullName;
414 };
415 
416 
417 long long TimestampDir( const wxString& aDirPath, const wxString& aFilespec );
418 
419 
420 
421 
422 #endif // INCLUDE__COMMON_H_
WX_FILENAME(const wxString &aPath, const wxString &aFilename)
Performance enhancements to file and directory operations.
Definition: common.cpp:621
~LOCALE_IO()
Definition: common.cpp:99
long timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: common.h:53
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:121
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:180
const wxString ResolveUriByEnvVars(const wxString &aUri)
Replace any environment variables in file-path uris (leaving network-path URIs alone).
Definition: common.cpp:471
const wxString PrePendPath(const wxString &aEnvVar, const wxString &aPriorityPath)
Put aPriorityPath in front of all paths in the value of aEnvVar.
Definition: prependpath.cpp:32
KIGFX::COLOR4D g_GhostColor
Draw color for moving objects.
Definition: common.cpp:57
pseudokeys
Pseudo key codes for command panning.
Definition: common.h:92
wxString GetName() const
Definition: common.cpp:634
Template specialization to enable wxStrings for certain containers (e.g. unordered_map)
Definition: bitmap.cpp:55
wxString GetFullName() const
Definition: common.cpp:641
wxString m_path
Definition: common.h:412
Class SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
void SetFullName(const wxString &aFileNameAndExtension)
Definition: common.cpp:628
wxString GetKicadConfigPath()
Return the user configuration path used to store KiCad's configuration files.
Definition: common.cpp:266
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/...
Definition: common.cpp:827
wxFileName m_fn
Definition: common.h:411
static std::atomic< unsigned int > m_c_count
Definition: common.h:188
int ProcessExecute(const wxString &aCommandLine, int aFlags=wxEXEC_ASYNC, wxProcess *callback=NULL)
Run a command in a child process.
Definition: common.cpp:210
long long GetTimestamp()
Definition: common.cpp:668
wxString SearchHelpFileFullPath(const SEARCH_STACK &aSearchStack, const wxString &aBaseName)
Return the help file's full path.
void resolve()
Definition: common.cpp:660
std::unique_ptr< wxConfigBase > GetNewConfig(const wxString &aProgName)
Create a new wxConfig so we can put configuration files in a more proper place for each platform.
Definition: common.cpp:255
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:114
Definition: common.h:161
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
Definition: common.cpp:187
uint32_t EDA_KEY
Definition: common.h:74
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 ...
Definition: common.cpp:129
LOCALE_IO()
Definition: common.cpp:82
const wxString ExpandEnvVarSubstitutions(const wxString &aString)
Replace any environment variable references with their values.
Definition: common.cpp:458
wxString GetPath() const
Definition: common.cpp:647
double RoundTo0(double x, double precision)
Round to the nearest precision.
Definition: common.cpp:232
timestamp_t GetNewTimeStamp()
Definition: common.cpp:216
wxString GetFullPath() const
Definition: common.cpp:653
A wrapper around a wxFileName which is much more performant with a subset of the API.
Definition: common.h:392
Implementation of std::make_unique for pre C++14 compilation environments.
void SelectReferenceNumber(wxTextEntry *aTextEntry)
Select the number (or "?") in a reference for ease of editing.
Definition: common.cpp:158
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.
Definition: common.cpp:485
int GetCommandOptions(const int argc, const char **argv, const char *stringtst, const char **optarg, int *optind)
wxString m_fullName
Definition: common.h:413
EDA_UNITS_T
Definition: common.h:160
std::string m_user_locale
Definition: common.h:192
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39