cl_gecko.c

   1 #ifdef SUPPORT_GECKO\r
   2 \r
   3 // includes everything!\r
   4 #include <OffscreenGecko/browser.h>\r
   5 \r
   6 #ifdef _MSC_VER\r
   7 #       pragma comment( lib, "OffscreenGecko" )\r
   8 #endif\r
   9 \r
  10 #include "quakedef.h"\r
  11 #include "cl_dyntexture.h"\r
  12 #include "cl_gecko.h"\r
  13 #include "timing.h"\r
  14 \r
  15 #define DEFAULT_GECKO_SIZE        512\r
  16 \r
  17 static rtexturepool_t *cl_geckotexturepool;\r
  18 static OSGK_Embedding *cl_geckoembedding;\r
  19 \r
  20 struct clgecko_s {\r
  21         qboolean active;\r
  22         char name[ MAX_QPATH + 32 ];\r
  23 \r
  24         OSGK_Browser *browser;\r
  25         int width, height;\r
  26         int texWidth, texHeight;\r
  27         \r
  28         rtexture_t *texture;\r
  29 };\r
  30 \r
  31 static clgecko_t cl_geckoinstances[ MAX_GECKO_INSTANCES ];\r
  32 \r
  33 static clgecko_t * cl_gecko_findunusedinstance( void ) {\r
  34         int i;\r
  35         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
  36                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
  37                 if( !instance->active ) {\r
  38                         return instance;\r
  39                 }\r
  40         }\r
  41         return NULL;\r
  42 }\r
  43 \r
  44 clgecko_t * CL_Gecko_FindBrowser( const char *name ) {\r
  45         int i;\r
  46 \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
  50                 }\r
  51                 return NULL;\r
  52         }\r
  53 \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
  57                         return instance;\r
  58                 }\r
  59         }\r
  60 \r
  61         return NULL;\r
  62 }\r
  63 \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->width, instance->height );\r
  70                 osgk_browser_unlock_data( instance->browser, data );\r
  71         }\r
  72 }\r
  73 \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->texWidth, instance->texHeight, 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
  80 }\r
  81 \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
  87         }\r
  88 }\r
  89 \r
  90 void CL_Gecko_Resize( clgecko_t *instance, int width, int height ) {\r
  91         int newWidth, newHeight;\r
  92 \r
  93         // early out if bad parameters are passed (no resize to a texture size bigger than the original texture size)\r
  94         if( !instance || !instance->browser) {\r
  95                 return;\r
  96         }\r
  97 \r
  98         newWidth = CeilPowerOf2( width );\r
  99         newHeight = CeilPowerOf2( height );\r
 100         if ((newWidth != instance->texWidth) || (newHeight != instance->texHeight))\r
 101         {\r
 102                 cl_gecko_unlinktexture( instance );\r
 103                 instance->texWidth = newWidth;\r
 104                 instance->texHeight = newHeight;\r
 105                 cl_gecko_linktexture( instance );\r
 106         }\r
 107         else\r
 108         {\r
 109                 /* The gecko area will only cover a part of the texture; to avoid\r
 110                 'old' pixels bleeding in at the border clear the texture. */\r
 111                 R_ClearTexture( instance->texture );\r
 112         }\r
 113 \r
 114         osgk_browser_resize( instance->browser, width, height);\r
 115         instance->width = width;\r
 116         instance->height = height;\r
 117 }\r
 118 \r
 119 void CL_Gecko_GetTextureExtent( clgecko_t *instance, float* pwidth, float* pheight )\r
 120 {\r
 121         if( !instance || !instance->browser ) {\r
 122                 return;\r
 123         }\r
 124 \r
 125         *pwidth = (float)instance->width / instance->texWidth;\r
 126         *pheight = (float)instance->height / instance->texHeight;\r
 127 }\r
 128 \r
 129 \r
 130 clgecko_t * CL_Gecko_CreateBrowser( const char *name ) {\r
 131         // TODO: verify that we dont use a name twice\r
 132         clgecko_t *instance = cl_gecko_findunusedinstance();\r
 133         // TODO: assert != NULL\r
 134         \r
 135         if( cl_geckoembedding == NULL ) {\r
 136                 char profile_path [MAX_OSPATH];\r
 137 \r
 138                 OSGK_EmbeddingOptions *options = osgk_embedding_options_create();\r
 139                 osgk_embedding_options_add_search_path( options, "./xulrunner/" );\r
 140                 dpsnprintf (profile_path, sizeof (profile_path), "%s/xulrunner_profile/", fs_gamedir);\r
 141                 osgk_embedding_options_set_profile_dir( options, profile_path, 0 );\r
 142                 cl_geckoembedding = osgk_embedding_create_with_options( options, NULL );\r
 143                 osgk_release( options );\r
 144                 \r
 145                 if( cl_geckoembedding == NULL ) {\r
 146                         Con_Printf( "CL_Gecko_CreateBrowser: Couldn't retrieve gecko embedding object!\n" );\r
 147                         return NULL;\r
 148                 }\r
 149         }\r
 150 \r
 151         instance->active = true;\r
 152         strlcpy( instance->name, name, sizeof( instance->name ) );\r
 153         instance->browser = osgk_browser_create( cl_geckoembedding, DEFAULT_GECKO_SIZE, DEFAULT_GECKO_SIZE );\r
 154         // TODO: assert != NULL\r
 155 \r
 156         instance->width = instance->texWidth = DEFAULT_GECKO_SIZE;\r
 157         instance->height = instance->texHeight = DEFAULT_GECKO_SIZE;\r
 158         cl_gecko_linktexture( instance );\r
 159 \r
 160         return instance;\r
 161 }\r
 162 \r
 163 void CL_Gecko_DestroyBrowser( clgecko_t *instance ) {\r
 164    if( !instance || !instance->active ) {\r
 165                 return;\r
 166         }\r
 167 \r
 168         instance->active = false;\r
 169         cl_gecko_unlinktexture( instance );\r
 170 \r
 171         osgk_release( instance->browser );\r
 172         instance->browser = NULL;\r
 173 }\r
 174 \r
 175 void CL_Gecko_Frame( void ) {\r
 176         int i;\r
 177         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
 178                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
 179                 if( instance->active ) {\r
 180                         if( instance->browser && osgk_browser_query_dirty( instance->browser ) == 1 ) {\r
 181                                 R_MarkDirtyTexture( instance->texture );\r
 182                         }\r
 183                 }\r
 184         }\r
 185 }\r
 186 \r
 187 static void cl_gecko_start( void )\r
 188 {\r
 189         int i;\r
 190         cl_geckotexturepool = R_AllocTexturePool();\r
 191 \r
 192         // recreate textures on module start\r
 193         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
 194                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
 195                 if( instance->active ) {\r
 196                         cl_gecko_linktexture( instance );\r
 197                 }\r
 198         }\r
 199 }\r
 200 \r
 201 static void cl_gecko_shutdown( void )\r
 202 {\r
 203         int i;\r
 204         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
 205                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
 206                 if( instance->active ) {\r
 207                         cl_gecko_unlinktexture( instance );\r
 208                 }\r
 209         }\r
 210         R_FreeTexturePool( &cl_geckotexturepool );\r
 211 }\r
 212 \r
 213 static void cl_gecko_newmap( void )\r
 214 {\r
 215         // DO NOTHING\r
 216 }\r
 217 \r
 218 void CL_Gecko_Shutdown( void ) {\r
 219         int i;\r
 220         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
 221                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
 222                 if( instance->active ) {\r
 223                         cl_gecko_unlinktexture( instance );\r
 224                 }               \r
 225         }\r
 226 \r
 227         if (cl_geckoembedding != NULL)\r
 228         {\r
 229             osgk_release( cl_geckoembedding );\r
 230             cl_geckoembedding = NULL;\r
 231         }\r
 232 }\r
 233 \r
 234 static void cl_gecko_create_f( void ) {\r
 235         char name[MAX_QPATH];\r
 236 \r
 237         if (Cmd_Argc() != 2)\r
 238         {\r
 239                 Con_Print("usage: gecko_create <name>\npcreates a browser (full texture path " CLGECKOPREFIX "<name>)\n");\r
 240                 return;\r
 241         }\r
 242 \r
 243         // TODO: use snprintf instead\r
 244         sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));\r
 245         CL_Gecko_CreateBrowser( name );\r
 246 }\r
 247 \r
 248 static void cl_gecko_destroy_f( void ) {\r
 249         char name[MAX_QPATH];\r
 250 \r
 251         if (Cmd_Argc() != 2)\r
 252         {\r
 253                 Con_Print("usage: gecko_destroy <name>\ndestroys a browser\n");\r
 254                 return;\r
 255         }\r
 256 \r
 257         // TODO: use snprintf instead\r
 258         sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));\r
 259         CL_Gecko_DestroyBrowser( CL_Gecko_FindBrowser( name ) );\r
 260 }\r
 261 \r
 262 static void cl_gecko_navigate_f( void ) {\r
 263         char name[MAX_QPATH];\r
 264         const char *URI;\r
 265 \r
 266         if (Cmd_Argc() != 3)\r
 267         {\r
 268                 Con_Print("usage: gecko_navigate <name> <URI>\nnavigates to a certain URI\n");\r
 269                 return;\r
 270         }\r
 271 \r
 272         // TODO: use snprintf instead\r
 273         sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));\r
 274         URI = Cmd_Argv( 2 );\r
 275         CL_Gecko_NavigateToURI( CL_Gecko_FindBrowser( name ), URI );\r
 276 }\r
 277 \r
 278 static void cl_gecko_injecttext_f( void ) {\r
 279         char name[MAX_QPATH];\r
 280         const char *text;\r
 281         clgecko_t *instance;\r
 282         const char *p;\r
 283 \r
 284         if (Cmd_Argc() < 3)\r
 285         {\r
 286                 Con_Print("usage: gecko_injecttext <name> <text>\ninjects a certain text into the browser\n");\r
 287                 return;\r
 288         }\r
 289 \r
 290         // TODO: use snprintf instead\r
 291         sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));\r
 292         instance = CL_Gecko_FindBrowser( name );\r
 293         if( !instance ) {\r
 294                 Con_Printf( "cl_gecko_injecttext_f: gecko instance '%s' couldn't be found!\n", name );\r
 295                 return;\r
 296         }\r
 297 \r
 298         text = Cmd_Argv( 2 );\r
 299 \r
 300         for( p = text ; *p ; p++ ) {\r
 301                 unsigned key = *p;\r
 302                 switch( key ) {\r
 303                         case ' ':\r
 304                                 key = K_SPACE;\r
 305                                 break;\r
 306                         case '\\':\r
 307                                 key = *++p;\r
 308                                 switch( key ) {\r
 309                                 case 'n':\r
 310                                         key = K_ENTER;\r
 311                                         break;\r
 312                                 case '\0':\r
 313                                         --p;\r
 314                                         key = '\\';\r
 315                                         break;\r
 316                                 }\r
 317                                 break;\r
 318                 }\r
 319 \r
 320                 CL_Gecko_Event_Key( instance, key, CLG_BET_PRESS );\r
 321         }\r
 322 }\r
 323 \r
 324 static void gl_gecko_movecursor_f( void ) {\r
 325         char name[MAX_QPATH];\r
 326         float x, y;\r
 327 \r
 328         if (Cmd_Argc() != 4)\r
 329         {\r
 330                 Con_Print("usage: gecko_movecursor <name> <x> <y>\nmove the cursor to a certain position\n");\r
 331                 return;\r
 332         }\r
 333 \r
 334         // TODO: use snprintf instead\r
 335         sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));\r
 336         x = atof( Cmd_Argv( 2 ) );\r
 337         y = atof( Cmd_Argv( 3 ) );\r
 338 \r
 339         CL_Gecko_Event_CursorMove( CL_Gecko_FindBrowser( name ), x, y );\r
 340 }\r
 341 \r
 342 void CL_Gecko_Init( void )\r
 343 {\r
 344         Cmd_AddCommand( "gecko_create", cl_gecko_create_f, "Create a gecko browser instance" );\r
 345         Cmd_AddCommand( "gecko_destroy", cl_gecko_destroy_f, "Destroy a gecko browser instance" );\r
 346         Cmd_AddCommand( "gecko_navigate", cl_gecko_navigate_f, "Navigate a gecko browser to a URI" );\r
 347         Cmd_AddCommand( "gecko_injecttext", cl_gecko_injecttext_f, "Injects text into a browser" );\r
 348         Cmd_AddCommand( "gecko_movecursor", gl_gecko_movecursor_f, "Move the cursor to a certain position" );\r
 349 \r
 350         R_RegisterModule( "CL_Gecko", cl_gecko_start, cl_gecko_shutdown, cl_gecko_newmap );\r
 351 }\r
 352 \r
 353 void CL_Gecko_NavigateToURI( clgecko_t *instance, const char *URI ) {\r
 354         if( instance && instance->active ) {\r
 355                 osgk_browser_navigate( instance->browser, URI );\r
 356         }\r
 357 }\r
 358 \r
 359 void CL_Gecko_Event_CursorMove( clgecko_t *instance, float x, float y ) {\r
 360         // TODO: assert x, y \in [0.0, 1.0]\r
 361         int mappedx, mappedy;\r
 362 \r
 363         if( !instance || !instance->browser ) {\r
 364                 return;\r
 365         }\r
 366 \r
 367         mappedx = x * instance->width;\r
 368         mappedy = y * instance->height;\r
 369         osgk_browser_event_mouse_move( instance->browser, mappedx, mappedy );\r
 370 }\r
 371 \r
 372 typedef struct geckokeymapping_s {\r
 373         keynum_t keycode;\r
 374         unsigned int geckokeycode;\r
 375 } geckokeymapping_t;\r
 376 \r
 377 static geckokeymapping_t geckokeymappingtable[] = {\r
 378         { K_BACKSPACE, OSGKKey_Backspace },\r
 379         { K_TAB, OSGKKey_Tab },\r
 380         { K_ENTER, OSGKKey_Return },\r
 381         { K_SHIFT, OSGKKey_Shift },\r
 382         { K_CTRL, OSGKKey_Control },\r
 383         { K_ALT, OSGKKey_Alt },\r
 384         { K_CAPSLOCK, OSGKKey_CapsLock },\r
 385         { K_ESCAPE, OSGKKey_Escape },\r
 386         { K_SPACE, OSGKKey_Space },\r
 387         { K_PGUP, OSGKKey_PageUp },\r
 388         { K_PGDN, OSGKKey_PageDown },\r
 389         { K_END, OSGKKey_End },\r
 390         { K_HOME, OSGKKey_Home },\r
 391         { K_LEFTARROW, OSGKKey_Left },\r
 392         { K_UPARROW, OSGKKey_Up },\r
 393         { K_RIGHTARROW, OSGKKey_Right },\r
 394         { K_DOWNARROW, OSGKKey_Down },\r
 395         { K_INS, OSGKKey_Insert },\r
 396         { K_DEL, OSGKKey_Delete },\r
 397         { K_F1, OSGKKey_F1 },\r
 398         { K_F2, OSGKKey_F2 },\r
 399         { K_F3, OSGKKey_F3 },\r
 400         { K_F4, OSGKKey_F4 },\r
 401         { K_F5, OSGKKey_F5 },\r
 402         { K_F6, OSGKKey_F6 },\r
 403         { K_F7, OSGKKey_F7 },\r
 404         { K_F8, OSGKKey_F8 },\r
 405         { K_F9, OSGKKey_F9 },\r
 406         { K_F10, OSGKKey_F10 },\r
 407         { K_F11, OSGKKey_F11 },\r
 408         { K_F12, OSGKKey_F12 },\r
 409         { K_NUMLOCK, OSGKKey_NumLock },\r
 410         { K_SCROLLOCK, OSGKKey_ScrollLock }\r
 411 };\r
 412 \r
 413 qboolean CL_Gecko_Event_Key( clgecko_t *instance, int key, clgecko_buttoneventtype_t eventtype ) {\r
 414         if( !instance || !instance->browser ) {\r
 415                 return false;\r
 416         }\r
 417 \r
 418         // determine whether its a keyboard event\r
 419         if( key < K_OTHERDEVICESBEGIN ) {\r
 420 \r
 421                 OSGK_KeyboardEventType mappedtype;\r
 422                 unsigned int mappedkey = key;\r
 423                 \r
 424                 int i;\r
 425                 // yes! then convert it if necessary!\r
 426                 for( i = 0 ; i < sizeof( geckokeymappingtable ) / sizeof( *geckokeymappingtable ) ; i++ ) {\r
 427                         const geckokeymapping_t * const mapping = &geckokeymappingtable[ i ];\r
 428                         if( key == mapping->keycode ) {\r
 429                                 mappedkey = mapping->geckokeycode;\r
 430                                 break;\r
 431                         }\r
 432                 }\r
 433 \r
 434                 // convert the eventtype\r
 435                 // map the type\r
 436                 switch( eventtype ) {\r
 437                 case CLG_BET_DOWN:\r
 438                         mappedtype = keDown;\r
 439                         break;\r
 440                 case CLG_BET_UP:\r
 441                         mappedtype = keUp;\r
 442                         break;\r
 443                 case CLG_BET_DOUBLECLICK:\r
 444                         // TODO: error message\r
 445                         break;\r
 446                 case CLG_BET_PRESS:\r
 447                         mappedtype = kePress;\r
 448                 }\r
 449 \r
 450                 return osgk_browser_event_key( instance->browser, mappedkey, mappedtype ) != 0;\r
 451         } else if( K_MOUSE1 <= key && key <= K_MOUSE3 ) {\r
 452                 OSGK_MouseButtonEventType mappedtype;\r
 453                 OSGK_MouseButton mappedbutton;\r
 454 \r
 455                 mappedbutton = (OSGK_MouseButton) (mbLeft + (key - K_MOUSE1));\r
 456 \r
 457                 switch( eventtype ) {\r
 458                 case CLG_BET_DOWN:\r
 459                         mappedtype = meDown;\r
 460                         break;\r
 461                 case CLG_BET_UP:\r
 462                         mappedtype = meUp;\r
 463                         break;\r
 464                 case CLG_BET_DOUBLECLICK:\r
 465                         mappedtype = meDoubleClick;\r
 466                         break;\r
 467                 case CLG_BET_PRESS:\r
 468                         // hihi, hacky hacky\r
 469                         osgk_browser_event_mouse_button( instance->browser, mappedbutton, meDown );\r
 470                         mappedtype = meUp;\r
 471                         break;\r
 472                 }\r
 473 \r
 474                 osgk_browser_event_mouse_button( instance->browser, mappedbutton, mappedtype );\r
 475                 return true;\r
 476         } else if( K_MWHEELUP <= key && key <= K_MWHEELDOWN ) {\r
 477                 if( eventtype == CLG_BET_DOWN )\r
 478                         osgk_browser_event_mouse_wheel( instance->browser, \r
 479                                 waVertical, (key == K_MWHEELUP) ? wdNegative : wdPositive );\r
 480                 return true;\r
 481         }\r
 482         // TODO: error?\r
 483         return false;\r
 484 }\r
 485 \r
 486 #endif\r