Look for files in a number of paths. More...

#include <search_stack.h>

Inheritance diagram for SEARCH_STACK:

Public Member Functions
KICAD_T	Type () override

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. More...

void	AddPaths (const wxString &aPaths, int aIndex=-1)
	Insert or append path(s). More...

void	RemovePaths (const wxString &aPaths)
	Remove the given path(s) from the library path list. More...

const wxString	LastVisitedPath (const wxString &aSubPathToSearch=wxEmptyString)
	A quirky function inherited from old code that seems to serve particular needs in the UI. More...

Static Public Member Functions
static int	Split (wxArrayString *aResult, const wxString &aPathString)
	Separate aPathString into individual paths. More...

Detailed Description

Look for files in a number of paths.

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.)

Definition at line 41 of file search_stack.h.

Member Function Documentation

◆ AddPaths()

void SEARCH_STACK::AddPaths	(	const wxString &	aPaths,
		int	aIndex = `-1`
	)

Insert or append path(s).

Parameters

aPaths	path or path list to add. paths must be separated by ";" on windows, or ":" \| ";" on unix.
aIndex	insertion point, -1 for append.

Definition at line 119 of file search_stack.cpp.

{
 bool isCS = wxFileName::IsCaseSensitive();
 wxArrayString paths;
 
 Split( &paths, aPaths );
 
 // appending all of them, on large or negative aIndex
 if( unsigned( aIndex ) >= GetCount() )
 {
 for( unsigned i=0; i<paths.GetCount(); ++i )
 {
 wxString path = paths[i];
 
 if( wxFileName::IsDirReadable( path )
 && Index( path, isCS ) == wxNOT_FOUND )
 {
 Add( path );
 }
 }
 }
 
 // inserting all of them:
 else
 {
 for( unsigned i=0; i<paths.GetCount(); ++i )
 {
 wxString path = paths[i];
 
 if( wxFileName::IsDirReadable( path )
 && Index( path, isCS ) == wxNOT_FOUND )
 {
 Insert( path, aIndex );
 aIndex++;
 }
 }
  }
}

References path, and Split().

Referenced by add_search_paths(), GlobalPathsAppend(), FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), PGM_KICAD::OnPgmInit(), SearchHelpFileFullPath(), SystemDirsAppend(), and DIALOG_GLOBAL_LIB_TABLE_CONFIG::TransferDataToWindow().

◆ FilenameWithRelativePathInSearchList()

wxString SEARCH_STACK::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.

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 library paths

Parameters

aFullFilename	The filename with path and extension.
aBaseDir	The absolute path on which relative paths in this SEARCH_STACK are based.

Returns: a short filename (with extension) with only a relative path if this filename can be found in library paths

Definition at line 69 of file search_stack.cpp.

{
 wxFileName fn = aFullFilename;
 wxString filename = aFullFilename;
 
 unsigned pathlen = fn.GetPath().Len(); // path len, used to find the better (shortest)
 // subpath within defaults paths
 
 for( unsigned kk = 0; kk < GetCount(); kk++ )
 {
 fn = aFullFilename;
 
 // Search for the shortest subpath within 'this':
 if( fn.MakeRelativeTo( base_dir( (*this)[kk], aBaseDir ) ) )
 {
 if( fn.GetPathWithSep().StartsWith( wxT("..") ) ) // Path outside kicad libs paths
 continue;
 
 if( pathlen > fn.GetPath().Len() ) // A better (shortest) subpath is found
 {
 filename = fn.GetPathWithSep() + fn.GetFullName();
 pathlen = fn.GetPath().Len();
 }
 }
 }
 
 return filename;
}

References base_dir().

◆ LastVisitedPath()

const wxString SEARCH_STACK::LastVisitedPath ( const wxString & aSubPathToSearch = wxEmptyString )

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.

Parameters

aSubPathToSearch is the preferred sub path to search in path list.

Definition at line 161 of file search_stack.cpp.

{
 wxString path;
 
 // Initialize default path to the main default lib path
 // this is the second path in list (the first is the project path).
 unsigned pcount = GetCount();
 
 if( pcount )
 {
 unsigned ipath = 0;
 
 if( (*this)[0] == wxGetCwd() )
 ipath = 1;
 
 // First choice of path:
 if( ipath < pcount )
 path = (*this)[ipath];
 
 // Search a sub path matching this SEARCH_PATH
 if( !IsEmpty() )
 {
 for( ; ipath < pcount; ipath++ )
 {
 if( (*this)[ipath].Contains( aSubPathToSearch ) )
 {
 path = (*this)[ipath];
 break;
 }
 }
 }
 }
 
 if( path.IsEmpty() )
 path = wxGetCwd();
 
 return path;
}

References path.

Referenced by SYMBOL_EDIT_FRAME::saveLibrary().

◆ RemovePaths()

void SEARCH_STACK::RemovePaths ( const wxString & aPaths )

Remove the given path(s) from the library path list.

Parameters

aPaths path or list of paths to remove. If list, paths must be separated by ";" on windows, or ":" | ";" on unix.

Definition at line 100 of file search_stack.cpp.

{
 bool isCS = wxFileName::IsCaseSensitive();
 wxArrayString paths;
 
 Split( &paths, aPaths );
 
 for( unsigned i=0; i<paths.GetCount(); ++i )
 {
 wxString path = paths[i];
 
 if( Index( path, isCS ) != wxNOT_FOUND )
 {
 Remove( path );
 }
 }
}

References path, and Split().

◆ Split()

int SEARCH_STACK::Split	(	wxArrayString *	aResult,
		const wxString &	aPathString
	)

static

Separate aPathString into individual paths.

Parameters

aResult	is where to put the paths, it should be empty upon entry.
aPathString	is concatenated string with interposing ';' or ':' separators.

Returns: the count of paths found in aPathString

Definition at line 39 of file search_stack.cpp.

{
 wxStringTokenizer tokenizer( aPathString, PATH_SEPS, wxTOKEN_STRTOK );
 
 while( tokenizer.HasMoreTokens() )
 {
 wxString path = tokenizer.GetNextToken();
 
 aResult->Add( path );
 }
 
 return aResult->GetCount();
}