macro.tex

   1 %% macro.tex
   2 %%
   3 %% Copyright (C) 2000-2012 Simone Piccardi.  Permission is granted to
   4 %% copy, distribute and/or modify this document under the terms of the GNU Free
   5 %% Documentation License, Version 1.1 or any later version published by the
   6 %% Free Software Foundation; with the Invariant Sections being "Un preambolo",
   7 %% with no Front-Cover Texts, and with no Back-Cover Texts.  A copy of the
   8 %% license is included in the section entitled "GNU Free Documentation
   9 %% License".
  10 %%
  11 %
  12 %
  13 % Defining some special character for use inside typewriter
  14 % text without using the verbatim environment
  15 %
  16 \def\tild{\char'176}
  17 \def\bslash{\char'134}
  18 \def\circonf{\char'136}
  19 \def\invap{\char'140}
  20
  21 \newcommand{\includecodesnip}[1]{\lstinputlisting[stepnumber=0,xleftmargin=\parindent,frame=]{#1}}{}
  22 \newcommand{\includestruct}[1]{\lstinputlisting[stepnumber=0]{#1}}{}
  23 \newcommand{\includecodesample}[1]{\lstinputlisting{#1}}{}
  24
  25 %
  26 % Defining some commands to manipulate counter to avoid ude of
  27 % \label and \ref commands (and related problem to remeber the
  28 % used labels) to refer nearest objects
  29 %
  30 %
  31 \newcounter{usercount}       % define a new counter for internal use
  32 %
  33 % equations commands
  34 %
  35 \newcommand{\cureq}{(\theequation)}
  36 \newcommand{\nxeq}{%
  37 \setcounter{usercount}{\value{equation}}%
  38 \addtocounter{usercount}{1}%
  39 (\thechapter.\theusercount)}
  40 \newcommand{\preeq}{%
  41 \setcounter{usercount}{\value{equation}}%
  42 \addtocounter{usercount}{-1}%
  43 (\thechapter.\theusercount)}
  44 %
  45 % Macro to put picture (in format PICT) inside a figure
  46 %
  47 \newcommand{\pictfig}[3]{
  48         \begin{minipage}[t][#1][b]{#2}
  49         \mbox{\special{pict=#3}}
  50 %    \vspace{3cm}
  51     \end{minipage}
  52 }
  53 %
  54 % Macro to create a special environment for function prototypes
  55 % boxed description
  56 %
  57 \newenvironment{prototype}[2]
  58 {% defining what is done by \begin
  59   \nobreak
  60   \center
  61   \begin{boxedminipage}[c]{14cm}
  62   \footnotesize
  63     \begin{description*}{}{}
  64     \item \texttt{\#include <#1>}
  65     \item \texttt{#2} \par
  66 %   \begin{lstlisting}{}
  67 % #1
  68 % #2
  69 %   \end{lstlisting}
  70 }
  71 {% defining what is done by \end
  72 %  \end{list}
  73 %  \par
  74 \end{description*}
  75 \end{boxedminipage}
  76 \vspace{6pt}
  77 \par
  78 \normalsize
  79 }
  80 \newenvironment{errlist}{\begin{basedescript}{\desclabelwidth{1.0cm}}}
  81 {\end{basedescript}}
  82 %
  83 % Slighty different environment to be used for multi-header,
  84 % multi-functions boxed description
  85 %
  86 \newcommand{\headdecl}[1]{\item\texttt{\#include <#1>}}
  87 \newcommand{\funcdecl}[1]{\item\texttt{#1}\par}
  88 \newcommand{\bodydesc}[1]{\par \end{description*} #1
  89  \begin{description*}{}{} \baselineskip=0pt
  90  \item \vspace{-4pt}
  91 }
  92 %
  93 \newenvironment{functions}
  94 {% defining what is done by \begin
  95   \nobreak
  96   \center
  97     \begin{boxedminipage}[c]{14cm}
  98       \footnotesize
  99     \begin{description*}{}{}
 100 }
 101 {% defining what is done by \end
 102       \end{description*}
 103     \end{boxedminipage}
 104     \vspace{6pt}
 105      \par
 106     \normalsize
 107 %\break
 108 }
 109
 110 %
 111 % Wrapper for shell command, functions, filenames, links,
 112 % variables, macros,  and everything can be useul,
 113 %
 114 \newcommand{\cmd}[1]{\texttt{#1}}     % shell command
 115 \newcommand{\code}[1]{\texttt{#1}}    % for simple code
 116
 117 \newcommand{\func}[1]{%
 118 \index{funzione!{#1}@{{\tt {#1}}}}\texttt{#1}%
 119 %\index{#1@{{\tt {#1}} (funzione)}}\texttt{#1}%
 120 }
 121
 122 \newcommand{\funcd}[1]{%
 123 \index{funzione!{#1}@{{\tt {#1}}}!definizione di}\texttt{#1}%
 124 %\index{#1@{{\tt {#1}} (funzione)}!definizione di}\texttt{#1}%
 125 }
 126
 127 \newcommand{\macro}[1]{%
 128 \index{macro!{#1}@{{\tt {#1}}}}\texttt{#1}%
 129 %\index{#1@{{\tt {#1}} (macro)}}\texttt{#1}%
 130 }
 131
 132 \newcommand{\errcode}[1]{%
 133 \index{errore!{#1}@{{\tt {#1}}}}\texttt{#1}%
 134 %\index{#1@{{\tt {#1}} (errore)}}\texttt{#1}%
 135 }
 136
 137 \newcommand{\errval}[1]{\texttt{#1}}     % value
 138 \newcommand{\var}[1]{\texttt{#1}}     % variable
 139 \newcommand{\val}[1]{\texttt{#1}}     % value
 140
 141 \newcommand{\signal}[1]{%
 142 \index{segnale!{#1}@{{\tt {#1}}}}\texttt{#1}%
 143 %\index{#1@{{\tt {#1}} (costante)}}\texttt{#1}%
 144 }                                     % constant name
 145
 146 \newcommand{\const}[1]{%
 147 \index{costante!{#1}@{{\tt {#1}}}}\texttt{#1}%
 148 %\index{#1@{{\tt {#1}} (costante)}}\texttt{#1}%
 149 }                                     % constant name
 150
 151 \newcommand{\instruction}[1]{%
 152 \index{istruzione linguaggio C!{#1}@{{\tt {#1}}}}\texttt{#1}%
 153 %\index{#1@{{\tt {#1}} (direttiva)}}\texttt{#1}%
 154 }                                     % constant name
 155
 156 \newcommand{\direct}[1]{%
 157 \index{direttiva linguaggio C!{#1}@{{\tt {#1}}}}\texttt{#1}%
 158 %\index{#1@{{\tt {#1}} (direttiva)}}\texttt{#1}%
 159 }                                     % constant name
 160
 161 \newcommand{\file}[1]{\texttt{#1}}    % file name
 162 \newcommand{\link}[1]{\texttt{#1}}    % html link
 163 \newcommand{\ctyp}[1]{\texttt{#1}}    % C standard type
 164
 165 \newcommand{\headfile}[1]{%
 166 %\index{file!include!{#1}@{{\tt {#1}}}}\texttt{#1}%
 167 \texttt{#1}%
 168 }                                     % header file name
 169
 170 \newcommand{\procfile}[1]{%
 171 \index{file!filesystem~\texttt{/proc}!{#1}@{{\tt {#1}}}}\texttt{#1}%
 172 %\index{#1@{{\tt {#1}} (direttiva)}}\texttt{#1}%
 173 }                                     % /proc file name
 174 \newcommand{\sysfile}[1]{%
 175 \index{file!di~sistema!{#1}@{{\tt {#1}}}}\texttt{#1}%
 176 %\index{#1@{{\tt {#1}} (direttiva)}}\texttt{#1}%
 177 }                                     % system file name
 178 \newcommand{\conffile}[1]{%
 179 \index{file!di~configurazione!{#1}@{{\tt {#1}}}}\texttt{#1}%
 180 %\index{#1@{{\tt {#1}} (direttiva)}}\texttt{#1}%
 181 }                                     % configuration file name
 182 \newcommand{\procrelfile}[2]{%
 183 \index{file!filesystem~\texttt{/proc}!{#1/#2}@{{\tt {#1/#2}}}}\texttt{#2}%
 184 %\index{#1@{{\tt {#1}} (direttiva)}}\texttt{#1}%
 185 }
 186
 187 \newcommand{\sysctlfile}[1]{%
 188 \index{file!file di controllo (sotto \texttt{/proc/sys})!{#1}@{{\tt {#1}}}}\texttt{/proc/sys/#1}%
 189 %\index{#1@{{\tt {#1}} (direttiva)}}\texttt{#1}%
 190 }                                     % /proc/sys file name
 191
 192 \newcommand{\sysctlrelfile}[2]{%
 193 \index{file!file di controllo (sotto \texttt{/proc/sys})!{#1/#2}@{{\tt {#1/#2}}}}\texttt{#2}%
 194 %\index{#1@{{\tt {#1}} (direttiva)}}\texttt{#1}%
 195 }                                     % /proc/sys file name
 196
 197
 198 \newcommand{\kstruct}[1]{%
 199 \index{struttura dati del kernel!{#1}@{{\tt {#1}}}}\texttt{#1}%
 200 %\index{#1@{{\tt {#1}} (struttura dati)}}\texttt{#1}%
 201 }                                     % struttura dati
 202 \newcommand{\kstructd}[1]{%
 203 \index{struttura dati del kernel!{#1}@{{\tt {#1}}}!definizione di}\texttt{#1}%
 204 %\index{#1@{{\tt {#1}} (struttura dati)}!definizione di}\texttt{#1}%
 205 }                                     % struttura dati
 206 \newcommand{\type}[1]{%
 207 \index{tipo di dato!{#1}@{{\tt {#1}}}}\texttt{#1}%
 208 %\index{#1@{{\tt {#1}} (tipo)}}\texttt{#1}%
 209 }                                     % system type
 210 \newcommand{\struct}[1]{%
 211 \index{struttura dati!{#1}@{{\tt {#1}}}}\texttt{#1}%
 212 %\index{#1@{{\tt {#1}} (struttura dati)}}\texttt{#1}%
 213 }                                     % struttura dati
 214 \newcommand{\structd}[1]{%
 215 \index{struttura dati!{#1}@{{\tt {#1}}}!definizione di}\texttt{#1}%
 216 %\index{#1@{{\tt {#1}} (struttura dati)}!definizione di}\texttt{#1}%
 217 }                                     % struttura dati
 218 \newcommand{\param}[1]{\texttt{#1}}   % function parameter
 219 \newcommand{\acr}[1]{\textsl{#1}}     % acrostic (for glibc, ext2, ecc.)
 220
 221 \newcommand{\ids}[1]{\textsl{#1}}     % Identifier (PID, GID, UID, TID, ecc.)
 222 \newcommand{\envvar}[1]{\texttt{#1}}   % environment variable
 223 \newcommand{\samplefunc}[1]{\texttt{#1}}   % funzione degli esempi
 224
 225 \newcommand{\itindex}[1]{%
 226 \index{#1@{\textit{#1}}}%
 227 }
 228
 229 \newcommand{\itindbeg}[1]{%
 230 \index{#1@{\textit{#1}}|(}%
 231 }
 232 \newcommand{\itindend}[1]{%
 233 \index{#1@{\textit{#1}}|)}%
 234 }
 235 \newcommand{\itindsub}[2]{%
 236 \index{#1@{\textit{#1}}!\textit{#2}}%
 237 }
 238
 239 % Aggiunte di Mirko per la gestione delle tabelle complicate come immagini
 240 % nella traslazione in HTML
 241 \newenvironment{usepicture}{}{}{}{}
 242
 243 %
 244 % Macro di definizione di alcune lunghezze usate per le formattazioni
 245 %
 246 \newlength{\codesamplewidth}
 247 \setlength{\codesamplewidth}{0.95\textwidth}
 248
 249 \newlength{\funcboxwidth}
 250 \setlength{\funcboxwidth}{0.85\textwidth}
 251
 252
 253 %
 254 % Nuove macro per diversa formattazione delle definizioni delle funzioni
 255 %
 256 \newcommand{\fhead}[1]{\texttt{\#include <#1>}\par}
 257 \newcommand{\fdecl}[1]{\texttt{#1}\par}
 258 \newcommand{\fdesc}[1]{\hfill{#1}\par}
 259
 260 \newenvironment{funcproto}[2]
 261 {% defining what is done by \begin
 262 \centering
 263 \vspace{3pt}
 264 \begin{funcbox}
 265 #1
 266 \end{funcbox}
 267 \begin{funcbox}
 268 #2
 269 }
 270 {% defining what is done by \end
 271 \end{funcbox}
 272 %\vspace{6pt}
 273 %\break
 274 }
 275
 276 \newenvironment{funcbox}
 277 {% defining what is done by \begin
 278   \nobreak
 279   \begin{boxedminipage}[c]{\funcboxwidth}
 280     \footnotesize
 281 }
 282 {% defining what is done by \end
 283 \end{boxedminipage}
 284 \break
 285 \normalsize
 286 \par
 287 }
 288
 289
 290
 291 %%% Local Variables:
 292 %%% mode: latex
 293 %%% TeX-master: "gapil"
 294 %%% End: