Files
klammertext/com/kdesc.cpp
Andy Kopra 6e7596ab2e Option sets: a .o target for shared parameters
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)
2026-08-06 13:11:37 +02:00

203 lines
7.4 KiB
C++

#include "argv.h"
#include "command.h"
#include "error.h"
#include "file.h"
#include "font_store.h"
#include "ktype.h"
#include "log.h"
#include "argtype_registry.h"
#include "klammerset_registry.h"
#include "character.h"
#include "show.h"
#include "util.h"
static void font_usage()
{
std::cout <<
"Font maintenance commands:\n"
" --font List the available fonts\n"
" --font list The same\n"
" --font samples <output-dir> Write a sample page of the available fonts\n"
" to <output-dir>/index.html\n"
" --font samples <input-dir> <output-dir>\n"
" Write a sample page for the (not yet\n"
" installed) font files under <input-dir>\n"
" --font install <input-dir> Install the font files found under\n"
" <input-dir> into the user font directory\n"
" --font install <input-dir> <output-dir>\n"
" Install into <output-dir> instead\n"
" --font help This description\n"
"\n"
"Fonts are searched in the directories of the KLAMMERTEXT_FONTS\n"
"environment variable (colon-separated; default $HOME/.klammertext/fonts)\n"
"and then in the default font set.\n";
}
static void klammerset_usage()
{
std::cout <<
"Klammerset commands:\n"
" --klammerset List the klammersets on the search path\n"
" --klammerset list The same\n"
" --klammerset help This description\n"
"\n"
"A klammerset symbol x names the declaration file x/x.k, searched for in:\n"
"the current directory (for ktext, the input document's directory), the\n"
"KLAMMERTEXT_KLAMMERSETS directories (colon-separated; default\n"
"$HOME/.klammertext/klammersets), and $KLAMMERTEXT_HOME. The first hit\n"
"wins, so a document-local klammerset shadows an installed one, which\n"
"shadows a distributed one.\n";
}
static void klammerset_command(const strings_t& words)
{
std::string verb = words.empty() ? "list" : words[0];
if (verb == "list") {
std::cout << boldblack << "Klammersets\n" << black
<< describe_klammerset_search(fs::current_path().string());
} else if (verb == "help") {
klammerset_usage();
} else {
std::cout << "Unrecognized klammerset command: --klammerset "
<< join(words, " ") << "\n\n";
klammerset_usage();
}
}
static void font_command(const strings_t& words)
{
std::string verb = words.empty() ? "list" : words[0];
size_t n = words.size() - (words.empty() ? 0 : 1);
if (verb == "list" && n == 0) {
std::cout << boldblack << "Fonts\n" << black << describe_fonts();
} else if (verb == "samples" && n == 1) {
std::cout << "Font samples written to "
<< write_font_samples(words[1]) << "\n";
} else if (verb == "samples" && n == 2) {
std::cout << "Font samples written to "
<< write_font_samples(words[2], words[1]) << "\n";
} else if (verb == "install" && (n == 1 || n == 2)) {
std::cout << "Installing fonts from " << words[1] << ":\n"
<< install_fonts(words[1], n == 2 ? words[2] : "");
} else if (verb == "help") {
font_usage();
} else {
std::cout << "Unrecognized font command: --font " << join(words, " ")
<< "\n\n";
font_usage();
}
}
int main(int argc, char* argv[])
{
try {
set_verbose_level(argc, argv);
Argv args {};
args.flag("c", "Special characters");
args.flag("a", "Argument types");
args.flag("k", "Katom types");
args.flag("r", "Katom rewrite patterns");
args.opt("input", "Input filename", "filename", "", "'text'");
args.flag("targets", "Show targets defined by the input file");
args.flag("klammers", "Show klammers defined by the input file");
args.flag("optionsets", "Show option sets declared by the input file");
args.var("font", "List installed fonts. Enter \"--font help\" for font maintenance commands.");
args.var("klammerset", "List the klammersets on the search path. Enter \"--klammerset help\" for details.");
args.opt("v", "'verbosity'", "n", "0", "'verbosity'");
if (show_usage(argc, argv)) {
args.usage(file_basename(argv[0]));
exit(1);
}
auto p = [&](const std::string& name) { return args.get(name) == "true"; };
args.parse(argc, argv);
verbose_level = stoi(args.get("v"));
if (verbose_level > 0) {
args.describe();
}
if (p("c")) {
show_special_characters();
std::cout << "\n";
}
if (p("a")) {
Argtype_registry argtypes;
std::cout << boldblack << "\nStandard klammer argument types\n" << black;
std::cout << argtypes.describe() << "\n";
}
if (p("k")) {
describe_katoms(verbose_level > 2);
}
if (p("r")) {
describe_rewrite_patterns();
}
// The --font subcommands operate on the Klammertext font store
// (infrastructure) and load no klammer set.
if (args.given("font")) {
strings_t words {};
for (const std::string& w : args.as_vector("font")) {
if (!w.empty()) {
words.push_back(w);
}
}
font_command(words);
return 0;
}
// The --klammerset subcommands operate on the search path
// (filesystem enumeration) and load no klammer set.
if (args.given("klammerset")) {
strings_t words {};
for (const std::string& w : args.as_vector("klammerset")) {
if (!w.empty()) {
words.push_back(w);
}
}
klammerset_command(words);
return 0;
}
Machine M;
strings_t input_filenames = resolve_filename_list(args.get("input"));
std::cout << "input_filenames: " << input_filenames << "\n";
if (input_filenames.empty()) {
M.read(fs::path(M.m_state.value("KLAMMERTEXT_HOME") + "/sks/sks.k"));
} else {
for (auto fname : input_filenames) {
if (is_klammerset_symbol(fname)) {
// A bare symbol resolves on the klammerset search
// path; kdesc has no input document, so the local
// stage is the cwd.
fname = resolve_klammerset_symbol(
fname, fs::current_path().string(), Locator()).string();
}
std::cout << "Read " << fname << "\n";
M.read(fs::path(absolute_pathname(fname)));
}
}
if (p("targets")) {
std::cout << boldblack << "Targets\n" << black << M.m_targets.describe(2, true);
}
if (p("klammers")) {
std::cout << boldblack << "Klammers\n" << black << M.m_klammers.describe(2);
}
if (p("optionsets")) {
std::cout << boldblack << "Option sets\n" << black << M.m_option_sets.describe(2);
}
}
catch (Error& e) {
e.print_message();
}
}