Ichthyostega
806db414dd
* Lumiera source code always was copyrighted by individual contributors * there is no entity "Lumiera.org" which holds any copyrights * Lumiera source code is provided under the GPL Version 2+ == Explanations == Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above. For this to become legally effective, the ''File COPYING in the root directory is sufficient.'' The licensing header in each file is not strictly necessary, yet considered good practice; attaching a licence notice increases the likeliness that this information is retained in case someone extracts individual code files. However, it is not by the presence of some text, that legally binding licensing terms become effective; rather the fact matters that a given piece of code was provably copyrighted and published under a license. Even reformatting the code, renaming some variables or deleting parts of the code will not alter this legal situation, but rather creates a derivative work, which is likewise covered by the GPL! The most relevant information in the file header is the notice regarding the time of the first individual copyright claim. By virtue of this initial copyright, the first author is entitled to choose the terms of licensing. All further modifications are permitted and covered by the License. The specific wording or format of the copyright header is not legally relevant, as long as the intention to publish under the GPL remains clear. The extended wording was based on a recommendation by the FSF. It can be shortened, because the full terms of the license are provided alongside the distribution, in the file COPYING.
114 lines
3.2 KiB
C++
114 lines
3.2 KiB
C++
/*
|
||
SEARCHPATH.hpp - helpers for searching directory lists and locating modules
|
||
|
||
Copyright (C)
|
||
2011, Hermann Vosseler <Ichthyostega@web.de>
|
||
|
||
**Lumiera** 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. See the file COPYING for further details.
|
||
|
||
*/
|
||
|
||
|
||
/** @file searchpath.hpp
|
||
** Helpers to handle directory search paths.
|
||
** The SerachPathSplitter allows to evaluate a "path" like specification
|
||
** with colon separated components. It is complemented by some magic convenience
|
||
** functions to self-discover the currently running executable and to resolve
|
||
** the `$ORIGIN` pattern similar to what is known from linker `rpath` / `runpath`
|
||
*/
|
||
|
||
|
||
#ifndef COMMON_SEARCHPATH_H
|
||
#define COMMON_SEARCHPATH_H
|
||
|
||
#include "lib/error.hpp"
|
||
#include "lib/nocopy.hpp"
|
||
|
||
#include <boost/filesystem.hpp>
|
||
#include <string>
|
||
#include <regex>
|
||
|
||
|
||
namespace lib {
|
||
|
||
using std::string;
|
||
|
||
using SubMatch = std::smatch::value_type const&;
|
||
|
||
namespace error = lumiera::error;
|
||
namespace fsys = boost::filesystem;
|
||
|
||
using LERR_(ITER_EXHAUST);
|
||
|
||
|
||
/** retrieve the location of the executable */
|
||
string findExePath();
|
||
|
||
/** replace $ORIGIN tokens in the given string
|
||
* @return copy with expansions applied */
|
||
string replaceMagicLinkerTokens (string const& src);
|
||
|
||
|
||
/**
|
||
* Helper: Access a path Specification as a sequence of filesystem Paths.
|
||
* This iterator class dissects a ':'-separated path list. The individual
|
||
* components may use the symbol \c $ORIGIN to refer to the directory
|
||
* holding the current executable.
|
||
* @note #next picks the current component and advances the iteration.
|
||
*/
|
||
class SearchPathSplitter
|
||
: util::NonCopyable
|
||
{
|
||
string pathSpec_;
|
||
std::sregex_iterator pos_,
|
||
end_;
|
||
|
||
static const std::regex EXTRACT_PATHSPEC;
|
||
|
||
public:
|
||
SearchPathSplitter (string const& searchPath)
|
||
: pathSpec_(replaceMagicLinkerTokens (searchPath))
|
||
, pos_(pathSpec_.begin(),pathSpec_.end(), EXTRACT_PATHSPEC)
|
||
, end_()
|
||
{ }
|
||
|
||
explicit operator bool() const { return isValid(); }
|
||
|
||
bool
|
||
isValid() const
|
||
{
|
||
return pos_ != end_;
|
||
}
|
||
|
||
string
|
||
next ()
|
||
{
|
||
if (!isValid())
|
||
throw error::Logic ("Search path exhausted."
|
||
,LERR_(ITER_EXHAUST));
|
||
|
||
string currentPathElement = pos_->str();
|
||
++pos_;
|
||
return currentPathElement;
|
||
}
|
||
};
|
||
|
||
|
||
|
||
/** helper to establish the location to search for loadable modules,
|
||
* configuration files, icons and further resources. After first trying
|
||
* the moduleName directly, the given search path is walked using the
|
||
* SearchPathSplitter, until encountering an existing file with the
|
||
* given name.
|
||
* @return the absolute pathname of the module file found
|
||
* @throws error::Config when the resolution fails
|
||
*/
|
||
string resolveModulePath (fsys::path moduleName, string searchPath = "");
|
||
|
||
|
||
|
||
} // namespace lib
|
||
#endif
|