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)
74 lines
2.9 KiB
C++
74 lines
2.9 KiB
C++
#pragma once
|
|
|
|
#include <limits>
|
|
#include <tuple>
|
|
#include <vector>
|
|
#include "katom.h"
|
|
#include "argument.h"
|
|
#include "locator.h"
|
|
|
|
class Argtype_registry;
|
|
|
|
std::tuple<std::vector<std::vector<Katom>>,std::vector<std::vector<Katom>>,std::vector<Katom>>
|
|
argument_split(std::vector<Katom>::const_iterator kbegin, std::vector<Katom>::const_iterator kend,
|
|
long unsigned int positional_limit = std::numeric_limits<int>::max());
|
|
|
|
// The katoms of a parameter list, split into one list per parameter:
|
|
// positional first, then optional (each beginning with its option-name
|
|
// katom). An option set keeps the katoms of its members this way, because
|
|
// those katoms are what a declaration using the set ends up declaring.
|
|
std::tuple<std::vector<std::vector<Katom>>,std::vector<std::vector<Katom>>>
|
|
parameter_split(std::vector<Katom>::const_iterator kbegin, std::vector<Katom>::const_iterator kend);
|
|
|
|
class Parameter_set
|
|
{
|
|
public:
|
|
Parameter_set() {};
|
|
~Parameter_set() = default;
|
|
Parameter_set(const std::string parameter_string);
|
|
Parameter_set(const std::vector<Katom>& katoms);
|
|
Parameter_set(const std::vector<Katom>& katoms, const Argtype_registry& argtypes);
|
|
|
|
void parse_parameters(const std::vector<Katom>& katoms, const Argtype_registry& argtypes);
|
|
void describe_parameters();
|
|
|
|
void check_positional(
|
|
const std::vector<std::vector<Katom>>& positional_arguments, const Locator& loc);
|
|
std::map<std::string, std::string> check_optional(
|
|
const std::vector<std::vector<Katom>>& optional_arguments, const Locator& loc);
|
|
const std::map<std::string, std::string> value_map(
|
|
const std::vector<std::vector<Katom>>& positional,
|
|
const std::vector<std::vector<Katom>>& optional,
|
|
const std::vector<Katom>& rest,
|
|
const Locator& loc);
|
|
const Parameter* find(const std::string& name) const;
|
|
static void validate(
|
|
const Parameter& parameter, const std::string& value, const Locator& loc);
|
|
bool empty() const { return m_katoms.size() == 0; };
|
|
|
|
std::vector<Katom> m_katoms {};
|
|
//Argtype_registry m_argtypes {};
|
|
std::vector<Parameter> m_positional {};
|
|
std::vector<Parameter> m_optional {};
|
|
std::vector<std::string> m_optional_names {};
|
|
std::vector<Parameter> m_rest {};
|
|
size_t m_positional_count = std::numeric_limits<int>::max();
|
|
|
|
};
|
|
|
|
bool operator==(Parameter_set lhs, Parameter_set rhs);
|
|
|
|
// The Argument_set alias is used at application sites, where the set
|
|
// describes arguments rather than parameters. See argument.h.
|
|
using Argument_set = Parameter_set;
|
|
|
|
void describe_arguments(
|
|
const std::string& label,
|
|
const std::vector<std::vector<Katom>>& positional,
|
|
const std::vector<std::vector<Katom>>& optional,
|
|
const std::vector<Katom>& rest);
|
|
|
|
std::string replace_arguments(
|
|
const std::map<std::string, std::string>& values,
|
|
const std::string& parameterized_text, const Locator& loc);
|