replaced preprocessor constants with enum values
[rocksndiamonds.git] / src / libgame / text.h
index d5a12ecd8f608131c32ba85792703c62df6a351e..701213f66ae58b04b389e729026afcd2b7668b40 100644 (file)
@@ -1,15 +1,13 @@
-/***********************************************************
-* Artsoft Retro-Game Library                               *
-*----------------------------------------------------------*
-* (c) 1994-2002 Artsoft Entertainment                      *
-*               Holger Schemel                             *
-*               Detmolder Strasse 189                      *
-*               33604 Bielefeld                            *
-*               Germany                                    *
-*               e-mail: info@artsoft.org                   *
-*----------------------------------------------------------*
-* text.h                                                   *
-***********************************************************/
+// ============================================================================
+// Artsoft Retro-Game Library
+// ----------------------------------------------------------------------------
+// (c) 1995-2014 by Artsoft Entertainment
+//                         Holger Schemel
+//                 info@artsoft.org
+//                 http://www.artsoft.org/
+// ----------------------------------------------------------------------------
+// text.h
+// ============================================================================
 
 #ifndef TEXT_H
 #define TEXT_H
 #include "system.h"
 
 
-/* default fonts */
-#define FONT_INITIAL_1         0
-#define FONT_INITIAL_2         1
-#define FONT_INITIAL_3         2
-#define FONT_INITIAL_4         3
+// default fonts
+#define MAIN_FONT_INITIAL_1    0
+#define MAIN_FONT_INITIAL_2    1
+#define MAIN_FONT_INITIAL_3    2
+#define MAIN_FONT_INITIAL_4    3
 
-/* font colors */
-#define FC_RED                 FONT_INITIAL_1
-#define FC_BLUE                        FONT_INITIAL_2
-#define FC_GREEN               FONT_INITIAL_3
-#define FC_YELLOW              FONT_INITIAL_4
+// font colors
+#define FC_RED                 MAIN_FONT_INITIAL_1
+#define FC_BLUE                        MAIN_FONT_INITIAL_2
+#define FC_GREEN               MAIN_FONT_INITIAL_3
+#define FC_YELLOW              MAIN_FONT_INITIAL_4
 
-#define FONT_CHARS_PER_LINE    16
-#define FONT_LINES_PER_FONT    4
+// text output definitions
+#define MAX_OUTPUT_LINESIZE    1024
 
-#define FONT_OPAQUE            0
-#define FONT_MASKED            1
+// special constants for old ISO-8859-1 character byte values
+#define CHAR_BYTE_UMLAUT_A     ((char)0xc4)
+#define CHAR_BYTE_UMLAUT_O     ((char)0xd6)
+#define CHAR_BYTE_UMLAUT_U     ((char)0xdc)
+#define CHAR_BYTE_UMLAUT_a     ((char)0xe4)
+#define CHAR_BYTE_UMLAUT_o     ((char)0xf6)
+#define CHAR_BYTE_UMLAUT_u     ((char)0xfc)
+#define CHAR_BYTE_SHARP_S      ((char)0xdf)
+#define CHAR_BYTE_COPYRIGHT    ((char)0xa9)
+#define CHAR_BYTE_REGISTERED   ((char)0xae)
+#define CHAR_BYTE_DEGREE       ((char)0xb0)
+#define CHAR_BYTE_CURSOR       ((char)0xa0)
 
-/* text output definitions */
-#define MAX_OUTPUT_LINESIZE    1024
+// special character mapping for default fonts
+#define FONT_ASCII_CURSOR      ((char)160)
+#define FONT_ASCII_BUTTON      ((char)128)
+#define FONT_ASCII_UP          ((char)129)
+#define FONT_ASCII_DOWN                ((char)130)
+#define FONT_ASCII_LEFT                ((char)'<')
+#define FONT_ASCII_RIGHT       ((char)'>')
+
+#define MAP_FONT_ASCII(c)      ((c) >= 'a' && (c) <= 'z' ? 'A' + (c) - 'a' : \
+                                (c) == CHAR_BYTE_COPYRIGHT  ?  96 :    \
+                                (c) == CHAR_BYTE_UMLAUT_a   ?  97 :    \
+                                (c) == CHAR_BYTE_UMLAUT_A   ?  97 :    \
+                                (c) == CHAR_BYTE_UMLAUT_o   ?  98 :    \
+                                (c) == CHAR_BYTE_UMLAUT_O   ?  98 :    \
+                                (c) == CHAR_BYTE_UMLAUT_u   ?  99 :    \
+                                (c) == CHAR_BYTE_UMLAUT_U   ?  99 :    \
+                                (c) == CHAR_BYTE_DEGREE     ? 100 :    \
+                                (c) == CHAR_BYTE_REGISTERED ? 101 :    \
+                                (c) == FONT_ASCII_CURSOR    ? 102 :    \
+                                (c) == FONT_ASCII_BUTTON    ? 109 :    \
+                                (c) == FONT_ASCII_UP        ? 110 :    \
+                                (c) == FONT_ASCII_DOWN      ? 111 :    \
+                                (c))
 
-/* font structure definitions */
+// 64 regular ordered ASCII characters, 6 special characters, 1 cursor char.
+#define MIN_NUM_CHARS_PER_FONT                 64
+#define DEFAULT_NUM_CHARS_PER_FONT             (MIN_NUM_CHARS_PER_FONT + 6 +1)
+#define DEFAULT_NUM_CHARS_PER_LINE             16
+
+
+// font structure definitions
 
 void InitFontInfo(struct FontBitmapInfo *, int,
-                 int (*select_font_function)(int));
+                 int (*function1)(int), int (*function2)(char *));
+void FreeFontInfo(struct FontBitmapInfo *);
+
+struct FontBitmapInfo *getFontBitmapInfo(int);
+
 int getFontWidth(int);
 int getFontHeight(int);
+int getFontDrawOffsetX(int);
+int getFontDrawOffsetY(int);
+int getTextWidth(char *, int);
+
+void getFontCharSource(int, char, Bitmap **, int *, int *);
+
+int maxWordLengthInRequestString(char *);
+
 void DrawInitText(char *, int, int);
+
 void DrawTextF(int, int, int, char *, ...);
 void DrawTextFCentered(int, int, char *, ...);
+void DrawTextS(int, int, int, char *);
+void DrawTextSCentered(int, int, char *);
+void DrawTextSAligned(int, int, char *, int, int);
+void DrawTextAligned(int, int, char *, int, int);
 void DrawText(int, int, char *, int);
 void DrawTextExt(DrawBuffer *, int, int, char *, int, int);
 
-#endif /* TEXT_H */
+char *GetTextBufferFromFile(char *, int);
+int DrawTextBuffer(int, int, char *, int, int, int, int, int, int,
+                  boolean, boolean, boolean);
+int DrawTextBufferVA(int, int, char *, va_list, int, int, int, int, int, int,
+                    boolean, boolean, boolean);
+int DrawTextFile(int, int, char *, int, int, int, int, int, int,
+                boolean, boolean, boolean);
+
+#endif // TEXT_H