open-cpp-utils/filesystem.h
2025-06-03 14:26:59 -04:00

349 lines
12 KiB
C++
Executable File

// =====================================================================================================================
// open-cpp-utils, an open-source cpp library with data structures that extend the STL.
// Copyright (C) 2024 Medusa Slockbower
//
// This program 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 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
// =====================================================================================================================
#ifndef OPEN_CPP_UTILS_FILESYSTEM_H
#define OPEN_CPP_UTILS_FILESYSTEM_H
#include <filesystem>
#include <stack>
#include <utility>
#include "directed_tree.h"
namespace open_cpp_utils
{
using path_t = std::filesystem::path;
template<typename T_, typename L_>
class filesystem
{
// Typedefs ============================================================================================================
public:
class file;
using data_t = T_;
using loader = L_;
using file_tree = directed_tree<file>;
using fileptr = file*;
using file_id = typename file_tree::node;
static constexpr file_id root = file_tree::root;
// Structs =============================================================================================================
public:
class file
{
private:
file(filesystem* parent, file_id node, path_t path, data_t* data)
: parent_(parent), node_(node), path_(std::move(path)), value_(data)
{ }
public:
file() : parent_(nullptr), node_(0), path_(""), value_(nullptr) { }
file(const file&) = default;
file(file&&) = default;
~file() { delete value_; }
const path_t& path() const { return path_; }
data_t* get_data() { return value_; }
const data_t* get_data() const { return value_; }
filesystem& system() { return *parent_; }
const filesystem& system() const { return *parent_; }
bool is_directory() const { return std::filesystem::is_directory(path_); }
bool empty() const { return is_empty(path_); }
bool has_subdirectory() const { for(const auto& path : std::filesystem::directory_iterator{ path_ }) { if(std::filesystem::is_directory(path)) return true; } return false; }
void erase() { delete value_; value_ = nullptr; }
file_id get_id() const { return node_; }
data_t* operator->() { return value_; }
const data_t* operator->() const { return value_; }
data_t* operator*() { return value_; }
const data_t* operator*() const { return value_; }
private:
filesystem* parent_;
file_id node_;
path_t path_;
data_t* value_;
friend class filesystem;
};
// Functions ===========================================================================================================
// Helpers -------------------------------------------------------------------------------------------------------------
private:
static path_t resolve_(const path_t& path) { return absolute(canonical(path)); }
static bool is_parent_(const path_t& base, const path_t& path)
{ return std::mismatch(path.begin(), path.end(), base.begin(), base.end()).second == base.end(); }
file_id find_(path_t path) const;
file_id get_index_(file_id parent, const path_t &path);
// Constructors & Destructor -------------------------------------------------------------------------------------------
public:
filesystem() = default;
~filesystem() = default;
file& operator[](file_id id) { return tree_[id]; }
const file& operator[](file_id id) const { return tree_[id]; }
file_id load_directory(const path_t& path);
void close_directory(file_id id) { tree_.erase(id); }
file_id import(const path_t& path, file_id parent);
file_id create(const std::string& name, file_id parent);
file_id create_folder(const std::string& name, file_id parent);
void rename(file_id id, const std::string& name);
void clear() { tree_.clear(); }
void erase(file_id id);
void erase(const path_t& path);
file_id find(const path_t& path) const;
file_id parent(file_id id) const { return tree_.parent(tree_[id].get_id()); }
file_id next(file_id id) const { return tree_.next_sibling(tree_[id].get_id()); }
file_id prev(file_id id) const { return tree_.prev_sibling(tree_[id].get_id()); }
file_id begin(file_id id) const { return tree_.first_child(tree_[id].get_id()); }
file_id end(file_id) const { return file_tree::root; }
uint32_t depth(file_id id) const { return tree_.depth(tree_[id].get_id()); }
template<typename O = typename file_tree::pre_order, typename V>
void traverse(V& visitor) { tree_.template traverse<O>(visitor); }
private:
file_tree tree_;
};
template<typename T_, typename L_>
typename filesystem<T_, L_>::file_id filesystem<T_, L_>::find_(path_t path) const
{
// Check if the path exists
if(not exists(path)) return file_tree::root;
// Setup for traversal
path = resolve_(path);
file_id dir = tree_.first_child(file_tree::root);
// Get the parent folder
while(dir != file_tree::root)
{
if(is_parent_(tree_[dir].path(), path)) break;
dir = tree_.next_sibling(dir);
}
// Path does not exist in file system
if(dir == file_tree::root) return file_tree::root;
// Get starting point for iteration
auto parent = tree_[dir].path();
auto start = std::mismatch(path.begin(), path.end(), parent.begin(), parent.end()).first;
// Parse down the tree
for(auto it = start; it != path.end(); ++it)
{
for(file_id child = tree_.first_child(dir); child != file_tree::root; child = tree_.next_sibling(child))
{
if(tree_[child].path().filename() == it->filename())
{
dir = child;
break;
}
}
}
return dir;
}
template<typename T_, typename L_>
typename filesystem<T_, L_>::file_id filesystem<T_, L_>::get_index_(file_id parent, const path_t &path)
{
file_id dir = tree_.first_child(parent);
// Get the insertion index
while(dir != file_tree::root)
{
if(tree_[dir].path().filename().compare(path.filename()) > 0) break;
dir = tree_.next_sibling(dir);
}
return dir;
}
template<typename T_, typename L_>
typename filesystem<T_, L_>::file_id filesystem<T_, L_>::load_directory(const path_t& path)
{
if(not exists(path)) return root;
const path_t directory = canonical(absolute(path));
file_id dir = tree_.first_child(file_tree::root);
// Validate this isn't a subdirectory
while(dir != file_tree::root)
{
if(is_parent_(tree_[dir].path(), directory)) return find(directory);
dir = tree_.next_sibling(dir);
}
dir = get_index_(file_tree::root, directory);
dir = tree_.insert(file(this, tree_.next_id(), directory, nullptr), file_tree::root, dir);
tree_[dir].value_ = loader::load(directory, dir);
file_id res = dir;
using iter_t = std::filesystem::directory_iterator;
std::stack<std::tuple<path_t, file_id, iter_t>> working;
working.emplace(directory, dir, iter_t(directory));
while(not working.empty())
{
auto& top = working.top();
const file_id p_dir = std::get<1>(top);
const iter_t& it = std::get<2>(top);
if(std::filesystem::begin(it) == std::filesystem::end(it))
{
working.pop();
continue;
}
const path_t create_path = *it;
file_id created = tree_.insert(file(this, tree_.next_id(), create_path, nullptr), p_dir);
tree_[created].value_ = loader::load(create_path, created);
if(is_directory(create_path))
{
working.emplace(create_path, created, iter_t(create_path));
}
++std::get<2>(top);
}
return res;
}
template<typename T_, typename L_>
typename filesystem<T_, L_>::file_id filesystem<T_, L_>::import(const path_t& path, file_id parent)
{
if(not exists(path)) return root;
file& prnt = tree_[parent];
path_t nloc = prnt.path() / path.filename();
const file_id node = tree_.insert(file(this, tree_.next_id(), nloc, nullptr), parent, get_index_(parent, nloc));
tree_[node].value_ = loader::import(path, nloc, node);
return node;
}
template<typename T_, typename L_>
typename filesystem<T_, L_>::file_id filesystem<T_, L_>::create(const std::string &name, file_id parent)
{
file& prnt = tree_[parent];
const file_id p_dir = prnt.get_id();
const path_t path = prnt.path() / name;
if(exists(path)) return 0;
const file_id node = tree_.insert(file(this, tree_.next_id(), path, nullptr), parent, get_index_(parent, path));
tree_[node].value_ = loader::create(path, node);
return node;
}
template<typename T_, typename L_>
typename filesystem<T_, L_>::file_id filesystem<T_, L_>::create_folder(const std::string &name, file_id parent)
{
file& prnt = tree_[parent];
const path_t path = prnt.path() / name;
if(exists(path)) return 0;
create_directory(path);
data_t* data = loader::load(path);
const file_id node = tree_.insert(file(this, tree_.next_id(), path, data), parent, get_index_(parent, path));
return tree_[node];
}
template<typename T_, typename L_>
void filesystem<T_, L_>::rename(file_id id, const std::string& name)
{
file& file = tree_[id];
const std::string new_name = path_t(name).stem().string() + file.path().extension().string();
fileptr current = &file;
while(true)
{
fileptr next = &tree_[filesystem::next(current->get_id())];
fileptr prev = &tree_[filesystem::prev(current->get_id())];
if(next != &tree_[root] && new_name.compare(next->path().filename().string()) > 0) { tree_.swap(current->get_id(), next->get_id()); current = next; continue; }
if(next != &tree_[root] && new_name.compare(prev->path().filename().string()) < 0) { tree_.swap(current->get_id(), prev->get_id()); current = prev; continue; }
break;
}
const path_t new_path = current->path().parent_path() / new_name;
std::filesystem::rename(current->path(), new_path);
current->path_ = new_path;
}
template<typename T_, typename L_>
void filesystem<T_, L_>::erase(file_id id)
{
file& file = tree_[id];
std::filesystem::remove(file.path());
tree_.erase(id);
}
template<typename T_, typename L_>
void filesystem<T_, L_>::erase(const path_t &path)
{
const file_id id = find_(path);
erase(tree_[id]);
}
template<typename T_, typename L_>
typename filesystem<T_, L_>::file_id filesystem<T_, L_>::find(const path_t &path) const
{
return find_(path);
}
}
#endif // OPEN_CPP_UTILS_FILESYSTEM_H