Introduce tool invocation partition (#178)

GabrielDosReis · GabrielDosReis · commit f0e1d1b91ec2 · 2025-12-29T14:54:04.000-08:00
* Fix `ifcdoc` command typo

* Tool Invocation and String Heap
diff --git a/ltx/heaps.tex b/ltx/heaps.tex
@@ -76,3 +76,9 @@ \subsection{Attribute heap}
 The attribute heap is a partition consisting entirely of \type{AttrIndex} values.
 
 \partition{heap.attr}
+
+\subsection{String heap}
+\label{sec:ifc-string-heap}
+
+The string heap is a partition consisting entirely of \type{TextOffset} values.  Each entry in that
+heap designates a NUL-terminated UTF-8 encoded string (\secref{sec:ifc-textoffset-data-type}).
diff --git a/ltx/meta.tex b/ltx/meta.tex
@@ -11,4 +11,34 @@ \section{Producing Tool}
 Each entry in that partition is a \type{TextOffset} representing a NUL-terminated UTF-8 encoded string (see \secref{sec:ifc-textoffset-data-type}).  
 The partition has as many entries as the tool deems necessary for identification purposes.
 
-\partition{meta.tool-maker}
+\partition{meta.tool.maker}
+
+\section{Tool Invocation}
+\label{sec:ifc-tool-invocation}
+
+A tool producing an IFC file may embed a partition describing the sequence of invocations of tools leading to the creating of that file.
+That partition is called the \emph{tool invocation} partition.  Each entry in that partition is
+a structure of the layout
+%
+\begin{figure}[H]
+    \centering
+    \structure{
+        \DeclareMember{cmd}{TextOffset} \\
+        \DeclareMember{args}{Sequence TextOffset} \\
+    }
+    \caption{Structure of a tool invocation}
+    \label{fig:ifc-tool-invocation}
+\end{figure}
+%
+with the following meaning:
+\begin{itemize}
+    \item The \field{cmd} field describes the name of the invoked command
+    \item The \field{args} field describes the sequence (\secref{sec:ifc-sequence}) of arguments to the 
+    invoked command.  It is a slice of the string heap (\secref{sec:ifc-string-heap}), meaning that the field \field{args.start}
+    designates an entry into the \emph{string heap} and \field{args.cardinality} designates how many 
+    \type{TextOffset} values there are in that sequence.  Each element of that sequence designates a NUL-terminated UTF-8 string.
+\end{itemize}
+
+
+\partition{meta.tool.invocation}
+
