RivetPaths.hh

Go to the documentation of this file.

// -*- C++ -*-
#ifndef RIVET_RivetPaths_HH
#define RIVET_RivetPaths_HH
#include <string>
#include <vector>
#include <unistd.h>

namespace Rivet {


  /// Convenience function for determining if a filesystem path exists
  inline bool fileexists(const std::string& path) {
    return (access(path.c_str(), R_OK) == 0);
  }


  /// @name Installation directory paths
  //@{

  /// Get library install path
  std::string getLibPath();

  /// Get data install path
  std::string getDataPath();

  /// Get Rivet data install path
  std::string getRivetDataPath();

  //@}


  /// @name Analysis library search paths
  //@{

  /// Get Rivet analysis plugin library search paths
  std::vector<std::string> getAnalysisLibPaths();

  /// Set the Rivet analysis plugin library search paths
  void setAnalysisLibPaths(const std::vector<std::string>& paths);

  /// Add a Rivet analysis plugin library search path
  void addAnalysisLibPath(const std::string& extrapath);

  /// @brief Find the first file of the given name in the analysis library search dirs
  /// @note If none found, returns an empty string
  std::string findAnalysisLibFile(const std::string& filename);

  //@}


  /// @name Analysis data/metadata paths and search functions
  //@{

  /// Get Rivet analysis reference data search paths
  std::vector<std::string> getAnalysisDataPaths();

  /// Set the Rivet data file search paths
  void setAnalysisDataPaths(const std::vector<std::string>& paths);

  /// Add a Rivet data file search path
  void addAnalysisDataPath(const std::string& extrapath);

  /// @brief Find the first file of the given name in the general data file search dirs
  /// @note If none found, returns an empty string
  std::string findAnalysisDataFile(const std::string& filename,
                                   const std::vector<std::string>& pathprepend=std::vector<std::string>(),
                                   const std::vector<std::string>& pathappend=std::vector<std::string>());


  /// Get Rivet analysis reference data search paths
  std::vector<std::string> getAnalysisRefPaths();

  /// @brief Find the first file of the given name in the ref data file search dirs
  /// @note If none found, returns an empty string
  std::string findAnalysisRefFile(const std::string& filename,
                                  const std::vector<std::string>& pathprepend=std::vector<std::string>(),
                                  const std::vector<std::string>& pathappend=std::vector<std::string>());


  /// Get Rivet analysis info metadata search paths
  std::vector<std::string> getAnalysisInfoPaths();

  /// @brief Find the first file of the given name in the analysis info file search dirs
  /// @note If none found, returns an empty string
  std::string findAnalysisInfoFile(const std::string& filename,
                                   const std::vector<std::string>& pathprepend=std::vector<std::string>(),
                                   const std::vector<std::string>& pathappend=std::vector<std::string>());


  /// Get Rivet analysis plot style search paths
  std::vector<std::string> getAnalysisPlotPaths();

  /// @brief Find the first file of the given name in the analysis plot file search dirs
  /// @note If none found, returns an empty string
  std::string findAnalysisPlotFile(const std::string& filename,
                                   const std::vector<std::string>& pathprepend=std::vector<std::string>(),
                                   const std::vector<std::string>& pathappend=std::vector<std::string>());

  //@}


}

#endif