file_listing.h

// -*-c++-*-
#ifndef STORMM_FILE_LISTING_H
#define STORMM_FILE_LISTING_H
 
#include <vector>
#include <string>
#include "copyright.h"
 
namespace stormm {
namespace diskutil {

enum class SearchStyle {
  RECURSIVE, NON_RECURSIVE
};

enum class DrivePathType {
  FILE, DIRECTORY, REGEXP
};

enum class OperatingSystem {
  LINUX, UNIX, WINDOWS, MAC_OS
};

#if defined(__linux__)
constexpr OperatingSystem detected_os = OperatingSystem::LINUX;
#elif defined(unix) || defined(__unix) || defined(__unix__)
constexpr OperatingSystem detected_os = OperatingSystem::UNIX;
#elif defined(_WIN32) || defined(_WIN64) || defined(__CYGWIN__)
constexpr OperatingSystem detected_os = OperatingSystem::WINDOWS;
#elif defined(__APPLE__) || defined(__MACH__)
constexpr OperatingSystem detected_os = OperatingSystem::MAC_OS;
#endif

char osSeparator();

DrivePathType getDrivePathType(const std::string &path);

std::vector<std::string> listDirectory(const std::string &path,
                                       SearchStyle r_option = SearchStyle::NON_RECURSIVE,
                                       DrivePathType entity_kind = DrivePathType::FILE);

bool pathIsAbsolute(const std::string &path);

std::string makePathAbsolute(const std::string &path);

std::string getNormPath(const std::string &path);

std::string getBaseName(const std::string &path);

std::string substituteNameExtension(const std::string &path, const std::string &new_ext);

std::vector<std::string> separatePath(const std::string &path);

void splitPath(const std::string &path, std::string *before, std::string *after);
  
std::vector<std::string> listFilesInPath(const std::string &regexp_path, SearchStyle r_option);

std::string findStormmPath(const std::string &path, const std::string &extension);

std::string commonPathVariableName(int index);
  
std::vector<std::string> extractCommonPaths(std::vector<std::string> *input_paths,
                                            int n_shortcut = 2, int n_instance = 2);

std::string listCommonPaths(const std::vector<std::string> &shortcuts, int indentation = 2);
  
} // namespace parse
} // namespace stormm
 
#endif