font.h

Go to the documentation of this file.

 
 
/*
 * font.h
 *
*  Created on: Mar 15, 2022
 *      Author: micahbly
 */
 
#ifndef LIB_FONT_H_
#define LIB_FONT_H_
 
 
/* about this class: Font
 *
 * This provides functionality for loading and drawing bitmapped proportional and fixed-width fonts
 *
 *** things this library needs to be able to do
 * 
 *
 * STRETCH GOALS
 * 
 *
 * SUPER STRETCH GOALS
 * 
 * 
 */
 
 
/*****************************************************************************/
/*                                Includes                                   */
/*****************************************************************************/
 
// project includes
 
// C includes
#include <stdbool.h>
 
 
// A2560 includes
#include <mcp/syscalls.h>
#include "a2560k.h"
 
 
/*****************************************************************************/
/*                            Macro Definitions                              */
/*****************************************************************************/
 
#define FONT_RECORD_SIZE        26  
 
#define FONT_CHAR_FOENIX_OUTLINE    0x11    
#define FONT_CHAR_CHECKMARK         0x12    
#define FONT_CHAR_DIAMOND           0x13    
#define FONT_CHAR_FOENIX_REG        0x14    
#define FONT_CHAR_MENU_RIGHT        0x15    
#define FONT_CHAR_MENU_RIGHT_WIDTH  7       
 
 
/*****************************************************************************/
/*                               Enumerations                                */
/*****************************************************************************/
 
 
 
/*****************************************************************************/
/*                                 Structs                                   */
/*****************************************************************************/
 
struct Font {
    int16_t             fontType;       
    int16_t             firstChar;      
    int16_t             lastChar;       
    int16_t             widMax;         
    int16_t             kernMax;        
    int16_t             nDescent;       
    int16_t             fRectWidth;     
    int16_t             fRectHeight;    
    uint16_t            owTLoc;         
    int16_t             ascent;         
    int16_t             descent;        
    int16_t             leading;        
    int16_t             rowWords;       
    uint16_t*           image_table_;   
    uint16_t*           loc_table_;     
    uint16_t*           width_table_;   
    uint16_t*           height_table_;  
};
 
 
 
 
 
 
/*****************************************************************************/
/*                             Global Variables                              */
/*****************************************************************************/
 
 
/*****************************************************************************/
/*                       Public Function Prototypes                          */
/*****************************************************************************/
 
 
// **** CONSTRUCTOR AND DESTRUCTOR *****
 
// constructor
Font* Font_New(uint8_t* the_data, uint16_t data_size);
 
// destructor
// frees all allocated memory associated with the passed object, and the object itself
bool Font_Destroy(Font** the_font);
 
 
 
 
 
 
// **** xxx functions *****
 
 
 
 
// **** Set xxx functions *****
 
 
 
 
 
// **** Get xxx functions *****
 
 
 
 
 
// **** Draw string functions *****
 
 
// Draw a string at the current "pen" location, using the current pen color of the bitmap
// Truncate, but still draw the string if it is too long to display on the line it started.
// No word wrap is performed. 
// If max_chars is less than the string length, only that many characters will be drawn (as space allows)
// If max_chars is -1, then the full string length will be drawn, as space allows.
bool Font_DrawString(Bitmap* the_bitmap, char* the_string, int16_t max_chars);
 
char* Font_DrawStringInBox(Bitmap* the_bitmap, int16_t width, int16_t height, char* the_string, int16_t num_chars, char** wrap_buffer, bool (* continue_function)(void));
 
int16_t Font_MeasureStringWidth(Font* the_font, char* the_string, int16_t num_chars, int16_t available_width, int16_t fixed_char_width, int16_t* measured_width);
 
 
int16_t Font_DrawChar(Bitmap* the_bitmap, uint8_t the_char, Font* the_font);
 
 
 
// **** xxx functions *****
 
 
 
 
// **** Debug functions *****
 
void Font_Print(Font* the_font);
 
 
 
#endif /* LIB_FONT_H_ */