kicad-source/include/search_stack.h
Dick Hollenbeck 7e483f69bd Modular KiCad Blueprint Milestone B), major portions:
*) When kicad.exe closes a project, close any open KIFACEs so that they cannot
     get disassociated from their true PROJECT.
  *) Allow loading eeschema library editor from kicad.exe
  *) Allow loading pcbnew library editor from kicad.exe
  *) Rename LIB_COMPONENT to LIB_PART.
  *) Add class PART_LIBS, and PART_LIB.
  *) Make PART_LIBS non-global, i.e. PROJECT specific.
  *) Implement "data on demand" for PART_LIBS
  *) Implement "data on demand" for schematic SEARCH_STACK.
  *) Use RSTRINGs to retain eeschema editor's notion of last library and part being edited.
  *) Get rid of library search on every SCH_COMPONENT::Draw() call, instead use
     a weak pointer.
  *) Remove all chdir() calls so projects don't need to be CWD.
  *) Romove APPEND support from OpenProjectFiles().
  *) Make OpenProjectFiles() robust, even for creating new projects.
  *) Load EESCHEMA colors in the KIWAY::OnKiwayStart() rather in window open,
     and save them in the .eeschema config file, not in the project file.
  *) Fix bug with wxDir() while accessing protected dirs in kicad.exe
  *) Consolidate template copying into PROJECT class, not in kicad.exe source.
  *) Generally untangle eeschema, making its libraries not global but rather
     held in the PROJECT.
2014-08-13 15:28:54 -05:00

103 lines
3.5 KiB
C++

#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 char* 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_