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 <functional>
36 #include <memory>
37 
38 #include <wx/fileconf.h>
39 #include <wx/string.h>
40 #include <wx/process.h>
41 
42 class PROJECT;
43 class SEARCH_STACK;
44 class REPORTER;
45 
55 int ProcessExecute( const wxString& aCommandLine, int aFlags = wxEXEC_ASYNC,
56  wxProcess *callback = nullptr );
57 
70 wxString SearchHelpFileFullPath( const wxString& aBaseName );
71 
81 bool EnsureFileDirectoryExists( wxFileName* aTargetFullFileName,
82  const wxString& aBaseFilename,
83  REPORTER* aReporter = nullptr );
84 
91 const wxString ExpandEnvVarSubstitutions( const wxString& aString, PROJECT* aProject );
92 
97 wxString ExpandTextVars( const wxString& aSource,
98  const std::function<bool( wxString* )>* aLocalResolver,
99  const std::function<bool( wxString* )>* aFallbackResolver,
100  const PROJECT* aProject );
101 
102 wxString ExpandTextVars( const wxString& aSource, const PROJECT* aProject );
103 
108 const wxString ResolveUriByEnvVars( const wxString& aUri, PROJECT* aProject );
109 
110 
111 long long TimestampDir( const wxString& aDirPath, const wxString& aFilespec );
112 
113 
120 
121 
122 #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:307
wxString SearchHelpFileFullPath(const wxString &aBaseName)
Return the help file's full path.
int ProcessExecute(const wxString &aCommandLine, int aFlags=wxEXEC_ASYNC, wxProcess *callback=nullptr)
Run a command in a child process.
Definition: common.cpp:46
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:70
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:516
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:279
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:292
bool WarnUserIfOperatingSystemUnsupported()
Checks if the operating system is explicitly unsupported and displays a disclaimer message box.
Definition: common.cpp:615
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:70