Andy Kopra
6e7596ab2e
A named group of optional parameters, declared once and used by several
klammers, so a writer learns one vocabulary instead of a spelling per
klammer. The "o" target is a pseudo-target beside "k": "k" declares a
klammer's interface and documents it, "o" declares an option interface and
documents it, and neither produces output for any target.
@@caption_args.o :caption :number.bool true :caption_side.side
: Arguments that define a caption for a block element @@
@@code.k :filename @hpos_args :hpos left @ @caption_args :caption_side top @
| text.literal : A source file displayed verbatim @@
A set is used only in the parameter list of a ".k" declaration -- the one
place a klammer's interface is declared once for all of its targets -- and
is resolved as that list is read. Names and types come from the set; a
default may be overridden where it is used. A klammer application in a
parameter list is now a definition-time error.
The SKS gains the sets caption_args and hpos_args (:hpos and :offset), and
@table, @image, @image_grid, @reference and @show gain .k declarations. A
distance is no longer written as a position: :hpos 4em is rejected, and the
same layout is :hpos left :offset 4em. Code listings are numbered by
default, like tables and figures.
New engine sources mac/option_set{,_registry}.{h,cpp}; tst/ ships two more
suites, option_set_test.sh and signature_test.sh (twelve in all).
(from dev 34e536cb0329)
119 lines
4.5 KiB
C++
119 lines
4.5 KiB
C++
#pragma once
|
|
|
|
#include <regex>
|
|
|
|
#include "deftype.h"
|
|
#include "argument_set.h"
|
|
#include "option_set_registry.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,
|
|
Option_set_registry& option_sets,
|
|
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 option_set_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);
|
|
|
|
// Split a definition's katoms into its definition separator, parameters,
|
|
// body and location. The target name is needed because the parameter list
|
|
// is where option sets are used, and a set may be used only in a ".k"
|
|
// declaration; option_sets is not const because a use is recorded on the set.
|
|
std::tuple<Katom, Parameter_set, std::vector<Katom>, Locator>
|
|
parse_definition_katoms(const std::string& klammer_name, const std::string& target_name,
|
|
const Argtype_registry& argtypes, Option_set_registry& option_sets,
|
|
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);
|
|
*/
|