Skip to content

Commit 7c6310e

Browse files
committed
Fix documentation links to GoblintCil
1 parent 545fc13 commit 7c6310e

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

doc/cil.tex

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@
1111
\def\secref#1{Section~\ref{sec-#1}}
1212
\def\chref#1{Chapter~\ref{ch-#1}}
1313

14-
\def\apiref#1#2#3{\ahref{api/goblint-cil/#1/index.html\##2#3}{#1.#3}}
15-
\def\moduleref#1{\ahref{api/goblint-cil/#1/index.html}{#1}}
14+
\def\apireff#1#2#3#4{\ahref{api/goblint-cil/GoblintCil/#4index.html\##2#3}{#1.#3}}
15+
\def\apiref#1#2#3{\apireff{#1}{#2}{#3}{#1/}}
16+
\def\moduleref#1{\ahref{api/goblint-cil/GoblintCil/#1/index.html}{#1}}
1617

1718
% Use this to refer to a Cil type/val
18-
\def\ciltyperef#1{\apiref{Cil}{type-}{#1}}
19-
\def\cilvalref#1{\apiref{Cil}{val-}{#1}}
19+
\def\ciltyperef#1{\apireff{GoblintCil}{type-}{#1}{}}
20+
\def\cilvalref#1{\apireff{GoblintCil}{val-}{#1}{}}
2021

2122
% Use this to refer to a type/val in the Pretty module
2223
\def\ptyperef#1{\apiref{Pretty}{type-}{#1}}
@@ -673,9 +674,9 @@ \section{CIL API Documentation}\label{sec-api}
673674
% \item \ahref{api/index\_values.html}{An index of all values}
674675
\item \ciltyperef{file} is the representation of a file.
675676
\item \ciltyperef{global} is the representation of a global declaration or
676-
definitions. Values for \ahref{api/goblint-cil/Cil/index.html\#val-emptyFunction}{operating on globals}.
677+
definitions. Values for \ahref{api/goblint-cil/GoblintCil/index.html\#val-emptyFunction}{operating on globals}.
677678
\item \ciltyperef{typ} is the representation of a type.
678-
Values for \ahref{api/goblint-cil/Cil/index.html\#val-voidType}{operating on types}.
679+
Values for \ahref{api/goblint-cil/GoblintCil/index.html\#val-voidType}{operating on types}.
679680
\item \ciltyperef{compinfo} is the representation of a structure or a union
680681
type
681682
\item \ciltyperef{fieldinfo} is the representation of a field in a structure
@@ -684,16 +685,16 @@ \section{CIL API Documentation}\label{sec-api}
684685
\item \ciltyperef{varinfo} is the representation of a variable
685686
\item \ciltyperef{fundec} is the representation of a function
686687
\item \ciltyperef{lval} is the representation of an lvalue.
687-
Values for \ahref{api/goblint-cil/Cil/index.html\#val-makeVarinfo}{operating on lvalues}.
688+
Values for \ahref{api/goblint-cil/GoblintCil/index.html\#val-makeVarinfo}{operating on lvalues}.
688689
\item \ciltyperef{exp} is the representation of an expression without
689690
side-effects.
690-
Values for \ahref{api/goblint-cil/Cil/index.html\#val-zero}{operating on expressions}.
691+
Values for \ahref{api/goblint-cil/GoblintCil/index.html\#val-zero}{operating on expressions}.
691692
\item \ciltyperef{instr} is the representation of an instruction (with
692693
side-effects but without control-flow)
693694
\item \ciltyperef{stmt} is the representation of a control-flow statements.
694-
Values for \ahref{api/goblint-cil/Cil/index.html\#val-mkStmt}{operating on statements}.
695+
Values for \ahref{api/goblint-cil/GoblintCil/index.html\#val-mkStmt}{operating on statements}.
695696
\item \ciltyperef{attribute} is the representation of attributes.
696-
Values for \ahref{api/goblint-cil/Cil/index.html\#type-attributeClass}{operating on attributes}.
697+
Values for \ahref{api/goblint-cil/GoblintCil/index.html\#type-attributeClass}{operating on attributes}.
697698
\end{itemize}
698699

699700

@@ -720,9 +721,9 @@ \section{CIL API Documentation}\label{sec-api}
720721
not propagate information from one node to another. Each visitor must use its
721722
own private data to achieve this effect if necessary.
722723

723-
Each visitor is an object that is an instance of a class of type \apiref{Cil}{class-type-}{cilVisitor}.
724+
Each visitor is an object that is an instance of a class of type \apireff{GoblintCil}{class-type-}{cilVisitor}{}.
724725
The most convenient way to obtain such classes is to specialize the
725-
\apiref{Cil}{class-}{nopCilVisitor} class (which just traverses the tree doing
726+
\apiref{GoblintCil}{class-}{nopCilVisitor}{} class (which just traverses the tree doing
726727
nothing). Any given specialization typically overrides only a few of the
727728
methods. Take a look for example at the
728729
[copyFunctionVisitor] defined in \t{cil.ml}.
@@ -1053,7 +1054,7 @@ \section{CIL API Documentation}\label{sec-api}
10531054
\end{itemize}
10541055

10551056
You can even customize the pretty-printer by creating instances of
1056-
\apiref{Cil}{class-type-}{cilPrinter}. Typically such an instance extends
1057+
\apiref{GoblintCil}{class-type-}{cilPrinter}{}. Typically such an instance extends
10571058
\cilvalref{defaultCilPrinter}. Once you have a customized pretty-printer you
10581059
can use the following printing functions:
10591060
\begin{itemize}

0 commit comments

Comments
 (0)