KiCad PCB EDA Suite
search_stack.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 CERN
5 * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Maciej Suminski <[email protected]>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#ifndef SEARCH_STACK_H_
27#define SEARCH_STACK_H_
28
29#include <wx/filefn.h>
30#include <wx/filename.h>
31#include <project.h>
32
33
41class SEARCH_STACK : public wxPathList, public PROJECT::_ELEM
42{
43public:
44 KICAD_T Type() override { return SEARCH_STACK_T; }
45
46#if defined(DEBUG)
47 void Show( const wxString& aPrefix ) const;
48#endif
49
67 wxString FilenameWithRelativePathInSearchList( const wxString& aFullFilename,
68 const wxString& aBaseDir );
69
77 void AddPaths( const wxString& aPaths, int aIndex = -1 );
78
85 void RemovePaths( const wxString& aPaths );
86
94 static int Split( wxArrayString* aResult, const wxString& aPathString );
95
96#if 1 // this function is so poorly designed it deserves not to exist.
108 const wxString LastVisitedPath( const wxString& aSubPathToSearch = wxEmptyString );
109#endif
110
111};
112
113#endif // SEARCH_STACK_H_
A PROJECT can hold stuff it knows nothing about, in the form of _ELEM derivatives.
Definition: project.h:74
Look for files in a number of paths.
Definition: search_stack.h:42
static int Split(wxArrayString *aResult, const wxString &aPathString)
Separate aPathString into individual paths.
void AddPaths(const wxString &aPaths, int aIndex=-1)
Insert or append path(s).
KICAD_T Type() override
Definition: search_stack.h:44
void RemovePaths(const wxString &aPaths)
Remove the given path(s) from the library path list.
wxString FilenameWithRelativePathInSearchList(const wxString &aFullFilename, const wxString &aBaseDir)
Return the shortest possible path which can be use later to find a full path from this SEARCH_STACK.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ SEARCH_STACK_T
Definition: typeinfo.h:238