file.hpp

Go to the documentation of this file.

/*
  FILE.hpp  -  Filesystem access and helpers

   Copyright (C)
     2022,            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.

*/


#ifndef LIB_STAT_FILE_H
#define LIB_STAT_FILE_H


#include "lib/error.hpp"
#include "lib/symbol.hpp"
#include "lib/meta/util.hpp"

#include <filesystem>
#include <cstdlib>


namespace fs = std::filesystem;
namespace std::filesystem {
  
  extern const string UNIX_HOMEDIR_SYMBOL;
  extern lib::Literal UNIX_HOMEDIR_ENV;
  
  
  inline fs::path
  getHomePath()
  {
    auto home = std::getenv(UNIX_HOMEDIR_ENV);
    if (not home)
        throw lumiera::error::Config{"Program environment doesn't define $HOME (Unix home directory)."};
    return fs::path{home};
  }
  
  
  inline fs::path
  consolidated (fs::path rawPath)
  {
      if (rawPath.empty())
          return rawPath;
      if (UNIX_HOMEDIR_SYMBOL == *rawPath.begin())
          rawPath = getHomePath() / rawPath.lexically_proximate(UNIX_HOMEDIR_SYMBOL);
  
      return fs::exists(rawPath)? fs::absolute(
                                  fs::canonical(rawPath))
                                : rawPath;
  }
  
  
  inline bool
  has_perm (fs::path const& p, fs::perms permissionMask)
  {
    return (fs::status(p).permissions() & permissionMask) == permissionMask;
  }
  
  inline bool
  can_read (fs::path const& p)
  {
    return has_perm (p, fs::perms::owner_read);
  }
  
  inline bool
  can_write (fs::path const& p)
  {
    return has_perm (p, fs::perms::owner_write);
  }
  
  inline bool
  can_exec (fs::path const& p)
  {
    return has_perm (p, fs::perms::owner_exec);
  }
}//(End)namespace fs



namespace util {
  
  template<>
  struct StringConv<fs::path, void>
    {
      static std::string
      invoke (fs::path path) noexcept
      try {
          return "≺"+std::string{path}+"≻";
        }
      catch(...)
        { return lib::meta::FAILURE_INDICATOR; }
    };
  
}//(End)namespace util
#endif /*LIB_STAT_FILE_H*/