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