3 // includes everything!
\r
4 #include <OffscreenGecko/browser.h>
\r
7 # pragma comment( lib, "OffscreenGecko" )
\r
10 #include "quakedef.h"
\r
11 #include "cl_dyntexture.h"
\r
12 #include "cl_gecko.h"
\r
15 #define DEFAULT_GECKO_SIZE 512
\r
17 static rtexturepool_t *cl_geckotexturepool;
\r
18 static OSGK_Embedding *cl_geckoembedding;
\r
22 char name[ MAX_QPATH + 32 ];
\r
24 OSGK_Browser *browser;
\r
26 int texWidth, texHeight;
\r
28 rtexture_t *texture;
\r
31 static clgecko_t cl_geckoinstances[ MAX_GECKO_INSTANCES ];
\r
33 static clgecko_t * cl_gecko_findunusedinstance( void ) {
\r
35 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
36 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
37 if( !instance->active ) {
\r
41 if( developer.integer > 0 ) {
\r
42 Con_Printf( "cl_gecko_findunusedinstance: out of geckos\n" );
\r
47 clgecko_t * CL_Gecko_FindBrowser( const char *name ) {
\r
50 if( !name || !*name || strncmp( name, CLGECKOPREFIX, sizeof( CLGECKOPREFIX ) - 1 ) != 0 ) {
\r
51 if( developer.integer > 0 ) {
\r
52 Con_Printf( "CL_Gecko_FindBrowser: Bad gecko texture name '%s'!\n", name );
\r
57 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
58 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
59 if( instance->active && strcmp( instance->name, name ) == 0 ) {
\r
64 if( developer.integer > 0 ) {
\r
65 Con_Printf( "CL_Gecko_FindBrowser: No browser named '%s'!\n", name );
\r
71 static void cl_gecko_updatecallback( rtexture_t *texture, clgecko_t *instance ) {
\r
72 const unsigned char *data;
\r
73 if( instance->browser ) {
\r
74 // TODO: OSGK only supports BGRA right now
\r
75 TIMING_TIMESTATEMENT(data = osgk_browser_lock_data( instance->browser, NULL ));
\r
76 R_UpdateTexture( texture, data, 0, 0, instance->width, instance->height );
\r
77 osgk_browser_unlock_data( instance->browser, data );
\r
81 static void cl_gecko_linktexture( clgecko_t *instance ) {
\r
82 // TODO: assert that instance->texture == NULL
\r
83 instance->texture = R_LoadTexture2D( cl_geckotexturepool, instance->name,
\r
84 instance->texWidth, instance->texHeight, NULL, TEXTYPE_BGRA, TEXF_ALPHA | TEXF_PERSISTENT, NULL );
\r
85 R_MakeTextureDynamic( instance->texture, cl_gecko_updatecallback, instance );
\r
86 CL_LinkDynTexture( instance->name, instance->texture );
\r
89 static void cl_gecko_unlinktexture( clgecko_t *instance ) {
\r
90 if( instance->texture ) {
\r
91 CL_UnlinkDynTexture( instance->name );
\r
92 R_FreeTexture( instance->texture );
\r
93 instance->texture = NULL;
\r
97 void CL_Gecko_Resize( clgecko_t *instance, int width, int height ) {
\r
98 int newWidth, newHeight;
\r
100 // early out if bad parameters are passed (no resize to a texture size bigger than the original texture size)
\r
101 if( !instance || !instance->browser) {
\r
105 newWidth = CeilPowerOf2( width );
\r
106 newHeight = CeilPowerOf2( height );
\r
107 if ((newWidth != instance->texWidth) || (newHeight != instance->texHeight))
\r
109 cl_gecko_unlinktexture( instance );
\r
110 instance->texWidth = newWidth;
\r
111 instance->texHeight = newHeight;
\r
112 cl_gecko_linktexture( instance );
\r
116 /* The gecko area will only cover a part of the texture; to avoid
\r
117 'old' pixels bleeding in at the border clear the texture. */
\r
118 R_ClearTexture( instance->texture );
\r
121 osgk_browser_resize( instance->browser, width, height);
\r
122 instance->width = width;
\r
123 instance->height = height;
\r
126 void CL_Gecko_GetTextureExtent( clgecko_t *instance, float* pwidth, float* pheight )
\r
128 if( !instance || !instance->browser ) {
\r
132 *pwidth = (float)instance->width / instance->texWidth;
\r
133 *pheight = (float)instance->height / instance->texHeight;
\r
137 clgecko_t * CL_Gecko_CreateBrowser( const char *name ) {
\r
138 // TODO: verify that we dont use a name twice
\r
139 clgecko_t *instance = cl_gecko_findunusedinstance();
\r
140 // TODO: assert != NULL
\r
142 if( cl_geckoembedding == NULL ) {
\r
143 char profile_path [MAX_OSPATH];
\r
144 OSGK_GeckoResult grc;
\r
145 OSGK_EmbeddingOptions *options;
\r
147 if( developer.integer > 0 ) {
\r
148 Con_Printf( "CL_Gecko_CreateBrowser: setting up gecko embedding\n" );
\r
151 options = osgk_embedding_options_create();
\r
152 osgk_embedding_options_add_search_path( options, "./xulrunner/" );
\r
153 dpsnprintf (profile_path, sizeof (profile_path), "%s/xulrunner_profile/", fs_gamedir);
\r
154 osgk_embedding_options_set_profile_dir( options, profile_path, 0 );
\r
155 cl_geckoembedding = osgk_embedding_create_with_options( options, &grc );
\r
156 osgk_release( options );
\r
158 if( cl_geckoembedding == NULL ) {
\r
159 Con_Printf( "CL_Gecko_CreateBrowser: Couldn't retrieve gecko embedding object (%.8x)!\n", grc );
\r
161 } else if( developer.integer > 0 ) {
\r
162 Con_Printf( "CL_Gecko_CreateBrowser: Embedding set up correctly\n" );
\r
166 instance->active = true;
\r
167 strlcpy( instance->name, name, sizeof( instance->name ) );
\r
168 instance->browser = osgk_browser_create( cl_geckoembedding, DEFAULT_GECKO_SIZE, DEFAULT_GECKO_SIZE );
\r
169 if( instance->browser == NULL ) {
\r
170 Con_Printf( "CL_Gecko_CreateBrowser: Browser object creation failed!\n" );
\r
172 // TODO: assert != NULL
\r
174 instance->width = instance->texWidth = DEFAULT_GECKO_SIZE;
\r
175 instance->height = instance->texHeight = DEFAULT_GECKO_SIZE;
\r
176 cl_gecko_linktexture( instance );
\r
181 void CL_Gecko_DestroyBrowser( clgecko_t *instance ) {
\r
182 if( !instance || !instance->active ) {
\r
186 instance->active = false;
\r
187 cl_gecko_unlinktexture( instance );
\r
189 osgk_release( instance->browser );
\r
190 instance->browser = NULL;
\r
193 void CL_Gecko_Frame( void ) {
\r
195 // FIXME: track cl_numgeckoinstances to avoid scanning the entire array?
\r
196 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
197 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
198 if( instance->active ) {
\r
199 if( instance->browser && osgk_browser_query_dirty( instance->browser ) == 1 ) {
\r
200 R_MarkDirtyTexture( instance->texture );
\r
206 static void cl_gecko_start( void )
\r
209 cl_geckotexturepool = R_AllocTexturePool();
\r
211 // recreate textures on module start
\r
212 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
213 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
214 if( instance->active ) {
\r
215 cl_gecko_linktexture( instance );
\r
220 static void cl_gecko_shutdown( void )
\r
223 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
224 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
225 if( instance->active ) {
\r
226 cl_gecko_unlinktexture( instance );
\r
229 R_FreeTexturePool( &cl_geckotexturepool );
\r
232 static void cl_gecko_newmap( void )
\r
237 void CL_Gecko_Shutdown( void ) {
\r
239 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
240 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
241 if( instance->active ) {
\r
242 cl_gecko_unlinktexture( instance );
\r
246 if (cl_geckoembedding != NULL)
\r
248 osgk_release( cl_geckoembedding );
\r
249 cl_geckoembedding = NULL;
\r
253 static void cl_gecko_create_f( void ) {
\r
254 char name[MAX_QPATH];
\r
256 if (Cmd_Argc() != 2)
\r
258 Con_Print("usage: gecko_create <name>\npcreates a browser (full texture path " CLGECKOPREFIX "<name>)\n");
\r
262 // TODO: use snprintf instead
\r
263 sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));
\r
264 CL_Gecko_CreateBrowser( name );
\r
267 static void cl_gecko_destroy_f( void ) {
\r
268 char name[MAX_QPATH];
\r
270 if (Cmd_Argc() != 2)
\r
272 Con_Print("usage: gecko_destroy <name>\ndestroys a browser\n");
\r
276 // TODO: use snprintf instead
\r
277 sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));
\r
278 CL_Gecko_DestroyBrowser( CL_Gecko_FindBrowser( name ) );
\r
281 static void cl_gecko_navigate_f( void ) {
\r
282 char name[MAX_QPATH];
\r
285 if (Cmd_Argc() != 3)
\r
287 Con_Print("usage: gecko_navigate <name> <URI>\nnavigates to a certain URI\n");
\r
291 // TODO: use snprintf instead
\r
292 sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));
\r
293 URI = Cmd_Argv( 2 );
\r
294 CL_Gecko_NavigateToURI( CL_Gecko_FindBrowser( name ), URI );
\r
297 static void cl_gecko_injecttext_f( void ) {
\r
298 char name[MAX_QPATH];
\r
300 clgecko_t *instance;
\r
303 if (Cmd_Argc() < 3)
\r
305 Con_Print("usage: gecko_injecttext <name> <text>\ninjects a certain text into the browser\n");
\r
309 // TODO: use snprintf instead
\r
310 sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));
\r
311 instance = CL_Gecko_FindBrowser( name );
\r
313 Con_Printf( "cl_gecko_injecttext_f: gecko instance '%s' couldn't be found!\n", name );
\r
317 text = Cmd_Argv( 2 );
\r
319 for( p = text ; *p ; p++ ) {
\r
339 CL_Gecko_Event_Key( instance, key, CLG_BET_PRESS );
\r
343 static void gl_gecko_movecursor_f( void ) {
\r
344 char name[MAX_QPATH];
\r
347 if (Cmd_Argc() != 4)
\r
349 Con_Print("usage: gecko_movecursor <name> <x> <y>\nmove the cursor to a certain position\n");
\r
353 // TODO: use snprintf instead
\r
354 sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));
\r
355 x = atof( Cmd_Argv( 2 ) );
\r
356 y = atof( Cmd_Argv( 3 ) );
\r
358 CL_Gecko_Event_CursorMove( CL_Gecko_FindBrowser( name ), x, y );
\r
361 void CL_Gecko_Init( void )
\r
363 Cmd_AddCommand( "gecko_create", cl_gecko_create_f, "Create a gecko browser instance" );
\r
364 Cmd_AddCommand( "gecko_destroy", cl_gecko_destroy_f, "Destroy a gecko browser instance" );
\r
365 Cmd_AddCommand( "gecko_navigate", cl_gecko_navigate_f, "Navigate a gecko browser to a URI" );
\r
366 Cmd_AddCommand( "gecko_injecttext", cl_gecko_injecttext_f, "Injects text into a browser" );
\r
367 Cmd_AddCommand( "gecko_movecursor", gl_gecko_movecursor_f, "Move the cursor to a certain position" );
\r
369 R_RegisterModule( "CL_Gecko", cl_gecko_start, cl_gecko_shutdown, cl_gecko_newmap );
\r
372 void CL_Gecko_NavigateToURI( clgecko_t *instance, const char *URI ) {
\r
373 if( !instance || !instance->browser ) {
\r
377 if( instance->active ) {
\r
378 osgk_browser_navigate( instance->browser, URI );
\r
382 void CL_Gecko_Event_CursorMove( clgecko_t *instance, float x, float y ) {
\r
383 // TODO: assert x, y \in [0.0, 1.0]
\r
384 int mappedx, mappedy;
\r
386 if( !instance || !instance->browser ) {
\r
390 mappedx = x * instance->width;
\r
391 mappedy = y * instance->height;
\r
392 osgk_browser_event_mouse_move( instance->browser, mappedx, mappedy );
\r
395 typedef struct geckokeymapping_s {
\r
397 unsigned int geckokeycode;
\r
398 } geckokeymapping_t;
\r
400 static geckokeymapping_t geckokeymappingtable[] = {
\r
401 { K_BACKSPACE, OSGKKey_Backspace },
\r
402 { K_TAB, OSGKKey_Tab },
\r
403 { K_ENTER, OSGKKey_Return },
\r
404 { K_SHIFT, OSGKKey_Shift },
\r
405 { K_CTRL, OSGKKey_Control },
\r
406 { K_ALT, OSGKKey_Alt },
\r
407 { K_CAPSLOCK, OSGKKey_CapsLock },
\r
408 { K_ESCAPE, OSGKKey_Escape },
\r
409 { K_SPACE, OSGKKey_Space },
\r
410 { K_PGUP, OSGKKey_PageUp },
\r
411 { K_PGDN, OSGKKey_PageDown },
\r
412 { K_END, OSGKKey_End },
\r
413 { K_HOME, OSGKKey_Home },
\r
414 { K_LEFTARROW, OSGKKey_Left },
\r
415 { K_UPARROW, OSGKKey_Up },
\r
416 { K_RIGHTARROW, OSGKKey_Right },
\r
417 { K_DOWNARROW, OSGKKey_Down },
\r
418 { K_INS, OSGKKey_Insert },
\r
419 { K_DEL, OSGKKey_Delete },
\r
420 { K_F1, OSGKKey_F1 },
\r
421 { K_F2, OSGKKey_F2 },
\r
422 { K_F3, OSGKKey_F3 },
\r
423 { K_F4, OSGKKey_F4 },
\r
424 { K_F5, OSGKKey_F5 },
\r
425 { K_F6, OSGKKey_F6 },
\r
426 { K_F7, OSGKKey_F7 },
\r
427 { K_F8, OSGKKey_F8 },
\r
428 { K_F9, OSGKKey_F9 },
\r
429 { K_F10, OSGKKey_F10 },
\r
430 { K_F11, OSGKKey_F11 },
\r
431 { K_F12, OSGKKey_F12 },
\r
432 { K_NUMLOCK, OSGKKey_NumLock },
\r
433 { K_SCROLLOCK, OSGKKey_ScrollLock }
\r
436 qboolean CL_Gecko_Event_Key( clgecko_t *instance, int key, clgecko_buttoneventtype_t eventtype ) {
\r
437 if( !instance || !instance->browser ) {
\r
441 // determine whether its a keyboard event
\r
442 if( key < K_OTHERDEVICESBEGIN ) {
\r
444 OSGK_KeyboardEventType mappedtype;
\r
445 unsigned int mappedkey = key;
\r
448 // yes! then convert it if necessary!
\r
449 for( i = 0 ; i < sizeof( geckokeymappingtable ) / sizeof( *geckokeymappingtable ) ; i++ ) {
\r
450 const geckokeymapping_t * const mapping = &geckokeymappingtable[ i ];
\r
451 if( key == mapping->keycode ) {
\r
452 mappedkey = mapping->geckokeycode;
\r
457 // convert the eventtype
\r
459 switch( eventtype ) {
\r
461 mappedtype = keDown;
\r
466 case CLG_BET_DOUBLECLICK:
\r
467 // TODO: error message
\r
469 case CLG_BET_PRESS:
\r
470 mappedtype = kePress;
\r
473 return osgk_browser_event_key( instance->browser, mappedkey, mappedtype ) != 0;
\r
474 } else if( K_MOUSE1 <= key && key <= K_MOUSE3 ) {
\r
475 OSGK_MouseButtonEventType mappedtype;
\r
476 OSGK_MouseButton mappedbutton;
\r
478 mappedbutton = (OSGK_MouseButton) (mbLeft + (key - K_MOUSE1));
\r
480 switch( eventtype ) {
\r
482 mappedtype = meDown;
\r
487 case CLG_BET_DOUBLECLICK:
\r
488 mappedtype = meDoubleClick;
\r
490 case CLG_BET_PRESS:
\r
491 // hihi, hacky hacky
\r
492 osgk_browser_event_mouse_button( instance->browser, mappedbutton, meDown );
\r
497 osgk_browser_event_mouse_button( instance->browser, mappedbutton, mappedtype );
\r
499 } else if( K_MWHEELUP <= key && key <= K_MWHEELDOWN ) {
\r
500 if( eventtype == CLG_BET_DOWN )
\r
501 osgk_browser_event_mouse_wheel( instance->browser,
\r
502 waVertical, (key == K_MWHEELUP) ? wdNegative : wdPositive );
\r