io.h

Go to the documentation of this file.

/* Author: Zachary Kingston */

#ifndef SE2EZ_CORE_IO_
#define SE2EZ_CORE_IO_

#include <string>
#include <utility>
#include <fstream>

#include <boost/date_time.hpp>

#include <yaml-cpp/yaml.h>

namespace se2ez
{
    namespace io
    {
        /** \brief Resolves file paths to their canonical form.
         *  \param[in] path Path to resolve.
         *  \return The canonical path, or "" on failure.
         */
        const std::string resolvePath(const std::string &path);

        /** \brief Loads a file to a string.
         *  \param[in] path File to load.
         *  \return The loaded file, or "" on failure (file does not exist).
         */
        const std::string loadFileToString(const std::string &path);

        /** \brief Runs a command \a cmd and returns stdout as a string.
         *  \param[in] cmd Command to run.
         *  \return Contents of stdout from \a cmd, or "" on failure.
         */
        const std::string runCommand(const std::string &cmd);

        /** \brief Loads a file to a YAML node.
         *  \param[in] path File to load.
         *  \return A pair, where the first is true on success false on failure, and second is the YAML node.
         */
        const std::pair<bool, YAML::Node> loadFileToYAML(const std::string &path);

        /** \brief Creates a directory.
         *  \param[in] dir Directory to create.
         */
        void createDirectory(const std::string &dir);

        /** \brief Creates a file and opens an output stream. Creates directories if they do not exist.
         *  \param[out] out Output stream to initialize.
         *  \param[in] file File to create and open.
         */
        void createFile(std::ofstream &out, const std::string &file);

        /** \brief Lists of the contents of a directory.
         *  \param[in] directory Directory to list.
         *  \return A pair of a bool and a vector of strings of filenames of the directories contents. The
         * first element will be true on success, false on failure. These filenames are absolute paths.
         */
        const std::pair<bool, std::vector<std::string>> listDirectory(const std::string &directory);

        /** \brief Get the current time (up to milliseconds)
         *  \return The time.
         */
        boost::posix_time::ptime getDate();

        /** \brief Separates a \a string into tokens, based upon \a separators.
         *  \param[in] string String to tokenize.
         *  \param[in] separators Separators to split string on.
         *  \return The tokenized string.
         */
        std::vector<std::string> tokenize(const std::string &string, const std::string &separators);

        /** \brief Write the contents of a YAML node out to a potentially new file.
         *  \param[in] node Node to write.
         *  \param[in] file Filename to open.
         *  \return True on success, false otherwise.
         */
        bool YAMLToFile(const YAML::Node &node, const std::string &file);

        /** \brief Have this thread sleep for some number of seconds.
         *  \param[in] seconds Seconds to sleep for.
         */
        void sleep(double seconds);
    }  // namespace io
}  // namespace se2ez

#endif