search_stack.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 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * @author Maciej Suminski <[email protected]>
 *
 * 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/>.
 */
 
#ifndef SEARCH_STACK_H_
#define SEARCH_STACK_H_
 
#include <kicommon.h>
#include <wx/filefn.h>
#include <wx/filename.h>
#include <project.h>
 

class KICOMMON_API SEARCH_STACK : public wxPathList, public PROJECT::_ELEM
{
public:
    PROJECT::ELEM ProjectElementType() override { return PROJECT::ELEM::SEARCH_STACK; }
 
#if defined(DEBUG)
    void Show( const wxString& aPrefix ) const;
#endif

    wxString FilenameWithRelativePathInSearchList( const wxString& aFullFilename,
                                                   const wxString& aBaseDir );

    void AddPaths( const wxString& aPaths, int aIndex = -1 );

    void RemovePaths( const wxString& aPaths );

    static int Split( wxArrayString* aResult, const wxString& aPathString );
 
#if 1   // this function is so poorly designed it deserves not to exist.
    const wxString LastVisitedPath( const wxString& aSubPathToSearch = wxEmptyString );
#endif
 
};
 
#endif  // SEARCH_STACK_H_