joystick updates from John Fay
[freeglut] / src / freeglut_font.c
1 /*
2  * freeglut_font.c
3  *
4  * Bitmap and stroke fonts displaying.
5  *
6  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
7  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
8  * Creation date: Thu Dec 16 1999
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining a
11  * copy of this software and associated documentation files (the "Software"),
12  * to deal in the Software without restriction, including without limitation
13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
14  * and/or sell copies of the Software, and to permit persons to whom the
15  * Software is furnished to do so, subject to the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be included
18  * in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
23  * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
24  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
25  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26  */
27
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include <GL/freeglut.h>
33 #include "freeglut_internal.h"
34
35 /*
36  * TODO BEFORE THE STABLE RELEASE:
37  *
38  *  Test things out ...
39  */
40
41 /* -- IMPORT DECLARATIONS -------------------------------------------------- */
42
43 /*
44  * These are the font faces defined in freeglut_font_data.c file:
45  */
46 extern SFG_Font fgFontFixed8x13;
47 extern SFG_Font fgFontFixed9x15;
48 extern SFG_Font fgFontHelvetica10;
49 extern SFG_Font fgFontHelvetica12;
50 extern SFG_Font fgFontHelvetica18;
51 extern SFG_Font fgFontTimesRoman10;
52 extern SFG_Font fgFontTimesRoman24;
53 extern SFG_StrokeFont fgStrokeRoman;
54 extern SFG_StrokeFont fgStrokeMonoRoman;
55
56
57 /* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
58
59 /*
60  * Matches a font ID with a SFG_Font structure pointer.
61  * This was changed to match the GLUT header style.
62  */
63 static SFG_Font* fghFontByID( void* font )
64 {
65     if( font == GLUT_BITMAP_8_BY_13        )
66         return &fgFontFixed8x13;
67     if( font == GLUT_BITMAP_9_BY_15        )
68         return &fgFontFixed9x15;
69     if( font == GLUT_BITMAP_HELVETICA_10   )
70         return &fgFontHelvetica10;
71     if( font == GLUT_BITMAP_HELVETICA_12   )
72         return &fgFontHelvetica12;
73     if( font == GLUT_BITMAP_HELVETICA_18   )
74         return &fgFontHelvetica18;
75     if( font == GLUT_BITMAP_TIMES_ROMAN_10 )
76         return &fgFontTimesRoman10;
77     if( font == GLUT_BITMAP_TIMES_ROMAN_24 )
78         return &fgFontTimesRoman24;
79
80     fgError( "font 0x%08x not found", font );
81     return 0; /*** NOT REACHED ***/
82 }
83
84 /*
85  * Matches a font ID with a SFG_StrokeFont structure pointer.
86  * This was changed to match the GLUT header style.
87  */
88 static SFG_StrokeFont* fghStrokeByID( void* font )
89 {
90     if( font == GLUT_STROKE_ROMAN      )
91         return &fgStrokeRoman;
92     if( font == GLUT_STROKE_MONO_ROMAN )
93         return &fgStrokeMonoRoman;
94
95     fgError( "stroke font 0x%08x not found", font );
96     return 0; /*** NOT REACHED ***/
97 }
98
99
100 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
101
102 /*
103  * Draw a bitmap character
104  */
105 void FGAPIENTRY glutBitmapCharacter( void* fontID, int character )
106 {
107     const GLubyte* face;
108     SFG_Font* font = fghFontByID( fontID );
109
110     freeglut_return_if_fail( ( character >= 1 )&&( character < 256 ) );
111
112     /*
113      * Find the character we want to draw (???)
114      */
115     face = font->Characters[ character ];
116
117     glPushClientAttrib( GL_CLIENT_PIXEL_STORE_BIT );
118     glPixelStorei( GL_UNPACK_SWAP_BYTES,  GL_FALSE );
119     glPixelStorei( GL_UNPACK_LSB_FIRST,   GL_FALSE );
120     glPixelStorei( GL_UNPACK_ROW_LENGTH,  0        );
121     glPixelStorei( GL_UNPACK_SKIP_ROWS,   0        );
122     glPixelStorei( GL_UNPACK_SKIP_PIXELS, 0        );
123     glPixelStorei( GL_UNPACK_ALIGNMENT,   1        );
124     glBitmap(
125         face[ 0 ], font->Height,      /* The bitmap's width and height  */
126         font->xorig, font->yorig,     /* The origin in the font glyph   */
127         ( float )( face[ 0 ] ), 0.0,  /* The raster advance -- inc. x,y */
128         ( face + 1 )                  /* The packed bitmap data...      */
129     );
130     glPopClientAttrib( );
131 }
132
133 void FGAPIENTRY glutBitmapString( void* fontID, const unsigned char *string )
134 {
135     int c;
136     int numchar = strlen( (char *) string );
137     SFG_Font* font = fghFontByID( fontID );
138     float x = 0.0f ;
139
140     glPushClientAttrib( GL_CLIENT_PIXEL_STORE_BIT );
141     glPixelStorei( GL_UNPACK_SWAP_BYTES,  GL_FALSE );
142     glPixelStorei( GL_UNPACK_LSB_FIRST,   GL_FALSE );
143     glPixelStorei( GL_UNPACK_ROW_LENGTH,  0        );
144     glPixelStorei( GL_UNPACK_SKIP_ROWS,   0        );
145     glPixelStorei( GL_UNPACK_SKIP_PIXELS, 0        );
146     glPixelStorei( GL_UNPACK_ALIGNMENT,   1        );
147
148     /*
149      * Step through the string, drawing each character.
150      * A newline will simply translate the next character's insertion
151      * point back to the start of the line and down one line.
152      */
153     for( c = 0; c < numchar; c++ )
154         if( string[c] == '\n' )
155         {
156             glBitmap ( 0, 0, 0, 0, -x, (float) -font->Height, NULL );
157             x = 0.0f;
158         }
159         else  /* Not an EOL, draw the bitmap character */
160         {
161             const GLubyte* face = font->Characters[ string[ c ] ];
162
163             glBitmap(
164                 face[ 0 ], font->Height,     /* Bitmap's width and height    */
165                 font->xorig, font->yorig,    /* The origin in the font glyph */
166                 ( float )( face[ 0 ] ), 0.0, /* The raster advance; inc. x,y */
167                 ( face + 1 )                 /* The packed bitmap data...    */
168             );
169
170             x += ( float )( face[ 0 ] );
171         }
172
173     glPopClientAttrib( );
174 }
175
176 /*
177  * Returns the width in pixels of a font's character
178  */
179 int FGAPIENTRY glutBitmapWidth( void* fontID, int character )
180 {
181     SFG_Font* font = fghFontByID( fontID );
182
183     freeglut_return_val_if_fail( character > 0 && character < 256, 0 );
184     return *( font->Characters[ character ] );
185 }
186
187 /*
188  * Return the width of a string drawn using a bitmap font
189  */
190 int FGAPIENTRY glutBitmapLength( void* fontID, const unsigned char* string )
191 {
192     int c, length = 0, this_line_length = 0;
193     SFG_Font* font = fghFontByID( fontID );
194     int numchar = strlen( (char *) string );
195
196     for( c = 0; c < numchar; c++ )
197     {
198         if( string[ c ] != '\n' )/* Not an EOL, increment length of line */
199             this_line_length += *( font->Characters[ string[ c ] ]);
200         else  /* EOL; reset the length of this line */
201         {
202             if( length < this_line_length )
203                 length = this_line_length;
204             this_line_length = 0;
205         }
206     }
207     if ( length < this_line_length )
208         length = this_line_length;
209
210     return length;
211 }
212
213 /*
214  * Returns the height of a bitmap font
215  */
216 int FGAPIENTRY glutBitmapHeight( void* fontID )
217 {
218     SFG_Font* font = fghFontByID( fontID );
219     return font->Height;
220 }
221
222 /*
223  * Draw a stroke character
224  */
225 void FGAPIENTRY glutStrokeCharacter( void* fontID, int character )
226 {
227     const SFG_StrokeChar *schar;
228     const SFG_StrokeStrip *strip;
229     int i, j;
230     SFG_StrokeFont* font = fghStrokeByID( fontID );
231
232     freeglut_return_if_fail( character >= 0 );
233     freeglut_return_if_fail( character < font->Quantity );
234
235     schar = font->Characters[ character ];
236     freeglut_return_if_fail( schar );
237     strip = schar->Strips;
238
239     for( i = 0; i < schar->Number; i++, strip++ )
240     {
241         glBegin( GL_LINE_STRIP );
242         for( j = 0; j < strip->Number; j++ )
243             glVertex2f( strip->Vertices[ j ].X, strip->Vertices[ j ].Y );
244         glEnd( );
245     }
246     glTranslatef( schar->Right, 0.0, 0.0 );
247 }
248
249 void FGAPIENTRY glutStrokeString( void* fontID, const unsigned char *string )
250 {
251     int c, i, j;
252     int numchar = strlen( (char *) string );
253     float length = 0.0;
254     SFG_StrokeFont* font = fghStrokeByID( fontID );
255
256     /*
257      * Step through the string, drawing each character.
258      * A newline will simply translate the next character's insertion
259      * point back to the start of the line and down one line.
260      */
261     for( c = 0; c < numchar; c++ )
262         if( string[ c ] < font->Quantity )
263         {
264             if( string[ c ] == '\n' )
265             {
266                 glTranslatef ( -length, -( float )( font->Height ), 0.0 );
267                 length = 0.0;
268             }
269             else  /* Not an EOL, draw the bitmap character */
270             {
271                 const SFG_StrokeChar *schar = font->Characters[ string[ c ] ];
272                 if( schar )
273                 {
274                     const SFG_StrokeStrip *strip = schar->Strips;
275
276                     for( i = 0; i < schar->Number; i++, strip++ )
277                     {
278                         glBegin( GL_LINE_STRIP );
279                         for( j = 0; j < strip->Number; j++ )
280                             glVertex2f( strip->Vertices[ j ].X,
281                                         strip->Vertices[ j ].Y);
282
283                         glEnd( );
284                     }
285
286                     length += schar->Right;
287                     glTranslatef( schar->Right, 0.0, 0.0 );
288                 }
289             }
290         }
291 }
292
293 /*
294  * Return the width in pixels of a stroke character
295  */
296 int FGAPIENTRY glutStrokeWidth( void* fontID, int character )
297 {
298     const SFG_StrokeChar *schar;
299     SFG_StrokeFont* font = fghStrokeByID( fontID );
300
301     freeglut_return_val_if_fail( ( character >= 0 ) &&
302                                  ( character < font->Quantity ),
303                                  0
304     );
305     schar = font->Characters[ character ];
306     freeglut_return_val_if_fail( schar, 0 );
307
308     return ( int )( schar->Right + 0.5 );
309 }
310
311 /*
312  * Return the width of a string drawn using a stroke font
313  */
314 int FGAPIENTRY glutStrokeLength( void* fontID, const unsigned char* string )
315 {
316     int c;
317     float length = 0.0;
318     float this_line_length = 0.0;
319     SFG_StrokeFont* font = fghStrokeByID( fontID );
320     int numchar = strlen( (char *) string );
321
322     for( c = 0; c < numchar; c++ )
323         if( string[ c ] < font->Quantity )
324         {
325             if( string[ c ] == '\n' ) /* EOL; reset the length of this line */
326             {
327                 if( length < this_line_length )
328                     length = this_line_length;
329                 this_line_length = 0.0;
330             }
331             else  /* Not an EOL, increment the length of this line */
332             {
333                 const SFG_StrokeChar *schar = font->Characters[ string[ c ] ];
334                 if( schar )
335                     this_line_length += schar->Right;
336             }
337         }
338     if( length < this_line_length )
339         length = this_line_length;
340     return( int )( length + 0.5 );
341 }
342
343 /*
344  * Returns the height of a stroke font
345  */
346 GLfloat FGAPIENTRY glutStrokeHeight( void* fontID )
347 {
348     SFG_StrokeFont* font = fghStrokeByID( fontID );
349     return font->Height;
350 }
351
352 /*** END OF FILE ***/