Files
klammertext/mac/klammer.h
Andy Kopra ef77f03584 Klammerset: the @@@klammerset construct, its search path, and const correctness
The @@@klammerset system command formally declares a klammerset — a
named, logically related group of klammer definitions — with an
operative, idempotent declaration (:requires and :files load in order
at the declaration point, relative to the declaring file). A bare
symbol given to ktext -k, kdesc --input, or :requires resolves to
x/x.k on the search path: the document's directory, then
KLAMMERTEXT_KLAMMERSETS, then KLAMMERTEXT_HOME; kdesc --klammerset
lists the available sets. sks/sks.k is the first declared klammerset,
so `-k sks` loads the SKS by name. The engine's lookup classes were
renamed *_set → *_registry to keep the two concepts apart, and the
whole C++ tree now follows standard const-correctness conventions.
tst/ gains klammerset_test.sh (18 cases).

(from dev 64b1abf23e56)
2026-07-30 23:50:07 +02:00

111 lines
4.0 KiB
C++

#pragma once
#include <regex>
#include "deftype.h"
#include "argument_set.h"
#include "target_registry.h"
#include "locator.h"
class Klammer
{
public:
Klammer() = default;
Klammer(const std::string& name)
: m_name(name)
{};
using variable_map_t = std::map<std::string, std::vector<int>>;
using target_variable_map_t = std::map<std::string, variable_map_t>;
static std::regex name_re; // = std::regex(R"((\w+)(?:\.(\w+))?)");
struct components {
std::string target;
katom_t deftype;
Parameter_set parameters;
std::vector<Katom> body;
variable_map_t varmap;
Locator loc;
};
// target-name -> [variable -> index]
void add_target_definition(
const std::string& target_name, const Argtype_registry& argtypes,
std::vector<Katom>::iterator begin, std::vector<Katom>::iterator end);
void remove_target_definition(const std::string& target_name);
auto target_defs(const std::vector<std::string>& target_names);
auto instance_defs();
void disallow_instances(); //Klammer::components declaration);
bool copy_to_instances(const Target_registry& targets);
void copy_components(
const Parameter_set& parameters, const std::vector<Klammer::components>& cs,
const Target_registry& targets);
void check_for_multiple_general_klammers();
void check_for_declaration_and_definitions();
void copy_general_klammer_to_undefined(const Target_registry& targets);
void no_declarations(const Target_registry& targets);
void one_declaration(const Target_registry& targets, const Klammer::components& declare);
void many_declarations(const std::vector<Klammer::components>& declares);
void rationalize(const Target_registry& targets);
/*
void add_description(const std::string& desc, Katom definition_type);
auto user_defs();
auto klammer_defines_parameters();
auto klammer_uses_parameters();
void check_for_target_errors(Target_registry targets);
bool explicit_parameters_match();
void copy_components(Klammer::components cs, Target_registry targets);
*/
std::string signature_text() const;
std::string description_text() const;
std::string describe(int margin=0) const;
bool has_literal_param() const {
for (const auto& p : m_parameters.m_positional)
if (p.m_argtype.m_name == "literal") return true;
for (const auto& p : m_parameters.m_rest)
if (p.m_argtype.m_name == "literal") return true;
return false;
}
strings_t get_target_names() const;
strings_t get_locations();
// Initial instantiation:
std::string m_name {};
// Collection: target, deftype, parameters, body, locator
std::vector<Klammer::components> m_defs {};
// After rationalization:
Parameter_set m_parameters {};
std::map<std::string, std::vector<Katom>> m_body {};
std::string m_desc {};
std::map<std::string, Locator> m_defloc {}; // target -> Locator
std::map<std::string, defmode_t> m_defmode {}; // target -> defmode
target_variable_map_t m_varmap {}; // target -> map: variable -> index
// target -> true if this target's body came from a general ("*") definition
// (writer content, subject to target escaping) vs a target-specific one.
std::map<std::string, bool> m_body_generic {};
};
std::string klammer_name_from_katom(const std::string& s, const Locator& loc);
std::tuple<std::string,std::string>
parse_name(const Target_registry& targets, const Katom& name_katom);
std::tuple<Katom, Parameter_set, std::vector<Katom>, Locator>
parse_definition_katoms(const std::string& klammer_name, const Argtype_registry& argtypes,
std::vector<Katom>::iterator& begin, std::vector<Katom>::iterator& end);
/*
klammer_definition_args parse_klammer_definition_katoms(
katom_list& katoms, Argtype_registry& argtypes);
void check_for_undefined_arguments(
std::string name, Parameters parameters, katom_list body_katoms, Locator loc);
*/