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-2020 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-2021 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 #include <functional>
37 
38 #include <wx/confbase.h>
39 #include <wx/fileconf.h>
40 #include <wx/dir.h>
41 #include <wx/string.h>
42 #include <wx/gdicmn.h>
43 #include <wx/process.h>
44 
45 #include <atomic>
46 #include <limits>
47 #include <memory>
48 #include <type_traits>
49 #include <typeinfo>
50 #include <macros.h>
51 
52 class PROJECT;
53 class SEARCH_STACK;
54 class REPORTER;
55 
65 int ProcessExecute( const wxString& aCommandLine, int aFlags = wxEXEC_ASYNC,
66  wxProcess *callback = nullptr );
67 
87 wxString SearchHelpFileFullPath( const SEARCH_STACK& aSearchStack, const wxString& aBaseName );
88 
98 bool EnsureFileDirectoryExists( wxFileName* aTargetFullFileName,
99  const wxString& aBaseFilename,
100  REPORTER* aReporter = nullptr );
101 
108 const wxString ExpandEnvVarSubstitutions( const wxString& aString, PROJECT* aProject );
109 
114 wxString ExpandTextVars( const wxString& aSource,
115  const std::function<bool( wxString* )>* aLocalResolver,
116  const std::function<bool( wxString* )>* aFallbackResolver,
117  const PROJECT* aProject );
118 
119 wxString ExpandTextVars( const wxString& aSource, const PROJECT* aProject );
120 
125 const wxString ResolveUriByEnvVars( const wxString& aUri, PROJECT* aProject );
126 
127 // Some wxWidgets versions (for instance before 3.1.0) do not include
128 // this function, so add it if missing
129 #if !wxCHECK_VERSION( 3, 1, 0 )
130 #define USE_KICAD_WXSTRING_HASH // for common.cpp
131 namespace std
133 {
134  template<> struct hash<wxString>
135  {
136  size_t operator()( const wxString& s ) const;
137  };
138 }
139 #endif
140 
142 #define USE_KICAD_WXPOINT_LESS_AND_HASH // for common.cpp
143 namespace std
144 {
145  template <> struct hash<wxPoint>
146  {
147  size_t operator() ( const wxPoint& k ) const;
148  };
149 }
150 
151 namespace std
152 {
153  template<> struct less<wxPoint>
154  {
155  bool operator()( const wxPoint& aA, const wxPoint& aB ) const;
156  };
157 }
158 
164 std::ostream& operator<<( std::ostream& out, const wxSize& size );
165 
171 std::ostream& operator<<( std::ostream& out, const wxPoint& pt );
172 
173 long long TimestampDir( const wxString& aDirPath, const wxString& aFilespec );
174 
175 
176 #endif // INCLUDE__COMMON_H_
Container for project specific data.
Definition: project.h:62
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter=nullptr)
Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.
Definition: common.cpp:297
Definition: bitmap.cpp:58
int ProcessExecute(const wxString &aCommandLine, int aFlags=wxEXEC_ASYNC, wxProcess *callback=nullptr)
Run a command in a child process.
Definition: common.cpp:40
Look for files in a number of paths.
Definition: search_stack.h:41
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
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:549
This file contains miscellaneous commonly used macros and functions.
wxString SearchHelpFileFullPath(const SEARCH_STACK &aSearchStack, const wxString &aBaseName)
Return the help file's full path.
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:269
const wxString ResolveUriByEnvVars(const wxString &aUri, PROJECT *aProject)
Replace any environment and/or text variables in file-path uris (leaving network-path URIs alone).
Definition: common.cpp:282
std::ostream & operator<<(std::ostream &out, const wxSize &size)
Helper function to print the given wxSize to a stream.
Definition: common.cpp:379
wxString ExpandTextVars(const wxString &aSource, const std::function< bool(wxString *)> *aLocalResolver, const std::function< bool(wxString *)> *aFallbackResolver, const PROJECT *aProject)
Expand '${var-name}' templates in text.
Definition: common.cpp:64