fdsdump: filelist: define component

Author: Lukas Hutak

src/tools/fdsdump/src/filelist.cpp

@@ -0,0 +1,106 @@
+/**
+ * \file src/utils/filelist.cpp
+ * \author Michal Sedlak <[email protected]>
+ * \brief Thread safe file list
+ *
+ * Copyright (C) 2021 CESNET, z.s.p.o.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of the Company nor the names of its contributors
+ *    may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * ALTERNATIVELY, provided that this notice is retained in full, this
+ * product may be distributed under the terms of the GNU General Public
+ * License (GPL) version 2 or later, in which case the provisions
+ * of the GPL apply INSTEAD OF those given above.
+ *
+ * This software is provided ``as is, and any express or implied
+ * warranties, including, but not limited to, the implied warranties of
+ * merchantability and fitness for a particular purpose are disclaimed.
+ * In no event shall the company or contributors be liable for any
+ * direct, indirect, incidental, special, exemplary, or consequential
+ * damages (including, but not limited to, procurement of substitute
+ * goods or services; loss of use, data, or profits; or business
+ * interruption) however caused and on any theory of liability, whether
+ * in contract, strict liability, or tort (including negligence or
+ * otherwise) arising in any way out of the use of this software, even
+ * if advised of the possibility of such damage.
+ *
+ */
+
+#include <memory>
+#include <string>
+
+#include <glob.h>
+
+#include "filelist.hpp"
+
+void
+FileList::add_files(const std::string &pattern)
+{
+    std::lock_guard<std::mutex> guard(m_mutex);
+
+    std::unique_ptr<glob_t, decltype(&globfree)> glob_ptr {nullptr, &globfree};
+    glob_t globbuf = {};
+    const int flags = GLOB_MARK | GLOB_BRACE | GLOB_TILDE;
+    int ret;
+
+    ret = glob(pattern.c_str(), flags, NULL, &globbuf);
+    switch (ret) {
+    case 0:
+        break;
+    case GLOB_NOMATCH:
+        return;
+    case GLOB_NOSPACE:
+        throw std::bad_alloc();
+    case GLOB_ABORTED:
+        throw std::runtime_error("glob() failed: GLOB_ABORTED");
+    default:
+        throw std::runtime_error("glob() failed: " + std::to_string(ret));
+        break;
+    }
+
+    glob_ptr.reset(&globbuf);
+
+    for (size_t i = 0; i < globbuf.gl_pathc; i++) {
+        std::string filename = globbuf.gl_pathv[i];
+
+        if (filename.back() == '/') {
+            // Skip directories
+            continue;
+        }
+
+        m_files.push_back(std::move(filename));
+    }
+}
+
+bool
+FileList::pop(std::string &filename)
+{
+    std::lock_guard<std::mutex> guard(m_mutex);
+
+    if (empty()) {
+        return false;
+    }
+
+    filename = std::move(*m_files.begin());
+    m_files.erase(m_files.begin());
+    return true;
+}
+
+void
+FileList::clear()
+{
+    std::lock_guard<std::mutex> guard(m_mutex);
+
+    m_files.clear();
+}

src/tools/fdsdump/src/filelist.hpp

@@ -0,0 +1,99 @@
+/**
+ * \file
+ * \author Michal Sedlak <[email protected]>
+ * \brief Thread safe file list
+ *
+ * Copyright (C) 2021 CESNET, z.s.p.o.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of the Company nor the names of its contributors
+ *    may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * ALTERNATIVELY, provided that this notice is retained in full, this
+ * product may be distributed under the terms of the GNU General Public
+ * License (GPL) version 2 or later, in which case the provisions
+ * of the GPL apply INSTEAD OF those given above.
+ *
+ * This software is provided ``as is, and any express or implied
+ * warranties, including, but not limited to, the implied warranties of
+ * merchantability and fitness for a particular purpose are disclaimed.
+ * In no event shall the company or contributors be liable for any
+ * direct, indirect, incidental, special, exemplary, or consequential
+ * damages (including, but not limited to, procurement of substitute
+ * goods or services; loss of use, data, or profits; or business
+ * interruption) however caused and on any theory of liability, whether
+ * in contract, strict liability, or tort (including negligence or
+ * otherwise) arising in any way out of the use of this software, even
+ * if advised of the possibility of such damage.
+ *
+ */
+#pragma once
+
+#include <string>
+#include <mutex>
+#include <vector>
+
+/**
+ * \brief  A file list that allows thread safe retrieval of items;
+ */
+class FileList {
+public:
+    using Iterator = std::vector<std::string>::const_iterator;
+
+	/**
+     * \brief Add files matching the specified pattern onto the list.
+     * \param[in] pattern The file path glob pattern.
+     */
+    void
+	add_files(const std::string &pattern);
+
+    /**
+     * \brief A thread safe method to retrieve a filename off the list.
+     * \param[out] filename  The filename
+     * \return true if the filename was retrieved, false if the list was empty
+     */
+    bool
+    pop(std::string &filename);
+
+    /**
+     * \brief Clear all files in the list.
+     */
+    void clear();
+
+    /**
+     * \brief  Get the length of the list
+     * \return The length of the list
+     */
+    size_t length() const { return m_files.size(); }
+
+    /**
+     * \brief Check whether the list is empty
+     * \return true or false
+     */
+    bool empty() const { return m_files.empty(); }
+
+    /**
+     * \brief  Get an iterator to the beginning of the list
+     * \return The constant iterator
+     */
+    Iterator begin() const { return m_files.cbegin(); }
+
+    /**
+     * \brief  Get an iterator representing the end of the list
+     * \return The constant iterator
+     */
+    Iterator end() const { return m_files.cend(); }
+
+private:
+    std::mutex m_mutex;
+	std::vector<std::string> m_files;
+};