Render via templates

.gitignore

@@ -3,3 +3,6 @@
 
 # rendered code fragments
 /*.pdf
+
+# documentation symlinks
+/doc/references

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "technique"
-version = "0.4.6"
+version = "0.5.0"
 edition = "2021"
 description = "A domain specific language for procedures."
 authors = [ "Andrew Cowie" ]

examples/prototype/AirlockPowerdown.tq

@@ -0,0 +1,39 @@
+% technique v1
+! PD; © 2003 National Aeronautics and Space Administration, Canadian Space Agency, European Space Agency, and Others
+& nasa-flight-plan,v4.0
+
+emergency_procedures :
+
+# ISS Powerdown and Recovery
+
+    1.  <rs_load_powerdown>
+    2.  <node1_htr_avail_16>
+    3.  <node1_htr_avail_79>
+
+rs_load_powerdown :
+
+# RS Load Powerdown
+
+ARCU deactivation is requested by MCC-H and performed after MCC-M concurrence.
+
+node1_htr_avail_16 :
+
+# Inhibiting Node 1 B HTRS (1 to 6)
+
+    @pcs
+    { foreach node in seq(6) }
+        1.  Check Availability
+        2.  Perform { cmd("Inhibit") }
+        3.  Check Availability
+                'Inhibited'
+
+node1_htr_avail_79 :
+
+# Inhibiting Node 1 B HTRS (7 to 9)
+
+    @pcs
+    { foreach node in seq(9) }
+        1.  Check Availability
+        2.  Perform { cmd("Inhibit") }
+        3.  Check Availability
+                'Inhibited'

examples/prototype/DatabaseUpgrade.tq

@@ -0,0 +1,75 @@
+% technique v1
+& procedure
+
+database_upgrade :
+
+# Production Database Upgrade
+
+In order to launch the next version of our e-commerce platform, we need to
+upgrade the schema of the core database at the heart of the application. We
+also have an outstanding requirement to upgrade the underlying database
+software, as we have had trouble with several bugs therein which the vendor
+reports fixed.
+
+I. Take site down
+
+site_down :
+
+# Take site down
+
+Before taking the database offline for its upgrade, we put the site into
+maintenance mode and safely down the servers. The start time is critical due
+to expected duration of the database schema upgrade scripts.
+
+    1.  Enter maintenance mode
+        @fozzie
+            a.  Put web site into maintenance mode (load balancer redirect to
+                alternate web servers with static pages)
+        @gonzo
+            b.  Activate IVR maintenance mode
+    2.  Down services
+        @kermit
+            a.  Stop all VMs
+            b.  Stop GFS on database1, database2
+            c.  Ensure RAID filesystems still mounted
+        @gonzo
+            d.  Stop Apache on web1, web2
+    3.  Verification
+        @kermit
+            a.  Verify maintenance mode is active
+            b.  Verify all VMs down
+            c.  GO / NO-GO FOR UPGRADE
+
+II. Database work
+
+software_update :
+
+# Database Software Upgrade
+
+Run an export of the database in order to ensure we have a good backup prior
+to upgrading the database software and running the schema change scripts.
+There is not much concurrent activity here, so those not directly involved in
+database activity will head for breakfast.
+
+    4.  Database safety
+        @beaker
+            a.  Database to single user mode
+            b.  Export database to secondary storage
+            c.  Stop database
+        @gonzo
+            d.  Run out to get coffees for everyone
+    5.  Software upgrade
+        @fozzie
+            a.  Install database software upgrade
+    6.  Restart database
+        @beaker
+            a.  Start database
+    7.  Preliminary database testing
+        @beaker
+            a.  Run access check scripts
+            b.  Run health check scripts
+        @fozzie
+            c.  Restart database monitoring
+    8.  Schema upgrade
+        @beaker
+            a.  Run database schema upgrade scripts

src/editor/server.rs

@@ -16,7 +16,7 @@ use technique::formatting::Identity;
 use technique::language::{Document, Technique};
 use tracing::{debug, error, info, warn};
 
-use crate::formatting;
+use crate::highlighting;
 use crate::parsing;
 use crate::parsing::ParsingError;
 use crate::problem::{calculate_column_number, calculate_line_number, Present};
@@ -353,7 +353,7 @@ impl TechniqueLanguageServer {
             }
         };
 
-        let result = formatting::render(&Identity, &document, 78);
+        let result = highlighting::render(&Identity, &document, 78);
 
         // convert to LSP type for return to editor.
         let edit = TextEdit {

src/formatting/mod.rs

@@ -1,6 +1,6 @@
 pub mod formatter;
-mod renderer;
+mod syntax;
 
 // Re-export all public symbols
 pub use formatter::*;
-pub use renderer::*;
+pub use syntax::*;

src/formatting/syntax.rs

@@ -0,0 +1,47 @@
+//! Renderers for colourizing Technique language
+
+/// Types of content that can be rendered with different styles
+#[derive(Debug, Clone, Copy, PartialEq)]
+pub enum Syntax {
+    Neutral, // default
+    Indent,
+    Newline,
+    Header,
+    Declaration,
+    Description,
+    Forma,
+    StepItem,
+    CodeBlock,
+    Variable,
+    Section,
+    String,
+    Numeric,
+    Response,
+    Invocation,
+    Title,
+    Keyword,
+    Function,
+    Multiline,
+    Label,
+    Operator,
+    Quote,
+    Language,
+    Attribute,
+    Structure,
+}
+
+/// Trait for different rendering backends (the no-op no-markup one, ANSI
+/// escapes for terminal colouring, Typst markup for documents)
+pub trait Render {
+    /// Apply styling to content with the specified syntax type
+    fn style(&self, content_type: Syntax, content: &str) -> String;
+}
+
+/// Returns content unchanged, with no markup applied
+pub struct Identity;
+
+impl Render for Identity {
+    fn style(&self, _syntax: Syntax, content: &str) -> String {
+        content.to_string()
+    }
+}

src/highlighting/mod.rs

@@ -0,0 +1,9 @@
+//! Rendering of Technique source code with syntax highlighting
+
+mod renderer;
+mod terminal;
+mod typst;
+
+pub use renderer::render;
+pub use terminal::Terminal;
+pub use typst::Typst;

src/formatting/renderer.rs → src/highlighting/renderer.rs

@@ -1,53 +1,8 @@
 //! Renderers for colourizing Technique language
 
+use crate::formatting::*;
 use crate::language::*;
 
-/// Types of content that can be rendered with different styles
-#[derive(Debug, Clone, Copy, PartialEq)]
-pub enum Syntax {
-    Neutral, // default
-    Indent,
-    Newline,
-    Header,
-    Declaration,
-    Description,
-    Forma,
-    StepItem,
-    CodeBlock,
-    Variable,
-    Section,
-    String,
-    Numeric,
-    Response,
-    Invocation,
-    Title,
-    Keyword,
-    Function,
-    Multiline,
-    Label,
-    Operator,
-    Quote,
-    Language,
-    Attribute,
-    Structure,
-}
-
-/// Trait for different rendering backends (the no-op no-markup one, ANSI
-/// escapes for terminal colouring, Typst markup for documents)
-pub trait Render {
-    /// Apply styling to content with the specified syntax type
-    fn style(&self, content_type: Syntax, content: &str) -> String;
-}
-
-/// Returns content unchanged, with no markup applied
-pub struct Identity;
-
-impl Render for Identity {
-    fn style(&self, _syntax: Syntax, content: &str) -> String {
-        content.to_string()
-    }
-}
-
 /// We do the code formatting in two passes. First we convert from our
 /// Abstract Syntax Tree types into a Vec of "fragments" (Syntax tag, String
 /// pairs). Then second we apply the specified renderer to each pair to result

src/rendering/terminal.rs → src/highlighting/terminal.rs

@@ -1,7 +1,7 @@
 //! Renderers for colourizing Technique language
 
+use crate::formatting::*;
 use owo_colors::OwoColorize;
-use technique::formatting::*;
 
 /// Embellish fragments with ANSI escapes to create syntax highlighting in
 /// terminal output.

src/rendering/typst.rs → src/highlighting/typst.rs

@@ -1,7 +1,7 @@
 //! Renderers for colourizing Technique language
 
+use crate::formatting::*;
 use std::borrow::Cow;
-use technique::formatting::*;
 
 /// Add markup around syntactic elements for use when including
 /// Technique source in Typst documents.

src/lib.rs

@@ -1,4 +1,6 @@
 pub mod formatting;
+pub mod highlighting;
 pub mod language;
 pub mod parsing;
 pub mod regex;
+pub mod templating;