mware/text.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
   6  * This file is part of DevLib - See devlib/README for information.
   7  * -->
   8  *
   9  * \brief Text graphic routines (interface)
  10  *
  11  * \author Bernardo Innocenti <bernie@develer.com>
  12  * \author Stefano Fedrigo <aleph@develer.com>
  13  * \version $Id$
  14  */
  15
  16 /*#*
  17  *#* $Log$
  18  *#* Revision 1.9  2004/12/31 16:44:29  bernie
  19  *#* Sanitize for non-Harvard processors.
  20  *#*
  21  *#* Revision 1.8  2004/10/03 20:43:37  bernie
  22  *#* Import changes from project_ks.
  23  *#*
  24  *#* Revision 1.7  2004/09/20 03:28:49  bernie
  25  *#* Fix header; Conditionalize AVR-specific code.
  26  *#*
  27  *#* Revision 1.6  2004/09/14 20:57:30  bernie
  28  *#* Reformat.
  29  *#*
  30  *#* Revision 1.5  2004/09/06 21:51:26  bernie
  31  *#* Extend interface to allow any algorithmic style.
  32  *#*
  33  *#* Revision 1.4  2004/08/25 14:12:09  rasky
  34  *#* Aggiornato il comment block dei log RCS
  35  *#*
  36  *#* Revision 1.3  2004/08/05 18:46:44  bernie
  37  *#* Documentation improvements.
  38  *#*
  39  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  40  *#* Add dual-license information.
  41  *#*
  42  *#*/
  43
  44 #ifndef MWARE_TEXT_H
  45 #define MWARE_TEXT_H
  46
  47 #include <compiler.h>
  48 #include <macros.h> /* BV() */
  49 #include <cpu.h> /* CPU_HARVARD */
  50
  51 #include <stdarg.h>
  52
  53 /*!
  54  * \name Style flags
  55  * \see text_style()
  56  * \{
  57  */
  58 #define STYLEF_BOLD        BV(0)
  59 #define STYLEF_ITALIC      BV(1)
  60 #define STYLEF_UNDERLINE   BV(2)
  61 #define STYLEF_INVERT      BV(3)
  62 #define STYLEF_EXPANDED    BV(4)
  63 #define STYLEF_CONDENSED   BV(5)
  64 #define STYLEF_STRIKEOUT   BV(6)  /*<! Not implemented */
  65
  66 #define STYLEF_MASK \
  67         (STYLEF_BOLD | STYLEF_ITALIC | STYLEF_UNDERLINE | \
  68         STYLEF_EXPANDED | STYLEF_CONDENSED | STYLEF_INVERT)
  69 /*\}*/
  70
  71 /*!
  72  * \name Formatting flags for text rendering
  73  * \see text_xprintf()
  74  * \{
  75  */
  76 #define TEXT_NORMAL   0       /*!< Normal mode */
  77 #define TEXT_FILL     BV(7)   /*!< Fill rest of line with spaces */
  78 #define TEXT_CENTER   BV(8)   /*!< Center string in line */
  79 #define TEXT_RIGHT    BV(9)   /*!< Right aligned */
  80 /*\}*/
  81
  82 /*! Escape sequences codes */
  83 #define ANSI_ESC_CLEARSCREEN 'c'
  84
  85
  86 /* Fwd decl */
  87 struct Bitmap;
  88
  89 /* Low-level text functions (mware/text.c) */
  90 void text_moveto(struct Bitmap *bm, int row, int col);
  91 void text_setcoord(struct Bitmap *bm, int x, int y);
  92 int text_putchar(char c, struct Bitmap *bm);
  93 uint8_t text_style(uint8_t flags, uint8_t mask);
  94 void text_clear(struct Bitmap *bm);
  95 void text_clearLine(struct Bitmap *bm, int line);
  96
  97 /* Text formatting functions (mware/text_format.c) */
  98 int text_puts(const char *str, struct Bitmap *bm);
  99 int text_vprintf(struct Bitmap *bm, const char *fmt, va_list ap);
 100 int text_printf(struct Bitmap *bm, const char *fmt, ...) FORMAT(__printf__, 2, 3);
 101 int text_xprintf(struct Bitmap *bm, uint8_t row, uint8_t col, uint16_t mode, const char *fmt, ...) FORMAT(__printf__, 5, 6);
 102 int text_vwidthf(struct Bitmap *bm, const char * fmt, va_list ap);
 103 int text_widthf(struct Bitmap *bm, const char * fmt, ...) FORMAT(__printf__, 2, 3);
 104
 105 /* Text formatting functions for program-memory strings (mware/text_format.c) */
 106 #if CPU_HARVARD
 107 int text_puts_P(const char * PROGMEM str, struct Bitmap *bm);
 108 int text_vprintf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap);
 109 int text_printf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...) FORMAT(__printf__, 2, 3);
 110 int text_xprintf_P(struct Bitmap *bm, uint8_t row, uint8_t col, uint16_t mode, const char * PROGMEM fmt, ...) FORMAT(__printf__, 5, 6);
 111 int text_vwidthf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap);
 112 int text_widthf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...);
 113 #endif /* CPU_HARVARD */
 114
 115 #endif /* MWARE_TEXT_H */