FileOperation.hpp

#pragma once
#include <Process/ExternalFiles.hpp>
 
#include <score/tools/ProjectFiles.hpp>
 
#include <QString>
 
#include <score_lib_process_export.h>
 
#include <functional>
#include <vector>
 
namespace score
{
struct DocumentContext;
}
 
namespace Process
{
 
enum class FileAction
{
  Unchanged,     
  Collect,       
  AlreadyThere,  
  KeptInLibrary, 
  Relinked,      
  Trimmed,       
  Unused,        
  Removed,       
  Missing,       
  Unsupported,   
  Skipped,       
  Failed         
};
 
SCORE_LIB_PROCESS_EXPORT
QString toString(FileAction) noexcept;
 
struct FileEntry
{
  QString storedPath;
  QString sourcePath;
  QString destinationPath;
  QString newStoredPath;
 
  score::FileKind kind{};
  FileUsage usage{};
  FileAction action{FileAction::Unchanged};
  QString owner;
  std::vector<QString> companions;
 
  qint64 size{};
  qint64 newSize{};
  bool copyNeeded{};
 
  QString note;
};
 
struct SCORE_LIB_PROCESS_EXPORT FileReport
{
  QString projectFolder;
  std::vector<FileEntry> entries;
 
  bool empty() const noexcept { return entries.empty(); }
  int count(FileAction) const noexcept;
  std::vector<const FileEntry*> with(FileAction) const noexcept;
 
  qint64 bytesToCopy() const noexcept;
  qint64 bytesSaved() const noexcept;
};
 
enum class FileOperationKind
{
  Consolidate,
  Reanchor,
  Relink,
  Trim
};
 
using FilePolicy = std::function<QString(const ExternalFileRef&, FileEntry&)>;
 
SCORE_LIB_PROCESS_EXPORT
FileReport runFileOperation(
    const score::DocumentContext& ctx, const FilePolicy& policy, bool dryRun,
    FileOperationKind kind = FileOperationKind::Consolidate);
}