2017-01-14 19:53:20 +00:00
|
|
|
#ifndef GUARD_TEXT_H
|
|
|
|
|
#define GUARD_TEXT_H
|
|
|
|
|
|
|
|
|
|
#define CHAR_SPACE 0x00
|
2018-07-07 12:24:19 +00:00
|
|
|
#define CHAR_PLUS 0x2E
|
2017-09-06 15:19:08 +00:00
|
|
|
#define CHAR_0 0xA1
|
2018-07-07 12:24:19 +00:00
|
|
|
#define CHAR_1 0xA2
|
|
|
|
|
#define CHAR_2 0xA3
|
|
|
|
|
#define CHAR_3 0xA4
|
|
|
|
|
#define CHAR_4 0xA5
|
|
|
|
|
#define CHAR_5 0xA6
|
|
|
|
|
#define CHAR_6 0xA7
|
|
|
|
|
#define CHAR_7 0xA8
|
|
|
|
|
#define CHAR_8 0xA9
|
|
|
|
|
#define CHAR_9 0xAA
|
2019-01-28 17:13:07 +00:00
|
|
|
#define CHAR_EXCL_MARK 0xAB
|
2017-01-14 19:53:20 +00:00
|
|
|
#define CHAR_QUESTION_MARK 0xAC
|
2017-09-06 15:19:08 +00:00
|
|
|
#define CHAR_PERIOD 0xAD
|
2017-01-14 19:53:20 +00:00
|
|
|
#define CHAR_HYPHEN 0xAE
|
2017-09-06 15:19:08 +00:00
|
|
|
#define CHAR_ELLIPSIS 0xB0
|
2019-01-28 18:02:34 +00:00
|
|
|
#define CHAR_DBL_QUOT_LEFT 0xB1
|
|
|
|
|
#define CHAR_DBL_QUOT_RIGHT 0xB2
|
|
|
|
|
#define CHAR_SGL_QUOT_LEFT 0xB3
|
|
|
|
|
#define CHAR_SGL_QUOT_RIGHT 0xB4
|
2017-09-06 15:19:08 +00:00
|
|
|
#define CHAR_MALE 0xB5
|
|
|
|
|
#define CHAR_FEMALE 0xB6
|
2017-01-14 19:53:20 +00:00
|
|
|
#define CHAR_CURRENCY 0xB7
|
2017-09-06 15:19:08 +00:00
|
|
|
#define CHAR_COMMA 0xB8
|
|
|
|
|
#define CHAR_MULT_SIGN 0xB9
|
|
|
|
|
#define CHAR_SLASH 0xBA
|
|
|
|
|
#define CHAR_A 0xBB
|
|
|
|
|
#define CHAR_B 0xBC
|
|
|
|
|
#define CHAR_C 0xBD
|
|
|
|
|
#define CHAR_D 0xBE
|
|
|
|
|
#define CHAR_E 0xBF
|
|
|
|
|
#define CHAR_F 0xC0
|
|
|
|
|
#define CHAR_G 0xC1
|
|
|
|
|
#define CHAR_H 0xC2
|
|
|
|
|
#define CHAR_I 0xC3
|
|
|
|
|
#define CHAR_J 0xC4
|
|
|
|
|
#define CHAR_K 0xC5
|
|
|
|
|
#define CHAR_L 0xC6
|
|
|
|
|
#define CHAR_M 0xC7
|
|
|
|
|
#define CHAR_N 0xC8
|
|
|
|
|
#define CHAR_O 0xC9
|
|
|
|
|
#define CHAR_P 0xCA
|
|
|
|
|
#define CHAR_Q 0xCB
|
|
|
|
|
#define CHAR_R 0xCC
|
|
|
|
|
#define CHAR_S 0xCD
|
|
|
|
|
#define CHAR_T 0xCE
|
|
|
|
|
#define CHAR_U 0xCF
|
|
|
|
|
#define CHAR_V 0xD0
|
|
|
|
|
#define CHAR_W 0xD1
|
|
|
|
|
#define CHAR_X 0xD2
|
|
|
|
|
#define CHAR_Y 0xD3
|
|
|
|
|
#define CHAR_Z 0xD4
|
|
|
|
|
#define CHAR_a 0xD5
|
|
|
|
|
#define CHAR_b 0xD6
|
|
|
|
|
#define CHAR_c 0xD7
|
|
|
|
|
#define CHAR_d 0xD8
|
|
|
|
|
#define CHAR_e 0xD9
|
|
|
|
|
#define CHAR_f 0xDA
|
|
|
|
|
#define CHAR_g 0xDB
|
|
|
|
|
#define CHAR_h 0xDC
|
|
|
|
|
#define CHAR_i 0xDD
|
|
|
|
|
#define CHAR_j 0xDE
|
|
|
|
|
#define CHAR_k 0xDF
|
|
|
|
|
#define CHAR_l 0xE0
|
|
|
|
|
#define CHAR_m 0xE1
|
|
|
|
|
#define CHAR_n 0xE2
|
|
|
|
|
#define CHAR_o 0xE3
|
|
|
|
|
#define CHAR_p 0xE4
|
|
|
|
|
#define CHAR_q 0xE5
|
|
|
|
|
#define CHAR_r 0xE6
|
|
|
|
|
#define CHAR_s 0xE7
|
|
|
|
|
#define CHAR_t 0xE8
|
|
|
|
|
#define CHAR_u 0xE9
|
|
|
|
|
#define CHAR_v 0xEA
|
|
|
|
|
#define CHAR_w 0xEB
|
|
|
|
|
#define CHAR_x 0xEC
|
|
|
|
|
#define CHAR_y 0xED
|
|
|
|
|
#define CHAR_z 0xEE
|
2017-11-23 18:29:11 +00:00
|
|
|
#define CHAR_SPECIAL_F7 0xF7
|
2018-10-14 13:04:25 +00:00
|
|
|
#define CHAR_SPECIAL_F8 0xF8
|
2017-09-26 20:39:59 +00:00
|
|
|
#define CHAR_SPECIAL_F9 0xF9
|
2017-01-14 19:53:20 +00:00
|
|
|
#define CHAR_COLON 0xF0
|
2017-09-06 15:19:08 +00:00
|
|
|
#define CHAR_PROMPT_SCROLL 0xFA // waits for button press and scrolls dialog
|
|
|
|
|
#define CHAR_PROMPT_CLEAR 0xFB // waits for button press and clears dialog
|
2017-01-14 19:53:20 +00:00
|
|
|
#define EXT_CTRL_CODE_BEGIN 0xFC // extended control code
|
|
|
|
|
#define PLACEHOLDER_BEGIN 0xFD // string placeholder
|
|
|
|
|
#define CHAR_NEWLINE 0xFE
|
2017-09-24 22:09:13 +00:00
|
|
|
#define EOS 0xFF // end of string
|
|
|
|
|
|
2018-02-07 02:37:54 +00:00
|
|
|
#define EXT_CTRL_CODE_COLOR 0x1
|
|
|
|
|
#define EXT_CTRL_CODE_HIGHLIGHT 0x2
|
|
|
|
|
#define EXT_CTRL_CODE_SHADOW 0x3
|
2018-11-27 23:21:23 +00:00
|
|
|
//
|
|
|
|
|
#define EXT_CTRL_CODE_UNKNOWN_7 0x7
|
|
|
|
|
//
|
|
|
|
|
#define EXT_CTRL_CODE_CLEAR 0x11
|
|
|
|
|
//
|
|
|
|
|
#define EXT_CTRL_CODE_JPN 0x15
|
|
|
|
|
#define EXT_CTRL_CODE_ENG 0x16
|
2018-02-07 02:37:54 +00:00
|
|
|
|
2017-09-26 20:39:59 +00:00
|
|
|
#define TEXT_COLOR_TRANSPARENT 0x0
|
|
|
|
|
#define TEXT_COLOR_WHITE 0x1
|
|
|
|
|
#define TEXT_COLOR_DARK_GREY 0x2
|
2018-03-27 22:33:08 +00:00
|
|
|
// 0x3
|
|
|
|
|
#define TEXT_COLOR_RED 0x4
|
|
|
|
|
// 0x5
|
|
|
|
|
#define TEXT_COLOR_GREEN 0x6
|
|
|
|
|
// 0x7
|
|
|
|
|
#define TEXT_COLOR_BLUE 0x8
|
2017-09-26 20:39:59 +00:00
|
|
|
|
2017-09-24 22:09:13 +00:00
|
|
|
// battle placeholders are located in battle_message.h
|
2017-09-06 15:19:08 +00:00
|
|
|
|
2017-03-07 13:44:41 +00:00
|
|
|
#define NUM_TEXT_PRINTERS 32
|
|
|
|
|
|
2017-11-19 21:48:46 +00:00
|
|
|
#define TEXT_SPEED_FF 0xFF
|
|
|
|
|
|
2018-11-21 20:58:35 +00:00
|
|
|
enum
|
|
|
|
|
{
|
2018-07-15 11:23:38 +00:00
|
|
|
FONTATTR_MAX_LETTER_WIDTH,
|
|
|
|
|
FONTATTR_MAX_LETTER_HEIGHT,
|
|
|
|
|
FONTATTR_LETTER_SPACING,
|
|
|
|
|
FONTATTR_LINE_SPACING,
|
2018-11-06 17:30:21 +00:00
|
|
|
FONTATTR_UNKNOWN, // dunno what this is yet
|
2018-07-15 11:23:38 +00:00
|
|
|
FONTATTR_COLOR_FOREGROUND,
|
|
|
|
|
FONTATTR_COLOR_BACKGROUND,
|
|
|
|
|
FONTATTR_COLOR_SHADOW
|
|
|
|
|
};
|
|
|
|
|
|
2018-11-05 20:42:12 +00:00
|
|
|
struct TextPrinterSubStruct
|
2017-09-22 03:43:13 +00:00
|
|
|
{
|
2018-11-06 16:44:48 +00:00
|
|
|
u8 glyphId:4; // 0x14
|
|
|
|
|
bool8 hasPrintBeenSpedUp:1;
|
2018-11-06 17:30:21 +00:00
|
|
|
u8 unk:3;
|
2018-11-06 16:44:48 +00:00
|
|
|
u8 downArrowDelay:5;
|
|
|
|
|
u8 downArrowYPosIdx:2;
|
|
|
|
|
bool8 hasGlyphIdBeenSet:1;
|
2018-11-06 17:30:21 +00:00
|
|
|
u8 autoScrollDelay;
|
2017-09-22 03:43:13 +00:00
|
|
|
};
|
|
|
|
|
|
2018-11-06 16:44:48 +00:00
|
|
|
struct TextPrinterTemplate
|
2017-09-26 20:39:59 +00:00
|
|
|
{
|
2018-11-06 16:44:48 +00:00
|
|
|
const u8* currentChar;
|
2017-09-23 01:26:37 +00:00
|
|
|
u8 windowId;
|
|
|
|
|
u8 fontId;
|
|
|
|
|
u8 x;
|
|
|
|
|
u8 y;
|
|
|
|
|
u8 currentX; // 0x8
|
|
|
|
|
u8 currentY;
|
|
|
|
|
u8 letterSpacing;
|
|
|
|
|
u8 lineSpacing;
|
2018-11-06 17:30:21 +00:00
|
|
|
u8 unk:4; // 0xC
|
2018-01-25 21:25:35 +00:00
|
|
|
u8 fgColor:4;
|
2017-09-23 01:26:37 +00:00
|
|
|
u8 bgColor:4;
|
|
|
|
|
u8 shadowColor:4;
|
|
|
|
|
};
|
|
|
|
|
|
2017-03-07 13:44:41 +00:00
|
|
|
struct TextPrinter
|
|
|
|
|
{
|
2018-11-06 16:44:48 +00:00
|
|
|
struct TextPrinterTemplate printerTemplate;
|
2017-09-06 15:19:08 +00:00
|
|
|
|
2018-11-06 16:44:48 +00:00
|
|
|
void (*callback)(struct TextPrinterTemplate *, u16); // 0x10
|
2017-09-06 15:19:08 +00:00
|
|
|
|
2018-11-05 20:42:12 +00:00
|
|
|
union __attribute__((packed)) {
|
2017-09-22 03:43:13 +00:00
|
|
|
struct TextPrinterSubStruct sub;
|
2018-11-06 17:30:21 +00:00
|
|
|
u8 fields[7];
|
|
|
|
|
} subUnion;
|
2017-09-06 15:19:08 +00:00
|
|
|
|
2018-11-05 20:42:12 +00:00
|
|
|
u8 active;
|
2017-03-07 13:44:41 +00:00
|
|
|
u8 state; // 0x1C
|
2018-11-05 20:42:12 +00:00
|
|
|
u8 textSpeed;
|
2017-03-07 13:44:41 +00:00
|
|
|
u8 delayCounter;
|
|
|
|
|
u8 scrollDistance;
|
|
|
|
|
u8 minLetterSpacing; // 0x20
|
|
|
|
|
u8 japanese;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct FontInfo
|
|
|
|
|
{
|
|
|
|
|
u16 (*fontFunction)(struct TextPrinter *x);
|
|
|
|
|
u8 maxLetterWidth;
|
|
|
|
|
u8 maxLetterHeight;
|
|
|
|
|
u8 letterSpacing;
|
|
|
|
|
u8 lineSpacing;
|
2018-11-06 17:30:21 +00:00
|
|
|
u8 unk:4;
|
2018-01-25 21:25:35 +00:00
|
|
|
u8 fgColor:4;
|
2017-03-07 13:44:41 +00:00
|
|
|
u8 bgColor:4;
|
|
|
|
|
u8 shadowColor:4;
|
|
|
|
|
};
|
|
|
|
|
|
2017-09-22 03:43:13 +00:00
|
|
|
extern const struct FontInfo *gFonts;
|
|
|
|
|
|
2017-09-18 21:48:47 +00:00
|
|
|
struct GlyphWidthFunc
|
|
|
|
|
{
|
2018-11-06 17:30:21 +00:00
|
|
|
u32 fontId;
|
2017-03-28 00:30:49 +00:00
|
|
|
u32 (*func)(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
};
|
|
|
|
|
|
2017-09-18 21:48:47 +00:00
|
|
|
struct KeypadIcon
|
|
|
|
|
{
|
2018-11-06 17:30:21 +00:00
|
|
|
u16 tileOffset;
|
2017-03-28 00:30:49 +00:00
|
|
|
u8 width;
|
|
|
|
|
u8 height;
|
|
|
|
|
};
|
|
|
|
|
|
2017-09-22 03:43:13 +00:00
|
|
|
typedef struct {
|
2018-11-06 17:30:21 +00:00
|
|
|
bool8 canABSpeedUpPrint:1;
|
|
|
|
|
bool8 useAlternateDownArrow:1;
|
|
|
|
|
bool8 autoScroll:1;
|
|
|
|
|
bool8 forceMidTextSpeed:1;
|
2017-09-22 03:43:13 +00:00
|
|
|
} TextFlags;
|
|
|
|
|
|
2018-11-05 20:42:12 +00:00
|
|
|
struct Struct_03002F90
|
|
|
|
|
{
|
2018-11-21 20:58:35 +00:00
|
|
|
u32 unk0[8];
|
|
|
|
|
u32 unk20[8];
|
|
|
|
|
u32 unk40[8];
|
|
|
|
|
u32 unk60[8];
|
2018-11-05 20:42:12 +00:00
|
|
|
u8 unk80;
|
|
|
|
|
u8 unk81;
|
|
|
|
|
};
|
|
|
|
|
|
2017-09-22 03:43:13 +00:00
|
|
|
extern TextFlags gTextFlags;
|
|
|
|
|
|
2018-11-05 20:42:12 +00:00
|
|
|
extern u8 gUnknown_03002F84;
|
|
|
|
|
extern struct Struct_03002F90 gUnknown_03002F90;
|
2017-09-22 03:43:13 +00:00
|
|
|
|
2017-03-28 04:20:55 +00:00
|
|
|
void SetFontsPointer(const struct FontInfo *fonts);
|
2017-09-18 16:36:05 +00:00
|
|
|
void DeactivateAllTextPrinters(void);
|
2018-11-06 16:44:48 +00:00
|
|
|
u16 AddTextPrinterParameterized(u8 windowId, u8 fontId, const u8 *str, u8 x, u8 y, u8 speed, void (*callback)(struct TextPrinterTemplate *, u16));
|
|
|
|
|
bool16 AddTextPrinter(struct TextPrinterTemplate *template, u8 speed, void (*callback)(struct TextPrinterTemplate *, u16));
|
2017-03-28 04:20:55 +00:00
|
|
|
void RunTextPrinters(void);
|
2017-09-18 21:48:47 +00:00
|
|
|
bool16 IsTextPrinterActive(u8 id);
|
2017-03-28 04:20:55 +00:00
|
|
|
u32 RenderFont(struct TextPrinter *textPrinter);
|
|
|
|
|
void GenerateFontHalfRowLookupTable(u8 fgColor, u8 bgColor, u8 shadowColor);
|
|
|
|
|
void SaveTextColors(u8 *fgColor, u8 *bgColor, u8 *shadowColor);
|
|
|
|
|
void RestoreTextColors(u8 *fgColor, u8 *bgColor, u8 *shadowColor);
|
2018-11-21 22:30:04 +00:00
|
|
|
void DecompressGlyphTile(const void *src_, void *dest_);
|
2017-03-28 04:20:55 +00:00
|
|
|
u8 GetLastTextColor(u8 colorType);
|
|
|
|
|
void CopyGlyphToWindow(struct TextPrinter *x);
|
|
|
|
|
void ClearTextSpan(struct TextPrinter *textPrinter, u32 width);
|
2018-02-09 02:00:28 +00:00
|
|
|
u8 GetMenuCursorDimensionByFont(u8, u8);
|
2017-03-28 04:20:55 +00:00
|
|
|
|
|
|
|
|
u16 Font0Func(struct TextPrinter *textPrinter);
|
|
|
|
|
u16 Font1Func(struct TextPrinter *textPrinter);
|
|
|
|
|
u16 Font2Func(struct TextPrinter *textPrinter);
|
|
|
|
|
u16 Font3Func(struct TextPrinter *textPrinter);
|
|
|
|
|
u16 Font4Func(struct TextPrinter *textPrinter);
|
|
|
|
|
u16 Font5Func(struct TextPrinter *textPrinter);
|
|
|
|
|
u16 Font7Func(struct TextPrinter *textPrinter);
|
|
|
|
|
u16 Font8Func(struct TextPrinter *textPrinter);
|
|
|
|
|
|
|
|
|
|
void TextPrinterInitDownArrowCounters(struct TextPrinter *textPrinter);
|
|
|
|
|
void TextPrinterDrawDownArrow(struct TextPrinter *textPrinter);
|
|
|
|
|
void TextPrinterClearDownArrow(struct TextPrinter *textPrinter);
|
|
|
|
|
bool8 TextPrinterWaitAutoMode(struct TextPrinter *textPrinter);
|
2017-09-22 03:43:13 +00:00
|
|
|
bool16 TextPrinterWaitWithDownArrow(struct TextPrinter *textPrinter);
|
|
|
|
|
bool16 TextPrinterWait(struct TextPrinter *textPrinter);
|
2017-03-28 04:20:55 +00:00
|
|
|
void DrawDownArrow(u8 windowId, u16 x, u16 y, u8 bgColor, bool8 drawArrow, u8 *counter, u8 *yCoordIndex);
|
|
|
|
|
u16 RenderText(struct TextPrinter *textPrinter);
|
2017-09-18 15:26:45 +00:00
|
|
|
u32 GetStringWidthFixedWidthFont(const u8 *str, u8 fontId, u8 letterSpacing);
|
2017-03-28 04:20:55 +00:00
|
|
|
u32 (*GetFontWidthFunc(u8 glyphId))(u16, bool32);
|
2018-12-15 22:58:47 +00:00
|
|
|
s32 GetStringWidth(u8 fontId, const u8 *str, s16 letterSpacing);
|
2017-03-28 04:20:55 +00:00
|
|
|
u8 RenderTextFont9(u8 *pixels, u8 fontId, u8 *str);
|
|
|
|
|
u8 DrawKeypadIcon(u8 windowId, u8 keypadIconId, u16 x, u16 y);
|
|
|
|
|
u8 GetKeypadIconTileOffset(u8 keypadIconId);
|
|
|
|
|
u8 GetKeypadIconWidth(u8 keypadIconId);
|
|
|
|
|
u8 GetKeypadIconHeight(u8 keypadIconId);
|
|
|
|
|
void SetDefaultFontsPointer(void);
|
|
|
|
|
u8 GetFontAttribute(u8 fontId, u8 attributeId);
|
|
|
|
|
u8 GetMenuCursorDimensionByFont(u8 fontId, u8 whichDimension);
|
|
|
|
|
void DecompressGlyphFont0(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
u32 GetGlyphWidthFont0(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
void DecompressGlyphFont7(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
u32 GetGlyphWidthFont7(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
void DecompressGlyphFont8(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
u32 GetGlyphWidthFont8(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
void DecompressGlyphFont2(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
u32 GetGlyphWidthFont2(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
void DecompressGlyphFont1(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
u32 GetGlyphWidthFont1(u16 glyphId, bool32 isJapanese);
|
|
|
|
|
void DecompressGlyphFont9(u16 glyphId);
|
|
|
|
|
|
2017-01-14 19:53:20 +00:00
|
|
|
#endif // GUARD_TEXT_H
|
