Formaline.hpp
1 // Distributed under the MIT License.
2 // See LICENSE.txt for details.
3 
4 #pragma once
5 
6 #include <string>
7 #include <vector>
8 
9 /*!
10  * \ingroup UtilitiesGroup
11  * \brief Functions for retrieving system and source tree information
12  */
13 namespace formaline {
14 /*!
15  * \brief Returns a byte stream of the source tree at the time the executable
16  * was compiled.
17  */
19 
20 /*!
21  * \brief Returns the environment variables at link time.
22  */
23 std::string get_environment_variables() noexcept;
24 
25 /*!
26  * \brief Returns the contents of SpECTRE's LibraryVersions.txt file.
27  */
28 std::string get_library_versions() noexcept;
29 
30 /*!
31  * \brief Returns the PATH, CPATH, LD_LIBRARY_PATH, LIBRARY_PATH, and
32  * CMAKE_PREFIX_PATH at time of compilation.
33  */
34 std::string get_paths() noexcept;
35 
36 /*!
37  * \brief Write the source tree archive to the file
38  * `filename_without_extension.tar.gz`
39  */
40 void write_to_file(const std::string& filename_without_extension) noexcept;
41 } // namespace formaline
std::string get_paths() noexcept
Returns the PATH, CPATH, LD_LIBRARY_PATH, LIBRARY_PATH, and CMAKE_PREFIX_PATH at time of compilation...
Functions for retrieving system and source tree information.
Definition: Formaline.cpp:15
std::vector< char > get_archive() noexcept
Returns a byte stream of the source tree at the time the executable was compiled. ...
std::string get_library_versions() noexcept
Returns the contents of SpECTRE&#39;s LibraryVersions.txt file.
void write_to_file(const std::string &filename_without_extension) noexcept
Write the source tree archive to the file filename_without_extension.tar.gz
Definition: Formaline.cpp:16
std::string get_environment_variables() noexcept
Returns the environment variables at link time.