#pragma once ///@file #include "types.hh" #include "error.hh" #include "logging.hh" #include "ansicolor.hh" #include #include #include #include #include #include #include #include #include #include #include #include #ifndef HAVE_STRUCT_DIRENT_D_TYPE #define DT_UNKNOWN 0 #define DT_REG 1 #define DT_LNK 2 #define DT_DIR 3 #endif namespace nix { struct Sink; struct Source; /** * The system for which Nix is compiled. */ extern const std::string nativeSystem; std::string getUserName(); /** * @return the given user's home directory from /etc/passwd. */ Path getHomeOf(uid_t userId); /** * @return $HOME or the user's home directory from /etc/passwd. */ Path getHome(); /** * @return $XDG_CACHE_HOME or $HOME/.cache. */ Path getCacheDir(); /** * @return $XDG_CONFIG_HOME or $HOME/.config. */ Path getConfigDir(); /** * @return the directories to search for user configuration files */ std::vector getConfigDirs(); /** * @return $XDG_DATA_HOME or $HOME/.local/share. */ Path getDataDir(); /** * @return $XDG_STATE_HOME or $HOME/.local/state. * * @note Not to be confused with settings.nixStateDir. */ Path getStateDir(); /** * Create $XDG_STATE_HOME/nix or $HOME/.local/state/nix, and return * the path to it. * @note Not to be confused with settings.nixStateDir. */ Path createNixStateDir(); /** * Save the current mount namespace. Ignored if called more than * once. */ void saveMountNamespace(); /** * Restore the mount namespace saved by saveMountNamespace(). Ignored * if saveMountNamespace() was never called. */ void restoreMountNamespace(); /** * Cause this thread to not share any FS attributes with the main * thread, because this causes setns() in restoreMountNamespace() to * fail. */ void unshareFilesystem(); /** * Convert a list of strings to a null-terminated vector of `char * *`s. The result must not be accessed beyond the lifetime of the * list of strings. */ std::vector stringsToCharPtrs(const Strings & ss); MakeError(FormatError, Error); /** * String tokenizer. */ template C tokenizeString(std::string_view s, std::string_view separators = " \t\n\r"); /** * Concatenate the given strings with a separator between the * elements. */ template std::string concatStringsSep(const std::string_view sep, const C & ss) { size_t size = 0; // need a cast to string_view since this is also called with Symbols for (const auto & s : ss) size += sep.size() + std::string_view(s).size(); std::string s; s.reserve(size); for (auto & i : ss) { if (s.size() != 0) s += sep; s += i; } return s; } template auto concatStrings(Parts && ... parts) -> std::enable_if_t<(... && std::is_convertible_v), std::string> { std::string_view views[sizeof...(parts)] = { parts... }; return concatStringsSep({}, views); } /** * Add quotes around a collection of strings. */ template Strings quoteStrings(const C & c) { Strings res; for (auto & s : c) res.push_back("'" + s + "'"); return res; } /** * Remove trailing whitespace from a string. * * \todo return std::string_view. */ std::string chomp(std::string_view s); /** * Remove whitespace from the start and end of a string. */ std::string trim(std::string_view s, std::string_view whitespace = " \n\r\t"); /** * Replace all occurrences of a string inside another string. */ std::string replaceStrings( std::string s, std::string_view from, std::string_view to); /** * Rewrites a string given a map of replacements, applying the replacements in * sorted order, only once, considering only the strings appearing in the input * string in performing replacement. * * - Replacements are not performed on intermediate strings. That is, for an input * `"abb"` with replacements `{"ab" -> "ba"}`, the result is `"bab"`. * - Transitive replacements are not performed. For example, for the input `"abcde"` * with replacements `{"a" -> "b", "b" -> "c", "e" -> "b"}`, the result is * `"bccdb"`. */ class Rewriter { private: std::string initials; std::map rewrites; public: explicit Rewriter(std::map rewrites); std::string operator()(std::string s); }; inline std::string rewriteStrings(std::string s, const StringMap & rewrites) { return Rewriter(rewrites)(s); } /** * Parse a string into an integer. */ template std::optional string2Int(const std::string_view s) { if (s.substr(0, 1) == "-" && !std::numeric_limits::is_signed) return std::nullopt; try { return boost::lexical_cast(s.data(), s.size()); } catch (const boost::bad_lexical_cast &) { return std::nullopt; } } /** * Like string2Int(), but support an optional suffix 'K', 'M', 'G' or * 'T' denoting a binary unit prefix. */ template N string2IntWithUnitPrefix(std::string_view s) { N multiplier = 1; if (!s.empty()) { char u = std::toupper(*s.rbegin()); if (std::isalpha(u)) { if (u == 'K') multiplier = 1ULL << 10; else if (u == 'M') multiplier = 1ULL << 20; else if (u == 'G') multiplier = 1ULL << 30; else if (u == 'T') multiplier = 1ULL << 40; else throw UsageError("invalid unit specifier '%1%'", u); s.remove_suffix(1); } } if (auto n = string2Int(s)) return *n * multiplier; throw UsageError("'%s' is not an integer", s); } /** * Parse a string into a float. */ template std::optional string2Float(const std::string_view s) { try { return boost::lexical_cast(s.data(), s.size()); } catch (const boost::bad_lexical_cast &) { return std::nullopt; } } /** * Convert a little-endian integer to host order. */ template T readLittleEndian(unsigned char * p) { T x = 0; for (size_t i = 0; i < sizeof(x); ++i, ++p) { x |= ((T) *p) << (i * 8); } return x; } /** * Convert a string to lower case. */ std::string toLower(const std::string & s); /** * Escape a string as a shell word. */ std::string shellEscape(const std::string_view s); /** * Exception handling in destructors: print an error message, then * ignore the exception. */ void ignoreException(Verbosity lvl = lvlError); /** * Tree formatting. */ constexpr char treeConn[] = "├───"; constexpr char treeLast[] = "└───"; constexpr char treeLine[] = "│ "; constexpr char treeNull[] = " "; /** * Base64 encoding/decoding. */ std::string base64Encode(std::string_view s); std::string base64Decode(std::string_view s); /** * Remove common leading whitespace from the lines in the string * 's'. For example, if every line is indented by at least 3 spaces, * then we remove 3 spaces from the start of every line. */ std::string stripIndentation(std::string_view s); /** * Get the prefix of 's' up to and excluding the next line break (LF * optionally preceded by CR), and the remainder following the line * break. */ std::pair getLine(std::string_view s); /** * Get a value for the specified key from an associate container. */ template const typename T::mapped_type * get(const T & map, const typename T::key_type & key) { auto i = map.find(key); if (i == map.end()) return nullptr; return &i->second; } template typename T::mapped_type * get(T & map, const typename T::key_type & key) { auto i = map.find(key); if (i == map.end()) return nullptr; return &i->second; } /** * Get a value for the specified key from an associate container, or a default value if the key isn't present. */ template const typename T::mapped_type & getOr(T & map, const typename T::key_type & key, const typename T::mapped_type & defaultValue) { auto i = map.find(key); if (i == map.end()) return defaultValue; return i->second; } /** * Remove and return the first item from a container. */ template std::optional remove_begin(T & c) { auto i = c.begin(); if (i == c.end()) return {}; auto v = std::move(*i); c.erase(i); return v; } /** * Remove and return the first item from a container. */ template std::optional pop(T & c) { if (c.empty()) return {}; auto v = std::move(c.front()); c.pop(); return v; } /** * A RAII helper that increments a counter on construction and * decrements it on destruction. */ template struct MaintainCount { T & counter; long delta; MaintainCount(T & counter, long delta = 1) : counter(counter), delta(delta) { counter += delta; } ~MaintainCount() { counter -= delta; } }; /** * A Rust/Python-like enumerate() iterator adapter. * * Borrowed from http://reedbeta.com/blog/python-like-enumerate-in-cpp17. */ template ())), typename = decltype(std::end(std::declval()))> constexpr auto enumerate(T && iterable) { struct iterator { size_t i; TIter iter; constexpr bool operator != (const iterator & other) const { return iter != other.iter; } constexpr void operator ++ () { ++i; ++iter; } constexpr auto operator * () const { return std::tie(i, *iter); } }; struct iterable_wrapper { T iterable; constexpr auto begin() { return iterator{ 0, std::begin(iterable) }; } constexpr auto end() { return iterator{ 0, std::end(iterable) }; } }; return iterable_wrapper{ std::forward(iterable) }; } /** * C++17 std::visit boilerplate */ template struct overloaded : Ts... { using Ts::operator()...; }; template overloaded(Ts...) -> overloaded; std::string showBytes(uint64_t bytes); /** * Provide an addition operator between strings and string_views * inexplicably omitted from the standard library. */ inline std::string operator + (const std::string & s1, std::string_view s2) { auto s = s1; s.append(s2); return s; } inline std::string operator + (std::string && s, std::string_view s2) { s.append(s2); return std::move(s); } inline std::string operator + (std::string_view s1, const char * s2) { std::string s; s.reserve(s1.size() + strlen(s2)); s.append(s1); s.append(s2); return s; } }