removing more static keywords
[uzbl-mobile] / uzbl.h
1 /* -*- c-basic-offset: 4; -*- 
2
3  * See LICENSE for license details
4  *
5  * Changelog:
6  * ---------
7  *
8  * (c) 2009 by Robert Manea
9  *     - introduced struct concept
10  *     - statusbar template
11  *
12  */
13
14 enum {
15   /* statusbar symbols */
16   SYM_TITLE, SYM_URI, SYM_NAME,
17   SYM_LOADPRGS, SYM_LOADPRGSBAR,
18   SYM_KEYCMD, SYM_MODE, SYM_MSG,
19   SYM_SELECTED_URI,
20   /* useragent symbols */
21   SYM_WK_MAJ, SYM_WK_MIN, SYM_WK_MIC,
22   SYM_SYSNAME, SYM_NODENAME,
23   SYM_KERNREL, SYM_KERNVER,
24   SYM_ARCHSYS, SYM_ARCHUZBL,
25   SYM_DOMAINNAME, SYM_COMMIT
26 };
27
28 const struct {
29     gchar *symbol_name;
30     guint symbol_token;
31 } symbols[] = {
32     {"NAME",                 SYM_NAME},
33     {"URI",                  SYM_URI},
34     {"TITLE",                SYM_TITLE},
35     {"SELECTED_URI",         SYM_SELECTED_URI},
36     {"KEYCMD",               SYM_KEYCMD},
37     {"MODE",                 SYM_MODE},
38     {"MSG",                  SYM_MSG},
39     {"LOAD_PROGRESS",        SYM_LOADPRGS},
40     {"LOAD_PROGRESSBAR",     SYM_LOADPRGSBAR},
41
42     {"WEBKIT_MAJOR",         SYM_WK_MAJ},
43     {"WEBKIT_MINOR",         SYM_WK_MIN},
44     {"WEBKIT_MICRO",         SYM_WK_MIC},
45     {"SYSNAME",              SYM_SYSNAME},
46     {"NODENAME",             SYM_NODENAME},
47     {"KERNREL",              SYM_KERNREL},
48     {"KERNVER",              SYM_KERNVER},
49     {"ARCH_SYSTEM",          SYM_ARCHSYS},
50     {"ARCH_UZBL",            SYM_ARCHUZBL},
51     {"DOMAINNAME",           SYM_DOMAINNAME},
52     {"COMMIT",               SYM_COMMIT},
53     {NULL,                   0}
54 }, *symp = symbols;
55
56 /* status bar elements */
57 typedef struct {
58     gint           load_progress;
59     gchar          *msg;
60     gchar          *progress_s, *progress_u;
61     int            progress_w;
62 } StatusBar;
63
64
65 /* gui elements */
66 typedef struct {
67     GtkWidget*     main_window;
68     GtkPlug*       plug;
69     GtkWidget*     scrolled_win;
70     GtkWidget*     vbox;
71     GtkWidget*     mainbar;
72     GtkWidget*     mainbar_label;
73     GtkScrollbar*  scbar_v;   // Horizontal and Vertical Scrollbar
74     GtkScrollbar*  scbar_h;   // (These are still hidden)
75     GtkAdjustment* bar_v; // Information about document length
76     GtkAdjustment* bar_h; // and scrolling position
77     WebKitWebView* web_view;
78     gchar*         main_title;
79     gchar*         icon;
80
81     /* WebInspector */
82     GtkWidget *inspector_window;
83     WebKitWebInspector *inspector;
84
85     StatusBar sbar;
86 } GUI;
87
88
89 /* external communication*/
90 enum { FIFO, SOCKET};
91 typedef struct {
92     gchar          *fifo_path;
93     gchar          *socket_path;
94     /* stores (key)"variable name" -> (value)"pointer to this var*/
95     GHashTable     *proto_var;
96     gchar          *sync_stdout;
97 } Communication;
98
99
100 /* internal state */
101 typedef struct {
102     gchar    *uri;
103     gchar    *config_file;
104     int      socket_id;
105     char     *instance_name;
106     gchar    *selected_url;
107     gchar    *executable_path;
108     GString* keycmd;
109     gchar*   searchtx;
110     struct utsname unameinfo; /* system info */
111     gboolean verbose;
112 } State;
113
114
115 /* networking */
116 typedef struct {
117     SoupSession *soup_session;
118     SoupLogger *soup_logger;
119     char *proxy_url;
120     char *useragent;
121     gint max_conns;
122     gint max_conns_host;
123 } Network;
124
125
126 /* behaviour */
127 typedef struct {
128     gchar*   load_finish_handler;
129     gchar*   load_start_handler;
130     gchar*   load_commit_handler;
131     gchar*   status_format;
132     gchar*   title_format_short;
133     gchar*   title_format_long;
134     gchar*   status_background;
135     gchar*   history_handler;
136     gchar*   fifo_dir;
137     gchar*   socket_dir;
138     gchar*   download_handler;
139     gchar*   cookie_handler;
140     gboolean always_insert_mode;
141     gboolean show_status;
142     gboolean insert_mode;
143     gboolean status_top;
144     gboolean reset_command_mode;
145     gchar*   modkey;
146     guint    modmask;
147     guint    http_debug;
148     gchar*   shell_cmd;
149     /* WebKitWebSettings exports */
150     guint    font_size;
151     guint    monospace_size;
152     guint    minimum_font_size;
153     gfloat   zoom_level;
154     guint    disable_plugins;
155     guint    disable_scripts;
156     guint    autoload_img;    
157     guint    autoshrink_img;  
158     guint    enable_spellcheck;
159     guint    enable_private;  
160     guint    print_bg;        
161     gchar*   style_uri;       
162     guint    resizable_txt;  
163     gchar*   default_encoding;       
164     guint    enforce_96dpi;  
165     gchar    *inject_html;
166     guint    caret_browsing;  
167     guint    mode;  
168     gchar*   base_url;
169     gchar*   html_endmarker;
170     gchar*   insert_indicator;
171     gchar*   cmd_indicator;
172     GString* html_buffer;
173     guint    html_timeout;  
174
175     /* command list: name -> Command  */
176     GHashTable* commands;
177 } Behaviour;
178
179 /* javascript */
180 typedef struct {
181     gboolean            initialized;
182     JSClassDefinition   classdef;
183     JSClassRef          classref;
184 } Javascript;
185
186 /* main uzbl data structure */
187 typedef struct {
188     GUI           gui;
189     State         state;
190     Network       net;
191     Behaviour     behave;
192     Communication comm;
193     Javascript    js;
194
195     Window        xwin;
196     GScanner      *scan;
197
198     /* group bindings: key -> action */
199     GHashTable* bindings;
200 } Uzbl;
201
202
203 typedef struct {
204     char* name;
205     char* param;
206 } Action;
207
208 typedef void sigfunc(int);
209
210 /* XDG Stuff */
211
212 typedef struct {
213     gchar* environmental;
214     gchar* default_value;
215 } XDG_Var;
216
217 XDG_Var XDG[] = 
218 {
219     { "XDG_CONFIG_HOME", "~/.config" },
220     { "XDG_DATA_HOME",   "~/.local/share" },
221     { "XDG_CACHE_HOME",  "~/.cache" },
222     { "XDG_CONFIG_DIRS", "/etc/xdg" },
223     { "XDG_DATA_DIRS",   "/usr/local/share/:/usr/share/" },
224 };
225
226 /* Functions */
227 gchar *
228 expand_template(const char *template, gboolean escape_markup);
229
230 void
231 setup_scanner();
232
233 char *
234 itos(int val);
235
236 char *
237 str_replace (const char* search, const char* replace, const char* string);
238
239 GArray*
240 read_file_by_line (gchar *path);
241
242 gchar*
243 parseenv (char* string);
244
245 void
246 clean_up(void);
247
248 void
249 catch_sigterm(int s);
250
251 sigfunc *
252 setup_signal(int signe, sigfunc *shandler);
253
254 gboolean
255 set_var_value(gchar *name, gchar *val);
256
257 void
258 print(WebKitWebView *page, GArray *argv, GString *result);
259
260 gboolean
261 new_window_cb (WebKitWebView *web_view, WebKitWebFrame *frame, WebKitNetworkRequest *request, WebKitWebNavigationAction *navigation_action, WebKitWebPolicyDecision *policy_decision, gpointer user_data);
262
263 gboolean
264 mime_policy_cb(WebKitWebView *web_view, WebKitWebFrame *frame, WebKitNetworkRequest *request, gchar *mime_type,  WebKitWebPolicyDecision *policy_decision, gpointer user_data);
265
266 WebKitWebView*
267 create_web_view_cb (WebKitWebView  *web_view, WebKitWebFrame *frame, gpointer user_data);
268
269 gboolean
270 download_cb (WebKitWebView *web_view, GObject *download, gpointer user_data);
271
272 void
273 toggle_zoom_type (WebKitWebView* page, GArray *argv, GString *result);
274
275 void
276 toggle_status_cb (WebKitWebView* page, GArray *argv, GString *result);
277
278 void
279 link_hover_cb (WebKitWebView* page, const gchar* title, const gchar* link, gpointer data);
280
281 void
282 title_change_cb (WebKitWebView* web_view, WebKitWebFrame* web_frame, const gchar* title, gpointer data);
283
284 void
285 progress_change_cb (WebKitWebView* page, gint progress, gpointer data);
286
287 void
288 load_commit_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
289
290 void
291 load_start_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
292
293 void
294 load_finish_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
295
296 void
297 destroy_cb (GtkWidget* widget, gpointer data);
298
299 void
300 log_history_cb ();
301
302 void
303 commands_hash(void);
304
305 void
306 free_action(gpointer act);
307
308 Action*
309 new_action(const gchar *name, const gchar *param);
310
311 bool
312 file_exists (const char * filename);
313
314 void
315 toggle_insert_mode(WebKitWebView *page, GArray *argv, GString *result);
316
317 void
318 load_uri (WebKitWebView * web_view, GArray *argv, GString *result);
319
320 void
321 new_window_load_uri (const gchar * uri);
322
323 void
324 chain (WebKitWebView *page, GArray *argv, GString *result);
325
326 void
327 keycmd (WebKitWebView *page, GArray *argv, GString *result);
328
329 void
330 keycmd_nl (WebKitWebView *page, GArray *argv, GString *result);
331
332 void
333 keycmd_bs (WebKitWebView *page, GArray *argv, GString *result);
334
335 void
336 close_uzbl (WebKitWebView *page, GArray *argv, GString *result);
337
338 gboolean
339 run_command(const gchar *command, const guint npre,
340             const gchar **args, const gboolean sync, char **output_stdout);
341
342 void
343 spawn(WebKitWebView *web_view, GArray *argv, GString *result);
344
345 void
346 spawn_sh(WebKitWebView *web_view, GArray *argv, GString *result);
347
348 void
349 spawn_sync(WebKitWebView *web_view, GArray *argv, GString *result);
350
351 void
352 spawn_sh_sync(WebKitWebView *web_view, GArray *argv, GString *result);
353
354 void
355 parse_command(const char *cmd, const char *param, GString *result);
356
357 void
358 parse_cmd_line(const char *ctl_line, GString *result);
359
360 gchar*
361 build_stream_name(int type, const gchar *dir);
362
363 gboolean
364 control_fifo(GIOChannel *gio, GIOCondition condition);
365
366 gchar*
367 init_fifo(gchar *dir);
368
369 gboolean
370 control_stdin(GIOChannel *gio, GIOCondition condition);
371
372 void
373 create_stdin();
374
375 gchar*
376 init_socket(gchar *dir);
377
378 gboolean
379 control_socket(GIOChannel *chan);
380
381 gboolean
382 control_client_socket(GIOChannel *chan);
383
384 void
385 update_title (void);
386
387 gboolean
388 key_press_cb (GtkWidget* window, GdkEventKey* event);
389
390 void
391 run_keycmd(const gboolean key_ret);
392
393 void
394 exec_paramcmd(const Action* act, const guint i);
395
396 GtkWidget*
397 create_browser ();
398
399 GtkWidget*
400 create_mainbar ();
401
402 GtkWidget*
403 create_window ();
404
405 GtkPlug* 
406 create_plug ();
407
408 void
409 run_handler (const gchar *act, const gchar *args);
410
411 void
412 add_binding (const gchar *key, const gchar *act);
413
414 gchar*
415 get_xdg_var (XDG_Var xdg);
416
417 gchar*
418 find_xdg_file (int xdg_type, char* filename);
419
420 void
421 settings_init ();
422
423 void
424 search_text (WebKitWebView *page, GArray *argv, const gboolean forward);
425
426 void
427 search_forward_text (WebKitWebView *page, GArray *argv, GString *result);
428
429 void
430 search_reverse_text (WebKitWebView *page, GArray *argv, GString *result);
431
432 void
433 dehilight (WebKitWebView *page, GArray *argv, GString *result);
434
435 void
436 run_js (WebKitWebView * web_view, GArray *argv, GString *result);
437
438 void
439 run_external_js (WebKitWebView * web_view, GArray *argv, GString *result);
440
441 void
442 eval_js(WebKitWebView * web_view, gchar *script, GString *result);
443
444 void handle_cookies (SoupSession *session,
445                             SoupMessage *msg,
446                             gpointer     user_data);
447 void
448 save_cookies (SoupMessage *msg,
449                 gpointer     user_data);
450
451 void
452 set_var(WebKitWebView *page, GArray *argv, GString *result);
453
454 void
455 act_bind(WebKitWebView *page, GArray *argv, GString *result);
456
457 void
458 act_dump_config();
459
460 void
461 render_html();
462
463 void
464 set_timeout(int seconds);
465
466 void
467 dump_var_hash(gpointer k, gpointer v, gpointer ud);
468
469 void
470 dump_key_hash(gpointer k, gpointer v, gpointer ud);
471
472 void
473 dump_config();
474
475 typedef void (*Command)(WebKitWebView*, GArray *argv, GString *result);
476 typedef struct {
477     Command function;
478     gboolean no_split;
479 } CommandInfo;
480
481 /* Command callbacks */
482 void
483 cmd_load_uri();
484
485 void
486 cmd_set_status();
487
488 void
489 set_proxy_url();
490
491 void
492 set_icon();
493
494 void
495 cmd_cookie_handler();
496
497 void
498 move_statusbar();
499
500 void
501 cmd_always_insert_mode();
502
503 void
504 cmd_http_debug();
505
506 void
507 cmd_max_conns();
508
509 void
510 cmd_max_conns_host();
511
512 /* exported WebKitWebSettings properties */
513
514 void
515 cmd_font_size();
516
517 void
518 cmd_zoom_level();
519
520 void
521 cmd_disable_plugins();
522
523 void
524 cmd_disable_scripts();
525
526 void
527 cmd_minimum_font_size();
528
529 void
530 cmd_fifo_dir();
531
532 void
533 cmd_socket_dir();
534
535 void
536 cmd_modkey();
537
538 void
539 cmd_useragent() ;
540
541 void
542 cmd_autoload_img();
543
544 void
545 cmd_autoshrink_img();
546
547 void
548 cmd_enable_spellcheck();
549
550 void
551 cmd_enable_private();
552
553 void
554 cmd_print_bg();
555
556 void 
557 cmd_style_uri();
558
559 void 
560 cmd_resizable_txt();
561
562 void 
563 cmd_default_encoding();
564
565 void 
566 cmd_enforce_96dpi();
567
568 void
569 cmd_inject_html();
570
571 void 
572 cmd_caret_browsing();
573
574 /* vi: set et ts=4: */