mware/text.h

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