refactor: Lint

HepLean/Meta/Informal.lean

@@ -0,0 +1,103 @@
+/-
+Copyright (c) 2024 Joseph Tooby-Smith. All rights reserved.
+Released under Apache 2.0 license.
+Authors: Joseph Tooby-Smith
+-/
+import Lean
+/-!
+
+## Informal definitions and lemmas
+
+-/
+open Lean Elab System
+
+/-! TODO: Derive a means to extract informal definitions and informal lemmas. -/
+
+/-- The structure representating an informal definition. -/
+structure InformalDefinition where
+  /-- The name of the informal definition. This is autogenerated. -/
+  name : Name
+  /-- The mathematical description of the definition. -/
+  math : String
+  /-- The physics description of the definition. -/
+  physics : String
+
+/-- The structure representating an informal proof. -/
+structure InformalLemma where
+  /-- The name of the informal lemma. This is autogenerated. -/
+  name : Name
+  /-- The mathematical description of the lemma. -/
+  math : String
+  /-- The physics description of the lemma. -/
+  physics : String
+  /-- A description of the proof. -/
+  proof : String
+
+namespace Informal
+
+/-- The Parser.Category we will use for assignments. -/
+declare_syntax_cat informalAssignment
+
+/-- The syntax describing an informal assignment of `ident` to a string. -/
+syntax (name := informalAssignment) ident ":≈" str : informalAssignment
+
+/-- The syntax for the command informal_definition. -/
+syntax (name := informal_definition) "informal_definition " ident
+  " where " (colGt informalAssignment)* : command
+
+/-- The macro turning `informal_definition ... where ...` into a definition. -/
+macro "informal_definition " name:ident " where " assignments:informalAssignment* : command => do
+  let mut math_def? : Option (TSyntax `term) := none
+  let mut physics_def? : Option (TSyntax `term) := none
+  for assignment in assignments do
+    match assignment with
+    | `(informalAssignment| physics :≈ $val:str) =>
+      let some strVal := val.raw.isStrLit? | Macro.throwError "Expected string literal for physics"
+      physics_def? := some (← `($(Lean.quote strVal)))
+    | `(informalAssignment| math :≈ $val:str) =>
+      let some strVal := val.raw.isStrLit? | Macro.throwError "Expected string literal for math"
+      math_def? := some (← `($(Lean.quote strVal)))
+    | _ => Macro.throwError "invalid assignment syntax"
+  unless physics_def?.isSome && math_def?.isSome do
+    Macro.throwError "Both 'physics' and 'math' assignments are required"
+  `(
+/-- An informal definition. -/
+def $name : InformalDefinition := {
+  name := $(Lean.quote name.getId),
+  physics := $(physics_def?.getD (← `("No physics description provided"))),
+  math := $(math_def?.getD (panic! "math not assigned"))
+    })
+
+/-- The syntax for the command `informal_lemma`. -/
+syntax (name := informal_lemma) "informal_lemma " ident " where "
+  (colGt informalAssignment)* : command
+
+/-- The macro turning `informal_lemma ... where ...` into a definition. -/
+macro "informal_lemma " name:ident " where " assignments:informalAssignment* : command => do
+  let mut math_def? : Option (TSyntax `term) := none
+  let mut physics_def? : Option (TSyntax `term) := none
+  let mut proof_def? : Option (TSyntax `term) := none
+  for assignment in assignments do
+    match assignment with
+    | `(informalAssignment| physics :≈ $val:str) =>
+      let some strVal := val.raw.isStrLit? | Macro.throwError "Expected string literal for physics"
+      physics_def? := some (← `($(Lean.quote strVal)))
+    | `(informalAssignment| math :≈ $val:str) =>
+      let some strVal := val.raw.isStrLit? | Macro.throwError "Expected string literal for math"
+      math_def? := some (← `($(Lean.quote strVal)))
+    | `(informalAssignment| proof :≈ $val:str) =>
+      let some strVal := val.raw.isStrLit? | Macro.throwError "Expected string literal for proof"
+      proof_def? := some (← `($(Lean.quote strVal)))
+    | _ => Macro.throwError "invalid assignment syntax"
+  unless math_def?.isSome do
+    Macro.throwError "Both 'physics' and 'math' assignments are required"
+  `(
+/-- An informal lemma. -/
+def $name : InformalLemma := {
+  name := $(Lean.quote name.getId),
+  physics := $(physics_def?.getD (← `("No physics description provided"))),
+  math := $(math_def?.getD (panic! "math not assigned")),
+  proof := $(proof_def?.getD (← `("No proof description provided"))),
+    })
+
+end Informal