Doc fixes.

[bertos.git] / gfx / font.h

diff --git a/gfx/font.h b/gfx/font.h
old mode 100755 (executable)
new mode 100644 (file)
index 1f5d278..b62b0b7
--- a/gfx/font.h
+++ b/gfx/font.h
@@ -1,8 +1,33 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \version $Id$
@@ -14,6 +39,21 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.7  2006/07/19 12:56:26  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.6  2006/05/27 22:31:34  bernie
+ *#* Switch to a smaller default fount.
+ *#*
+ *#* Revision 1.5  2006/03/13 02:06:04  bernie
+ *#* FONT_HAS_GLYPH(): New macro.
+ *#*
+ *#* Revision 1.4  2006/02/15 09:10:15  bernie
+ *#* Implement prop fonts; Fix algo styles.
+ *#*
+ *#* Revision 1.3  2006/02/10 12:29:05  bernie
+ *#* Add multiple font support in bitmaps.
+ *#*
  *#* Revision 1.2  2005/11/04 18:17:45  bernie
  *#* Fix header guards and includes for new location of gfx module.
  *#*
@@ -51,15 +91,35 @@
 #include <cfg/compiler.h> /* uint8_t */
 #include <mware/pgm.h> /* PROGMEM */
 
-/*!
- * \name Font size (in pixel)
- * \{
- */
-#define FONT_WIDTH   6
-#define FONT_HEIGHT  8
-/* \} */
+typedef struct Font
+{
+       /**
+        * Pointer to glyph data.
+        *
+        * Data is an array of at most 256 glyphs packed together.
+        * Raster format must be the same of the bitmap.
+        */
+       const PROGMEM uint8_t *glyph;
+
+       uint8_t width;     /**< Pixel width of character cell. */
+       uint8_t height;    /**< Pixel height of character cell. */
+
+       uint8_t first;     /**< First encoded character in glyph array. */
+       uint8_t last;      /**< Last encoded character in glyph array (inclusive). */
+
+       /** Array of glyph offsets in bytes. NULL for fixed-width fonts. */
+       const PROGMEM uint16_t *offset;
+       const PROGMEM uint8_t *widths;
+
+} Font;
+
+
+/** Return true if glyph \a c is available in \a font. */
+#define FONT_HAS_GLYPH(font, c) ((c) >= (font)->first && (c) <= (font)->last)
+
 
-/*! Font table. */
-extern const PROGMEM uint8_t font[256 * FONT_WIDTH];
+/** The default font. */
+#define default_font font_luBS14
+extern const struct Font default_font;
 
 #endif /* GFX_FONT_H */