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 <[email protected]>
6 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
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
42class PROJECT;
43class SEARCH_STACK;
44class REPORTER;
45
58wxString SearchHelpFileFullPath( const wxString& aBaseName );
59
69bool EnsureFileDirectoryExists( wxFileName* aTargetFullFileName,
70 const wxString& aBaseFilename,
71 REPORTER* aReporter = nullptr );
72
79const wxString ExpandEnvVarSubstitutions( const wxString& aString, PROJECT* aProject );
80
85wxString ExpandTextVars( const wxString& aSource,
86 const std::function<bool( wxString* )>* aLocalResolver,
87 const std::function<bool( wxString* )>* aFallbackResolver,
88 const PROJECT* aProject );
89
90wxString ExpandTextVars( const wxString& aSource, const PROJECT* aProject );
91
96const wxString ResolveUriByEnvVars( const wxString& aUri, PROJECT* aProject );
97
98
99long long TimestampDir( const wxString& aDirPath, const wxString& aFilespec );
100
101
108
109
110#endif // INCLUDE__COMMON_H_
Container for project specific data.
Definition: project.h:63
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
Look for files in a number of paths.
Definition: search_stack.h:42
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:63
bool WarnUserIfOperatingSystemUnsupported()
Checks if the operating system is explicitly unsupported and displays a disclaimer message box.
Definition: common.cpp:603
wxString SearchHelpFileFullPath(const wxString &aBaseName)
Return the help file's full path.
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:295
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:280
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:504
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:267