MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
SignatureEntries.hpp
Go to the documentation of this file.
1#pragma once
2
4
5/**
6 * @struct SignatureEntry
7 * @brief One class of the Creator registry: the method name, its qualified type and its header.
8 */
10 std::string name;
11 std::string type_name;
12 std::filesystem::path header;
13};
14
15/**
16 * @brief Reads the N, W and B registrations of the registry header and finds each class's header.
17 *
18 * A registration is a line of the form N(Name, MayaFlux::Qualified::Type), with an optional
19 * trailing backslash. The header of a class is the one file named after it under
20 * @p source_root / MayaFlux that declares it as a class or struct with a body.
21 *
22 * @param error Receives the reason when nullopt is returned: an unreadable registry, an empty
23 * or duplicated registration list, or a class with no header or more than one.
24 */
25[[nodiscard]] std::optional<std::vector<SignatureEntry>> read_signature_entries(
26 const std::filesystem::path& registry, const std::filesystem::path& source_root, std::string& error);
27
28}
std::optional< std::vector< SignatureEntry > > read_signature_entries(const std::filesystem::path &registry, const std::filesystem::path &source_root, std::string &error)
Reads the N, W and B registrations of the registry header and finds each class's header.
One class of the Creator registry: the method name, its qualified type and its header.