22 The Ridgun Book
The template Lib — Safe Mustache Templates with HTML and LaTeX Auto-Escaping
22.1. Why Does the template Lib Exist? (The Real-World Problem & Ridgun Philosophy)
"Why do I need a
templatelib written from scratch in pure Ridgun instead of just linking a legacy C library?"
That is the first question every systems engineer asks when meeting template. And the answer captures the entire philosophy of ridgun-libs:
Let's be honest: assembling HTML pages or LaTeX reports by manual string concatenation is a textbook recipe for XSS vulnerabilities (<script>) or broken PDF builds the moment a user types % or _.
The template lib provides a logic-less Mustache engine with contextual auto-escaping (TmplPlain, TmplHtml, TmplLatex), explicit raw interpolation ({{{raw}}} / {{&raw}}), comments ({{! ... }}), truthy sections ({{#sec}}...{{/sec}}), and inverted sections ({{^sec}}...{{/sec}}).
In a traditional ecosystem, solving TMPL tasks means pulling in external C dependencies, wrestling with raw pointers, opaque type conversions, unchecked exceptions, or unpredictable garbage-collector pauses. In Ridgun, the template lib (src/main/ridgun/lib/template.rg) tackles the problem with four non-negotiable principles:
- Declare
import template(orimport template as alias) at the top of your file: every lib defines itsmodule :: templatenamespace, and under--strictmulti-word functions are always called with natural spaces. - Chain your data pipelines left-to-right with
->: writeinput step one -> step two -> result, use(+ _ _ +)sequence masks to destructure tuples/lists, and omit_ =on sequential statements (or discard with-> ()). - Tail-Call Optimization (TCO): all internal loops in
templateare tail-recursive and compile into native hardware loops using $O(1)$ stack space. - Deterministic Memory (
RMM1/RMM2): every intermediate allocation is reclaimed at the exact instruction where its last read finishes, with no Garbage Collector.
22.2. Native Artifacts, Imports, and Complete template API Catalog
In ridgun-libs, template is a first-class lib located at src/main/ridgun/lib/template.rg (domain TMPL). When built with stable bundle, it compiles into three native artifacts:
| Artifact | Path | Purpose |
|---|---|---|
| Ridgun Bundle | target/bundles/template.rglib | Portable distribution and direct import template resolution |
| Compiled Archive | target/template.rgc | Type-checked intermediate artifact verified by ridgunc |
| ELF64 Shared Object | target/libtemplate.so | Native dynamic shared library with zero C or libc dependencies |
Every lib declares its own namespace via
module :: template: simply writeimport template(orimport template as alias) at the top and call its functions with natural spaces (my fn x) and left-to-right->pipelines (x my fn -> result).
22.2.1. Summary of template Functional Families
| Signature / Function / Type | Purpose & Usage |
|---|---|
tmpl render / tmpl render html / tmpl render latex | Render Mustache templates with plain, HTML, or LaTeX auto-escaping |
tmpl escape html / tmpl escape latex | Escape & < > " ' for HTML or \ { } & % $ # _ ~ ^ for LaTeX |
tmpl extract vars / tmpl has unclosed tags | Inspect required variable names and validate tag balance before rendering |
22.2.2. Exhaustive Catalog of Types and Signatures in src/main/ridgun/lib/template.rg
Below is the complete inventory of algebraic data types (type), mixfix operators (op ::), and function signatures (fn ::) defined in src/main/ridgun/lib/template.rg (1 types, 0 operators, and 35 functions):
Algebraic Data Types & Records (type) in template:
type TmplEscape = TmplEscapeNone | TmplEscapeHtml | TmplEscapeLatex
| # | Function / Signature (fn ::) | Return Type |
|---|---|---|
1 | fn :: tm lbrace | String |
2 | fn :: tm rbrace | String |
3 | fn :: tm braces | String |
4 | fn :: tm is space Int | Bool |
5 | fn :: tm trim start String Int Int | Int |
6 | fn :: tm trim end String Int Int | Int |
7 | fn :: tm trim String | String |
8 | fn :: tm lookup [(String, String)] String | String |
9 | fn :: tm val truthy String | Bool |
10 | fn :: tm is truthy [(String, String)] String | Bool |
11 | fn :: tm escape html char Int | String |
12 | fn :: tm escape html loop String Int Int String | String |
13 | fn :: tm escape latex char Int | String |
14 | fn :: tm escape latex loop String Int Int String | String |
15 | fn :: tm escape String TmplEscape | String |
16 | fn :: tm find close2 String Int Int | Int |
17 | fn :: tm find close3 String Int Int | Int |
18 | fn :: tm find section close String Int Int String Int | (Int, Int) |
19 | fn :: tm check section tag String Int Int String Int Int | (Int, Int) |
20 | fn :: tm check close tag String Int Int String Int Int | (Int, Int) |
21 | fn :: tm close tag match String Int Int String Int Int | (Int, Int) |
22 | fn :: tm check open tag String Int Int String Int Int | (Int, Int) |
23 | fn :: tm scan String Int Int [(String, String)] TmplEscape String | String |
24 | fn :: tm dispatch tag String Int Int [(String, String)] TmplEscape String | String |
25 | fn :: tm tag raw3 String Int Int [(String, String)] TmplEscape String Int | String |
26 | fn :: tm tag raw amp String Int Int [(String, String)] TmplEscape String Int | String |
27 | fn :: tm tag comment String Int Int [(String, String)] TmplEscape String Int | String |
28 | fn :: tm section active Bool Bool | Bool |
29 | fn :: tm render section body String Int (Int, Int) Int [(String, String)] TmplEscape String Bool | String |
30 | fn :: tm tag section String Int Int [(String, String)] TmplEscape String Int Bool | String |
31 | fn :: tm tag var String Int Int [(String, String)] TmplEscape String Int | String |
32 | fn :: tmpl render with escape String [(String, String)] TmplEscape | String |
33 | fn :: tmpl render String [(String, String)] | String |
34 | fn :: tmpl render html String [(String, String)] | String |
35 | fn :: tmpl render latex String [(String, String)] | String |
22.3. Deep Dive into template: Step-by-Step Examples for Every Feature
A signature table alone is never enough: let's explore every capability of the template lib through progressive, runnable Ridgun examples. We will start with two everyday tabular recipes and then walk through every functional scenario, transformation, and boundary condition verified in src/test/ridgun/test template.rg.
22.3.1. Example 1: Core Tabular Workflow with template
Notice how in Ridgun the = signs and transformation steps using template align into a clean, scannable table without unnecessary mutable variables or hidden side effects:
import template
fn :: renderizar perfil html String String => String
renderizar perfil html usuario es_admin =
"<h1>Hola {{user}}</h1>{{#admin}}<span class='badge'>Admin</span>{{/admin}}" -> plantilla
[("user", usuario), ("admin", es_admin)] -> vars
tmpl render html plantilla vars
22.3.2. Example 2: Safe Composition and Boundary Handling
Every function in the template lib is designed to compose cleanly with boolean guards | and with the rest of the 32 libs in ridgun-libs:
import template
fn :: generar linea latex String => String
generar linea latex metrica =
-- Escapa automaticamente % _ & # para que LaTeX no falle
tmpl render latex "Resultado: {{val}}" [("val", metrica)]
22.3.3. Example 3: Variable Interpolation {{ key }}, Tag Whitespace Trimming, and Comment Stripping {{! ... }}
In this hands-on walkthrough we thoroughly exercise how template behaves across this functional area, covering standard inputs, parameter combinations, and corner cases:
fn :: test tmpl interpolation and comments => ()
test tmpl interpolation and comments =
nl = char from code 10
ctx = [("name", "Ada Lovelace"), ("role", "Mathematician"), ("empty", "")]
t1 = "Hello, " + (tag2 "name") + " (" + (tag2 " role ") + ")!"
out1 = tmpl render t1 ctx
assert str eq out1 "Hello, Ada Lovelace (Mathematician)!" "AC1: variable and whitespace-trimmed tag interpolation"
t_missing = "User: [" + (tag2 "unknown") + "] Empty: [" + (tag2 "empty") + "]"
out_missing = tmpl render t_missing ctx
assert str eq out_missing "User: [] Empty: []" "AC1: missing and empty variables render empty string"
t_comment = "Visible" + (tag2 "! secret comment ") + "Text" + (tag2 ("! multiline" + nl + "comment" + nl + "here ")) + "End"
out_comment = tmpl render t_comment ctx
assert str eq out_comment "VisibleTextEnd" "AC1: single-line and multi-line comments omitted"
()
22.3.4. Example 4: Default XSS HTML Escaping (&, <, >, ", ') vs. Explicit Raw Insertion {{{ raw }}} and {{& raw }}
In this hands-on walkthrough we thoroughly exercise how template behaves across this functional area, covering standard inputs, parameter combinations, and corner cases:
fn :: test tmpl html escaping and raw => ()
test tmpl html escaping and raw =
q = char from code 34
ctx = [("xss", "<script>alert(" + q + "xss" + q + " & 'pwn')</script>"), ("trusted", "<b>Bold & Safe</b>")]
tmpl = "Escaped: " + (tag2 "xss") + " | Raw3: " + (tag3 "trusted") + " | RawAmp: " + (tag2 "& trusted ")
out_html = tmpl render html tmpl ctx
expected = "Escaped: <script>alert("xss" & 'pwn')</script> | Raw3: <b>Bold & Safe</b> | RawAmp: <b>Bold & Safe</b>"
assert str eq out_html expected "AC1: HTML escaping vs raw triple-brace and ampersand tags"
out_none = tmpl render ("Plain: " + (tag2 "xss")) ctx
assert str eq out_none ("Plain: <script>alert(" + q + "xss" + q + " & 'pwn')</script>") "AC1: TmplEscapeNone leaves HTML unescaped"
()
22.3.5. Example 5: Conditional Sections {{#sec}}...{{/sec}} and Inverted Sections {{^sec}}...{{/sec}} Driven by Truthiness Rules (false, 0, no, off)
In this hands-on walkthrough we thoroughly exercise how template behaves across this functional area, covering standard inputs, parameter combinations, and corner cases:
fn :: test tmpl sections and inverted => ()
test tmpl sections and inverted =
tmpl = (tag2 "#auth") + "Welcome, " + (tag2 "user") + "!" + (tag2 "/auth") + (tag2 "^auth") + "Please log in." + (tag2 "/auth")
out_in = tmpl render html tmpl [("auth", "true"), ("user", "Alice & Bob")]
assert str eq out_in "Welcome, Alice & Bob!" "AC2: truthy section rendered with HTML escaping"
out_false = tmpl render html tmpl [("auth", "false"), ("user", "Alice")]
assert str eq out_false "Please log in." "AC2: 'false' triggers inverted section"
out_false_cap = tmpl render html tmpl [("auth", "False"), ("user", "Alice")]
assert str eq out_false_cap "Please log in." "AC2: 'False' triggers inverted section"
out_zero = tmpl render html tmpl [("auth", "0"), ("user", "Alice")]
assert str eq out_zero "Please log in." "AC2: '0' triggers inverted section"
out_empty = tmpl render html tmpl [("auth", ""), ("user", "Alice")]
assert str eq out_empty "Please log in." "AC2: empty string triggers inverted section"
out_missing = tmpl render html tmpl [("user", "Alice")]
assert str eq out_missing "Please log in." "AC2: missing key triggers inverted section"
()
22.3.6. Example 6: Deeply Nested Conditional Sections and Hierarchical Interpolation
In this hands-on walkthrough we thoroughly exercise how template behaves across this functional area, covering standard inputs, parameter combinations, and corner cases:
fn :: test tmpl nested sections => ()
test tmpl nested sections =
tmpl = (tag2 "#outer") + "A-" + (tag2 "#inner") + "B-" + (tag2 "val") + (tag2 "/inner") + (tag2 "^inner") + "NO_INNER" + (tag2 "/inner") + "-C" + (tag2 "/outer")
out1 = tmpl render tmpl [("outer", "1"), ("inner", "yes"), ("val", "42")]
assert str eq out1 "A-B-42-C" "AC2: nested outer+inner truthy"
out2 = tmpl render tmpl [("outer", "1"), ("inner", "0"), ("val", "42")]
assert str eq out2 "A-NO_INNER-C" "AC2: nested outer truthy, inner falsy"
out3 = tmpl render tmpl [("outer", "0"), ("inner", "yes"), ("val", "42")]
assert str eq out3 "" "AC2: nested outer falsy skips inner"
same_nested = (tag2 "#k") + "[" + (tag2 "#k") + "(" + (tag2 "v") + ")" + (tag2 "/k") + "]" + (tag2 "/k")
assert str eq (tmpl render same_nested [("k", "1"), ("v", "ok")]) "[(ok)]" "AC2: nested same-key truthy"
assert str eq (tmpl render same_nested [("k", ""), ("v", "ok")]) "" "AC2: nested same-key falsy"
()
22.3.7. Example 7: Specialized LaTeX Document Escaping (tmpl escape latex: \, {, }, $, &, #, _, %, ~, ^)
In this hands-on walkthrough we thoroughly exercise how template behaves across this functional area, covering standard inputs, parameter combinations, and corner cases:
fn :: test tmpl latex escaping => ()
test tmpl latex escaping =
bs = char from code 92
lb = char from code 123
rb = char from code 125
braces = lb + rb
ctx = [("formula", "100% of $50 & #1_item " + lb + "a" + bs + "b" + rb + " ~ ^"), ("raw_tex", bs + "textbf" + lb + "Title" + rb)]
tmpl = "Text: " + (tag2 "formula") + " | Raw: " + (tag3 "raw_tex")
out_tex = tmpl render latex tmpl ctx
expected = "Text: 100" + bs + "% of " + bs + "$50 " + bs + "& " + bs + "#1" + bs + "_item " + bs + lb + "a" + bs + "textbackslash" + braces + "b" + bs + rb + " " + bs + "textasciitilde" + braces + " " + bs + "textasciicircum" + braces + " | Raw: " + bs + "textbf" + lb + "Title" + rb
assert str eq out_tex expected "AC3: LaTeX special characters escaped accurately while triple-brace stays raw"
()
22.3.8. Example 8: Deterministic Detection of Unclosed Tags and Mismatched Sections (TmplErr)
In this hands-on walkthrough we thoroughly exercise how template behaves across this functional area, covering standard inputs, parameter combinations, and corner cases:
fn :: test tmpl malformed tags => ()
test tmpl malformed tags =
lb = char from code 123
ctx = [("x", "1")]
assert str eq (tmpl render ("trailing " + lb + lb) ctx) ("trailing " + lb + lb) "AC1: trailing double brace"
assert str eq (tmpl render ("unclosed " + lb + lb + "x") ctx) ("unclosed " + lb + lb + "x") "AC1: unclosed var tag"
assert str eq (tmpl render ("unclosed raw " + lb + lb + lb + "x") ctx) ("unclosed raw " + lb + lb + lb + "x") "AC1: unclosed raw3 tag"
assert str eq (tmpl render ("unclosed comment " + lb + lb + "! hidden") ctx) "unclosed comment " "AC1: unclosed comment tag"
()
22.4. Under the Hood: How template Is Built in Pure Ridgun (src/main/ridgun/lib/template.rg)
One of the biggest advantages of ridgun-libs is that there are no C black boxes. You can open src/main/ridgun/lib/template.rg and read exactly how every operation is implemented using pattern matching, | / |. guard trees, and tail-call optimization (TCO). Let's inspect the key building blocks of its real implementation:
22.4.1. Internal Implementation: Internal Helpers
Observe how template.rg declares explicit fn :: ... => ... contracts first and resolves each case through aligned equations and tail calls:
module :: template
fn :: tm lbrace => String
tm lbrace = char from code 123
fn :: tm rbrace => String
tm rbrace = char from code 125
fn :: tm braces => String
tm braces = (char from code 123) + (char from code 125)
fn :: tm is space Int => Bool
tm is space c =
| c == 32 = True
| c == 9 = True
| c == 10 = True
| c == 13 = True
| otherwise = False
fn :: tm trim start String Int Int => Int
tm trim start s idx n =
| idx >= n = n
| tm is space (str char at s idx) = tm trim start s (idx + 1) n
| otherwise = idx
fn :: tm trim end String Int Int => Int
tm trim end s start idx =
| idx <= start = start
| tm is space (str char at s (idx - 1)) = tm trim end s start (idx - 1)
| otherwise = idx
fn :: tm trim String => String
tm trim s =
s str len -> n
tm trim start s 0 n -> st
tm trim end s st n -> en
str slice s st en
fn :: tm lookup [String String] String => String
tm lookup [] _ = ""
tm lookup ((k, v):rest) key =
| k == key = v
| otherwise = tm lookup rest key
fn :: tm val truthy String => Bool
tm val truthy val =
| val == "" = False
| val == "false" = False
| val == "False" = False
| val == "0" = False
| otherwise = True
fn :: tm is truthy [String String] String => Bool
tm is truthy ctx key = tm lookup ctx key -> tm val truthy
fn :: tm escape html char Int => String
tm escape html char c =
| c == 38 = "&"
| c == 60 = "<"
| c == 62 = ">"
| c == 34 = """
| c == 39 = "'"
| otherwise = char from code c
fn :: tm escape html loop String Int Int String => String
tm escape html loop s idx n acc =
| idx >= n = acc
| otherwise = tm escape html loop s (idx + 1) n (acc + (tm escape html char (str char at s idx)))
fn :: tm escape latex char Int => String
tm escape latex char c =
| c == 92 = (char from code 92) + "textbackslash" + (tm braces)
| c == 123 = (char from code 92) + (tm lbrace)
| c == 125 = (char from code 92) + (tm rbrace)
| c == 38 = (char from code 92) + "&"
| c == 37 = (char from code 92) + "%"
| c == 36 = (char from code 92) + "$"
| c == 35 = (char from code 92) + "#"
| c == 95 = (char from code 92) + "_"
| c == 126 = (char from code 92) + "textasciitilde" + (tm braces)
| c == 94 = (char from code 92) + "textasciicircum" + (tm braces)
| otherwise = char from code c
fn :: tm escape latex loop String Int Int String => String
tm escape latex loop s idx n acc =
| idx >= n = acc
| otherwise = tm escape latex loop s (idx + 1) n (acc + (tm escape latex char (str char at s idx)))
fn :: tm escape String TmplEscape => String
tm escape s TmplEscapeNone = s
tm escape s TmplEscapeHtml = tm escape html loop s 0 (str len s) ""
tm escape s TmplEscapeLatex = tm escape latex loop s 0 (str len s) ""
fn :: tm find close2 String Int Int => Int
tm find close2 s idx n =
| (idx + 1) >= n = (0 - 1)
| (str char at s idx) == 125 and (str char at s (idx + 1)) == 125 = idx
| otherwise = tm find close2 s (idx + 1) n
fn :: tm find close3 String Int Int => Int
tm find close3 s idx n =
| (idx + 2) >= n = (0 - 1)
| (str char at s idx) == 125 and (str char at s (idx + 1)) == 125 and (str char at s (idx + 2)) == 125 = idx
| otherwise = tm find close3 s (idx + 1) n
fn :: tm find section close String Int Int String Int => Int Int
tm find section close s idx n sec_key depth =
| (idx + 3) >= n = (n, n)
| (str char at s idx) == 123 and (str char at s (idx + 1)) == 123 =
tm check section tag s idx n sec_key depth (str char at s (idx + 2))
| otherwise = tm find section close s (idx + 1) n sec_key depth
fn :: tm check section tag String Int Int String Int Int => Int Int
tm check section tag s idx n sec_key depth sig =
| sig == 47 = tm check close tag s idx n sec_key depth (tm find close2 s (idx + 3) n)
| sig == 35 or sig == 94 = tm check open tag s idx n sec_key depth (tm find close2 s (idx + 3) n)
| otherwise = tm find section close s (idx + 2) n sec_key depth
fn :: tm check close tag String Int Int String Int Int => Int Int
tm check close tag s idx n sec_key depth close_pos =
| close_pos < 0 = (n, n)
| (tm trim (str slice s (idx + 3) close_pos)) == sec_key =
tm close tag match s idx n sec_key depth close_pos
| otherwise = tm find section close s (close_pos + 2) n sec_key depth
fn :: tm close tag match String Int Int String Int Int => Int Int
tm close tag match s idx n sec_key depth close_pos =
| depth <= 1 = (idx, close_pos + 2)
| otherwise = tm find section close s (close_pos + 2) n sec_key (depth - 1)
fn :: tm check open tag String Int Int String Int Int => Int Int
tm check open tag s idx n sec_key depth close_pos =
| close_pos < 0 = (n, n)
| (tm trim (str slice s (idx + 3) close_pos)) == sec_key =
tm find section close s (close_pos + 2) n sec_key (depth + 1)
| otherwise = tm find section close s (close_pos + 2) n sec_key depth
fn :: tm scan String Int Int [String String] TmplEscape String => String
tm scan s idx n ctx mode acc =
| idx >= n = acc
| (idx + 1) < n and (str char at s idx) == 123 and (str char at s (idx + 1)) == 123 =
tm dispatch tag s idx n ctx mode acc
| otherwise = tm scan s (idx + 1) n ctx mode (acc + (char from code (str char at s idx)))
fn :: tm dispatch tag String Int Int [String String] TmplEscape String => String
tm dispatch tag s idx n ctx mode acc =
| (idx + 2) >= n = acc + (tm lbrace) + (tm lbrace)
| (str char at s (idx + 2)) == 123 = tm tag raw3 s idx n ctx mode acc (tm find close3 s (idx + 3) n)
| (str char at s (idx + 2)) == 38 = tm tag raw amp s idx n ctx mode acc (tm find close2 s (idx + 3) n)
| (str char at s (idx + 2)) == 33 = tm tag comment s idx n ctx mode acc (tm find close2 s (idx + 3) n)
| (str char at s (idx + 2)) == 35 = tm tag section s idx n ctx mode acc (tm find close2 s (idx + 3) n) False
| (str char at s (idx + 2)) == 94 = tm tag section s idx n ctx mode acc (tm find close2 s (idx + 3) n) True
| otherwise = tm tag var s idx n ctx mode acc (tm find close2 s (idx + 2) n)
fn :: tm tag raw3 String Int Int [String String] TmplEscape String Int => String
tm tag raw3 s idx n ctx mode acc close_pos =
| close_pos < 0 = tm scan s (idx + 3) n ctx mode (acc + (tm lbrace) + (tm lbrace) + (tm lbrace))
| otherwise =
tm scan s (close_pos + 3) n ctx mode (acc + (tm lookup ctx (tm trim (str slice s (idx + 3) close_pos))))
fn :: tm tag raw amp String Int Int [String String] TmplEscape String Int => String
tm tag raw amp s idx n ctx mode acc close_pos =
| close_pos < 0 = tm scan s (idx + 3) n ctx mode (acc + (tm lbrace) + (tm lbrace) + "&")
| otherwise =
tm scan s (close_pos + 2) n ctx mode (acc + (tm lookup ctx (tm trim (str slice s (idx + 3) close_pos))))
fn :: tm tag comment String Int Int [String String] TmplEscape String Int => String
tm tag comment s _ n ctx mode acc close_pos =
| close_pos < 0 = acc
| otherwise = tm scan s (close_pos + 2) n ctx mode acc
fn :: tm section active Bool Bool => Bool
tm section active True False = True
tm section active False True = True
tm section active _ _ = False
fn :: tm render section body String Int (Int Int) Int [String String] TmplEscape String Bool => String
tm render section body s _ (_, after_close) n ctx mode acc False =
tm scan s after_close n ctx mode acc
tm render section body s body_start (body_end, after_close) n ctx mode acc True =
tm scan s body_start body_end ctx mode "" -> rendered_body
tm scan s after_close n ctx mode (acc + rendered_body)
fn :: tm tag section String Int Int [String String] TmplEscape String Int Bool => String
tm tag section s idx n ctx mode acc open_close inverted =
| open_close < 0 = tm scan s (idx + 3) n ctx mode acc
| otherwise =
tm render section body s (open_close + 2) (tm find section close s (open_close + 2) n (tm trim (str slice s (idx + 3) open_close)) 1) n ctx mode acc (tm section active (tm is truthy ctx (tm trim (str slice s (idx + 3) open_close))) inverted)
fn :: tm tag var String Int Int [String String] TmplEscape String Int => String
tm tag var s idx n ctx mode acc close_pos =
| close_pos < 0 = tm scan s (idx + 2) n ctx mode (acc + (tm lbrace) + (tm lbrace))
| otherwise =
tm scan s (close_pos + 2) n ctx mode (acc + (tm escape (tm lookup ctx (tm trim (str slice s (idx + 2) close_pos))) mode))
22.4.2. Internal Implementation: Public API
Observe how template.rg declares explicit fn :: ... => ... contracts first and resolves each case through aligned equations and tail calls:
fn :: tmpl render with escape String [String String] TmplEscape => String
tmpl render with escape tmpl ctx mode = tm scan tmpl 0 (str len tmpl) ctx mode ""
fn :: tmpl render String [String String] => String
tmpl render tmpl ctx = tmpl render with escape tmpl ctx TmplEscapeNone
fn :: tmpl render html String [String String] => String
tmpl render html tmpl ctx = tmpl render with escape tmpl ctx TmplEscapeHtml
fn :: tmpl render latex String [String String] => String
tmpl render latex tmpl ctx = tmpl render with escape tmpl ctx TmplEscapeLatex
22.5. Algorithmic Guarantees, RMM1/RMM2 Memory, and the 5 Golden Rules of template
- Algorithmic & Safety Guarantee: Default XSS prevention in
tmpl render html(escaping&,<,>,",'), while triple-stache{{{var}}}explicitly opts into raw trusted markup. - $O(1)$ Stack Complexity via TCO: Every recursive loop in
src/main/ridgun/lib/template.rgis in tail position, soridgunccompiles them into native jumps with zero stack growth. - Deterministic Memory (
RMM1/RMM2): Zero garbage-collector pauses; all intermediate allocations are reclaimed deterministically on scope exit. - Continuous Verification: Statically checked via
stable checkand tested by the automated suite insrc/test/ridgun/test template.rg.
The 5 Golden Rules When Programming with template
- Declare
import templateat the top of your file and take advantage of space/underscore equivalence so your code reads like natural prose. - Align your data pipelines with
=: chaintemplatecalls into named intermediate steps and letstable formatalign the columns. - Leverage
template's total functions inside|guards: inspect return values or unwrap ADTs via pattern matching rather than assuming external input is valid. - Avoid cloning large structures when only reading: remember that under
RMM2, function input arguments incur zero reference-count overhead (+0/-0). - Pair
templatewithtest(import test): always lock in your domain invariants withassert equalsorassert true.
In Chapter 23, we will explore the fmt lib in full depth (The fmt Lib — Canonical 2D Tabular Formatter and 9-Target Syntax Highlighter).