Files
klammertext/mac/character.h
T
ack e4f1307aa9 Characters that killed a render, what may sit next to a klammer, and ref/
A character written in the ^...^ mnemonic form -- ^oe^, ^zz^, ^hello^ --
used to kill ktext outright: no message, no output, and an exit status
that looked like a crash because it was one.  Only the forms that happen
to spell hexadecimal digits escaped, and they were right by luck rather
than by reading.  Any caret form that names no character is now a located
error that quotes what was written.

A klammer may now sit inside square brackets and braces as it already
could inside parentheses, and may be followed by the punctuation that
ends a sentence: [@i word@], {@b word@}, @i word@'s.  The rule is a fixed
list of characters, because none of them can occur inside a klammer name
and so none of them is ambiguous next to a delimiter.  A letter still
cannot: "x@" is the named closing delimiter, so a letter before "@" has
two readings and no rule can separate them.

The abbreviations an author writes -- the hyphen form @i-word, a klammer
glued to its neighbouring punctuation -- are now recognised as author
conveniences only.  They are not applied to @@ definitions or @@@ system
commands, which are written by someone who needs no such shorthand and
whose forms are already whole.

Also fixed, each of them silent: an exported shell function in the
environment broke every @eval in the document; a line break written with
@nl was destroyed when it passed through a klammer that generates a
table, printing as \textbackslash{}newline in the finished PDF; and
"kdesc --coverage" shortened its file column by comparing the spelling of
a path rather than the path, so a klammer set reached by a symbolic link
showed a full path where its neighbours showed a short one.

New in the distribution: ref/, a small klammerset that describes the
Klammermachine's own tables in Klammertext.  It currently provides the
character tables -- the diacritics and the extended Latin letters -- as
klammers that render to any target, so the documentation of what can be
written cannot drift from what the machine accepts.  It is early, and
will grow.

The Klammertext taxonomy now has a section on targets, describes the
@@@klammerset system command alongside the other three, and states the
precedence of "^" -- what a caret means before a letter, a digit, a
punctuation character, and a quote, in one ordered list.

(from dev 6594c7ff8c1f)
2026-09-07 22:37:05 +02:00

165 lines
4.9 KiB
C++

