From caa88a9b36d9e1dfae40ecb31aee05bc2891fa17 Mon Sep 17 00:00:00 2001 From: _ov4 Date: Tue, 27 Oct 2026 14:07:24 +0000 Subject: docs(preprocessor): document switches and library regions Add manuals and aliases for all five PP directives, replace the retired #LIB page, and update compiler and shared-editor architecture notes. Co-Authored-By: Claude Opus 5.5 --- AGENTS/CONVENTIONS/EXCEPTIONS_AND_UNITS.md | 14 ++++++++++---- AGENTS/CONVENTIONS/LEXING.md | 13 ++++++++++++- 2 files changed, 22 insertions(+), 5 deletions(-) (limited to 'AGENTS/CONVENTIONS') diff --git a/AGENTS/CONVENTIONS/EXCEPTIONS_AND_UNITS.md b/AGENTS/CONVENTIONS/EXCEPTIONS_AND_UNITS.md index 8ee97ec..0b8a887 100644 --- a/AGENTS/CONVENTIONS/EXCEPTIONS_AND_UNITS.md +++ b/AGENTS/CONVENTIONS/EXCEPTIONS_AND_UNITS.md @@ -35,10 +35,16 @@ Part of [Load-bearing conventions](../CONVENTIONS.md). through ExceptionHandler, truncates its result and retains the final uncaught handler. -**Library units.** Line-leading `#LIB` marks SourceUnit::IsLibrary. RuntimeCheck uses -the externally visible i32 `__cps_user_line`; FunctionGen's shared call hook updates -it only on non-library to library calls. Runtime helper line arguments use -RuntimeCheck::lineValue too. Compiler diagnostics retain the owning file location. +**Library regions.** PP_DEFINE __LIB enables library mode for subsequent source +positions; PP_UNDEF __LIB disables it, including inside functions. SourceUnit owns +LibraryLines and answers isLibrary(Line). RuntimeCheck queries the current unit's +map with each original source line and uses the shared external i32 __cps_user_line +only in enabled regions. FunctionGen's call hook updates that global for calls +from ordinary positions, regardless of the callee's header mode: a callee can +enable __LIB inside its body. Library calls preserve it. Runtime helper arguments +also use RuntimeCheck::lineValue. Templates keep definition source lines and +owning units; deferred object cleanup keeps its registration's line and unit. +Compiler diagnostics retain the owning file location. **Default standard library.** The driver extracts embedded std.cps, its imported units and matching objects to a content-keyed cache (or temporary fallback) that survives diff --git a/AGENTS/CONVENTIONS/LEXING.md b/AGENTS/CONVENTIONS/LEXING.md index 81b01d1..654d7ae 100644 --- a/AGENTS/CONVENTIONS/LEXING.md +++ b/AGENTS/CONVENTIONS/LEXING.md @@ -20,7 +20,8 @@ identifier. Assignment is `<-` (ASCII only), equality is single `=`, inequality concatenation `&` (reaches the parser as raw ASCII 38 — no token). Identifiers use ASCII case-insensitive lookup/comparison through `IdentifierMap`, `IdentifierSet` and `sameIdentifier`; retain source spelling in ASTs and diagnostics. This includes -functions, types, enum values, fields and builtins, but not C_TYPE import strings. +functions, types, enum values, fields and builtins, but not C_TYPE import strings +or preprocessor switch names. Integer tokens carry a checked unsigned magnitude through lookahead; the parser applies the sign and i64 range check, including the minimum value. String/char literals support C++17 byte escapes and Unicode escapes (UTF-8 in STRING, ASCII only @@ -32,3 +33,13 @@ reserved in every user identifier, including EXTERN declarations. **The lexer reads a caller-owned stream.** Construct it with `Lexer(std::istream &)`; the stream must outlive the lexer. Lookahead, line number and error state belong to each instance. The driver opens the source file; stdin is not used for compilation. + +**Preprocessing precedes lexing.** `preprocess(std::istream &)` returns masked source, +per-line __LIB states and an error flag. PP_DEFINE/PP_UNDEF change case-sensitive, +file-local switches; PP_IFDEF/PP_IFNDEF/PP_ENDIF maintain a nested conditional stack. +Directives occupy a line, with optional leading whitespace and trailing // comments. +Disabled ordinary source is never tokenized; DEFINE/UNDEF in it have no effect. +Masking preserves byte lengths, CRLF and original source line numbers. The driver +owns the processed stream passed to Lexer. PP_* keywords remain reserved outside +valid directives. There is no macro expansion, value, PP_ELSE or switch propagation +through INCLUDE; line-leading # directives are errors. -- cgit v1.3.1-4-g156e