2 * $Logfile: /Freespace2/code/Graphics/Font.cpp $
7 * source file for font stuff
10 * Revision 1.1 2002/05/03 03:28:09 root
14 * 9 7/09/99 10:32p Dave
15 * Command brief and red alert screens.
17 * 8 12/14/98 9:21a Dan
18 * Put gr8_string() back in
20 * 7 12/02/98 5:47p Dave
21 * Put in interface xstr code. Converted barracks screen to new format.
23 * 6 11/30/98 1:07p Dave
24 * 16 bit conversion, first run.
26 * 5 11/05/98 4:18p Dave
27 * First run nebula support. Beefed up localization a bit. Removed all
28 * conditional compiles for foreign versions. Modified mission file
31 * 4 10/13/98 9:28a Dave
32 * Started neatening up freespace.h. Many variables renamed and
33 * reorganized. Added AlphaColors.[h,cpp]
35 * 3 10/13/98 9:19a Andsager
36 * Add localization support to cfile. Optional parameter with cfopen that
37 * looks for localized files.
39 * 2 10/07/98 10:52a Dave
42 * 1 10/07/98 10:49a Dave
44 * 49 7/02/98 3:41p Allender
45 * fix nasty assembler bug where pushf wasn't accompanied by corresponding
46 * pop in certain clipping conditions -- manifested only in software and
47 * usually on the PXO chat screen.
49 * 48 6/18/98 10:10a Allender
50 * fixed compiler warnings
52 * 47 6/13/98 10:48p Lawrance
53 * Changed code to utilize proper fixed-space 1 character.
55 * 46 6/13/98 3:18p Hoffoss
56 * NOX()ed out a bunch of strings that shouldn't be translated.
58 * 45 5/25/98 10:32a John
59 * Took out redundant code for font bitmap offsets that converted to a
60 * float, then later on converted back to an integer. Quite unnecessary.
62 * 44 5/12/98 11:45a John
63 * Fixed a bug with the length of string being passed to
64 * gr_get_string_size. The bug occurred if you had two or more'\n'''s in
67 * 43 3/10/98 4:18p John
68 * Cleaned up graphics lib. Took out most unused gr functions. Made D3D
69 * & Glide have popups and print screen. Took out all >8bpp software
70 * support. Made Fred zbuffer. Made zbuffer allocate dynamically to
71 * support Fred. Made zbuffering key off of functions rather than one
74 * 42 3/09/98 6:06p John
75 * Restructured font stuff to avoid duplicate code in Direct3D and Glide.
76 * Restructured Glide to avoid redundent state setting.
78 * 41 3/02/98 10:33a John
79 * Fixed bug where Y clip was using X value.
81 * 40 2/19/98 9:04a John
82 * Fixed fonts with glide
84 * 39 2/17/98 7:27p John
85 * Got fonts and texturing working in Direct3D
87 * 38 2/05/98 9:21p John
88 * Some new Direct3D code. Added code to monitor a ton of stuff in the
91 * 37 1/20/98 2:25p Hoffoss
92 * Fixed bug where timestamp printing incorrectly increments an hour at 6
95 * 36 1/19/98 6:15p John
96 * Fixed all my Optimized Build compiler warnings
98 * 35 11/30/97 12:18p John
99 * added more 24 & 32-bpp primitives
101 * 34 11/29/97 2:24p John
104 * 33 11/29/97 2:06p John
105 * added mode 16-bpp support
107 * 32 11/10/97 2:35p Hoffoss
108 * Changed timestamp printing code to utilize new fixed-space '1'
111 * 31 11/06/97 5:42p Hoffoss
112 * Added support for fixed size timstamp rendering.
114 * 30 11/03/97 10:08p Hoffoss
115 * Changed gr_get_string_size to utilize an optional length specifier, if
116 * you want to use non-null terminated strings.
118 * 29 11/03/97 10:59a John
119 * added support for more than one font.
121 * 28 10/24/97 12:13p Hoffoss
122 * Added gr_force_fit_string().
124 * 27 10/19/97 12:55p John
125 * new code to lock / unlock surfaces for smooth directx integration.
127 * 26 10/14/97 4:50p John
130 * 25 10/14/97 8:08a John
131 * added a bunch more 16 bit support
133 * 24 10/09/97 5:23p John
134 * Added support for more 16-bpp functions
136 * 23 9/23/97 10:53a Hoffoss
137 * Fixed bug in assumptions made half the time, and not the other half.
139 * 22 9/09/97 3:39p Sandeep
140 * warning level 4 bugs
142 * 21 8/19/97 5:46p Hoffoss
143 * Changed font used in Fred, and added display to show current eye
146 * 20 6/25/97 2:35p John
147 * added some functions to use the windows font for Fred.
149 * 19 6/17/97 12:03p John
150 * Moved color/alphacolor functions into their own module. Made all color
151 * functions be part of the low-level graphics drivers, not just the
154 * 18 6/13/97 2:37p John
155 * fixed a string bug that printed weird characters sometimes.
157 * 17 6/11/97 6:00p John
158 * sped up alpha matching a bit.
160 * 16 6/11/97 5:49p John
161 * Changed palette code to only recalculate alphacolors when needed, not
162 * when palette changes.
164 * 15 6/11/97 5:01p John
165 * Fixed mission log text. Added fast clipped font drawer.
167 * 14 6/11/97 4:11p John
168 * addec function to get font height
170 * 13 6/11/97 1:12p John
171 * Started fixing all the text colors in the game.
173 * 12 6/09/97 9:24a John
174 * Changed the way fonts are set.
176 * 11 6/06/97 4:41p John
177 * Fixed alpha colors to be smoothly integrated into gr_set_color_fast
180 * 10 6/06/97 2:40p John
181 * Made all the radar dim in/out
183 * 9 6/05/97 4:53p John
184 * First rev of new antialiased font stuff.
186 * 8 5/12/97 12:27p John
187 * Restructured Graphics Library to add support for multiple renderers.
189 * 7 4/24/97 11:28a Hoffoss
190 * added code to handle gr_String being called before gr_init_font ever
193 * 6 4/23/97 5:26p John
194 * First rev of new debug console stuff.
196 * 5 4/22/97 12:20p John
197 * fixed more resource leaks
199 * 4 4/22/97 10:33a John
200 * fixed the 2d resource leaks that Alan found.
202 * 3 4/04/97 11:21a Hoffoss
203 * JOHN: Fixed invalid param that caused a trap in BoundsChecker.
205 * 2 4/01/97 9:26a Allender
206 * added support for descent style fonts although they are not used in the
209 * 1 3/31/97 9:42a Allender
216 #include <windowsx.h>
220 #include "grinternal.h"
227 #include "localize.h"
230 font Fonts[MAX_FONTS];
231 font *Current_font = NULL;
234 // crops a string if required to force it to not exceed max_width pixels when printed.
235 // Does this by dropping characters at the end of the string and adding '...' to the end.
236 // str = string to crop. Modifies this string directly
237 // max_str = max characters allowed in str
238 // max_width = number of pixels to limit string to (less than or equal to).
239 // Returns: returns same pointer passed in for str.
240 char *gr_force_fit_string(char *str, int max_str, int max_width)
244 gr_get_string_size(&w, NULL, str);
246 if ((int) strlen(str) > max_str - 3) {
247 Assert(max_str >= 3);
248 str[max_str - 3] = 0;
251 strcpy(str + strlen(str) - 1, "...");
252 gr_get_string_size(&w, NULL, str);
253 while (w > max_width) {
254 Assert(strlen(str) >= 4); // if this is hit, a bad max_width was passed in and the calling function needs fixing.
255 strcpy(str + strlen(str) - 4, "...");
256 gr_get_string_size(&w, NULL, str);
263 //takes the character BEFORE being offset into current font
264 // Returns the letter code
265 int get_char_width(ubyte c1,ubyte c2,int *width,int *spacing)
269 Assert ( Current_font != NULL );
270 letter = c1-Current_font->first_ascii;
272 if (letter<0 || letter>=Current_font->num_chars) { //not in font, draw as space
274 *spacing = Current_font->w;
278 *width = Current_font->char_data[letter].byte_width;
279 *spacing = Current_font->char_data[letter].spacing;
281 i = Current_font->char_data[letter].kerning_entry;
283 if (!(c2==0 || c2=='\n')) {
286 letter2 = c2-Current_font->first_ascii;
288 if ((letter2>=0) && (letter2<Current_font->num_chars) ) { //not in font, draw as space
289 font_kernpair *k = &Current_font->kern_data[i];
290 while( (k->c1 == letter) && (k->c2<letter2) && (i<Current_font->num_kern_pairs) ) {
294 if ( k->c2 == letter2 ) {
295 *spacing += k->offset;
303 int get_centered_x(char *s)
307 for (w=0;*s!=0 && *s!='\n';s++) {
308 get_char_width(s[0],s[1],&w2,&s2);
312 return ((gr_screen.clip_width - w) / 2);
315 // draws a character centered on x
316 void gr_char_centered(int x, int y, char chr)
321 sc = Lcl_special_chars;
323 chr = (char)(sc + 1);
327 gr_get_string_size(&w, NULL, str);
328 gr_string(x - w / 2, y, str);
331 void gr_print_timestamp(int x, int y, int timestamp)
333 char h[2], m[3], s[3];
336 // format the time information into strings
337 sprintf(h, "%0.1d", (timestamp / 3600000) % 10);
338 sprintf(m, "%0.2d", (timestamp / 60000) % 60);
339 sprintf(s, "%0.2d", (timestamp / 1000) % 60);
341 gr_get_string_size(&w, NULL, "0");
342 gr_get_string_size(&c, NULL, ":");
344 gr_string(x + w, y, ":");
345 gr_string(x + w * 3 + c, y, ":");
348 gr_char_centered(x, y, h[0]);
350 gr_char_centered(x, y, m[0]);
352 gr_char_centered(x, y, m[1]);
354 gr_char_centered(x, y, s[0]);
356 gr_char_centered(x, y, s[1]);
359 int gr_get_font_height()
362 return Current_font->h;
368 void gr_get_string_size(int *w1, int *h1, char *text, int len)
389 h += Current_font->h;
390 while (*text && (len>0) ) {
392 // Process one or more
393 while ((*text == '\n') && (len>0) ) {
397 h += Current_font->h;
406 get_char_width(text[0], text[1], &width, &spacing);
408 if (w > longest_width)
424 MONITOR( FontChars );
429 void gr8_char(int x,int y,int letter)
433 ch = &Current_font->char_data[letter];
435 gr_aabitmap_ex( x, y, ch->byte_width, Current_font->h, Current_font->u[letter], Current_font->v[letter] );
437 // mprintf(( "String = %s\n", text ));
441 void gr8_string( int sx, int sy, char *s )
443 int width, spacing, letter;
446 if ( !Current_font ) return;
449 gr_set_bitmap(Current_font->bitmap);
454 if (sx==0x8000) { //centered
455 x = get_centered_x(s);
463 y += Current_font->h;
464 if (sx==0x8000) { //centered
465 x = get_centered_x(s);
472 letter = get_char_width(s[0],s[1],&width,&spacing);
474 if (letter<0) { //not in font, draw as space
479 gr8_char( x, y, letter );
487 void gr8_string(int sx, int sy, char *s )
489 int row,width, spacing, letter;
492 if ( !Current_font ) return;
498 if (sx==0x8000) { //centered
499 x = get_centered_x(s);
510 MONITOR_INC( FontChars, 1 );
515 y += Current_font->h;
516 if (sx==0x8000) { //centered
517 x = get_centered_x(s);
524 letter = get_char_width(s[0],s[1],&width,&spacing);
527 //If not in font, draw as space
528 if (letter<0) continue;
533 // Check if this character is totally clipped
534 if ( x + width < gr_screen.clip_left ) continue;
535 if ( y + Current_font->h < gr_screen.clip_top ) continue;
536 if ( x > gr_screen.clip_right ) continue;
537 if ( y > gr_screen.clip_bottom ) continue;
540 if ( x < gr_screen.clip_left ) xd = gr_screen.clip_left - x;
541 if ( y < gr_screen.clip_top ) yd = gr_screen.clip_top - y;
545 wc = width - xd; hc = Current_font->h - yd;
546 if ( xc + wc > gr_screen.clip_right ) wc = gr_screen.clip_right - xc;
547 if ( yc + hc > gr_screen.clip_bottom ) hc = gr_screen.clip_bottom - yc;
549 if ( wc < 1 ) continue;
550 if ( hc < 1 ) continue;
552 ubyte *fp = Current_font->pixel_data + Current_font->char_data[letter].offset + xd + yd*width;
553 ubyte *dptr = GR_SCREEN_PTR(ubyte, xc, yc);
555 #ifndef HARDWARE_ONLY
556 if ( Current_alphacolor ) {
557 for (row=0; row<hc; row++) {
558 #ifdef USE_INLINE_ASM
559 ubyte *lookup = &Current_alphacolor->table.lookup[0][0];
578 _asm mov al, [edx+eax]
579 _asm mov ah, [edx+ebx]
584 _asm jnz InnerFontLoop
592 _asm mov al, [edx+eax]
596 dptr += gr_screen.rowsize;
600 for (i=0; i< wc; i++ ) {
601 *dptr++ = Current_alphacolor->table.lookup[*fp++][*dptr];
604 dptr += gr_screen.rowsize - wc;
607 } else { // No alpha color
609 for (row=0; row<hc; row++) {
611 for (i=0; i< wc; i++ ) {
613 *dptr = gr_screen.current_color.raw8;
618 dptr += gr_screen.rowsize - wc;
626 HFONT MyhFont = NULL;
630 void gr_string_win(int x, int y, char *s)
638 if ( MyhFont==NULL ) {
639 MyhFont = CreateFont(14, 0, 0, 0, // height,width,?,?
644 ANSI_CHARSET, // character set
648 DEFAULT_PITCH | FF_DONTCARE,
650 // "Times New Roman" );
656 SelectObject( hDibDC, MyhFont );
658 if ( gr_screen.bits_per_pixel==8 )
659 SetTextColor(hDibDC, PALETTEINDEX(gr_screen.current_color.raw8));
661 SetTextColor(hDibDC, RGB(gr_screen.current_color.red,gr_screen.current_color.green,gr_screen.current_color.blue));
663 SetBkMode(hDibDC,TRANSPARENT);
667 hclip = CreateRectRgn( gr_screen.offset_x,
669 gr_screen.offset_x+gr_screen.clip_width-1,
670 gr_screen.offset_y+gr_screen.clip_height-1 );
672 SelectClipRgn(hDibDC, hclip );
673 x += gr_screen.offset_x;
674 y += gr_screen.offset_y;
675 //ptr = strchr(s,'\n);
676 while ((ptr = strchr(s, '\n'))!=NULL) {
677 TextOut(hDibDC, x, y, s, ptr - s);
678 GetTextExtentPoint32(hDibDC, s, ptr - s, &size);
683 TextOut(hDibDC, x, y, s, strlen(s));
684 SelectClipRgn(hDibDC, NULL);
689 void gr_get_string_size_win(int *w, int *h, char *text)
697 ptr = strchr(text, '\n');
705 SelectObject( hDibDC, MyhFont );
708 GetTextExtentPoint32( hDibDC, text, strlen(text), &size);
714 GetTextExtentPoint32(hDibDC, text, ptr - text, &size);
715 gr_get_string_size_win(w, h, ptr+1);
716 if (w && (size.cx > *w) )
724 char grx_printf_text[2048];
726 void _cdecl gr_printf( int x, int y, char * format, ... )
730 if ( !Current_font ) return;
732 va_start(args, format);
733 vsprintf(grx_printf_text,format,args);
736 gr_string(x,y,grx_printf_text);
744 // Returns -1 if couldn't init font, otherwise returns the
746 int gr_create_font(char * typeface)
754 for (fontnum=0; fontnum<Num_fonts; fontnum++ ) {
756 if ( !_strnicmp( fnt->filename, typeface, MAX_FILENAME_LEN ) ) {
767 if ( fontnum==MAX_FONTS ) {
768 Error( LOCATION, "Too many fonts!\nSee John, or change MAX_FONTS in Graphics\\Font.h\n" );
771 if ( fontnum == Num_fonts ) {
775 bool localize = true;
777 fp = cfopen( typeface, "rb", CFILE_NORMAL, CF_TYPE_ANY, localize );
778 if ( fp == NULL ) return -1;
780 strncpy( fnt->filename, typeface, MAX_FILENAME_LEN );
781 cfread( &fnt->id, 4, 1, fp );
782 cfread( &fnt->version, sizeof(int), 1, fp );
783 cfread( &fnt->num_chars, sizeof(int), 1, fp );
784 cfread( &fnt->first_ascii, sizeof(int), 1, fp );
785 cfread( &fnt->w, sizeof(int), 1, fp );
786 cfread( &fnt->h, sizeof(int), 1, fp );
787 cfread( &fnt->num_kern_pairs, sizeof(int), 1, fp );
788 cfread( &fnt->kern_data_size, sizeof(int), 1, fp );
789 cfread( &fnt->char_data_size, sizeof(int), 1, fp );
790 cfread( &fnt->pixel_data_size, sizeof(int), 1, fp );
792 if ( fnt->kern_data_size ) {
793 fnt->kern_data = (font_kernpair *)malloc( fnt->kern_data_size );
794 Assert(fnt->kern_data!=NULL);
795 cfread( fnt->kern_data, fnt->kern_data_size, 1, fp );
797 fnt->kern_data = NULL;
799 if ( fnt->char_data_size ) {
800 fnt->char_data = (font_char *)malloc( fnt->char_data_size );
801 Assert( fnt->char_data != NULL );
802 cfread( fnt->char_data, fnt->char_data_size, 1, fp );
804 fnt->char_data = NULL;
806 if ( fnt->pixel_data_size ) {
807 fnt->pixel_data = (ubyte *)malloc( fnt->pixel_data_size );
808 Assert(fnt->pixel_data!=NULL);
809 cfread( fnt->pixel_data, fnt->pixel_data_size, 1, fp );
811 fnt->pixel_data = NULL;
815 // Create a bitmap for hardware cards.
816 // JAS: Try to squeeze this into the smallest square power of two texture.
817 // This should probably be done at font generation time, not here.
819 if ( fnt->pixel_data_size < 64*64 ) {
821 } else if ( fnt->pixel_data_size < 128*128 ) {
829 fnt->bm_data = (ubyte *)malloc(fnt->bm_w*fnt->bm_h);
830 fnt->bm_u = (int *)malloc(sizeof(int)*fnt->num_chars);
831 fnt->bm_v = (int *)malloc(sizeof(int)*fnt->num_chars);
835 for (i=0; i<fnt->num_chars; i++ ) {
838 fp = &fnt->pixel_data[fnt->char_data[i].offset];
839 if ( x + fnt->char_data[i].byte_width >= fnt->bm_w ) {
842 if ( y+fnt->h > fnt->bm_h ) {
843 Error( LOCATION, "Font too big!\n" );
849 for( y1=0; y1<fnt->h; y1++ ) {
850 for (x1=0; x1<fnt->char_data[i].byte_width; x1++ ) {
852 if ( c > 14 ) c = 14;
853 fnt->bm_data[(x+x1)+(y+y1)*fnt->bm_w] = (unsigned char)(c);
856 x += fnt->char_data[i].byte_width;
859 fnt->bitmap_id = bm_create( 8, fnt->bm_w, fnt->bm_h, fnt->bm_data, BMP_AABITMAP );
864 void grx_set_font(int fontnum)
871 if ( fontnum >= 0 ) {
872 Current_font = &Fonts[fontnum];
878 gr_init_font( NOX("font01.vf") );
879 gr_init_font( NOX("font02.vf") );
880 gr_init_font( NOX("font03.vf") );
883 // Returns -1 if couldn't init font, otherwise returns the
885 int gr_init_font(char * typeface)
889 Loaded_fontnum = gr_create_font(typeface);
891 Assert( Loaded_fontnum > -1 );
893 gr_set_font( Loaded_fontnum );
895 return Loaded_fontnum;