Chiunque di voi abbia avuto a che fare con la linea di comando avrà senz'altro apprezzato due cose: la possibilità di ridare un comando già digitato semplicemente cercandolo con le freccie «su» e «giù» e la possibilità di completare un comando con la doppia pressione del tasto «TAB».

Quelli più esperti poi apprezzeranno la possibilità di muovere il cursore più velocemente spostandolo direttamente da una parola all'altra, oppure la possibilità di cancellare parte della linea di comando con una combinazione di tasti particolare, ecc.. Bene, vi sieti mai chiesti come e ossibile questo? E perché queste funzionalità alle volte si trovano anche in altri programmi? No? Beh, ve lo dico io! Dipende tutto dalla libreria readline.

Questa libreria, che fa parte del progetto GNU, è alla base di molte interfacce di testo di diversi programmi a cominciare, ovviamente, delle shell. In questo articoletto vedremo molto brevemente come poter utilizzare questa libreria per realizzare un piccolo programma che possa essere utilizzato, ad esempio, per ottenere una serie di informazioni da un ipotetico dispositivo installato sul nostro sistema. Ovviamente, poiché nella realtà il dispositivo non esiste, metteremo del codice ad hoc per simularne il funzionamento.

L'interfaccia di base

Come tutte le librerie che si rispettino anche la readline ha una propria interfaccia verso le applicazioni che intendono utilizzarla. Anche se la readline è molto complessa, ha però una interfaccia di base molto semplice. In questo articolo ci limiteremo alle funzonalità di base che però, come vedremo, sono già abbastanza interessanti da utilizzare.

Ma vediamo subito un semplice corpo di una funzione main() che implementa le funzionalità di base:

Una volta che si è controllato se la stringa è non vuota (altrimenti si esce perché vuol dire che l'utente ha inserito un End-Of-File) la si ripulisce dagli spazi in testa ed in cosa, e se il risultato è non nullo allora lo si passa alla funzione add_history() e quindi alla funzione execute_line().

La funzione add_history() è un'altra funzione propria della libreria readline (anche se in realtà, ad essere pignoli, essa fa parte della libreria history, ma questo è un altro discorso) che permette di gestire la possibilità di rieseguire un comando già dato semplicemente cercandolo con le freccie, mentre la fuzione execute_line() è una funzione ad hoc che si incarica di eseguire il comando che l'utente ci ha appena inserito dalla linea di comando.

E' abbastanza evidente allora che di per se la cosa è abbastanza semplice, ma andiamo avanti nell'esposizione perché occorre chiarire altri punti essenziali della questione.

Scendiamo più a fondo

Vediamo ora come si realizza la funzione forse più interessante ed utile di readline: il completamento dei comandi. Ritorniamo al codice appena presentato e vediamo cosa contiene la funzione initialize_readline():

Questa funzione inizializza le variabili rl_readline_name e rl_attempted_completion_function.

Non mi addentro di più nella cosa perché è al di fuori dello scopo di questo articolo ma rimando il lettore curioso alle pagine del manuale della libreria.

Con la variabile rl_attempted_completion_function invece si definisce la funzione che permette di impostare le modalità di completamento dei comandi. Questa è la funzione che ci interessa ed è qui che le cose si complicano... :)

Completare un comando

Come appena detto occorre definire la funzione rl_attempted_completion_function la quale viene chiamata da readline ogni qual volta essa ha bisogno di completare un comando e non sa come. In parole povere se l'utente preme il tasto «TAB» per chiedere il completamento del comando allora questa funzione viene attivata.

Vediamo un esempio di come questa potrebbe essere implementata:

C'è da dire subito che in questo esempio abbiamo utilizzato la struttura seguente per definire la variabile cmds_root:

Ma ritorniamo a noi e supponiamo allora di voler realizzare una piccola interfaccia a linea di comando verso un dispositivo che riporta lo stato di alcune grandezze notevoli e supponiamo anche che tale interfaccia possegga un comando del tipo: 

Cioè dando show status voltages si ottengono le letture delle tensioni, mentre dando show version hardware si ottiene la versione dell'hardware controllato. In pratica, come ben si vede, la struttura di tutti i comandi è correlata ad una struttura ad albero, dove, nel nostro caso, la variabile cmds_root è appunto la radice; in particolare abbiamo definito, per quanto riguarda il primo livello di comandi: 

La funzione command_generator() è la seguente:

e come di vede è una funzione a stati, nel senso che essa, ogni volta che viene invocata, restituisce un nuovo possibile comando che completa quello dell'utente.

Un esempio: se l'utente scrive show version e poi preme due volte il tasto «TAB» otterrà una lista di comandi possibili, e cioè driver, hardware e shell, questo grazie al fatto che la funzione command_generator() restituisce uno di questi valori ogni volta che viene invocata.

Un esempio pratico

Facciamo ora un esempio pratico per fissare un po' le idee (posso immaginare che la cosa sia un po' «ingarbugliata» ma se analizzate bene il tutto vedrete che non è poi impossibile capire come funziona).

Per coloro che vogliono ben capire il funzionamento del codice che sto utilizzando io possono scaricarsi il tutto dal mio FTP anonimo all'indirizzo: http://ftp.enneenne.com/pub/misc/readline/.

Prima di proseguire vediamo però come sia possibile definire le strutture dati che definisco i vari comandi.

I comandi principali possono essere definiti come segue:

Si noti come la funzione che esegue il comando exit è la stessa del comando quit (i due comandi sono quindi sinonimi) e come la lista dei sottocomandi del comando help sia appunto la lista dei comandi principali, questo perché è possibile dare comandi del tipo: help help o help reset ecc..

Per completezza vediamo anche come potrebbe essere il corpo di una funzione che ha il compito di eseguire un comando dell'utente:

Provate ora a dare un po' di comandi e quindi premete le freccie «su» e «giù» e vedrete che scorreranno i vari comandi che avete già dato in precedenza! Bello no? ;)

Bon direi che possiamo fermarci qua. Vi consiglio di continuare a provare ad utilizzare questo programmino di esempio.

E' interessante secondo me vedere come è stato implementato il comando help, infatti se ad esempio date il solo comando help otterrete:

Ma se date help show allora otterrete:

testsh> help show                                            

Secondo voi, come mai? Beh, buono studio! ;