ProjectFiles.hpp

#pragma once
#include <QHash>
#include <QSet>
#include <QString>
 
#include <score_lib_base_export.h>
 
#include <vector>
 
namespace score
{
struct DocumentContext;
 
enum class FileKind
{
  Unknown,
  Audio,
  Video,
  Image,
  Midi,
  Model3D,
  Shader,
  Script,
  Data,
  Folder,
  Plugin
};
 
SCORE_LIB_BASE_EXPORT
FileKind guessFileKind(const QString& path) noexcept;
 
SCORE_LIB_BASE_EXPORT
QString mediaSubfolder(FileKind k) noexcept;
 
struct SCORE_LIB_BASE_EXPORT PathRoots
{
  QString documentFile;
  QString library;
 
  QString documentFolder() const noexcept;
};
 
SCORE_LIB_BASE_EXPORT
QString pickerStartFolder(
    const QString& current, const PathRoots& roots, const QString& userDocuments,
    const QString& workingDir) noexcept;
 
SCORE_LIB_BASE_EXPORT
PathRoots pathRoots(const score::DocumentContext& ctx) noexcept;
 
SCORE_LIB_BASE_EXPORT
PathRoots pathRoots() noexcept;
 
SCORE_LIB_BASE_EXPORT
QString locateFilePath(const QString& filename, const PathRoots& roots) noexcept;
 
SCORE_LIB_BASE_EXPORT
QString relativizeFilePath(const QString& filename, const PathRoots& roots) noexcept;
 
SCORE_LIB_BASE_EXPORT
bool isUnderFolder(const QString& path, const QString& folder) noexcept;
 
SCORE_LIB_BASE_EXPORT
bool isRemoteUrl(const QString& path) noexcept;
 
SCORE_LIB_BASE_EXPORT
bool isContainedRelativePath(const QString& relative) noexcept;
 
SCORE_LIB_BASE_EXPORT
bool isProjectRelativePath(const QString& path) noexcept;
SCORE_LIB_BASE_EXPORT
bool isLibraryRelativePath(const QString& path) noexcept;
 
SCORE_LIB_BASE_EXPORT
QString sanitizeFileName(const QString& name) noexcept;
 
SCORE_LIB_BASE_EXPORT
bool sameFileContents(const QString& lhs, const QString& rhs) noexcept;
 
enum class CopyMode
{
  Copy,     
  Symlink,  
  Hardlink  
};
 
struct SCORE_LIB_BASE_EXPORT ConsolidateOptions
{
  CopyMode mode = CopyMode::Copy;
 
  bool collectLibraryFiles = false;
 
  bool useKindSubfolders = true;
 
  bool keepSourceFolderName = false;
};
 
class SCORE_LIB_BASE_EXPORT FilePlacement
{
public:
  explicit FilePlacement(QString projectFolder, ConsolidateOptions opts = {}) noexcept;
 
  struct Placement
  {
    QString destination;
    bool alreadyInProject{};
    bool reused{};
  };
 
  Placement place(
      const QString& absoluteSource, FileKind kind,
      const std::vector<QString>& companions = {});
 
  const QString& projectFolder() const noexcept { return m_root; }
  const ConsolidateOptions& options() const noexcept { return m_opts; }
 
private:
  QString subfolderFor(const QString& absoluteSource, FileKind kind) const;
  Placement placeWithCompanions(
      const QString& canonicalSource, FileKind kind,
      const std::vector<QString>& companions);
 
  QString m_root;
  QString m_canonicalRoot;
  ConsolidateOptions m_opts;
  QHash<QString, Placement> m_placed;
  QSet<QString> m_claimed;
  QSet<QString> m_fileFolders;
};
 
SCORE_LIB_BASE_EXPORT
bool materializeFile(
    const QString& source, const QString& destination, CopyMode mode, QString& error);
}