directory_manager.h

// SPDX-FileCopyrightText: © 2019-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include <utility>
 
#include "utils/types.h"
 
#include "juce_wrapper.h"
 
class IDirectoryManager
{
public:
  enum class DirectoryType
  {
    SYSTEM_PREFIX,

    SYSTEM_BINDIR,

    SYSTEM_PARENT_DATADIR,

    SYSTEM_PARENT_LIBDIR,

    SYSTEM_ZRYTHM_LIBDIR,

    SYSTEM_BUNDLED_PLUGINSDIR,

    SYSTEM_BUNDLED_VST3_PLUGINSDIR,

    SYSTEM_LOCALEDIR,

    SYSTEM_ZRYTHM_DATADIR,

    SYSTEM_SAMPLESDIR,

    SYSTEM_SCRIPTSDIR,

    SYSTEM_THEMESDIR,

    SYSTEM_THEMES_CSS_DIR,

    SYSTEM_THEMES_ICONS_DIR,

    SYSTEM_SPECIAL_LV2_PLUGINS_DIR,

    SYSTEM_TEMPLATES,
 
    /* ************************************ */

    USER_TOP,

    USER_PROJECTS,
    USER_TEMPLATES,
    USER_THEMES,

    USER_THEMES_CSS,

    USER_THEMES_ICONS,

    USER_SCRIPTS,

    USER_LOG,

    USER_PROFILING,

    USER_GDB,

    USER_BACKTRACE,
  };

  virtual fs::path get_prefix () const = 0;

  virtual fs::path get_user_dir (bool force_default) = 0;

  virtual fs::path get_default_user_dir () = 0;

  virtual fs::path get_dir (DirectoryType type);
 
  virtual ~IDirectoryManager () = default;
};

class DirectoryManager : public IDirectoryManager
{
public:
  using UserDirProvider = std::function<fs::path ()>;
  using DefaultUserDirProvider = std::function<fs::path ()>;
  using ApplicationDirPathProvider = std::function<fs::path ()>;
 
public:
  DirectoryManager (
    UserDirProvider            user_dir_provider,
    DefaultUserDirProvider     default_user_dir_provider,
    ApplicationDirPathProvider application_dir_path_provider)
      : user_dir_provider_ (std::move (user_dir_provider)),
        default_user_dir_provider_ (std::move (default_user_dir_provider)),
        application_dir_path_provider_ (std::move (application_dir_path_provider))
  {
  }
  ~DirectoryManager () override = default;
 
  fs::path get_prefix () const override;
  fs::path get_user_dir (bool force_default) override;
  fs::path get_default_user_dir () override;
 
private:
  UserDirProvider            user_dir_provider_;
  DefaultUserDirProvider     default_user_dir_provider_;
  ApplicationDirPathProvider application_dir_path_provider_;
};
 
struct TestingDirectoryManager : public IDirectoryManager
{
  TestingDirectoryManager () = default;
  Q_DISABLE_COPY_MOVE (TestingDirectoryManager)
  ~TestingDirectoryManager () override { remove_testing_dir (); }
 
  fs::path get_user_dir (bool force_default) override;

  const fs::path &get_testing_dir ();

  void remove_testing_dir ();
 
  fs::path get_prefix () const override;
  fs::path get_default_user_dir () override;

  fs::path testing_dir_;
};