#pragma once
// https://jakubmarian.com/special-characters-diacritics-used-in-european-languages/
#include <string>
#include <map>
#include <iomanip>
#include <tuple>
#include <vector>
#include <utility>
#include <regex>
#include <unistd.h>
#include "locator.h"
inline
std::string klammertext_special_characters { "@|*^#" };
inline
std::string encoding_marker { "UU" };
inline
std::string diacritic_symbols = "-'`h~\"cbrdwa";
inline
std::string diacritic_symbols_order = "'`h~\"c-brdwa";
// ^UUUU^ — a Unicode code point in hex, 4 to 6 digits (^263A^ is the BMP,
// ^13000^ EGYPTIAN HIEROGLYPH A001, ^10FFFD^ the top of the range), or a
// single digit. Lengths 2-3 are NOT accepted: two- and three-letter
// sequences of a-f collide with the ^s^-style mnemonic names.
const std::regex unicode_re(R"(\^(([0-9A-Fa-f]{4,6})|([0-9A-Fa-f]))\^)");
const std::regex unicode_hide_re(R"(=([0-9A-Fa-f]{2})=)");
const std::regex hex2_re(R"(([0-9A-Fa-f]{2}))");
const std::regex hex4_re(R"(([0-9A-Fa-f]{4}))");
const std::regex hex5_re(R"(([0-9A-Fa-f]{5}))");
// The hide_special_characters vector was removed. The ^X mechanism for
// Klammertext special characters is handled by the katomizer (type
// katom_t::special) and the general KTESC escape mechanism for
// target-specific characters.
inline
std::map<std::string, std::string> diacritic_example_letter {
{"'", "e"},
{"`", "a"},
{"h", "o"},
{"~", "n"},
{"\"", "u"},
{"c", "c"},
{"-", "o"},
{"b", "g"},
{"r", "a"},
{"d", "e"},
{"w", "s"},
{"a", "o"}};
inline
std::map<std::string, std::pair<std::string, std::string>> diacritics {
{"`", {"0300", "grave accent"}},
{"'", {"0301", "acute accent"}},
{"h", {"0302", "circumflex"}},
{"~", {"0303", "tilde"}},
{"-", {"0304", "macron"}},
{"\"", {"0308", "diaresis"}},
// {"v", {"0305", "vinculum"}},
{"b", {"0306", "breve"}},
{"d", {"0307", "dot above"}},
{"r", {"030A", "ring above"}},
{"w", {"030C", "wedge"}},
{"c", {"0327", "cedilla"}},
{"a", {"030B", "double acute accent"}}};
inline
std::vector<std::string> extended_latin_symbols = {
"s",
"i", "I", "t", "T", "e", "E", "o", "O", "d", "D",
"ae", "AE", "oe", "OE"
};
inline
std::map<std::string, std::pair<std::string, std::string>> extended_latin {
{"ae", {"00E6", "ae ligature"}},
{"AE", {"00C6", "ae ligature capital"}},
{"oe", {"0153", "oe ligature"}},
{"OE", {"0152", "oe ligature capital"}},
{"i", {"0131", "dotless i"}},
{"I", {"0130", "capital dotted i"}},
{"t", {"00FE", "thorn"}},
{"T", {"00DE", "thorn capital"}},
{"e", {"00F0", "eth"}},
{"E", {"00D0", "eth capital"}},
{"o", {"00F8", "o stroke"}},
{"O", {"00D8", "o stroke capital"}},
{"s", {"00DF", "Eszett"}},
{"d", {"0111", "d stroke"}},
{"D", {"0110", "d stroke capital"}}};
inline
std::map<std::string, std::pair<std::string, std::string>> pinyin_tones {
{"1", {"0304", "high"}},
{"2", {"0301", "rising"}},
{"3", {"030C", "falling-rising"}},
{"4", {"0300", "falling"}}};
inline
std::vector<std::vector<std::string>> ptolemy {
{"Q3", "P", "132AA"},
{"X1", "t", "133CF"},
{"V4", "o/wa", "13371"},
{"E23", "l/r", "130ED"},
{"Aa15", "m", "1340D"},
{"M17A", "e/y", "131CC"},
{"S29", "s", "132F4"}};
/*
道 (dào): U+9053
可 (kě): U+53EF
道 (dào): U+9053
非 (fēi): U+975E
常 (cháng): U+5E38
道 (dào): U+9053
*/
inline
std::vector<std::vector<std::string>> dao {
{"dào", "9053"},
{"kě", "53EF"},
{"dào", "9053"},
{"fēi", "975E"},
{"cháng", "5E38"},
{"dào", "9053"}};
inline
bool is_tty() { return isatty(fileno(stdout)); }
inline
const std::string italic_on() { return is_tty() ? "\033[3m" : ""; }
inline
const std::string italic_off() { return is_tty() ? "\033[0m" : ""; }
std::string encode(const std::string& s, const Locator& loc);
// UTF-8 encoding of one code point (to U+10FFFF; surrogates and values
// above the range yield an "Invalid Unicode: N" text). Used by the
// character tables here and by the ^UUUU UUUU ...^ sequence pass
// (process_unicode_sequences in katom_process.cpp).
std::string utf8char(int cp);
// Whether cp may be written in a ^...^ form: within the Unicode range,
// not a surrogate, and not a NONCHARACTER (U+FDD0-U+FDEF and the last two
// code points of every plane) -- the standard reserves those for internal
// use, never for interchange. An invalid code point in a document is a
// located Parsing_error (the no-warn-and-continue policy; the in-band
// "Invalid Unicode" text is no longer reachable from input).
bool valid_codepoint(int cp);
std::string invalid_codepoint_reason(int cp);
// void diacritics_examples(const std::string& kt_filename = "");
// void extended_latin_examples(const std::string& kt_filename = "");
void pinyin_examples(const std::string& kt_filename = "");
void unicode_examples(const std::string& kt_filename = "");
void show_special_characters();