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_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
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
44 clgecko_t * CL_Gecko_FindBrowser( const char *name ) {
\r
47 if( !name || !*name || strncmp( name, CLGECKOPREFIX, sizeof( CLGECKOPREFIX ) - 1 ) != 0 ) {
\r
48 if( developer.integer > 0 ) {
\r
49 Con_Printf( "CL_Gecko_FindBrowser: Bad gecko texture name '%s'!\n", name );
\r
54 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
55 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
56 if( instance->active && strcmp( instance->name, name ) == 0 ) {
\r
64 static void cl_gecko_updatecallback( rtexture_t *texture, clgecko_t *instance ) {
\r
65 const unsigned char *data;
\r
66 if( instance->browser ) {
\r
67 // TODO: OSGK only supports BGRA right now
\r
68 TIMING_TIMESTATEMENT(data = osgk_browser_lock_data( instance->browser, NULL ));
\r
69 R_UpdateTexture( texture, data, 0, 0, instance->w, instance->h);
\r
70 osgk_browser_unlock_data( instance->browser, data );
\r
74 static void cl_gecko_linktexture( clgecko_t *instance ) {
\r
75 // TODO: assert that instance->texture == NULL
\r
76 instance->texture = R_LoadTexture2D( cl_geckotexturepool, instance->name,
\r
77 instance->texW, instance->texH, NULL, TEXTYPE_BGRA, TEXF_ALPHA | TEXF_PERSISTENT, NULL );
\r
78 R_MakeTextureDynamic( instance->texture, cl_gecko_updatecallback, instance );
\r
79 CL_LinkDynTexture( instance->name, instance->texture );
\r
82 static void cl_gecko_unlinktexture( clgecko_t *instance ) {
\r
83 if( instance->texture ) {
\r
84 CL_UnlinkDynTexture( instance->name );
\r
85 R_FreeTexture( instance->texture );
\r
86 instance->texture = NULL;
\r
90 clgecko_t * CL_Gecko_CreateBrowser( const char *name ) {
\r
91 // TODO: verify that we dont use a name twice
\r
92 clgecko_t *instance = cl_gecko_findunusedinstance();
\r
93 // TODO: assert != NULL
\r
95 if( cl_geckoembedding == NULL ) {
\r
96 OSGK_EmbeddingOptions *options = osgk_embedding_options_create();
\r
97 osgk_embedding_options_add_search_path( options, "./xulrunner/" );
\r
98 cl_geckoembedding = osgk_embedding_create_with_options( options, NULL );
\r
99 osgk_release( options );
\r
101 if( cl_geckoembedding == NULL ) {
\r
102 Con_Printf( "CL_Gecko_CreateBrowser: Couldn't retrieve gecko embedding object!\n" );
\r
107 instance->active = true;
\r
108 strlcpy( instance->name, name, sizeof( instance->name ) );
\r
109 instance->browser = osgk_browser_create( cl_geckoembedding, DEFAULT_SIZE, DEFAULT_SIZE );
\r
110 // TODO: assert != NULL
\r
112 instance->texW = DEFAULT_SIZE;
\r
113 instance->texH = DEFAULT_SIZE;
\r
114 instance->w = DEFAULT_SIZE;
\r
115 instance->h = DEFAULT_SIZE;
\r
116 cl_gecko_linktexture( instance );
\r
121 void CL_Gecko_DestroyBrowser( clgecko_t *instance ) {
\r
122 if( !instance || !instance->active ) {
\r
126 instance->active = false;
\r
127 cl_gecko_unlinktexture( instance );
\r
129 osgk_release( instance->browser );
\r
130 instance->browser = NULL;
\r
133 void CL_Gecko_Frame( void ) {
\r
135 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
136 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
137 if( instance->active ) {
\r
138 if( instance->browser && osgk_browser_query_dirty( instance->browser ) == 1 ) {
\r
139 R_MarkDirtyTexture( instance->texture );
\r
145 static void cl_gecko_start( void )
\r
148 cl_geckotexturepool = R_AllocTexturePool();
\r
150 // recreate textures on module start
\r
151 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
152 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
153 if( instance->active ) {
\r
154 cl_gecko_linktexture( instance );
\r
159 static void cl_gecko_shutdown( void )
\r
162 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
163 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
164 if( instance->active ) {
\r
165 cl_gecko_unlinktexture( instance );
\r
168 R_FreeTexturePool( &cl_geckotexturepool );
\r
171 static void cl_gecko_newmap( void )
\r
176 void CL_Gecko_Shutdown( void ) {
\r
178 for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {
\r
179 clgecko_t *instance = &cl_geckoinstances[ i ];
\r
180 if( instance->active ) {
\r
181 cl_gecko_unlinktexture( instance );
\r
185 if (cl_geckoembedding != NULL)
\r
187 osgk_release( cl_geckoembedding );
\r
188 cl_geckoembedding = NULL;
\r
192 static void cl_gecko_create_f( void ) {
\r
193 char name[MAX_QPATH];
\r
195 if (Cmd_Argc() != 2)
\r
197 Con_Print("usage: gecko_create <name>\npcreates a browser (full texture path " CLGECKOPREFIX "<name>)\n");
\r
201 // TODO: use snprintf instead
\r
202 sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));
\r
203 CL_Gecko_CreateBrowser( name );
\r
206 static void cl_gecko_destroy_f( void ) {
\r
207 char name[MAX_QPATH];
\r
209 if (Cmd_Argc() != 2)
\r
211 Con_Print("usage: gecko_destroy <name>\ndestroys a browser\n");
\r
215 // TODO: use snprintf instead
\r
216 sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));
\r
217 CL_Gecko_DestroyBrowser( CL_Gecko_FindBrowser( name ) );
\r
220 static void cl_gecko_navigate_f( void ) {
\r
221 char name[MAX_QPATH];
\r
224 if (Cmd_Argc() != 3)
\r
226 Con_Print("usage: gecko_navigate <name> <URI>\nnavigates to a certain URI\n");
\r
230 // TODO: use snprintf instead
\r
231 sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));
\r
232 URI = Cmd_Argv( 2 );
\r
233 CL_Gecko_NavigateToURI( CL_Gecko_FindBrowser( name ), URI );
\r
236 static void cl_gecko_injecttext_f( void ) {
\r
237 char name[MAX_QPATH];
\r
239 clgecko_t *instance;
\r
242 if (Cmd_Argc() < 3)
\r
244 Con_Print("usage: gecko_injecttext <name> <text>\ninjects a certain text into the browser\n");
\r
248 // TODO: use snprintf instead
\r
249 sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));
\r
250 instance = CL_Gecko_FindBrowser( name );
\r
252 Con_Printf( "cl_gecko_injecttext_f: gecko instance '%s' couldn't be found!\n", name );
\r
256 text = Cmd_Argv( 2 );
\r
258 for( p = text ; *p ; p++ ) {
\r
278 CL_Gecko_Event_Key( instance, key, CLG_BET_PRESS );
\r
282 void CL_Gecko_Init( void )
\r
284 Cmd_AddCommand( "gecko_create", cl_gecko_create_f, "Create a gecko browser instance" );
\r
285 Cmd_AddCommand( "gecko_destroy", cl_gecko_destroy_f, "Destroy a gecko browser instance" );
\r
286 Cmd_AddCommand( "gecko_navigate", cl_gecko_navigate_f, "Navigate a gecko browser to a URI" );
\r
287 Cmd_AddCommand( "gecko_injecttext", cl_gecko_injecttext_f, "Injects text into a browser" );
\r
289 R_RegisterModule( "CL_Gecko", cl_gecko_start, cl_gecko_shutdown, cl_gecko_newmap );
\r
292 void CL_Gecko_NavigateToURI( clgecko_t *instance, const char *URI ) {
\r
293 if( instance && instance->active ) {
\r
294 osgk_browser_navigate( instance->browser, URI );
\r
298 void CL_Gecko_Event_CursorMove( clgecko_t *instance, float x, float y ) {
\r
299 // TODO: assert x, y \in [0.0, 1.0]
\r
300 int mappedx, mappedy;
\r
302 if( !instance || !instance->browser ) {
\r
306 mappedx = x * instance->w;
\r
307 mappedy = y * instance->h;
\r
308 osgk_browser_event_mouse_move( instance->browser, mappedx, mappedy );
\r
311 typedef struct geckokeymapping_s {
\r
313 unsigned int geckokeycode;
\r
314 } geckokeymapping_t;
\r
316 static geckokeymapping_t geckokeymappingtable[] = {
\r
317 { K_BACKSPACE, OSGKKey_Backspace },
\r
318 { K_TAB, OSGKKey_Tab },
\r
319 { K_ENTER, OSGKKey_Return },
\r
320 { K_SHIFT, OSGKKey_Shift },
\r
321 { K_CTRL, OSGKKey_Control },
\r
322 { K_ALT, OSGKKey_Alt },
\r
323 { K_CAPSLOCK, OSGKKey_CapsLock },
\r
324 { K_ESCAPE, OSGKKey_Escape },
\r
325 { K_SPACE, OSGKKey_Space },
\r
326 { K_PGUP, OSGKKey_PageUp },
\r
327 { K_PGDN, OSGKKey_PageDown },
\r
328 { K_END, OSGKKey_End },
\r
329 { K_HOME, OSGKKey_Home },
\r
330 { K_LEFTARROW, OSGKKey_Left },
\r
331 { K_UPARROW, OSGKKey_Up },
\r
332 { K_RIGHTARROW, OSGKKey_Right },
\r
333 { K_DOWNARROW, OSGKKey_Down },
\r
334 { K_INS, OSGKKey_Insert },
\r
335 { K_DEL, OSGKKey_Delete },
\r
336 { K_F1, OSGKKey_F1 },
\r
337 { K_F2, OSGKKey_F2 },
\r
338 { K_F3, OSGKKey_F3 },
\r
339 { K_F4, OSGKKey_F4 },
\r
340 { K_F5, OSGKKey_F5 },
\r
341 { K_F6, OSGKKey_F6 },
\r
342 { K_F7, OSGKKey_F7 },
\r
343 { K_F8, OSGKKey_F8 },
\r
344 { K_F9, OSGKKey_F9 },
\r
345 { K_F10, OSGKKey_F10 },
\r
346 { K_F11, OSGKKey_F11 },
\r
347 { K_F12, OSGKKey_F12 },
\r
348 { K_NUMLOCK, OSGKKey_NumLock },
\r
349 { K_SCROLLOCK, OSGKKey_ScrollLock }
\r
352 qboolean CL_Gecko_Event_Key( clgecko_t *instance, int key, clgecko_buttoneventtype_t eventtype ) {
\r
353 if( !instance || !instance->browser ) {
\r
357 // determine whether its a keyboard event
\r
358 if( key < K_OTHERDEVICESBEGIN ) {
\r
360 OSGK_KeyboardEventType mappedtype;
\r
361 unsigned int mappedkey = key;
\r
364 // yes! then convert it if necessary!
\r
365 for( i = 0 ; i < sizeof( geckokeymappingtable ) / sizeof( *geckokeymappingtable ) ; i++ ) {
\r
366 const geckokeymapping_t * const mapping = &geckokeymappingtable[ i ];
\r
367 if( key == mapping->keycode ) {
\r
368 mappedkey = mapping->geckokeycode;
\r
373 // convert the eventtype
\r
375 switch( eventtype ) {
\r
377 mappedtype = keDown;
\r
382 case CLG_BET_DOUBLECLICK:
\r
383 // TODO: error message
\r
385 case CLG_BET_PRESS:
\r
386 mappedtype = kePress;
\r
389 return osgk_browser_event_key( instance->browser, mappedkey, mappedtype ) != 0;
\r
390 } else if( K_MOUSE1 <= key && key <= K_MOUSE3 ) {
\r
391 OSGK_MouseButtonEventType mappedtype;
\r
392 OSGK_MouseButton mappedbutton;
\r
394 mappedbutton = (OSGK_MouseButton) (mbLeft + (key - K_MOUSE1));
\r
396 switch( eventtype ) {
\r
398 mappedtype = meDown;
\r
403 case CLG_BET_DOUBLECLICK:
\r
404 mappedtype = meDoubleClick;
\r
406 case CLG_BET_PRESS:
\r
407 // hihi, hacky hacky
\r
408 osgk_browser_event_mouse_button( instance->browser, mappedbutton, meDown );
\r
413 osgk_browser_event_mouse_button( instance->browser, mappedbutton, mappedtype );
\r
420 void CL_Gecko_Resize( clgecko_t *instance, int w, int h ) {
\r
423 if( !instance || !instance->browser ) {
\r
427 newW = 1; while( newW < w ) newW *= 2;
\r
428 newH = 1; while( newH < h ) newH *= 2;
\r
429 if ((newW != instance->texW) || (newH != instance->texH))
\r
431 cl_gecko_unlinktexture( instance );
\r
432 instance->texW = newW;
\r
433 instance->texH = newH;
\r
434 cl_gecko_linktexture( instance );
\r
438 /* The gecko area will only cover a part of the texture; to avoid
\r
439 'old' pixels bleeding in at the border clear the texture. */
\r
440 R_ClearTexture( instance->texture );
\r
443 osgk_browser_resize( instance->browser, w, h);
\r
448 void CL_Gecko_GetTextureExtent( clgecko_t *instance, float* u, float* v )
\r
450 if( !instance || !instance->browser ) {
\r
454 *u = (float)instance->w / instance->texW;
\r
455 *v = (float)instance->h / instance->texH;
\r