Auxiliary.cpp

Go to the documentation of this file.

 
#include "ElementsKernel/Auxiliary.h"
 
#include <algorithm>  // for remove_if
#include <iterator>
#include <map>
#include <string>  // for string
#include <vector>  // for vector
 
#include <boost/filesystem/operations.hpp>  // for exists
 
#include "ElementsKernel/Path.h"    // for Type, Item, VARIABLE
#include "ElementsKernel/System.h"  // for DEFAULT_INSTALL_PREFIX
 
using std::string;
 
namespace Elements {
inline namespace Kernel {
 
string getAuxiliaryVariableName() {
  return Path::VARIABLE.at(Path::Type::auxiliary);
}
 
// instantiation of the most expected types
template Path::Item getAuxiliaryPath(const Path::Item& file_name, bool raise_exception);
template Path::Item getAuxiliaryPath(const string& file_name, bool raise_exception);
 
std::vector<Path::Item> getAuxiliaryLocations(bool exist_only) {
 
  using System::DEFAULT_INSTALL_PREFIX;
 
  auto location_list = Path::getLocations(Path::Type::auxiliary, exist_only);
 
  // extended to /usr/share/aux{dir,}
  location_list.emplace_back(Path::Item(DEFAULT_INSTALL_PREFIX) / "share" / "auxdir");
  // for backward compatibility with the former convention
  location_list.emplace_back(Path::Item(DEFAULT_INSTALL_PREFIX) / "share" / "aux");
 
  if (exist_only) {
    auto new_end = std::remove_if(location_list.begin(), location_list.end(), [](const Path::Item& p) {
      return (not boost::filesystem::exists(p));
    });
    location_list.erase(new_end, location_list.end());
  }
 
  return location_list;
}
 
namespace Auxiliary {
 
string getVariableName() {
  return getAuxiliaryVariableName();
}
 
// instantiation of the most expected types
template Path::Item getPath(const Path::Item& file_name, bool raise_exception);
template Path::Item getPath(const std::string& file_name, bool raise_exception);
 
std::vector<Path::Item> getLocations(bool exist_only) {
  return getAuxiliaryLocations(exist_only);
}
 
}  // namespace Auxiliary
 
}  // namespace Kernel
}  // namespace Elements