console.h

Go to the documentation of this file.

 
// *****************************************************************************
//
//  Includes
//
// *****************************************************************************
 
#include "config.h"
 
#if (MODULE_CONSOLE != 0)
 
#include "types.h"
#include "string.h"
#include "maths.h"
#include "dma.h"
 
#pragma once
 
// *****************************************************************************
//
//  Defines
//
// *****************************************************************************

#define ENABLE_ASSERT_CHECKS
 
// *****************************************************************************
//
//  Types
//
// *****************************************************************************

typedef int (*vsprintf_t)(char *buf, const char *fmt, va_list args);
typedef int (*vsnprintf_t)(char *buf, int count, const char *fmt, va_list args);
 
// *****************************************************************************
//
//  Macros
//
// *****************************************************************************

#define str(s) xstr(s)
#define xstr(s) #s

 
#if defined(ENABLE_ASSERT_CHECKS) && !defined(NDEBUG)
#define assert(condition)                                                              \
    if ( !(condition) )                                                                \
    {                                                                                  \
        CON_reset();                                                                   \
        CON_systemResetOnNextWrite();                                                  \
        CON_write(__FILE__":"str(__LINE__)": Assertion \'"str(condition)"\' failed."); \
        while (TRUE);                                                                  \
    }
#else
#define assert(condition)
#endif

 
#define ASSERT(condition) assert(condition)
 
// *****************************************************************************
//
//  Function Declarations
//
// *****************************************************************************
 
// -----------------------------------------------------------------------------
// printf functions
// -----------------------------------------------------------------------------

 
int CON_sprintf(char* buf, const char *fmt, ...)  __attribute__ ((format (printf, 2, 3)));

 
int CON_snprintf(char* buf, int count, const char *fmt, ...)  __attribute__ ((format (printf, 3, 4)));

 
void CON_setVsprintf(vsprintf_t vsprintf_func);

 
void CON_setVsnprintf(vsnprintf_t vsnprintf_func);
 
// -----------------------------------------------------------------------------
// Console setup
// -----------------------------------------------------------------------------

 
void CON_setConsoleSize(u16 left, u16 top, u16 width, u16 height);

 
void CON_setLineBufferSize(u16 size);

 
void CON_setTransferMethod(TransferMethod tm);

 
void CON_reset();

 
void CON_systemResetOnNextWrite();
 
// -----------------------------------------------------------------------------
// Console write functions
// -----------------------------------------------------------------------------

 
void CON_clear();

 
void CON_setCursorPosition(u16 x, u16 y);

 
V2u16 CON_getCursorPosition();

 
int CON_write(const char *fmt, ...)  __attribute__ ((format (printf, 1, 2)));
 
#endif // MODULE_CONSOLE