Files
klammertext/mac/option_set_registry.h
Andy Kopra 240cff4278 An output policy for the three commands, and @cond as a true special form
A snapshot of the development tree.  The substantial changes since the last one:

COMMAND OUTPUT POLICY.  The three commands display text in exactly three cases,
and each owns a stream: LOGGING under "-v" greater than 0 and an ERROR before
termination go to STDERR; OUTPUT THE USER ASKED FOR goes to STDOUT.  For ktext
that output is a document, so "ktext doc.kt -d | ..." is now safe -- logging
used to share the stream and land inside the document.  A bare command prints
its usage and succeeds rather than failing.  Colour is emitted only to a
terminal, per stream, and NO_COLOR is honoured.

"-v 1" reports every decision whose outcome you could not have read off your own
input: the klammerset that was loaded and from which file, a font's directory, a
":files" name's file, how "-o" was expanded.  Higher levels are the trace.

The commands no longer warn and continue: an anomaly is an error, described with
its location.  Two exceptions remain, each for a stated reason -- a condition
that is expected and temporary by design, and a judgment that is a heuristic
rather than exact.

@cond IS NOW A TRUE SPECIAL FORM, resolved at APPLICATION time rather than when
the file is read.  Two consequences for a writer:

  * a state variable reaches the predicate.  "@@@state Flag :value true @@@
    @cond *Flag* | T | F @" renders "T"; it used to see the literal "*Flag*" and
    silently take the false branch.  The document now behaves like a klammer
    body, whose arguments are bound before its conditionals are decided.
  * nothing in a discarded branch happens -- it is not read, not evaluated, not
    expanded.  An @eval in the branch not taken used to run anyway.

Its predicate relation is total and strict: true, True, 1; false, False, 0, and
empty; anything else is an error at the @cond rather than silently false.

@eval REACHING OUTSIDE.  ":shell" and ":haskell" now keep the command's standard
error out of the document (it appears under "-v 1") and treat a nonzero exit as
an error naming what the command reported.  A command that exits nonzero on
purpose -- "grep" finding no match -- says so with "|| true".

KLAMMER SETS.  Several combine: "--klammersets a b c" loads all three in the
order given, sharing one namespace, with the definition modes deciding
collisions.  "none" means none and may not be combined with other symbols.  A
klammerset with symbol X is declared in a file X/X.k, which is what lets two
sets require the same third set without loading it twice.

TESTS.  Four new suites: the kdiag command's interface, the @eval primitive's
contract with the outside world, and verbosity at both tiers.  Three suites
that could not run on macOS at all now do.

Assembled from dev commit 6c8ee6c22fca.
2026-08-16 01:37:59 +02:00

64 lines
2.5 KiB
C++

#pragma once
#include <map>
#include <string>
#include <vector>
#include "argtype_registry.h"
#include "katom.h"
#include "option_set.h"
class Option_set_registry
{
public:
// Parse and register an "@@name.o <parameters> : <description> @@"
// declaration. The name is passed in because the caller has already
// split it from its ".o" target suffix in order to route here.
void add(const Argtype_registry& argtypes, const std::string& name,
katom_iter begin, katom_iter end, katom_list& katoms);
bool has(const std::string& name) const;
const Option_set& get(const std::string& name, const Locator& loc) const;
void add_user(const std::string& set_name, const std::string& klammer_name);
// `defined_outside`: list only sets declared in a file not in the list --
// the input's own, with the loaded klammersets' left out. See
// Klammer::defined_outside.
std::string describe(int margin = 2, const strings_t& defined_outside = {}) const;
// "a, b, c" -- the sets that exist, for a diagnostic about one that does not.
std::string available() const;
std::map<std::string, Option_set> m_option_sets {};
std::vector<std::string> m_names {};
};
// What one parameter inherited from an option set: which set it came from,
// and whether its default was overridden where the set was used. Default
// resolution has three levels -- argument type, option set, use site -- and
// kdesc says which one a klammer's effective default came from, so the level
// has to be recorded rather than inferred from the value.
struct Option_set_use
{
std::string m_set {};
bool m_overridden {};
};
// parameter name -> where it came from
using option_set_uses_t = std::map<std::string, Option_set_use>;
// Replace every option-set use in a parameter list with the parameters it
// stands for. Any other klammer application in a parameter list is an
// error: an option set is the only construct that may put parameters there,
// and only in a ".k" declaration.
//
// `parameters` is modified in place. Sets are recorded as used by
// `klammer_name`, so `option_sets` is not const.
option_set_uses_t expand_option_sets(
katom_list& parameters, const std::string& klammer_name,
const std::string& target_name, Option_set_registry& option_sets);
// Record on each parameter that came from a set which set it came from and
// whether its default was overridden. Called after the expanded parameter
// list has been parsed.
void stamp_option_set_uses(Parameter_set& parameters, const option_set_uses_t& uses);