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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <kicommon.h>
#include <functional>
#include <memory>
#include <vector>
 
#include <wx/fileconf.h>
#include <wx/string.h>
#include <wx/process.h>
 
#include <text_var_dependency.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 wxString JoinExtensions( const std::vector<std::string>& aExts );

KICOMMON_API const wxString ExpandEnvVarSubstitutions( const wxString& aString, const PROJECT* aProject );
 
enum RESOLUTION_CONTEXT
{
    FOR_CANVAS,
    FOR_GUI,
    FOR_NETNAME,
    FOR_ERC_DRC,
    INTERNAL,       // Importantly, keeps the escape on literal variable references (such as "\${foo}")
    RESOLVED,
    RAW_VALUE
};
 
KICOMMON_API void FinalizeTextVarExpansion( wxString& aText, RESOLUTION_CONTEXT aContext );
 
KICOMMON_API wxString ExpandTextVars( const wxString& aSource, const std::function<bool( wxString* )>* aResolver,
                                      RESOLUTION_CONTEXT aContext, int aDepth = 0 );
 
KICOMMON_API wxString ExpandTextVars( const wxString& aSource, const PROJECT* aProject,
                                      RESOLUTION_CONTEXT aContext );

KICOMMON_API wxString NormalizeFilePathForTextVars( const wxString& aPath );

KICOMMON_API std::vector<TEXT_VAR_REF_KEY> ExtractTextVarReferences( const wxString& aSource );

KICOMMON_API wxString ResolveTextVars( const wxString& aSource, const std::function<bool( wxString* )>* aResolver,
                                       int& aDepth );

KICOMMON_API wxString GetGeneratedFieldDisplayName( const wxString& aSource );

KICOMMON_API bool IsGeneratedField( const wxString& aFieldName );

KICOMMON_API bool IsGeneratedValue( const wxString& aValue );

KICOMMON_API wxString DescribeRef( const wxString& aRef );

KICOMMON_API const wxString ResolveUriByEnvVars( const wxString& aUri, const PROJECT* aProject );
 

KICOMMON_API bool WarnUserIfOperatingSystemUnsupported();