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.4 2002/06/09 04:41:17 relnev
19 * added copyright header
21 * Revision 1.3 2002/06/05 08:05:29 relnev
22 * stub/warning removal.
24 * reworked the sound code.
26 * Revision 1.2 2002/05/07 03:16:45 theoddone33
27 * The Great Newline Fix
29 * Revision 1.1.1.1 2002/05/03 03:28:09 root
33 * 9 7/09/99 10:32p Dave
34 * Command brief and red alert screens.
36 * 8 12/14/98 9:21a Dan
37 * Put gr8_string() back in
39 * 7 12/02/98 5:47p Dave
40 * Put in interface xstr code. Converted barracks screen to new format.
42 * 6 11/30/98 1:07p Dave
43 * 16 bit conversion, first run.
45 * 5 11/05/98 4:18p Dave
46 * First run nebula support. Beefed up localization a bit. Removed all
47 * conditional compiles for foreign versions. Modified mission file
50 * 4 10/13/98 9:28a Dave
51 * Started neatening up freespace.h. Many variables renamed and
52 * reorganized. Added AlphaColors.[h,cpp]
54 * 3 10/13/98 9:19a Andsager
55 * Add localization support to cfile. Optional parameter with cfopen that
56 * looks for localized files.
58 * 2 10/07/98 10:52a Dave
61 * 1 10/07/98 10:49a Dave
63 * 49 7/02/98 3:41p Allender
64 * fix nasty assembler bug where pushf wasn't accompanied by corresponding
65 * pop in certain clipping conditions -- manifested only in software and
66 * usually on the PXO chat screen.
68 * 48 6/18/98 10:10a Allender
69 * fixed compiler warnings
71 * 47 6/13/98 10:48p Lawrance
72 * Changed code to utilize proper fixed-space 1 character.
74 * 46 6/13/98 3:18p Hoffoss
75 * NOX()ed out a bunch of strings that shouldn't be translated.
77 * 45 5/25/98 10:32a John
78 * Took out redundant code for font bitmap offsets that converted to a
79 * float, then later on converted back to an integer. Quite unnecessary.
81 * 44 5/12/98 11:45a John
82 * Fixed a bug with the length of string being passed to
83 * gr_get_string_size. The bug occurred if you had two or more'\n'''s in
86 * 43 3/10/98 4:18p John
87 * Cleaned up graphics lib. Took out most unused gr functions. Made D3D
88 * & Glide have popups and print screen. Took out all >8bpp software
89 * support. Made Fred zbuffer. Made zbuffer allocate dynamically to
90 * support Fred. Made zbuffering key off of functions rather than one
93 * 42 3/09/98 6:06p John
94 * Restructured font stuff to avoid duplicate code in Direct3D and Glide.
95 * Restructured Glide to avoid redundent state setting.
97 * 41 3/02/98 10:33a John
98 * Fixed bug where Y clip was using X value.
100 * 40 2/19/98 9:04a John
101 * Fixed fonts with glide
103 * 39 2/17/98 7:27p John
104 * Got fonts and texturing working in Direct3D
106 * 38 2/05/98 9:21p John
107 * Some new Direct3D code. Added code to monitor a ton of stuff in the
110 * 37 1/20/98 2:25p Hoffoss
111 * Fixed bug where timestamp printing incorrectly increments an hour at 6
114 * 36 1/19/98 6:15p John
115 * Fixed all my Optimized Build compiler warnings
117 * 35 11/30/97 12:18p John
118 * added more 24 & 32-bpp primitives
120 * 34 11/29/97 2:24p John
123 * 33 11/29/97 2:06p John
124 * added mode 16-bpp support
126 * 32 11/10/97 2:35p Hoffoss
127 * Changed timestamp printing code to utilize new fixed-space '1'
130 * 31 11/06/97 5:42p Hoffoss
131 * Added support for fixed size timstamp rendering.
133 * 30 11/03/97 10:08p Hoffoss
134 * Changed gr_get_string_size to utilize an optional length specifier, if
135 * you want to use non-null terminated strings.
137 * 29 11/03/97 10:59a John
138 * added support for more than one font.
140 * 28 10/24/97 12:13p Hoffoss
141 * Added gr_force_fit_string().
143 * 27 10/19/97 12:55p John
144 * new code to lock / unlock surfaces for smooth directx integration.
146 * 26 10/14/97 4:50p John
149 * 25 10/14/97 8:08a John
150 * added a bunch more 16 bit support
152 * 24 10/09/97 5:23p John
153 * Added support for more 16-bpp functions
155 * 23 9/23/97 10:53a Hoffoss
156 * Fixed bug in assumptions made half the time, and not the other half.
158 * 22 9/09/97 3:39p Sandeep
159 * warning level 4 bugs
161 * 21 8/19/97 5:46p Hoffoss
162 * Changed font used in Fred, and added display to show current eye
165 * 20 6/25/97 2:35p John
166 * added some functions to use the windows font for Fred.
168 * 19 6/17/97 12:03p John
169 * Moved color/alphacolor functions into their own module. Made all color
170 * functions be part of the low-level graphics drivers, not just the
173 * 18 6/13/97 2:37p John
174 * fixed a string bug that printed weird characters sometimes.
176 * 17 6/11/97 6:00p John
177 * sped up alpha matching a bit.
179 * 16 6/11/97 5:49p John
180 * Changed palette code to only recalculate alphacolors when needed, not
181 * when palette changes.
183 * 15 6/11/97 5:01p John
184 * Fixed mission log text. Added fast clipped font drawer.
186 * 14 6/11/97 4:11p John
187 * addec function to get font height
189 * 13 6/11/97 1:12p John
190 * Started fixing all the text colors in the game.
192 * 12 6/09/97 9:24a John
193 * Changed the way fonts are set.
195 * 11 6/06/97 4:41p John
196 * Fixed alpha colors to be smoothly integrated into gr_set_color_fast
199 * 10 6/06/97 2:40p John
200 * Made all the radar dim in/out
202 * 9 6/05/97 4:53p John
203 * First rev of new antialiased font stuff.
205 * 8 5/12/97 12:27p John
206 * Restructured Graphics Library to add support for multiple renderers.
208 * 7 4/24/97 11:28a Hoffoss
209 * added code to handle gr_String being called before gr_init_font ever
212 * 6 4/23/97 5:26p John
213 * First rev of new debug console stuff.
215 * 5 4/22/97 12:20p John
216 * fixed more resource leaks
218 * 4 4/22/97 10:33a John
219 * fixed the 2d resource leaks that Alan found.
221 * 3 4/04/97 11:21a Hoffoss
222 * JOHN: Fixed invalid param that caused a trap in BoundsChecker.
224 * 2 4/01/97 9:26a Allender
225 * added support for descent style fonts although they are not used in the
228 * 1 3/31/97 9:42a Allender
235 #include <windowsx.h>
239 #include "grinternal.h"
246 #include "localize.h"
249 font Fonts[MAX_FONTS];
250 font *Current_font = NULL;
253 // crops a string if required to force it to not exceed max_width pixels when printed.
254 // Does this by dropping characters at the end of the string and adding '...' to the end.
255 // str = string to crop. Modifies this string directly
256 // max_str = max characters allowed in str
257 // max_width = number of pixels to limit string to (less than or equal to).
258 // Returns: returns same pointer passed in for str.
259 char *gr_force_fit_string(char *str, int max_str, int max_width)
263 gr_get_string_size(&w, NULL, str);
265 if ((int) strlen(str) > max_str - 3) {
266 Assert(max_str >= 3);
267 str[max_str - 3] = 0;
270 strcpy(str + strlen(str) - 1, "...");
271 gr_get_string_size(&w, NULL, str);
272 while (w > max_width) {
273 Assert(strlen(str) >= 4); // if this is hit, a bad max_width was passed in and the calling function needs fixing.
274 strcpy(str + strlen(str) - 4, "...");
275 gr_get_string_size(&w, NULL, str);
282 //takes the character BEFORE being offset into current font
283 // Returns the letter code
284 int get_char_width(ubyte c1,ubyte c2,int *width,int *spacing)
288 Assert ( Current_font != NULL );
289 letter = c1-Current_font->first_ascii;
291 if (letter<0 || letter>=Current_font->num_chars) { //not in font, draw as space
293 *spacing = Current_font->w;
297 *width = Current_font->char_data[letter].byte_width;
298 *spacing = Current_font->char_data[letter].spacing;
300 i = Current_font->char_data[letter].kerning_entry;
302 if (!(c2==0 || c2=='\n')) {
305 letter2 = c2-Current_font->first_ascii;
307 if ((letter2>=0) && (letter2<Current_font->num_chars) ) { //not in font, draw as space
308 font_kernpair *k = &Current_font->kern_data[i];
309 while( (k->c1 == letter) && (k->c2<letter2) && (i<Current_font->num_kern_pairs) ) {
313 if ( k->c2 == letter2 ) {
314 *spacing += k->offset;
322 int get_centered_x(char *s)
326 for (w=0;*s!=0 && *s!='\n';s++) {
327 get_char_width(s[0],s[1],&w2,&s2);
331 return ((gr_screen.clip_width - w) / 2);
334 // draws a character centered on x
335 void gr_char_centered(int x, int y, char chr)
340 sc = Lcl_special_chars;
342 chr = (char)(sc + 1);
346 gr_get_string_size(&w, NULL, str);
347 gr_string(x - w / 2, y, str);
350 void gr_print_timestamp(int x, int y, int timestamp)
352 char h[2], m[3], s[3];
355 // format the time information into strings
356 sprintf(h, "%0.1d", (timestamp / 3600000) % 10);
357 sprintf(m, "%0.2d", (timestamp / 60000) % 60);
358 sprintf(s, "%0.2d", (timestamp / 1000) % 60);
360 gr_get_string_size(&w, NULL, "0");
361 gr_get_string_size(&c, NULL, ":");
363 gr_string(x + w, y, ":");
364 gr_string(x + w * 3 + c, y, ":");
367 gr_char_centered(x, y, h[0]);
369 gr_char_centered(x, y, m[0]);
371 gr_char_centered(x, y, m[1]);
373 gr_char_centered(x, y, s[0]);
375 gr_char_centered(x, y, s[1]);
378 int gr_get_font_height()
381 return Current_font->h;
387 void gr_get_string_size(int *w1, int *h1, char *text, int len)
408 h += Current_font->h;
409 while (*text && (len>0) ) {
411 // Process one or more
412 while ((*text == '\n') && (len>0) ) {
416 h += Current_font->h;
425 get_char_width(text[0], text[1], &width, &spacing);
427 if (w > longest_width)
443 MONITOR( FontChars );
448 void gr8_char(int x,int y,int letter)
452 ch = &Current_font->char_data[letter];
454 gr_aabitmap_ex( x, y, ch->byte_width, Current_font->h, Current_font->u[letter], Current_font->v[letter] );
456 // mprintf(( "String = %s\n", text ));
460 void gr8_string( int sx, int sy, char *s )
462 int width, spacing, letter;
465 if ( !Current_font ) return;
468 gr_set_bitmap(Current_font->bitmap);
473 if (sx==0x8000) { //centered
474 x = get_centered_x(s);
482 y += Current_font->h;
483 if (sx==0x8000) { //centered
484 x = get_centered_x(s);
491 letter = get_char_width(s[0],s[1],&width,&spacing);
493 if (letter<0) { //not in font, draw as space
498 gr8_char( x, y, letter );
506 void gr8_string(int sx, int sy, char *s )
508 int row,width, spacing, letter;
511 if ( !Current_font ) return;
517 if (sx==0x8000) { //centered
518 x = get_centered_x(s);
529 MONITOR_INC( FontChars, 1 );
534 y += Current_font->h;
535 if (sx==0x8000) { //centered
536 x = get_centered_x(s);
543 letter = get_char_width(s[0],s[1],&width,&spacing);
546 //If not in font, draw as space
547 if (letter<0) continue;
552 // Check if this character is totally clipped
553 if ( x + width < gr_screen.clip_left ) continue;
554 if ( y + Current_font->h < gr_screen.clip_top ) continue;
555 if ( x > gr_screen.clip_right ) continue;
556 if ( y > gr_screen.clip_bottom ) continue;
559 if ( x < gr_screen.clip_left ) xd = gr_screen.clip_left - x;
560 if ( y < gr_screen.clip_top ) yd = gr_screen.clip_top - y;
564 wc = width - xd; hc = Current_font->h - yd;
565 if ( xc + wc > gr_screen.clip_right ) wc = gr_screen.clip_right - xc;
566 if ( yc + hc > gr_screen.clip_bottom ) hc = gr_screen.clip_bottom - yc;
568 if ( wc < 1 ) continue;
569 if ( hc < 1 ) continue;
571 ubyte *fp = Current_font->pixel_data + Current_font->char_data[letter].offset + xd + yd*width;
572 ubyte *dptr = GR_SCREEN_PTR(ubyte, xc, yc);
574 #ifndef HARDWARE_ONLY
575 if ( Current_alphacolor ) {
576 for (row=0; row<hc; row++) {
577 #ifdef USE_INLINE_ASM
578 ubyte *lookup = &Current_alphacolor->table.lookup[0][0];
597 _asm mov al, [edx+eax]
598 _asm mov ah, [edx+ebx]
603 _asm jnz InnerFontLoop
611 _asm mov al, [edx+eax]
615 dptr += gr_screen.rowsize;
619 for (i=0; i< wc; i++ ) {
620 *dptr++ = Current_alphacolor->table.lookup[*fp++][*dptr];
623 dptr += gr_screen.rowsize - wc;
626 } else { // No alpha color
628 for (row=0; row<hc; row++) {
630 for (i=0; i< wc; i++ ) {
632 *dptr = gr_screen.current_color.raw8;
637 dptr += gr_screen.rowsize - wc;
645 HFONT MyhFont = NULL;
649 void gr_string_win(int x, int y, char *s)
657 if ( MyhFont==NULL ) {
658 MyhFont = CreateFont(14, 0, 0, 0, // height,width,?,?
663 ANSI_CHARSET, // character set
667 DEFAULT_PITCH | FF_DONTCARE,
669 // "Times New Roman" );
675 SelectObject( hDibDC, MyhFont );
677 if ( gr_screen.bits_per_pixel==8 )
678 SetTextColor(hDibDC, PALETTEINDEX(gr_screen.current_color.raw8));
680 SetTextColor(hDibDC, RGB(gr_screen.current_color.red,gr_screen.current_color.green,gr_screen.current_color.blue));
682 SetBkMode(hDibDC,TRANSPARENT);
686 hclip = CreateRectRgn( gr_screen.offset_x,
688 gr_screen.offset_x+gr_screen.clip_width-1,
689 gr_screen.offset_y+gr_screen.clip_height-1 );
691 SelectClipRgn(hDibDC, hclip );
692 x += gr_screen.offset_x;
693 y += gr_screen.offset_y;
694 //ptr = strchr(s,'\n);
695 while ((ptr = strchr(s, '\n'))!=NULL) {
696 TextOut(hDibDC, x, y, s, ptr - s);
697 GetTextExtentPoint32(hDibDC, s, ptr - s, &size);
702 TextOut(hDibDC, x, y, s, strlen(s));
703 SelectClipRgn(hDibDC, NULL);
708 void gr_get_string_size_win(int *w, int *h, char *text)
716 ptr = strchr(text, '\n');
724 SelectObject( hDibDC, MyhFont );
727 GetTextExtentPoint32( hDibDC, text, strlen(text), &size);
733 GetTextExtentPoint32(hDibDC, text, ptr - text, &size);
734 gr_get_string_size_win(w, h, ptr+1);
735 if (w && (size.cx > *w) )
743 char grx_printf_text[2048];
745 void _cdecl gr_printf( int x, int y, char * format, ... )
749 if ( !Current_font ) return;
751 va_start(args, format);
752 vsprintf(grx_printf_text,format,args);
755 gr_string(x,y,grx_printf_text);
763 // Returns -1 if couldn't init font, otherwise returns the
765 int gr_create_font(char * typeface)
773 for (fontnum=0; fontnum<Num_fonts; fontnum++ ) {
775 if ( !_strnicmp( fnt->filename, typeface, MAX_FILENAME_LEN ) ) {
786 if ( fontnum==MAX_FONTS ) {
787 Error( LOCATION, "Too many fonts!\nSee John, or change MAX_FONTS in Graphics\\Font.h\n" );
790 if ( fontnum == Num_fonts ) {
794 bool localize = true;
796 fp = cfopen( typeface, "rb", CFILE_NORMAL, CF_TYPE_ANY, localize );
797 if ( fp == NULL ) return -1;
799 strncpy( fnt->filename, typeface, MAX_FILENAME_LEN );
800 cfread( &fnt->id, 4, 1, fp );
801 cfread( &fnt->version, sizeof(int), 1, fp );
802 cfread( &fnt->num_chars, sizeof(int), 1, fp );
803 cfread( &fnt->first_ascii, sizeof(int), 1, fp );
804 cfread( &fnt->w, sizeof(int), 1, fp );
805 cfread( &fnt->h, sizeof(int), 1, fp );
806 cfread( &fnt->num_kern_pairs, sizeof(int), 1, fp );
807 cfread( &fnt->kern_data_size, sizeof(int), 1, fp );
808 cfread( &fnt->char_data_size, sizeof(int), 1, fp );
809 cfread( &fnt->pixel_data_size, sizeof(int), 1, fp );
811 if ( fnt->kern_data_size ) {
812 fnt->kern_data = (font_kernpair *)malloc( fnt->kern_data_size );
813 Assert(fnt->kern_data!=NULL);
814 cfread( fnt->kern_data, fnt->kern_data_size, 1, fp );
816 fnt->kern_data = NULL;
818 if ( fnt->char_data_size ) {
819 fnt->char_data = (font_char *)malloc( fnt->char_data_size );
820 Assert( fnt->char_data != NULL );
821 cfread( fnt->char_data, fnt->char_data_size, 1, fp );
823 fnt->char_data = NULL;
825 if ( fnt->pixel_data_size ) {
826 fnt->pixel_data = (ubyte *)malloc( fnt->pixel_data_size );
827 Assert(fnt->pixel_data!=NULL);
828 cfread( fnt->pixel_data, fnt->pixel_data_size, 1, fp );
830 fnt->pixel_data = NULL;
834 // Create a bitmap for hardware cards.
835 // JAS: Try to squeeze this into the smallest square power of two texture.
836 // This should probably be done at font generation time, not here.
838 if ( fnt->pixel_data_size < 64*64 ) {
840 } else if ( fnt->pixel_data_size < 128*128 ) {
848 fnt->bm_data = (ubyte *)malloc(fnt->bm_w*fnt->bm_h);
849 fnt->bm_u = (int *)malloc(sizeof(int)*fnt->num_chars);
850 fnt->bm_v = (int *)malloc(sizeof(int)*fnt->num_chars);
854 for (i=0; i<fnt->num_chars; i++ ) {
857 fp = &fnt->pixel_data[fnt->char_data[i].offset];
858 if ( x + fnt->char_data[i].byte_width >= fnt->bm_w ) {
861 if ( y+fnt->h > fnt->bm_h ) {
862 Error( LOCATION, "Font too big!\n" );
868 for( y1=0; y1<fnt->h; y1++ ) {
869 for (x1=0; x1<fnt->char_data[i].byte_width; x1++ ) {
871 if ( c > 14 ) c = 14;
872 fnt->bm_data[(x+x1)+(y+y1)*fnt->bm_w] = (unsigned char)(c);
875 x += fnt->char_data[i].byte_width;
878 fnt->bitmap_id = bm_create( 8, fnt->bm_w, fnt->bm_h, fnt->bm_data, BMP_AABITMAP );
883 void grx_set_font(int fontnum)
890 if ( fontnum >= 0 ) {
891 Current_font = &Fonts[fontnum];
897 gr_init_font( NOX("font01.vf") );
898 gr_init_font( NOX("font02.vf") );
899 gr_init_font( NOX("font03.vf") );
902 // Returns -1 if couldn't init font, otherwise returns the
904 int gr_init_font(char * typeface)
908 Loaded_fontnum = gr_create_font(typeface);
910 Assert( Loaded_fontnum > -1 );
912 gr_set_font( Loaded_fontnum );
914 return Loaded_fontnum;