filename_resolver.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015-2016 Cirilo Bernardo <cirilo.bernardo@gmail.com>
 * Copyright (C) 2020 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 FILENAME_RESOLVER_H
#define FILENAME_RESOLVER_H

#include <list>
#include <map>
#include <vector>
#include <wx/string.h>

class PGM_BASE;

struct SEARCH_PATH
{
    wxString m_Alias;           // alias to the base path
    wxString m_Pathvar;         // base path as stored in the config file
    wxString m_Pathexp;         // expanded base path
    wxString m_Description;     // description of the aliased path
};


class FILENAME_RESOLVER
{
public:
    FILENAME_RESOLVER();

    bool Set3DConfigDir( const wxString& aConfigDir );

    bool SetProject( PROJECT* aProject, bool* flgChanged = nullptr );

    wxString GetProjectDir( void );

    void SetProgramBase( PGM_BASE* aBase );


    bool UpdatePathList( std::vector< SEARCH_PATH >& aPathList );

    wxString ResolvePath( const wxString& aFileName );

    wxString ShortenPath( const wxString& aFullPathName );

    const std::list< SEARCH_PATH >* GetPaths( void );

    bool SplitAlias( const wxString& aFileName, wxString& anAlias, wxString& aRelPath );

    bool ValidateFileName( const wxString& aFileName, bool& hasAlias );

    bool GetKicadPaths( std::list< wxString >& paths );

private:
    bool createPathList( void );

    bool addPath( const SEARCH_PATH& aPath );

    bool readPathList( void );

    bool writePathList( void );

    void checkEnvVarPath( const wxString& aPath );

    wxString               m_configDir;     // 3D configuration directory
    std::list<SEARCH_PATH> m_paths;         // list of base paths to search from
    int                    m_errflags;
    PGM_BASE*              m_pgm;
    PROJECT*               m_project;
    wxString               m_curProjDir;
};

#endif  // FILENAME_RESOLVER_H