1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2014 CERN
* Copyright (C) 1992-2014 KiCad Developers, see CHANGELOG.TXT for contributors.
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* 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 SEARCH_STACK_H_
#define SEARCH_STACK_H_
#include <wx/filefn.h>
#include <wx/filename.h>
#include <project.h>
/**
* Class SEARCH_STACK
* looks for files in a number of places. Augments wxPathList.
* I chose the name because it sounded like a stack of work, as a reminder
* that anything you put in here means searching work at some point in time.
* (An alternative is to simply know where something is.)
*/
class SEARCH_STACK : public wxPathList, public PROJECT::_ELEM
{
public:
#if defined(DEBUG)
void Show( const wxString& aPrefix ) const;
#endif
/**
* Function FilenameWithRelativePathInSearchList
* returns the shortest possible path which can be use later to find
* a full path from this SEARCH_STACK.
* <p>
* If the library path is already in the library search paths list,
* just add the library name to the list. Otherwise, add the library
* name with the full or relative path. The relative path is preferable
* because it preserves use of default libraries paths, when the path
* is a sub path of these default paths. Note we accept only sub paths
* not relative paths starting by ../ that are not subpaths and are
* outside kicad libs paths
*
* @param aFullFilename The filename with path and extension.
* @param aBaseDir The absolute path on which relative paths in this
* SEARCH_STACK are based.
* @return a short filename (with extension) with only a relative path if
* this filename can be found in library paths
*/
wxString FilenameWithRelativePathInSearchList(
const wxString& aFullFilename, const wxString& aBaseDir );
wxString FindValidPath( const wxString& aFileName ) const
{
#if 1 // might not be needed
if( wxFileName::FileExists( aFileName ) )
return aFileName;
else
#endif
return wxPathList::FindValidPath( aFileName );
}
/**
* Function AddPaths
* insert or append path(s)
*
* @param aPaths = path or path list to add. paths must be
* separated by ";" on windows, or ":" | ";" on unix.
*
* @param aIndex = insertion point, -1 for append.
*/
void AddPaths( const wxString& aPaths, int aIndex = -1 );
/**
* Function RemovePaths
* removes the given path(s) from the library path list
* @param aPaths = path or list of paths to remove. If list, paths must be separated by
* ";" on windows, or ":" | ";" on unix.
*/
void RemovePaths( const wxString& aPaths );
/**
* Function Split
* separates aPathString into individual paths.
* @param aResult is where to put the paths, it should be empty upon entry.
* @param aPathString is concatonated string with interposing ';' or ':' separators.
* @return int - the count of paths found in aPathString
*/
static int Split( wxArrayString* aResult, const wxString aPathString );
#if 1 // this function is so poorly designed it deserves not to exist.
/**
* Function LastVisitedPath
* is a quirky function inherited from old code that seems to serve particular
* needs in the UI. It returns what is called the last visited directory, or
* if aSubPathToSearch is empty, the first path in this SEARCH_STACK
* ( but not the CWD ).
*
* @todo add more here if you can figure it out.
*
* @param aSubPathToSearch is the preferred sub path to search in path list
*/
const wxString LastVisitedPath( const wxString& aSubPathToSearch = wxEmptyString );
#endif
};
#endif // SEARCH_STACK_H_
|
