mware/text.h

   1 /*!
   2  * \file
   3  * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
   4  * Copyright 2003,2004 Develer S.r.l. (http://www.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.3  2004/08/05 18:46:44  bernie
  18  * Documentation improvements.
  19  *
  20  * Revision 1.2  2004/06/03 11:27:09  bernie
  21  * Add dual-license information.
  22  *
  23  */
  24
  25 #ifndef TEXT_H
  26 #define TEXT_H
  27
  28 #include "compiler.h"
  29 #include <stdarg.h>
  30
  31 /*!
  32  * \name Style flags
  33  * \see text_style()
  34  * \{
  35  */
  36 #define STYLEF_BOLD        BV(0)
  37 #define STYLEF_ITALIC      BV(1)
  38 #define STYLEF_UNDERLINE   BV(2)
  39 #define STYLEF_INVERT      BV(3)
  40 #define STYLEF_EXPANDED    BV(4)
  41 #define STYLEF_CONDENSED   BV(5)
  42 #define STYLEF_STRIKEOUT   BV(6)  /*<! Not implemented */
  43
  44 #define STYLEF_MASK \
  45         (STYLEF_BOLD | STYLEF_ITALIC | STYLEF_UNDERLINE | \
  46         STYLEF_EXPANDED | STYLEF_CONDENSED | STYLEF_INVERT)
  47 /*\}*/
  48
  49 /*!
  50  * \name Formatting flags for text rendering
  51  * \see text_xprintf()
  52  * \{
  53  */
  54 #define TEXT_NORMAL   0       /*!< Normal mode */
  55 #define TEXT_FILL     BV(0)   /*!< Fill rest of line with spaces */
  56 #define TEXT_CENTER   BV(1)   /*!< Center string in line */
  57 #define TEXT_INVERT   BV(2)   /*!< Inverted mode */
  58 #define TEXT_RIGHT    BV(3)   /*!< Right aligned */
  59 /*\}*/
  60
  61 /*! Escape sequences codes */
  62 #define ANSI_ESC_CLEARSCREEN 'c'
  63
  64
  65
  66 /* Fwd decl */
  67 struct Bitmap;
  68
  69 void text_moveto(struct Bitmap *bm, int row, int col);
  70 void text_setcoord(struct Bitmap *bm, int x, int y);
  71 int text_putchar(char c, struct Bitmap *bm);
  72 int text_puts(const char *str, struct Bitmap *bm);
  73 int text_vprintf(struct Bitmap *bm, const char *fmt, va_list ap);
  74 int text_printf(struct Bitmap *bm, const char *fmt, ...) FORMAT(__printf__, 2, 3);
  75 int text_xprintf(struct Bitmap *bm, uint8_t row, uint8_t col, uint8_t mode, const char *fmt, ...) FORMAT(__printf__, 5, 6);
  76 uint8_t text_style(uint8_t flags, uint8_t mask);
  77 void text_clear(struct Bitmap *bm);
  78
  79 int text_puts_P(const char * PROGMEM str, struct Bitmap *bm);
  80 int text_vprintf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap);
  81 int text_printf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...) FORMAT(__printf__, 2, 3);
  82 int text_xprintf_P(struct Bitmap *bm, uint8_t row, uint8_t col, uint8_t mode, const char * PROGMEM fmt, ...) FORMAT(__printf__, 5, 6);
  83
  84 #endif /* TEXT_H */