debug.c

Go to the documentation of this file.

/*
 * debug.c
 *
 * Better debug log messages.
 *
 * (c) 2017 Simon Brooke <simon@journeyman.cc>
 * Licensed under GPL version 2.0, or, at your option, any later version.
 */
 
#include <ctype.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
/*
 * wide characters
 */
#include <wchar.h>
#include <wctype.h>
 
#include "memory/consspaceobject.h"
#include "debug.h"
#include "memory/dump.h"
#include "io/io.h"
#include "io/print.h"
 
/**
 * @brief the controlling flags for `debug_print`; set in `init.c`, q.v.
 *
 * Interpreted as a set o binary flags. The values are controlled by macros 
 * with names 'DEBUG_[A_Z]*' in `debug.h`, q.v.
 */
int verbosity = 0;
 
/**
 * When debugging, we want to see exceptions as they happen, because they may
 * not make their way back down the stack to whatever is expected to handle
 * them.
 */
void debug_print_exception( struct cons_pointer ex_ptr ) {
#ifdef DEBUG
    if ( ( verbosity != 0 ) && exceptionp( ex_ptr ) ) {
        fwide( stderr, 1 );
        fputws( L"EXCEPTION: ", stderr );
 
        URL_FILE *ustderr = file_to_url_file( stderr );
        fwide( stderr, 1 );
        print( ustderr, ex_ptr );
        free( ustderr );
    }
#endif
}
 
/**
 * @brief print this debug `message` to stderr, if `verbosity` matches `level`.
 *
 * `verbosity` is a set of flags, see debug_print.h; so you can
 * turn debugging on for only one part of the system.
 */
void debug_print( wchar_t *message, int level ) {
#ifdef DEBUG
    if ( level & verbosity ) {
        fwide( stderr, 1 );
        fputws( message, stderr );
    }
#endif
}
 
/**
 * @brief print a 128 bit integer value to stderr, if `verbosity` matches `level`.
 *
 * `verbosity` is a set of flags, see debug_print.h; so you can
 * turn debugging on for only one part of the system.
 *
 * stolen from https://stackoverflow.com/questions/11656241/how-to-print-uint128-t-number-using-gcc
 */
void debug_print_128bit( __int128_t n, int level ) {
#ifdef DEBUG
    if ( level & verbosity ) {
        if ( n == 0 ) {
            fwprintf( stderr, L"0" );
        } else {
            char str[40] = { 0 }; // log10(1 << 128) + '\0'
            char *s = str + sizeof( str ) - 1;  // start at the end
            while ( n != 0 ) {
                if ( s == str )
                    return;     // never happens
 
                *--s = "0123456789"[n % 10];  // save last digit
                n /= 10;        // drop it
            }
            fwprintf( stderr, L"%s", s );
        }
    }
#endif
}
 
/**
 * @brief print a line feed to stderr, if `verbosity` matches `level`.
 *
 * `verbosity` is a set of flags, see debug_print.h; so you can
 * turn debugging on for only one part of the system.
 */
void debug_println( int level ) {
#ifdef DEBUG
    if ( level & verbosity ) {
        fwide( stderr, 1 );
        fputws( L"\n", stderr );
    }
#endif
}
 
 
/**
 * @brief `wprintf` adapted for the debug logging system. 
 *
 * Print to stderr only if `verbosity` matches `level`. All other arguments
 * as for `wprintf`.
 */
void debug_printf( int level, wchar_t *format, ... ) {
#ifdef DEBUG
    if ( level & verbosity ) {
        fwide( stderr, 1 );
        va_list( args );
        va_start( args, format );
        vfwprintf( stderr, format, args );
    }
#endif
}
 
/**
 * @brief print the object indicated by this `pointer` to stderr, if `verbosity`
 * matches `level`.
 *
 * `verbosity` is a set of flags, see debug_print.h; so you can
 * turn debugging on for only one part of the system.
 */
void debug_print_object( struct cons_pointer pointer, int level ) {
#ifdef DEBUG
    if ( level & verbosity ) {
        URL_FILE *ustderr = file_to_url_file( stderr );
        fwide( stderr, 1 );
        print( ustderr, pointer );
        free( ustderr );
    }
#endif
}
 
/**
 * @brief Like `dump_object`, q.v., but protected by the verbosity mechanism.
 *
 * `verbosity` is a set of flags, see debug_print.h; so you can
 * turn debugging on for only one part of the system.
 */
void debug_dump_object( struct cons_pointer pointer, int level ) {
#ifdef DEBUG
    if ( level & verbosity ) {
        URL_FILE *ustderr = file_to_url_file( stderr );
        fwide( stderr, 1 );
        dump_object( ustderr, pointer );
        free( ustderr );
    }
#endif
}
 
/**
 * Standardise printing of binding trace messages.
 */
void debug_print_binding( struct cons_pointer key, struct cons_pointer val,
                          bool deep, int level ) {
#ifdef DEBUG
    // wchar_t * depth = (deep ? L"Deep" : L"Shallow");
 
    debug_print( ( deep ? L"Deep" : L"Shallow" ), level );
    debug_print( L" binding `", level );
    debug_print_object( key, level );
    debug_print( L"` to `", level );
    debug_print_object( val, level );
    debug_print( L"`\n", level );
#endif
}