io_utils.h

// SPDX-FileCopyrightText: © 2018-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __UTILS_IO_H__
#define __UTILS_IO_H__
 
#include "zrythm-config.h"
 
#include <optional>
 
#include "utils/utf8_string.h"
 
#include <QTemporaryDir>
#include <QTemporaryFile>
 
namespace zrythm::utils::io
{

utils::Utf8String
get_path_separator_string ();

fs::path
get_home_path ();
 
fs::path
get_temp_path ();

fs::path
get_dir (const fs::path &filename);

void
mkdir (const fs::path &dir);

bool
touch_file (const fs::path &file_path);
 
fs::path
uri_to_file (const utils::Utf8String &uri);

fs::path
file_strip_ext (const fs::path &filename);

fs::path
file_get_ext (const fs::path &file);

fs::path
path_get_basename (const fs::path &filename);

fs::path
path_get_basename_without_ext (const fs::path &filename);

qint64
file_get_last_modified_datetime (const fs::path &filename);
 
Utf8String
file_get_last_modified_datetime_as_str (const fs::path &filename);

bool
remove (const fs::path &path);

std::unique_ptr<QTemporaryDir>
make_tmp_dir (
  std::optional<QString> template_path = std::nullopt,
  bool                   in_temp_dir = true);

inline std::unique_ptr<QTemporaryDir>
make_tmp_dir_at_path (const fs::path &absolute_template_path)
{
  return make_tmp_dir (
    Utf8String::from_path (absolute_template_path).to_qstring (), false);
}

std::unique_ptr<QTemporaryFile>
make_tmp_file (
  std::optional<utils::Utf8String> template_path = std::nullopt,
  bool                             in_temp_dir = true);

bool
rmdir (const fs::path &path, bool force);

std::vector<fs::path>
get_files_in_dir_as_basenames (const fs::path &_dir);

std::vector<fs::path>
get_files_in_dir_ending_in (
  const fs::path                         &_dir,
  bool                                    recursive,
  const std::optional<utils::Utf8String> &end_string);

std::vector<fs::path>
get_files_in_dir (const fs::path &_dir);

void
copy_dir (
  const fs::path &destdir,
  const fs::path &srcdir,
  bool            follow_symlinks,
  bool            recursive);

void
copy_file (const fs::path &destfile, const fs::path &srcfile);

fs::path
get_next_available_filepath (const fs::path &filepath);

Utf8String
get_legal_file_name (const Utf8String &file_name);

Utf8String
get_legal_path_name (const Utf8String &path);
 
#ifdef _WIN32
utils::Utf8String
get_registry_string_val (const utils::Utf8String &key);
#endif
 
#if defined(__APPLE__) && ZRYTHM_IS_INSTALLER_VER
[[gnu::nonnull]] int
get_bundle_path (char * bundle_path);
#endif

bool
path_exists (const fs::path &path);
 
bool
is_file_hidden (const fs::path &file);

[[nodiscard]] bool
reflink_file (const fs::path &dest, const fs::path &src);

[[nodiscard]] QByteArray
read_file_contents (const fs::path &path);

void
set_file_contents (const fs::path &path, const char * contents, size_t size);

void
set_file_contents (const fs::path &file_path, const utils::Utf8String &data);

QStringList
split_paths (const QString &paths);
 
}; // namespace zrythm::utils::io
 
#endif