Initial revision
[gapil.git] / option.tex
1 \chapter{Gestione di parametri e opzioni}
2
3 Il passaggio dei parametri e delle variabili di ambiente dalla riga di comando
4 al singolo programma quando viene lanciato è effettuato attraverso le
5 variabili \texttt{argc}, \texttt{argv}, queste vengono passate al programma
6 come argomenti della funzione principale:
7
8 \begin{verbatim}
9     main(int argc, char * argv[])
10 \end{verbatim}
11
12 \section{Il formato dei parametri}
13
14 Il passaggio dei parametri al programma viene effettuato dalla shell, che si
15 incarica di leggere la linea di comando e di effettuarne la scansione (il
16 cosiddetto \textit{parsing}) per individuare le parole che la compongono,
17 ciascuna delle quali viene considerata un parametro; di default per
18 individuare le parole viene usato come separatore lo spazio (comportamento
19 modificabile attraverso il settaggio della variabile di ambiente IFS).
20
21 Nella scansione viene costruito l'array di puntatori \texttt{argv} inserendo
22 in successione il puntatore alla stringa costituente l'$n$-simo parametro; la
23 variabile \texttt{argc} viene inizializzata al numero di parametri trovati, in
24 questo modo il primo parametro è sempre il nome del programma (vedi \nfig).
25
26 \section{La gestione delle opzioni}
27
28 In generale un programma unix riceve da linea di comando sia i parametri che
29 le opzioni, queste ultime sono standardizzate per essere riconosciute come
30 tali: un elemento di \texttt{argv} che inizia con \texttt{-} e che non sia un
31 singolo \texttt{-} o \texttt{--} viene considerato un'opzione.  In in genere
32 le opzioni sono costituite da un lettera preceduta dal meno e possono avere o
33 no un parametro associato; un comando tipico può essere cioè qualcosa del
34 tipo:
35 \begin{verbatim}
36 touch -r riferimento.txt -m questofile.txt
37 \end{verbatim}
38 ed in questo caso le opzioni sono \texttt{m} ed \texttt{r}.
39
40 Per gestire le opzioni all'interno dei parametri passati in \texttt{argv} le
41 librerie standard del C forniscono la funzione \texttt{getopt} (accessibile
42 includendo \texttt{unistd.h}), che ha il prototipo:
43 \begin{verbatim}
44 int getopt(int argc, char * const argv[], const char * optstring);
45 \end{verbatim}
46
47 Questa funzione prende come argomenti le due variabili \texttt{argc} e
48 \texttt{argv} ed una stringa che indica quali sono le opzioni valide; la
49 funzione effettua la scansione della lista dei parametri ricercando ogni
50 stringa che comincia con \texttt{-} e ritorna ogni volta che trova una opzione
51 valida.
52
53 La stringa \texttt{optstring} indica quali sono le opzioni riconosciute ed è
54 costituita da tutti i caratteri usati per identificare le singole opzioni, se
55 l'opzione ha un parametro al carattere deve essere fatto seguire un segno di
56 due punti \texttt{:} nel caso appena accennato ad esempio la stringa di
57 opzioni sarebbe \texttt{"r:m"}.
58
59 La modalità di uso è pertanto quella di chiamare più volte la funzione
60 all'interno di un ciclo di while fintanto che essa non ritorna il valore
61 \texttt{-1} che indica che non ci sono più opzioni. Nel caso si incontri
62 un'opzione non dichiarata in \texttt{optstring} viene ritornato un \texttt{?}
63 mentre se l'opzione non è seguita da un parametro viene ritornato un
64 \texttt{:} infine se viene incontrato il valore \texttt{--} la scansione viene
65 considerata conclusa.
66
67 Quando la funzione trova un'opzione essa ritorna il valore numerico del
68 carattere, in questo modo si possono prendere le azioni relative usando un
69 case; la funzione inizializza inoltre alcune varibili globali:
70 \begin{itemize}
71 \item \texttt{char * optarg} contiene il puntatore alla stringa argomento
72   dell'opzione.
73 \item \texttt{int optind} alla fine della scansione restituisce l'indice del
74   primo argomento che non è un'opzione.
75 \item \texttt{int opterr} previene, se posto a zero, la stampa di un messaggio
76   di errore in caso di riconoscimento di opzioni non definite.
77 \item \texttt{int optopt} contiene il carattere dell'opzione non riconosciuta.
78 \end{itemize}
79
80 In \nfig è mostrato un programma di esempio, 
81
82 \begin{figure}[htbp]
83   \begin{center}
84     \begin{verbatim}
85     opterr = 0;  /* don't want writing to stderr */
86     while ( (i = getopt(argc, argv, "o:a:i:hve")) != -1) {
87         switch (i) {
88         case 'i':   /* input file */
89             in_file=open(optarg,O_RDONLY);
90             if (in_file<0) {
91                 perror("Cannot open input file");
92                 exit(1);
93             }
94             break;
95         case 'o':   /* output file (overwrite) */
96             out_file=open(optarg,O_WRONLY|O_CREAT);
97             if (out_file<0) {
98                 perror("Cannot open output file");
99                 exit(1);
100             }
101             break;
102             break;
103         case 'a':   /* output file (append) */
104             out_file=open(optarg,O_WRONLY|O_CREAT|O_APPEND);
105             break;
106         case 'h':   /* print help usage */
107             usage();
108             break;
109         case 'v':   /* set verbose mode */
110             debug("Option -v active\n");
111             verbose=1;
112             break;
113         case '?':   /* unrecognized options */
114             printf("Unrecognized options -%c\n",optopt);
115             usage();
116         default:    /* should not reached */
117             debug("default option\n");
118             usage();
119         }
120     }
121     debug("Optind %d, argc %d\n",optind,argc);
122     \end{verbatim}
123     \caption{Esempio di codice per la gestione delle opzioni.}
124     \label{fig:options_code}
125   \end{center}
126 \end{figure}
127
128 \subsection{Opzioni in formato esteso}
129
130 Un'estensione di questo schema è costituito dalle cosiddette
131 \textit{long-options} espresse nella forma \texttt{--option=parameter}, anche
132 la gestione di queste ultime è stata standardizzata attraverso l'uso di una
133 versione estesa di \texttt{getopt}.
134
135
136 \section{Le variabili di ambiente}
137
138 Questo va fatto.
139
140
141
142
143
144
145