mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-13 17:53:11 +02:00
0b2d4d4879
Recommendation is to avoid using the year nomenclature as this information is already encoded in the git repo. Avoids needing to repeatly update. Also updates AUTHORS.txt from current repo with contributor names
115 lines
4.4 KiB
C++
115 lines
4.4 KiB
C++
/*
|
|
* 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 <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 <kicommon.h>
|
|
#include <wx/filefn.h>
|
|
#include <wx/filename.h>
|
|
#include <project.h>
|
|
|
|
|
|
/**
|
|
* 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.)
|
|
*/
|
|
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
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @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 );
|
|
|
|
/**
|
|
* 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 );
|
|
|
|
/**
|
|
* Remove 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 );
|
|
|
|
/**
|
|
* Separate \a aPathString into individual paths.
|
|
*
|
|
* @param aResult is where to put the paths, it should be empty upon entry.
|
|
* @param aPathString is concatenated string with interposing ';' or ':' separators.
|
|
* @return the count of paths found in \a aPathString
|
|
*/
|
|
static int Split( wxArrayString* aResult, const wxString& aPathString );
|
|
|
|
#if 1 // this function is so poorly designed it deserves not to exist.
|
|
/**
|
|
* 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 \a 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_
|