gfx/text.h

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