2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/Graphics/Font.cpp $
15 * source file for font stuff
18 * Revision 1.5 2002/07/13 06:46:47 theoddone33
21 * Revision 1.4 2002/06/09 04:41:17 relnev
22 * added copyright header
24 * Revision 1.3 2002/06/05 08:05:29 relnev
25 * stub/warning removal.
27 * reworked the sound code.
29 * Revision 1.2 2002/05/07 03:16:45 theoddone33
30 * The Great Newline Fix
32 * Revision 1.1.1.1 2002/05/03 03:28:09 root
36 * 9 7/09/99 10:32p Dave
37 * Command brief and red alert screens.
39 * 8 12/14/98 9:21a Dan
40 * Put gr8_string() back in
42 * 7 12/02/98 5:47p Dave
43 * Put in interface xstr code. Converted barracks screen to new format.
45 * 6 11/30/98 1:07p Dave
46 * 16 bit conversion, first run.
48 * 5 11/05/98 4:18p Dave
49 * First run nebula support. Beefed up localization a bit. Removed all
50 * conditional compiles for foreign versions. Modified mission file
53 * 4 10/13/98 9:28a Dave
54 * Started neatening up freespace.h. Many variables renamed and
55 * reorganized. Added AlphaColors.[h,cpp]
57 * 3 10/13/98 9:19a Andsager
58 * Add localization support to cfile. Optional parameter with cfopen that
59 * looks for localized files.
61 * 2 10/07/98 10:52a Dave
64 * 1 10/07/98 10:49a Dave
66 * 49 7/02/98 3:41p Allender
67 * fix nasty assembler bug where pushf wasn't accompanied by corresponding
68 * pop in certain clipping conditions -- manifested only in software and
69 * usually on the PXO chat screen.
71 * 48 6/18/98 10:10a Allender
72 * fixed compiler warnings
74 * 47 6/13/98 10:48p Lawrance
75 * Changed code to utilize proper fixed-space 1 character.
77 * 46 6/13/98 3:18p Hoffoss
78 * NOX()ed out a bunch of strings that shouldn't be translated.
80 * 45 5/25/98 10:32a John
81 * Took out redundant code for font bitmap offsets that converted to a
82 * float, then later on converted back to an integer. Quite unnecessary.
84 * 44 5/12/98 11:45a John
85 * Fixed a bug with the length of string being passed to
86 * gr_get_string_size. The bug occurred if you had two or more'\n'''s in
89 * 43 3/10/98 4:18p John
90 * Cleaned up graphics lib. Took out most unused gr functions. Made D3D
91 * & Glide have popups and print screen. Took out all >8bpp software
92 * support. Made Fred zbuffer. Made zbuffer allocate dynamically to
93 * support Fred. Made zbuffering key off of functions rather than one
96 * 42 3/09/98 6:06p John
97 * Restructured font stuff to avoid duplicate code in Direct3D and Glide.
98 * Restructured Glide to avoid redundent state setting.
100 * 41 3/02/98 10:33a John
101 * Fixed bug where Y clip was using X value.
103 * 40 2/19/98 9:04a John
104 * Fixed fonts with glide
106 * 39 2/17/98 7:27p John
107 * Got fonts and texturing working in Direct3D
109 * 38 2/05/98 9:21p John
110 * Some new Direct3D code. Added code to monitor a ton of stuff in the
113 * 37 1/20/98 2:25p Hoffoss
114 * Fixed bug where timestamp printing incorrectly increments an hour at 6
117 * 36 1/19/98 6:15p John
118 * Fixed all my Optimized Build compiler warnings
120 * 35 11/30/97 12:18p John
121 * added more 24 & 32-bpp primitives
123 * 34 11/29/97 2:24p John
126 * 33 11/29/97 2:06p John
127 * added mode 16-bpp support
129 * 32 11/10/97 2:35p Hoffoss
130 * Changed timestamp printing code to utilize new fixed-space '1'
133 * 31 11/06/97 5:42p Hoffoss
134 * Added support for fixed size timstamp rendering.
136 * 30 11/03/97 10:08p Hoffoss
137 * Changed gr_get_string_size to utilize an optional length specifier, if
138 * you want to use non-null terminated strings.
140 * 29 11/03/97 10:59a John
141 * added support for more than one font.
143 * 28 10/24/97 12:13p Hoffoss
144 * Added gr_force_fit_string().
146 * 27 10/19/97 12:55p John
147 * new code to lock / unlock surfaces for smooth directx integration.
149 * 26 10/14/97 4:50p John
152 * 25 10/14/97 8:08a John
153 * added a bunch more 16 bit support
155 * 24 10/09/97 5:23p John
156 * Added support for more 16-bpp functions
158 * 23 9/23/97 10:53a Hoffoss
159 * Fixed bug in assumptions made half the time, and not the other half.
161 * 22 9/09/97 3:39p Sandeep
162 * warning level 4 bugs
164 * 21 8/19/97 5:46p Hoffoss
165 * Changed font used in Fred, and added display to show current eye
168 * 20 6/25/97 2:35p John
169 * added some functions to use the windows font for Fred.
171 * 19 6/17/97 12:03p John
172 * Moved color/alphacolor functions into their own module. Made all color
173 * functions be part of the low-level graphics drivers, not just the
176 * 18 6/13/97 2:37p John
177 * fixed a string bug that printed weird characters sometimes.
179 * 17 6/11/97 6:00p John
180 * sped up alpha matching a bit.
182 * 16 6/11/97 5:49p John
183 * Changed palette code to only recalculate alphacolors when needed, not
184 * when palette changes.
186 * 15 6/11/97 5:01p John
187 * Fixed mission log text. Added fast clipped font drawer.
189 * 14 6/11/97 4:11p John
190 * addec function to get font height
192 * 13 6/11/97 1:12p John
193 * Started fixing all the text colors in the game.
195 * 12 6/09/97 9:24a John
196 * Changed the way fonts are set.
198 * 11 6/06/97 4:41p John
199 * Fixed alpha colors to be smoothly integrated into gr_set_color_fast
202 * 10 6/06/97 2:40p John
203 * Made all the radar dim in/out
205 * 9 6/05/97 4:53p John
206 * First rev of new antialiased font stuff.
208 * 8 5/12/97 12:27p John
209 * Restructured Graphics Library to add support for multiple renderers.
211 * 7 4/24/97 11:28a Hoffoss
212 * added code to handle gr_String being called before gr_init_font ever
215 * 6 4/23/97 5:26p John
216 * First rev of new debug console stuff.
218 * 5 4/22/97 12:20p John
219 * fixed more resource leaks
221 * 4 4/22/97 10:33a John
222 * fixed the 2d resource leaks that Alan found.
224 * 3 4/04/97 11:21a Hoffoss
225 * JOHN: Fixed invalid param that caused a trap in BoundsChecker.
227 * 2 4/01/97 9:26a Allender
228 * added support for descent style fonts although they are not used in the
231 * 1 3/31/97 9:42a Allender
238 #include <windowsx.h>
242 #include "grinternal.h"
249 #include "localize.h"
252 font Fonts[MAX_FONTS];
253 font *Current_font = NULL;
256 // crops a string if required to force it to not exceed max_width pixels when printed.
257 // Does this by dropping characters at the end of the string and adding '...' to the end.
258 // str = string to crop. Modifies this string directly
259 // max_str = max characters allowed in str
260 // max_width = number of pixels to limit string to (less than or equal to).
261 // Returns: returns same pointer passed in for str.
262 char *gr_force_fit_string(char *str, int max_str, int max_width)
266 gr_get_string_size(&w, NULL, str);
268 if ((int) strlen(str) > max_str - 3) {
269 Assert(max_str >= 3);
270 str[max_str - 3] = 0;
273 strcpy(str + strlen(str) - 1, "...");
274 gr_get_string_size(&w, NULL, str);
275 while (w > max_width) {
276 Assert(strlen(str) >= 4); // if this is hit, a bad max_width was passed in and the calling function needs fixing.
277 strcpy(str + strlen(str) - 4, "...");
278 gr_get_string_size(&w, NULL, str);
285 //takes the character BEFORE being offset into current font
286 // Returns the letter code
287 int get_char_width(ubyte c1,ubyte c2,int *width,int *spacing)
291 Assert ( Current_font != NULL );
292 letter = c1-Current_font->first_ascii;
294 if (letter<0 || letter>=Current_font->num_chars) { //not in font, draw as space
296 *spacing = Current_font->w;
300 *width = Current_font->char_data[letter].byte_width;
301 *spacing = Current_font->char_data[letter].spacing;
303 i = Current_font->char_data[letter].kerning_entry;
305 if (!(c2==0 || c2=='\n')) {
308 letter2 = c2-Current_font->first_ascii;
310 if ((letter2>=0) && (letter2<Current_font->num_chars) ) { //not in font, draw as space
311 font_kernpair *k = &Current_font->kern_data[i];
312 while( (k->c1 == letter) && (k->c2<letter2) && (i<Current_font->num_kern_pairs) ) {
316 if ( k->c2 == letter2 ) {
317 *spacing += k->offset;
325 int get_centered_x(char *s)
329 for (w=0;*s!=0 && *s!='\n';s++) {
330 get_char_width(s[0],s[1],&w2,&s2);
334 return ((gr_screen.clip_width - w) / 2);
337 // draws a character centered on x
338 void gr_char_centered(int x, int y, char chr)
343 sc = Lcl_special_chars;
345 chr = (char)(sc + 1);
349 gr_get_string_size(&w, NULL, str);
350 gr_string(x - w / 2, y, str);
353 void gr_print_timestamp(int x, int y, int timestamp)
355 char h[2], m[3], s[3];
358 // format the time information into strings
359 sprintf(h, "%.1d", (timestamp / 3600000) % 10);
360 sprintf(m, "%.2d", (timestamp / 60000) % 60);
361 sprintf(s, "%.2d", (timestamp / 1000) % 60);
363 gr_get_string_size(&w, NULL, "0");
364 gr_get_string_size(&c, NULL, ":");
366 gr_string(x + w, y, ":");
367 gr_string(x + w * 3 + c, y, ":");
370 gr_char_centered(x, y, h[0]);
372 gr_char_centered(x, y, m[0]);
374 gr_char_centered(x, y, m[1]);
376 gr_char_centered(x, y, s[0]);
378 gr_char_centered(x, y, s[1]);
381 int gr_get_font_height()
384 return Current_font->h;
390 void gr_get_string_size(int *w1, int *h1, char *text, int len)
411 h += Current_font->h;
412 while (*text && (len>0) ) {
414 // Process one or more
415 while ((*text == '\n') && (len>0) ) {
419 h += Current_font->h;
428 get_char_width(text[0], text[1], &width, &spacing);
430 if (w > longest_width)
446 MONITOR( FontChars );
451 void gr8_char(int x,int y,int letter)
455 ch = &Current_font->char_data[letter];
457 gr_aabitmap_ex( x, y, ch->byte_width, Current_font->h, Current_font->u[letter], Current_font->v[letter] );
459 // mprintf(( "String = %s\n", text ));
463 void gr8_string( int sx, int sy, char *s )
465 int width, spacing, letter;
468 if ( !Current_font ) return;
471 gr_set_bitmap(Current_font->bitmap);
476 if (sx==0x8000) { //centered
477 x = get_centered_x(s);
485 y += Current_font->h;
486 if (sx==0x8000) { //centered
487 x = get_centered_x(s);
494 letter = get_char_width(s[0],s[1],&width,&spacing);
496 if (letter<0) { //not in font, draw as space
501 gr8_char( x, y, letter );
509 void gr8_string(int sx, int sy, char *s )
511 int row,width, spacing, letter;
514 if ( !Current_font ) return;
520 if (sx==0x8000) { //centered
521 x = get_centered_x(s);
532 MONITOR_INC( FontChars, 1 );
537 y += Current_font->h;
538 if (sx==0x8000) { //centered
539 x = get_centered_x(s);
546 letter = get_char_width(s[0],s[1],&width,&spacing);
549 //If not in font, draw as space
550 if (letter<0) continue;
555 // Check if this character is totally clipped
556 if ( x + width < gr_screen.clip_left ) continue;
557 if ( y + Current_font->h < gr_screen.clip_top ) continue;
558 if ( x > gr_screen.clip_right ) continue;
559 if ( y > gr_screen.clip_bottom ) continue;
562 if ( x < gr_screen.clip_left ) xd = gr_screen.clip_left - x;
563 if ( y < gr_screen.clip_top ) yd = gr_screen.clip_top - y;
567 wc = width - xd; hc = Current_font->h - yd;
568 if ( xc + wc > gr_screen.clip_right ) wc = gr_screen.clip_right - xc;
569 if ( yc + hc > gr_screen.clip_bottom ) hc = gr_screen.clip_bottom - yc;
571 if ( wc < 1 ) continue;
572 if ( hc < 1 ) continue;
574 ubyte *fp = Current_font->pixel_data + Current_font->char_data[letter].offset + xd + yd*width;
575 ubyte *dptr = GR_SCREEN_PTR(ubyte, xc, yc);
577 #ifndef HARDWARE_ONLY
578 if ( Current_alphacolor ) {
579 for (row=0; row<hc; row++) {
580 #ifdef USE_INLINE_ASM
581 ubyte *lookup = &Current_alphacolor->table.lookup[0][0];
600 _asm mov al, [edx+eax]
601 _asm mov ah, [edx+ebx]
606 _asm jnz InnerFontLoop
614 _asm mov al, [edx+eax]
618 dptr += gr_screen.rowsize;
622 for (i=0; i< wc; i++ ) {
623 *dptr++ = Current_alphacolor->table.lookup[*fp++][*dptr];
626 dptr += gr_screen.rowsize - wc;
629 } else { // No alpha color
631 for (row=0; row<hc; row++) {
633 for (i=0; i< wc; i++ ) {
635 *dptr = gr_screen.current_color.raw8;
640 dptr += gr_screen.rowsize - wc;
648 HFONT MyhFont = NULL;
652 void gr_string_win(int x, int y, char *s)
660 if ( MyhFont==NULL ) {
661 MyhFont = CreateFont(14, 0, 0, 0, // height,width,?,?
666 ANSI_CHARSET, // character set
670 DEFAULT_PITCH | FF_DONTCARE,
672 // "Times New Roman" );
678 SelectObject( hDibDC, MyhFont );
680 if ( gr_screen.bits_per_pixel==8 )
681 SetTextColor(hDibDC, PALETTEINDEX(gr_screen.current_color.raw8));
683 SetTextColor(hDibDC, RGB(gr_screen.current_color.red,gr_screen.current_color.green,gr_screen.current_color.blue));
685 SetBkMode(hDibDC,TRANSPARENT);
689 hclip = CreateRectRgn( gr_screen.offset_x,
691 gr_screen.offset_x+gr_screen.clip_width-1,
692 gr_screen.offset_y+gr_screen.clip_height-1 );
694 SelectClipRgn(hDibDC, hclip );
695 x += gr_screen.offset_x;
696 y += gr_screen.offset_y;
697 //ptr = strchr(s,'\n);
698 while ((ptr = strchr(s, '\n'))!=NULL) {
699 TextOut(hDibDC, x, y, s, ptr - s);
700 GetTextExtentPoint32(hDibDC, s, ptr - s, &size);
705 TextOut(hDibDC, x, y, s, strlen(s));
706 SelectClipRgn(hDibDC, NULL);
711 void gr_get_string_size_win(int *w, int *h, char *text)
719 ptr = strchr(text, '\n');
727 SelectObject( hDibDC, MyhFont );
730 GetTextExtentPoint32( hDibDC, text, strlen(text), &size);
736 GetTextExtentPoint32(hDibDC, text, ptr - text, &size);
737 gr_get_string_size_win(w, h, ptr+1);
738 if (w && (size.cx > *w) )
746 char grx_printf_text[2048];
748 void _cdecl gr_printf( int x, int y, char * format, ... )
752 if ( !Current_font ) return;
754 va_start(args, format);
755 vsprintf(grx_printf_text,format,args);
758 gr_string(x,y,grx_printf_text);
766 // Returns -1 if couldn't init font, otherwise returns the
768 int gr_create_font(char * typeface)
776 for (fontnum=0; fontnum<Num_fonts; fontnum++ ) {
778 if ( !_strnicmp( fnt->filename, typeface, MAX_FILENAME_LEN ) ) {
789 if ( fontnum==MAX_FONTS ) {
790 Error( LOCATION, "Too many fonts!\nSee John, or change MAX_FONTS in Graphics\\Font.h\n" );
793 if ( fontnum == Num_fonts ) {
797 bool localize = true;
799 fp = cfopen( typeface, "rb", CFILE_NORMAL, CF_TYPE_ANY, localize );
800 if ( fp == NULL ) return -1;
802 strncpy( fnt->filename, typeface, MAX_FILENAME_LEN );
803 cfread( &fnt->id, 4, 1, fp );
804 cfread( &fnt->version, sizeof(int), 1, fp );
805 cfread( &fnt->num_chars, sizeof(int), 1, fp );
806 cfread( &fnt->first_ascii, sizeof(int), 1, fp );
807 cfread( &fnt->w, sizeof(int), 1, fp );
808 cfread( &fnt->h, sizeof(int), 1, fp );
809 cfread( &fnt->num_kern_pairs, sizeof(int), 1, fp );
810 cfread( &fnt->kern_data_size, sizeof(int), 1, fp );
811 cfread( &fnt->char_data_size, sizeof(int), 1, fp );
812 cfread( &fnt->pixel_data_size, sizeof(int), 1, fp );
814 if ( fnt->kern_data_size ) {
815 fnt->kern_data = (font_kernpair *)malloc( fnt->kern_data_size );
816 Assert(fnt->kern_data!=NULL);
817 cfread( fnt->kern_data, fnt->kern_data_size, 1, fp );
819 fnt->kern_data = NULL;
821 if ( fnt->char_data_size ) {
822 fnt->char_data = (font_char *)malloc( fnt->char_data_size );
823 Assert( fnt->char_data != NULL );
824 cfread( fnt->char_data, fnt->char_data_size, 1, fp );
826 fnt->char_data = NULL;
828 if ( fnt->pixel_data_size ) {
829 fnt->pixel_data = (ubyte *)malloc( fnt->pixel_data_size );
830 Assert(fnt->pixel_data!=NULL);
831 cfread( fnt->pixel_data, fnt->pixel_data_size, 1, fp );
833 fnt->pixel_data = NULL;
837 // Create a bitmap for hardware cards.
838 // JAS: Try to squeeze this into the smallest square power of two texture.
839 // This should probably be done at font generation time, not here.
841 if ( fnt->pixel_data_size < 64*64 ) {
843 } else if ( fnt->pixel_data_size < 128*128 ) {
851 fnt->bm_data = (ubyte *)malloc(fnt->bm_w*fnt->bm_h);
852 fnt->bm_u = (int *)malloc(sizeof(int)*fnt->num_chars);
853 fnt->bm_v = (int *)malloc(sizeof(int)*fnt->num_chars);
857 for (i=0; i<fnt->num_chars; i++ ) {
860 fp = &fnt->pixel_data[fnt->char_data[i].offset];
861 if ( x + fnt->char_data[i].byte_width >= fnt->bm_w ) {
864 if ( y+fnt->h > fnt->bm_h ) {
865 Error( LOCATION, "Font too big!\n" );
871 for( y1=0; y1<fnt->h; y1++ ) {
872 for (x1=0; x1<fnt->char_data[i].byte_width; x1++ ) {
874 if ( c > 14 ) c = 14;
875 fnt->bm_data[(x+x1)+(y+y1)*fnt->bm_w] = (unsigned char)(c);
878 x += fnt->char_data[i].byte_width;
881 fnt->bitmap_id = bm_create( 8, fnt->bm_w, fnt->bm_h, fnt->bm_data, BMP_AABITMAP );
886 void grx_set_font(int fontnum)
893 if ( fontnum >= 0 ) {
894 Current_font = &Fonts[fontnum];
900 gr_init_font( NOX("font01.vf") );
901 gr_init_font( NOX("font02.vf") );
902 gr_init_font( NOX("font03.vf") );
905 // Returns -1 if couldn't init font, otherwise returns the
907 int gr_init_font(char * typeface)
911 Loaded_fontnum = gr_create_font(typeface);
913 Assert( Loaded_fontnum > -1 );
915 gr_set_font( Loaded_fontnum );
917 return Loaded_fontnum;