MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
Discovery.hpp
Go to the documentation of this file.
1#pragma once
2
4
5/**
6 * @brief Finds headers under @p roots that contain an MF_DESCRIBE request.
7 *
8 * A root may be a directory searched recursively or a single header. A request
9 * is a line that starts with MF_DESCRIBE, or has it after ';' or '}', followed
10 * by '('. Generated sidecars are skipped. Results are canonical and sorted.
11 */
12[[nodiscard]] std::vector<std::filesystem::path> discover_headers(const std::vector<std::filesystem::path>& roots);
13
14/** @brief Every Name.describe.hpp under the directories among @p roots, canonical and sorted. */
15[[nodiscard]] std::vector<std::filesystem::path> discover_sidecars(const std::vector<std::filesystem::path>& roots);
16
17/**
18 * @brief discover_headers() for another request marker, such as MF_DESCRIBE_FUNCTION.
19 *
20 * The marker must be followed by '(' on its line, so MF_DESCRIBE does not match
21 * MF_DESCRIBE_FUNCTION and the reverse. Generated sidecars are skipped.
22 */
23[[nodiscard]] std::vector<std::filesystem::path> discover_headers(
24 const std::vector<std::filesystem::path>& roots, std::string_view marker);
25
26/** @brief discover_sidecars() for another sidecar suffix, such as ".signatures.hpp". */
27[[nodiscard]] std::vector<std::filesystem::path> discover_sidecars(
28 const std::vector<std::filesystem::path>& roots, std::string_view suffix);
29
30}
std::vector< std::filesystem::path > discover_headers(const std::vector< std::filesystem::path > &roots)
Finds headers under roots that contain an MF_DESCRIBE request.
Definition Discovery.cpp:45
std::vector< std::filesystem::path > discover_sidecars(const std::vector< std::filesystem::path > &roots)
Every Name.describe.hpp under the directories among roots, canonical and sorted.
Definition Discovery.cpp:76