common.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014-2020 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2007-2015 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

 
#ifndef INCLUDE__COMMON_H_
#define INCLUDE__COMMON_H_
 
#include <kicommon.h>
#include <functional>
#include <memory>
 
#include <wx/fileconf.h>
#include <wx/string.h>
#include <wx/process.h>
 
class PROJECT;
class SEARCH_STACK;
class REPORTER;

KICOMMON_API wxString SearchHelpFileFullPath( const wxString& aBaseName );

KICOMMON_API bool EnsureFileDirectoryExists( wxFileName*     aTargetFullFileName,
                                             const wxString& aBaseFilename,
                                             REPORTER*       aReporter = nullptr );

KICOMMON_API wxString EnsureFileExtension( const wxString& aFilename, const wxString& aExtension );

KICOMMON_API const wxString ExpandEnvVarSubstitutions( const wxString& aString,
                                                       const PROJECT*  aProject );

#define FOR_ERC_DRC 1
 
KICOMMON_API wxString ExpandTextVars( const wxString& aSource,
                                      const std::function<bool( wxString* )>* aResolver,
                                      int aFlags = 0 );
 
KICOMMON_API wxString ExpandTextVars( const wxString& aSource, const PROJECT* aProject,
                                      int aFlags = 0 );

KICOMMON_API wxString GetGeneratedFieldDisplayName( const wxString& aSource );

KICOMMON_API bool IsGeneratedField( const wxString& aSource );

KICOMMON_API wxString DescribeRef( const wxString& aRef );

KICOMMON_API const wxString ResolveUriByEnvVars( const wxString& aUri, const PROJECT* aProject );
 
 
KICOMMON_API long long TimestampDir( const wxString& aDirPath, const wxString& aFilespec );
 

KICOMMON_API bool WarnUserIfOperatingSystemUnsupported();
 
 
#endif  // INCLUDE__COMMON_H_