MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
Check.hpp
Go to the documentation of this file.
1#pragma once
2
3#include "Request.hpp"
4
6
7/**
8 * @brief Compares the sidecars on disk with what the generator would write, touching nothing.
9 *
10 * Reports, one message per problem:
11 * - a header with MF_DESCRIBE text that produced no request;
12 * - a missing sidecar;
13 * - a sidecar that differs, naming the records and members added or removed;
14 * - a missing, repeated or misplaced sidecar include;
15 * - a sidecar in @p existing whose header has no request left.
16 *
17 * @param headers Every header the scan covered.
18 * @param existing Sidecars found on disk under the roots, for the orphan check. Empty skips it.
19 * @return No messages when everything is current.
20 */
21[[nodiscard]] std::vector<std::string> check_sidecars(
22 const RequestMap& requests,
23 const std::vector<std::filesystem::path>& headers,
24 const std::vector<std::filesystem::path>& existing);
25
26}
std::map< std::filesystem::path, HeaderRequests > RequestMap
Definition Request.hpp:30
std::vector< std::string > check_sidecars(const RequestMap &requests, const std::vector< std::filesystem::path > &headers, const std::vector< std::filesystem::path > &existing)
Compares the sidecars on disk with what the generator would write, touching nothing.
Definition Check.cpp:102