L’assert è un sistema di controllo delle asserzioni. Di default il C definisce la macro nell’header assert.h, in C++ in cassert.h. La particolarità delle asserzioni è che vengono testate solo in fase di debug (cioè solo quando l’applicazione viene compilata in debug e poi eseguita) e spariscono senza aggiungere overhead quando compiliamo in release. L’assert di default controlla un’esplessione booleana passata come argomento e se questa è false scrive sullo stderr l’espressione che ha fallito, il file e la riga dove è avvenuto l’errore e successivamente viene chiamato abort() per terminare il programma.

Bisogna cerca di capire quando va usata un’assert e quando invece bisogna usare un’altro sistema di gestione degli errori (ad esempio ritornare un’eccezione, un valore noto, etc etc….). Sostanzialmente va usata un’assert tutte quelle volte che bisogna controllare una condizione che sicuramente NON deve assolutamente verificarsi. Se questo non è vero, ad esempio se prevediamo un pointer che può essere nullo, dobbiamo usare altre strategie come le eccezioni o semplicemente ritornare un particolare valore… E’ preferibile l’uso di assert, quando possibile, poiché, come già detto, non aggiunge overhead nella release finale e questo è una grandissimo vantaggio.

Un caso emblematico si verifica, ad esempio, in una funzione che restituisce l’elemento i-esimo di un vettore. Se l’elemento i-esimo non esiste? Questa è una condizione che non si deve mai verificare e quindi il metodo è un buon candidato per l’aggiunta di un’asserzione che controlli la consistenza del parametro di input (appunto l’indice del vettore). In codice:

Da notare che molte volte possiamo fare a meno dell’assert…ad esempio immaginiamoci un metodo che prende un pointer come parametro e NON vogliamo assolutamente che sia NULL:

Ora mettere un assert per controllare T è semplicemente brutto perché basta usare un reference al posto del pointer per impedire il passaggio di un riferimento nullo (come sappiamo i reference non possono essere “nulli”).

Sfortunatamente le assert di default non sempre soddisfano tutte le necessità. Ad esempio si potrebbe voler specificare, oltre all’espressione, anche un testo che indichi a parole cosa “è andato storto” o mettere a disposizione delle assert senza condizione cioè “assert(void);” uno statement che porta alla terminazione del programma cioè in sostanza un ramo “morto” dove non saremmo mai dovuti entrare (anche se è uno stile alquanto discutibile ).

Ad ogni modo basta definirsi in modo adeguato il nostro sistema di macro. Un esempio può essere il seguente (poco leggibile sul blog, me ne scuso):

Per prima cosa viene controllato se siamo in debug o no (con la define _DEBUG). Se non siamo in debug le nostre definizione sono nulle, cioè non fanno niente [1] mentre in debug vengono definite.
Come potete vedere ho definito 3 tipi di assert [2]: std_assert, full_assert e fail_assert. La prima ha lo stesso comportamento dell’assert del C con la sola differenza che l’avvisso dell’errore viene scritto su stdout e non su stderr. La full_assert, oltre alla condizione prende anche un testo che serve per spiegare a parole umanamente comprensibili l’errore stesso dell’assert (per quale motivo è scattata). La fair_assert non ha condizione, scatta quando viene incontrata e serve per definire un percorso del codice “non consentito”. Tutte e tre al posto di abortire il programma terminano la fase di debug chiamando __debugbreak(); (questa è una call platform/compiler dipendent!)

Note: possiamo vedere un uso di ‘\’ a fine riga: servono per dichiarare una macro su più righe.
La macro __FILE__ viene rimpiazzata dal compilatore con il nome del file che sta processando, __LINE__ stessa cosa ma per il numero di riga.

Vediamo come usarle:

[1] Come in tutte le cose del C++, anche per questa ci sono mille teorie. L’assert di default in release è definita come ((void)0). In altre implementazioni ho visto sizeof(x) etc…io ho semplicemente definito la/le macro vuote e visualizzando l’assembly generato dal compilatore ho notato che non viene aggiunto nessun comando. Chi avesse maggiori informazioni su questo è il benvenuto.

[2] Avrei preferito avere un sola macro con 3 overload in base al numero di parametri passato ma questo nella definizione delle macro non è consentito.

Vi sono altre implementazioni di assert, come l’uso di funzioni inline al posto di macro, l’utilizzo, previa definizione, di opportune callbacks richiamate dall’assert, l’integrazione con il nostro sistema di log e così via….

Saluti!

ps non potevo lasciarvi senza qualche sano link:

Ottimo articolo di JP sulle nuove assert statiche del C++0x.
riferimenti:
http://cnicholson.net/2009/02/stupid-c-tricks-adventures-in-assert/
http://msinilo.pl/blog/?p=212