]> de.git.xonotic.org Git - xonotic/netradiant.git/blob - libs/gtkutil/glfont.cpp
09211a05450d3bd103dfb691ff8e6bfb9b04dde2
[xonotic/netradiant.git] / libs / gtkutil / glfont.cpp
1 /*
2    Copyright (C) 2001-2006, William Joseph.
3    All Rights Reserved.
4
5    This file is part of GtkRadiant.
6
7    GtkRadiant is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    GtkRadiant is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with GtkRadiant; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20  */
21
22 #include "glfont.h"
23 #include "igl.h"
24
25 // generic string printing with call lists
26 class GLFontCallList : public GLFont
27 {
28 GLuint m_displayList;
29 int m_pixelHeight;
30 int m_pixelAscent;
31 int m_pixelDescent;
32 public:
33 GLFontCallList( GLuint displayList, int asc, int desc, int pixelHeight ) : m_displayList( displayList ), m_pixelHeight( pixelHeight ), m_pixelAscent( asc ), m_pixelDescent( desc ){
34 }
35 virtual ~GLFontCallList(){
36         glDeleteLists( m_displayList, 256 );
37 }
38 void printString( const char *s ){
39         GlobalOpenGL().m_glListBase( m_displayList );
40         GlobalOpenGL().m_glCallLists( GLsizei( strlen( s ) ), GL_UNSIGNED_BYTE, reinterpret_cast<const GLubyte*>( s ) );
41 }
42 virtual int getPixelAscent() const {
43         return m_pixelAscent;
44 }
45 virtual int getPixelDescent() const {
46         return m_pixelDescent;
47 }
48 virtual int getPixelHeight() const {
49         return m_pixelHeight;
50 }
51 };
52
53 #ifdef _WIN32
54         #include <windows.h>
55 #endif
56 #include "debugging/debugging.h"
57
58 // LordHavoc: this is code for direct Xlib bitmap character fetching, as an
59 // alternative to requiring gtkglarea, it was created due to a lack of this
60 // package on SuSE 9.x but this package is now commonly shipping in Linux
61 // distributions so this code may be unnecessary, feel free however to enable
62 // it when building packages for distros that do not ship with that package,
63 // or if you just prefer less dependencies...
64 #if 0
65
66 #include <X11/Xlib.h>
67 #include <gdk/gdkx.h>
68 #include <GL/glx.h>
69
70 GLFont *glfont_create( const char* font_string ){
71         GLuint font_list_base;
72         XFontStruct *fontInfo;
73         Display *dpy = GDK_DISPLAY();
74         unsigned int i, first, last, firstrow, lastrow;
75         int maxchars;
76         int firstbitmap;
77
78         fontInfo = XLoadQueryFont( dpy, "-*-fixed-*-*-*-*-8-*-*-*-*-*-*-*" );
79         if ( fontInfo == NULL ) {
80                 // try to load other fonts
81                 fontInfo = XLoadQueryFont( dpy, "-*-fixed-*-*-*-*-*-*-*-*-*-*-*-*" );
82
83                 // any font will do !
84                 if ( fontInfo == NULL ) {
85                         fontInfo = XLoadQueryFont( dpy, "-*-*-*-*-*-*-*-*-*-*-*-*-*-*" );
86                 }
87
88                 if ( fontInfo == NULL ) {
89                         ERROR_MESSAGE( "couldn't create font" );
90                 }
91         }
92
93         first = (int)fontInfo->min_char_or_byte2;
94         last = (int)fontInfo->max_char_or_byte2;
95         firstrow = (int)fontInfo->min_byte1;
96         lastrow = (int)fontInfo->max_byte1;
97         /*
98          * How many chars in the charset
99          */
100         maxchars = 256 * lastrow + last;
101         font_list_base = glGenLists( maxchars + 1 );
102         if ( font_list_base == 0 ) {
103                 ERROR_MESSAGE( "couldn't create font" );
104         }
105
106         /*
107          * Get offset to first char in the charset
108          */
109         firstbitmap = 256 * firstrow + first;
110         /*
111          * for each row of chars, call glXUseXFont to build the bitmaps.
112          */
113
114         for ( i = firstrow; i <= lastrow; i++ )
115         {
116                 glXUseXFont( fontInfo->fid, firstbitmap, last - first + 1, font_list_base + firstbitmap );
117                 firstbitmap += 256;
118         }
119
120 /*    *height = fontInfo->ascent + fontInfo->descent;
121  *width = fontInfo->max_bounds.width;  */
122         return new GLFontCallList( font_list_base, fontInfo->ascent, fontInfo->descent, fontInfo->ascent + fontInfo->descent );
123 }
124
125 #elif 0
126
127 #include <gtk/gtkglwidget.h>
128
129 GLFont *glfont_create( const char* font_string ){
130         GLuint font_list_base = glGenLists( 256 );
131         gint font_height = 0, font_ascent = 0, font_descent = 0;
132
133         PangoFontDescription* font_desc = pango_font_description_from_string( font_string );
134
135         PangoFont* font = gdk_gl_font_use_pango_font( font_desc, 0, 256, font_list_base );
136
137         if ( font == 0 ) {
138                 pango_font_description_free( font_desc );
139                 font_desc = pango_font_description_from_string( "fixed 8" );
140                 font = gdk_gl_font_use_pango_font( font_desc, 0, 256, font_list_base );
141         }
142
143         if ( font == 0 ) {
144                 pango_font_description_free( font_desc );
145                 font_desc = pango_font_description_from_string( "courier new 8" );
146                 font = gdk_gl_font_use_pango_font( font_desc, 0, 256, font_list_base );
147         }
148
149         if ( font != 0 ) {
150                 PangoFontMetrics* font_metrics = pango_font_get_metrics( font, 0 );
151
152                 font_ascent = pango_font_metrics_get_ascent( font_metrics );
153                 font_descent = pango_font_metrics_get_descent( font_metrics );
154                 font_height = font_ascent + font_descent;
155
156                 font_ascent = PANGO_PIXELS( font_ascent );
157                 font_descent = PANGO_PIXELS( font_descent );
158                 font_height = PANGO_PIXELS( font_height );
159
160                 pango_font_metrics_unref( font_metrics );
161         }
162
163         pango_font_description_free( font_desc );
164
165         // fix for pango/gtkglext metrix bug
166         if ( font_height > 256 ) {
167                 font_height = 16;
168         }
169
170         return new GLFontCallList( font_list_base, font_ascent, font_descent, font_height );
171 }
172 #else
173
174 // new font code ripped from ZeroRadiant
175
176 #include <pango/pangoft2.h>
177 #include <pango/pango-utils.h>
178
179 class GLFontInternal : public GLFont
180 {
181 const char *font_string;
182 int font_height;
183 int font_ascent;
184 int font_descent;
185 int y_offset_bitmap_render_pango_units;
186 PangoContext *ft2_context;
187 PangoFontMap *fontmap;
188
189 public:
190 GLFontInternal( const char *_font_string ) : font_string( _font_string ){
191         PangoFontDescription *font_desc;
192         PangoLayout *layout;
193         PangoRectangle log_rect;
194         int font_ascent_pango_units;
195         int font_descent_pango_units;
196
197 #if !PANGO_VERSION_CHECK( 1,22,0 )
198         ft2_context = pango_ft2_get_context( 72, 72 );
199 #else
200         fontmap = pango_ft2_font_map_new();
201         pango_ft2_font_map_set_resolution( PANGO_FT2_FONT_MAP( fontmap ), 72, 72 );
202         ft2_context = pango_font_map_create_context( fontmap );
203 #endif
204
205         font_desc = pango_font_description_from_string( font_string );
206         //pango_font_description_set_size(font_desc, 10 * PANGO_SCALE);
207         pango_context_set_font_description( ft2_context, font_desc );
208         pango_font_description_free( font_desc );
209         // TODO fallback to fixed 8, courier new 8
210
211         layout = pango_layout_new( ft2_context );
212
213 #ifdef FONT_SIZE_WORKAROUND
214         pango_layout_set_width( layout, -1 );   // -1 no wrapping.  All text on one line.
215         pango_layout_set_text( layout, "The quick brown fox jumped over the lazy sleeping dog's back then sat on a tack.", -1 );   // -1 null-terminated string.
216 #endif
217
218 #if !PANGO_VERSION_CHECK( 1,22,0 )
219         PangoLayoutIter *iter;
220         iter = pango_layout_get_iter( layout );
221         font_ascent_pango_units = pango_layout_iter_get_baseline( iter );
222         pango_layout_iter_free( iter );
223 #else
224         font_ascent_pango_units = pango_layout_get_baseline( layout );
225 #endif
226         pango_layout_get_extents( layout, NULL, &log_rect );
227         g_object_unref( G_OBJECT( layout ) );
228         font_descent_pango_units = log_rect.height - font_ascent_pango_units;
229
230         font_ascent = PANGO_PIXELS_CEIL( font_ascent_pango_units );
231         font_descent = PANGO_PIXELS_CEIL( font_descent_pango_units );
232         font_height = font_ascent + font_descent;
233         y_offset_bitmap_render_pango_units = ( font_ascent * PANGO_SCALE ) - font_ascent_pango_units;
234 }
235
236 virtual ~GLFontInternal(){
237         g_object_unref( G_OBJECT( ft2_context ) );
238         g_object_unref( G_OBJECT( fontmap ) );
239 }
240
241 // Renders the input text at the current location with the current color.
242 // The X position of the current location is used to place the left edge of the text image,
243 // where the text image bounds are defined as the logical extents of the line of text.
244 // The Y position of the current location is used to place the bottom of the text image.
245 // You should offset the Y position by the amount returned by gtk_glwidget_font_descent()
246 // if you want to place the baseline of the text image at the current Y position.
247 // Note: A problem with this function is that if the lower left corner of the text falls
248 // just a hair outside of the viewport (meaning the current raster position is invalid),
249 // then no text will be rendered.  The solution to this is a very hacky one.  You can search
250 // Google for "glDrawPixels clipping".
251 virtual void printString( const char *s ){
252         // The idea for this code initially came from the font-pangoft2.c example that comes with GtkGLExt.
253
254         PangoLayout *layout;
255         PangoRectangle log_rect;
256         FT_Bitmap bitmap;
257         unsigned char *begin_bitmap_buffer;
258         GLfloat color[4];
259         GLint previous_unpack_alignment;
260         GLboolean previous_blend_enabled;
261         GLint previous_blend_func_src;
262         GLint previous_blend_func_dst;
263         GLfloat previous_red_bias;
264         GLfloat previous_green_bias;
265         GLfloat previous_blue_bias;
266         GLfloat previous_alpha_scale;
267
268         layout = pango_layout_new( ft2_context );
269         pango_layout_set_width( layout, -1 );   // -1 no wrapping.  All text on one line.
270         pango_layout_set_text( layout, s, -1 );   // -1 null-terminated string.
271         pango_layout_get_extents( layout, NULL, &log_rect );
272
273         if ( log_rect.width > 0 && log_rect.height > 0 ) {
274                 bitmap.rows = font_ascent + font_descent;
275                 bitmap.width = PANGO_PIXELS_CEIL( log_rect.width );
276                 bitmap.pitch = -bitmap.width;     // Rendering it "upside down" for OpenGL.
277                 begin_bitmap_buffer = (unsigned char *) g_malloc( bitmap.rows * bitmap.width );
278                 memset( begin_bitmap_buffer, 0, bitmap.rows * bitmap.width );
279                 bitmap.buffer = begin_bitmap_buffer + ( bitmap.rows - 1 ) * bitmap.width;   // See pitch above.
280                 bitmap.num_grays = 0xff;
281                 bitmap.pixel_mode = FT_PIXEL_MODE_GRAY;
282                 pango_ft2_render_layout_subpixel( &bitmap, layout, -log_rect.x,
283                                                                                   y_offset_bitmap_render_pango_units );
284                 GlobalOpenGL().m_glGetFloatv( GL_CURRENT_COLOR, color );
285
286                 // Save state.  I didn't see any OpenGL push/pop operations for these.
287                 // Question: Is saving/restoring this state necessary?  Being safe.
288                 GlobalOpenGL().m_glGetIntegerv( GL_UNPACK_ALIGNMENT, &previous_unpack_alignment );
289                 previous_blend_enabled = GlobalOpenGL().m_glIsEnabled( GL_BLEND );
290                 GlobalOpenGL().m_glGetIntegerv( GL_BLEND_SRC, &previous_blend_func_src );
291                 GlobalOpenGL().m_glGetIntegerv( GL_BLEND_DST, &previous_blend_func_dst );
292                 GlobalOpenGL().m_glGetFloatv( GL_RED_BIAS, &previous_red_bias );
293                 GlobalOpenGL().m_glGetFloatv( GL_GREEN_BIAS, &previous_green_bias );
294                 GlobalOpenGL().m_glGetFloatv( GL_BLUE_BIAS, &previous_blue_bias );
295                 GlobalOpenGL().m_glGetFloatv( GL_ALPHA_SCALE, &previous_alpha_scale );
296
297                 GlobalOpenGL().m_glPixelStorei( GL_UNPACK_ALIGNMENT, 1 );
298                 GlobalOpenGL().m_glEnable( GL_BLEND );
299                 GlobalOpenGL().m_glBlendFunc( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA );
300                 GlobalOpenGL().m_glPixelTransferf( GL_RED_BIAS, color[0] );
301                 GlobalOpenGL().m_glPixelTransferf( GL_GREEN_BIAS, color[1] );
302                 GlobalOpenGL().m_glPixelTransferf( GL_BLUE_BIAS, color[2] );
303                 GlobalOpenGL().m_glPixelTransferf( GL_ALPHA_SCALE, color[3] );
304
305                 GlobalOpenGL().m_glDrawPixels( bitmap.width, bitmap.rows,
306                                                                            GL_ALPHA, GL_UNSIGNED_BYTE, begin_bitmap_buffer );
307                 g_free( begin_bitmap_buffer );
308
309                 // Restore state in reverse order of how we set it.
310                 GlobalOpenGL().m_glPixelTransferf( GL_ALPHA_SCALE, previous_alpha_scale );
311                 GlobalOpenGL().m_glPixelTransferf( GL_BLUE_BIAS, previous_blue_bias );
312                 GlobalOpenGL().m_glPixelTransferf( GL_GREEN_BIAS, previous_green_bias );
313                 GlobalOpenGL().m_glPixelTransferf( GL_RED_BIAS, previous_red_bias );
314                 GlobalOpenGL().m_glBlendFunc( previous_blend_func_src, previous_blend_func_dst );
315                 if ( !previous_blend_enabled ) {
316                         GlobalOpenGL().m_glDisable( GL_BLEND );
317                 }
318                 GlobalOpenGL().m_glPixelStorei( GL_UNPACK_ALIGNMENT, previous_unpack_alignment );
319         }
320
321         g_object_unref( G_OBJECT( layout ) );
322 }
323
324 virtual int getPixelAscent() const {
325         return font_ascent;
326 }
327 virtual int getPixelDescent() const {
328         return font_descent;
329 }
330 virtual int getPixelHeight() const {
331         return font_height;
332 }
333 };
334
335 GLFont *glfont_create( const char* font_string ){
336         return new GLFontInternal( font_string );
337 }
338
339 #endif