Add TEXF_PERSISTENT and R_PurgeTexture which only frees textures if that flag isn...
[divverent/darkplaces.git] / 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 \r
14 static rtexturepool_t *cl_geckotexturepool;\r
15 static OSGK_Embedding *cl_geckoembedding;\r
16 \r
17 struct clgecko_s {\r
18         qboolean active;\r
19         char name[ MAX_QPATH + 32 ];\r
20 \r
21         OSGK_Browser *browser;\r
22         \r
23         rtexture_t *texture;\r
24 };\r
25 \r
26 static clgecko_t cl_geckoinstances[ MAX_GECKO_INSTANCES ];\r
27 \r
28 static clgecko_t * cl_gecko_findunusedinstance( void ) {\r
29         int i;\r
30         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
31                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
32                 if( !instance->active ) {\r
33                         return instance;\r
34                 }\r
35         }\r
36         return NULL;\r
37 }\r
38 \r
39 clgecko_t * CL_Gecko_FindBrowser( const char *name ) {\r
40         int i;\r
41 \r
42         if( !name || !*name || strncmp( name, CLGECKOPREFIX, sizeof( CLGECKOPREFIX ) - 1 ) != 0 ) {\r
43                 if( developer.integer > 0 ) {\r
44                         Con_Printf( "CL_Gecko_FindBrowser: Bad gecko texture name '%s'!\n", name );\r
45                 }\r
46                 return NULL;\r
47         }\r
48 \r
49         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
50                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
51                 if( instance->active && strcmp( instance->name, name ) == 0 ) {\r
52                         return instance;\r
53                 }\r
54         }\r
55 \r
56         return NULL;\r
57 }\r
58 \r
59 static void cl_gecko_updatecallback( rtexture_t *texture, clgecko_t *instance ) {\r
60         const unsigned char *data;\r
61         if( instance->browser ) {\r
62                 // TODO: OSGK only supports BGRA right now\r
63                 data = osgk_browser_lock_data( instance->browser, NULL );\r
64                 R_UpdateTexture( texture, data, 0, 0, DEFAULT_GECKO_WIDTH, DEFAULT_GECKO_HEIGHT );\r
65                 osgk_browser_unlock_data( instance->browser, data );\r
66         }\r
67 }\r
68 \r
69 static void cl_gecko_linktexture( clgecko_t *instance ) {\r
70         // TODO: assert that instance->texture == NULL\r
71         instance->texture = R_LoadTexture2D( cl_geckotexturepool, instance->name, DEFAULT_GECKO_WIDTH, DEFAULT_GECKO_HEIGHT, NULL, TEXTYPE_BGRA, TEXF_ALPHA | TEXF_PERSISTENT, NULL );\r
72         R_MakeTextureDynamic( instance->texture, cl_gecko_updatecallback, instance );\r
73         CL_LinkDynTexture( instance->name, instance->texture );\r
74 }\r
75 \r
76 static void cl_gecko_unlinktexture( clgecko_t *instance ) {\r
77         if( instance->texture ) {\r
78                 CL_UnlinkDynTexture( instance->name );\r
79                 R_FreeTexture( instance->texture );\r
80                 instance->texture = NULL;\r
81         }\r
82 }\r
83 \r
84 clgecko_t * CL_Gecko_CreateBrowser( const char *name ) {\r
85         // TODO: verify that we dont use a name twice\r
86         clgecko_t *instance = cl_gecko_findunusedinstance();\r
87         // TODO: assert != NULL\r
88         \r
89         instance->active = true;\r
90         strlcpy( instance->name, name, sizeof( instance->name ) );\r
91         instance->browser = osgk_browser_create( cl_geckoembedding, DEFAULT_GECKO_WIDTH, DEFAULT_GECKO_HEIGHT );\r
92         // TODO: assert != NULL\r
93 \r
94         cl_gecko_linktexture( instance );\r
95 \r
96         return instance;\r
97 }\r
98 \r
99 void CL_Gecko_DestroyBrowser( clgecko_t *instance ) {\r
100    if( !instance || !instance->active ) {\r
101                 return;\r
102         }\r
103 \r
104         instance->active = false;\r
105         cl_gecko_unlinktexture( instance );\r
106 \r
107         osgk_release( instance->browser );\r
108         instance->browser = NULL;\r
109 }\r
110 \r
111 void CL_Gecko_Frame( void ) {\r
112         int i;\r
113         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
114                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
115                 if( instance->active ) {\r
116                         if( instance->browser && osgk_browser_query_dirty( instance->browser ) == 1 ) {\r
117                                 R_MarkDirtyTexture( instance->texture );\r
118                         }\r
119                 }\r
120         }\r
121 }\r
122 \r
123 static void cl_gecko_start( void )\r
124 {\r
125         int i;\r
126         cl_geckotexturepool = R_AllocTexturePool();\r
127 \r
128         // recreate textures on module start\r
129         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
130                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
131                 if( instance->active ) {\r
132                         cl_gecko_linktexture( instance );\r
133                 }\r
134         }\r
135 }\r
136 \r
137 static void cl_gecko_shutdown( void )\r
138 {\r
139         int i;\r
140         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
141                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
142                 if( instance->active ) {\r
143                         cl_gecko_unlinktexture( instance );\r
144                 }\r
145         }\r
146         R_FreeTexturePool( &cl_geckotexturepool );\r
147 }\r
148 \r
149 static void cl_gecko_newmap( void )\r
150 {\r
151         // DO NOTHING\r
152 }\r
153 \r
154 void CL_Gecko_Shutdown( void ) {\r
155         int i;\r
156         for( i = 0 ; i < MAX_GECKO_INSTANCES ; i++ ) {\r
157                 clgecko_t *instance = &cl_geckoinstances[ i ];\r
158                 if( instance->active ) {\r
159                         cl_gecko_unlinktexture( instance );\r
160                 }               \r
161         }\r
162         osgk_release( cl_geckoembedding );\r
163 }\r
164 \r
165 static void cl_gecko_create_f( void ) {\r
166         char name[MAX_QPATH];\r
167 \r
168         if (Cmd_Argc() != 2)\r
169         {\r
170                 Con_Print("usage: gecko_create <name>\npcreates a browser (full texture path " CLGECKOPREFIX "<name>)\n");\r
171                 return;\r
172         }\r
173 \r
174         // TODO: use snprintf instead\r
175         sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));\r
176         CL_Gecko_CreateBrowser( name );\r
177 }\r
178 \r
179 static void cl_gecko_destroy_f( void ) {\r
180         char name[MAX_QPATH];\r
181 \r
182         if (Cmd_Argc() != 2)\r
183         {\r
184                 Con_Print("usage: gecko_destroy <name>\ndestroys a browser (full texture path " CLGECKOPREFIX "<name>)\n");\r
185                 return;\r
186         }\r
187 \r
188         // TODO: use snprintf instead\r
189         sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));\r
190         CL_Gecko_DestroyBrowser( CL_Gecko_FindBrowser( name ) );\r
191 }\r
192 \r
193 static void cl_gecko_navigate_f( void ) {\r
194         char name[MAX_QPATH];\r
195         const char *URI;\r
196 \r
197         if (Cmd_Argc() != 3)\r
198         {\r
199                 Con_Print("usage: gecko_navigate <name> <URI>\nnavigates to a certain URI (full texture path " CLGECKOPREFIX "<name>)\n");\r
200                 return;\r
201         }\r
202 \r
203         // TODO: use snprintf instead\r
204         sprintf(name, CLGECKOPREFIX "%s", Cmd_Argv(1));\r
205         URI = Cmd_Argv( 2 );\r
206         CL_Gecko_NavigateToURI( CL_Gecko_FindBrowser( name ), URI );\r
207 }\r
208 \r
209 void CL_Gecko_Init( void )\r
210 {\r
211         OSGK_EmbeddingOptions *options = osgk_embedding_options_create();\r
212         osgk_embedding_options_add_search_path( options, "./xulrunner/" );\r
213    cl_geckoembedding = osgk_embedding_create_with_options( options, NULL );\r
214         osgk_release( options );\r
215         \r
216         if( cl_geckoembedding == NULL ) {\r
217                 Con_Printf( "CL_Gecko_Init: Couldn't retrieve gecko embedding object!\n" );\r
218         }\r
219         \r
220         Cmd_AddCommand( "gecko_create", cl_gecko_create_f, "Create a gecko browser instance" );\r
221         Cmd_AddCommand( "gecko_destroy", cl_gecko_destroy_f, "Destroy a gecko browser instance" );\r
222         Cmd_AddCommand( "gecko_navigate", cl_gecko_navigate_f, "Navigate a gecko browser to an URI" );\r
223 \r
224         R_RegisterModule( "CL_Gecko", cl_gecko_start, cl_gecko_shutdown, cl_gecko_newmap );\r
225 }\r
226 \r
227 void CL_Gecko_NavigateToURI( clgecko_t *instance, const char *URI ) {\r
228         if( instance && instance->active ) {\r
229                 osgk_browser_navigate( instance->browser, URI );\r
230         }\r
231 }\r
232 \r
233 // TODO: write this function\r
234 void CL_Gecko_Event_CursorMove( clgecko_t *instance, float x, float y );\r
235 qboolean CL_Gecko_Event_Key( clgecko_t *instance, int key, clgecko_buttoneventtype_t eventtype );\r
236 \r
237 #endif