MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
Sidecar.hpp File Reference
#include "Request.hpp"
Include dependency graph for Sidecar.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  MayaFlux
 Main namespace for the Maya Flux audio engine.
namespace  MayaFlux::Reflect
namespace  MayaFlux::Reflect::Tool

Functions

std::optional< std::string > MayaFlux::Reflect::Tool::check_include (const HeaderRequests &requests)
 Checks that the header includes its sidecar exactly once, after its last marker.
std::optional< std::string > MayaFlux::Reflect::Tool::check_include (const std::filesystem::path &header, unsigned last_marker, std::string_view suffix)
 check_include() for any marker, given the header, the line of its last marker and the sidecar suffix.
bool MayaFlux::Reflect::Tool::ensure_stub (const std::filesystem::path &path, std::string &error)
 Writes an empty sidecar when none exists, so the include never fails a first scan.
bool MayaFlux::Reflect::Tool::insert_include (const HeaderRequests &requests, bool &inserted, std::string &error)
 Inserts the sidecar include on the line after the last marker when the header has none.
bool MayaFlux::Reflect::Tool::insert_include (const std::filesystem::path &header, unsigned last_marker, std::string_view suffix, bool &inserted, std::string &error)
 insert_include() for any marker, given the header, the line of its last marker and the sidecar suffix.
std::optional< std::string > MayaFlux::Reflect::Tool::read_text (const std::filesystem::path &path)
 The whole content of path, or nullopt when it cannot be read.
std::string MayaFlux::Reflect::Tool::render_sidecar (const HeaderRequests &requests)
 Text of the sidecar for one header, with its records sorted by name.
std::filesystem::path MayaFlux::Reflect::Tool::sidecar_path (const std::filesystem::path &header)
 Path of the sidecar for header: Name.hpp becomes Name.describe.hpp beside it.
std::filesystem::path MayaFlux::Reflect::Tool::sidecar_path (const std::filesystem::path &header, std::string_view suffix)
 sidecar_path() with another suffix, such as ".signatures.hpp": Name.hpp becomes Name.signatures.hpp.
bool MayaFlux::Reflect::Tool::write_if_changed (const std::filesystem::path &path, const std::string &content, std::string &error)
 Replaces path with content only when the content differs.