lib/sod.h: Introduce `SOD_RECKLESS' feature macro to inhibit checking.

Currently there isn't any, but there will be soon.

diff --git a/doc/runtime.tex b/doc/runtime.tex
index 46e470ea59b12edd6ca4b15a5c2e88b0b0386ee4..4f6d277c673b6159116293faed8d1ecac3d7716b 100644 (file)
--- a/doc/runtime.tex
+++ b/doc/runtime.tex
@@ -615,6 +615,13 @@ instances and classes inherit from the standard @|SodObject| root object.
 While the translator can (at some effort) support alternative roots, they
 will require different run-time support machinery.
 
 While the translator can (at some effort) support alternative roots, they
 will require different run-time support machinery.
 

+\begin{describe}{feat}{SOD_RECKLESS}
+  Some of Sod's macros include runtime checking by default.  This checking
+  can be disabled if you value performance more than early diagnosis of
+  problems.  Define @|SOD_RECKLESS| to a nonzero value before including
+  @|<sod/sod.h>| to inhibit the runtime checking.
+\end{describe}
+

 
 \subsection{Layout utilities} \label{sec:runtime.object.layout}
 
 
 \subsection{Layout utilities} \label{sec:runtime.object.layout}
 

diff --git a/doc/sod.sty b/doc/sod.sty
index 0452348bfa86f725e8fdb557eecb8a4ca682fc54..531fce04daa4844d3e009090f4c19a81506be9b6 100644 (file)
--- a/doc/sod.sty
+++ b/doc/sod.sty
@@ -215,6 +215,7 @@
 \definedescribecategory{ty}{type}
 \definedescribecategory{type}{type}
 \definedescribecategory{mac}{#1{macro}}
 \definedescribecategory{ty}{type}
 \definedescribecategory{type}{type}
 \definedescribecategory{mac}{#1{macro}}

+\definedescribecategory{feat}{feature macro}

 \definedescribecategory{lmac}{local #1{macro}}
 \definedescribecategory{parse}{parser spec}
 \definedescribecategory{parseform}{parser form}
 \definedescribecategory{lmac}{local #1{macro}}
 \definedescribecategory{parse}{parser spec}
 \definedescribecategory{parseform}{parser form}

diff --git a/lib/sod.3 b/lib/sod.3
index 9f95c78f25a00ff7d3eb8bb82b95b2bd361dc106..de46128cf5568081ae01450ccfbc943637cea0c6 100644 (file)
--- a/lib/sod.3
+++ b/lib/sod.3
@@ -147,6 +147,16 @@ instances and classes inherit from the standard
 root object.
 While the translator can (at some effort) support alternative roots,
 they will require different run-time support machinery.
 root object.
 While the translator can (at some effort) support alternative roots,
 they will require different run-time support machinery.

+.PP
+Some of Sod's macros include runtime checking by default.
+This checking can be disabled if you value performance
+more than early diagnosis of problems.
+Define
+.B SOD_RECKLESS
+to a nonzero value
+before including
+.B <sod/sod.h>
+to inhibit the runtime checking.

 .
 .SS Layout utilities
 The following macros are useful in
 .
 .SS Layout utilities
 The following macros are useful in

diff --git a/lib/sod.h b/lib/sod.h
index 5a14adeb124330206e4bad667fcf2c6155997b8c..dd1ee03aa1533259ad4a7fbe3bd83c98b9961a30 100644 (file)
--- a/lib/sod.h
+++ b/lib/sod.h
@@ -116,6 +116,22 @@ SOD__VARARGS_MACROS_PREAMBLE
 
 #define SOD__IGNORE(var) ((void)(var))
 
 
 #define SOD__IGNORE(var) ((void)(var))
 

+/* --- @SOD__PARANOIA@ --- *
+ *
+ * Arguments:  @cond@ = a condition to check
+ *             @conseq@ = a thing to evaluate to if the check passes
+ *             @alt@ = a thing to do if the check fails
+ *
+ * Use:                Check to make sure something is good at runtime, unless
+ *             disabled.
+ */
+
+#if SOD_RECKLESS
+#  define SOD__PARANOIA(cond, conseq, alt) (conseq)
+#else
+#  define SOD__PARANOIA(cond, conseq, alt) ((cond) ? (conseq) : (alt))
+#endif
+

 /* --- @SOD__CAR@ --- *
  *
  * Arguments:  @...@ = a nonempty list of arguments
 /* --- @SOD__CAR@ --- *
  *
  * Arguments:  @...@ = a nonempty list of arguments