Merge commit 'holizz/whitespace' into experimental
[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     gchar*   new_window;
141     gboolean always_insert_mode;
142     gboolean show_status;
143     gboolean insert_mode;
144     gboolean status_top;
145     gboolean reset_command_mode;
146     gchar*   modkey;
147     guint    modmask;
148     guint    http_debug;
149     gchar*   shell_cmd;
150     /* WebKitWebSettings exports */
151     guint    font_size;
152     guint    monospace_size;
153     guint    minimum_font_size;
154     gfloat   zoom_level;
155     guint    disable_plugins;
156     guint    disable_scripts;
157     guint    autoload_img;
158     guint    autoshrink_img;
159     guint    enable_spellcheck;
160     guint    enable_private;
161     guint    print_bg;
162     gchar*   style_uri;
163     guint    resizable_txt;
164     gchar*   default_encoding;
165     guint    enforce_96dpi;
166     gchar    *inject_html;
167     guint    caret_browsing;
168     guint    mode;
169     gchar*   base_url;
170     gchar*   html_endmarker;
171     gchar*   insert_indicator;
172     gchar*   cmd_indicator;
173     GString* html_buffer;
174     guint    html_timeout;
175     gboolean print_version;
176
177     /* command list: name -> Command  */
178     GHashTable* commands;
179 } Behaviour;
180
181 /* javascript */
182 typedef struct {
183     gboolean            initialized;
184     JSClassDefinition   classdef;
185     JSClassRef          classref;
186 } Javascript;
187
188 /* main uzbl data structure */
189 typedef struct {
190     GUI           gui;
191     State         state;
192     Network       net;
193     Behaviour     behave;
194     Communication comm;
195     Javascript    js;
196
197     Window        xwin;
198     GScanner      *scan;
199
200     /* group bindings: key -> action */
201     GHashTable* bindings;
202 } Uzbl;
203
204
205 typedef struct {
206     char* name;
207     char* param;
208 } Action;
209
210 typedef void sigfunc(int);
211
212 /* XDG Stuff */
213
214 typedef struct {
215     gchar* environmental;
216     gchar* default_value;
217 } XDG_Var;
218
219 XDG_Var XDG[] =
220 {
221     { "XDG_CONFIG_HOME", "~/.config" },
222     { "XDG_DATA_HOME",   "~/.local/share" },
223     { "XDG_CACHE_HOME",  "~/.cache" },
224     { "XDG_CONFIG_DIRS", "/etc/xdg" },
225     { "XDG_DATA_DIRS",   "/usr/local/share/:/usr/share/" },
226 };
227
228 /* Functions */
229 static void
230 setup_scanner();
231
232 char *
233 itos(int val);
234
235 static char *
236 str_replace (const char* search, const char* replace, const char* string);
237
238 static GArray*
239 read_file_by_line (gchar *path);
240
241 static
242 gchar* parseenv (char* string);
243
244 static void
245 clean_up(void);
246
247 static void
248 catch_sigterm(int s);
249
250 static sigfunc *
251 setup_signal(int signe, sigfunc *shandler);
252
253 static gboolean
254 set_var_value(gchar *name, gchar *val);
255
256 static void
257 print(WebKitWebView *page, GArray *argv, GString *result);
258
259 static gboolean
260 new_window_cb (WebKitWebView *web_view, WebKitWebFrame *frame, WebKitNetworkRequest *request, WebKitWebNavigationAction *navigation_action, WebKitWebPolicyDecision *policy_decision, gpointer user_data);
261
262 static gboolean
263 mime_policy_cb(WebKitWebView *web_view, WebKitWebFrame *frame, WebKitNetworkRequest *request, gchar *mime_type,  WebKitWebPolicyDecision *policy_decision, gpointer user_data);
264
265 WebKitWebView*
266 create_web_view_cb (WebKitWebView  *web_view, WebKitWebFrame *frame, gpointer user_data);
267
268 static gboolean
269 download_cb (WebKitWebView *web_view, GObject *download, gpointer user_data);
270
271 static void
272 toggle_zoom_type (WebKitWebView* page, GArray *argv, GString *result);
273
274 static void
275 toggle_status_cb (WebKitWebView* page, GArray *argv, GString *result);
276
277 static void
278 link_hover_cb (WebKitWebView* page, const gchar* title, const gchar* link, gpointer data);
279
280 static void
281 title_change_cb (WebKitWebView* web_view, GParamSpec param_spec);
282
283 static void
284 progress_change_cb (WebKitWebView* page, gint progress, gpointer data);
285
286 static void
287 load_commit_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
288
289 static void
290 load_start_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
291
292 static void
293 load_finish_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
294
295 static void
296 destroy_cb (GtkWidget* widget, gpointer data);
297
298 static void
299 log_history_cb ();
300
301 static void
302 commands_hash(void);
303
304 void
305 free_action(gpointer act);
306
307 Action*
308 new_action(const gchar *name, const gchar *param);
309
310 static bool
311 file_exists (const char * filename);
312
313 static void
314 toggle_insert_mode(WebKitWebView *page, GArray *argv, GString *result);
315
316 static void
317 load_uri (WebKitWebView * web_view, GArray *argv, GString *result);
318
319 static void
320 new_window_load_uri (const gchar * uri);
321
322 static void
323 chain (WebKitWebView *page, GArray *argv, GString *result);
324
325 static void
326 keycmd (WebKitWebView *page, GArray *argv, GString *result);
327
328 static void
329 keycmd_nl (WebKitWebView *page, GArray *argv, GString *result);
330
331 static void
332 keycmd_bs (WebKitWebView *page, GArray *argv, GString *result);
333
334 static void
335 close_uzbl (WebKitWebView *page, GArray *argv, GString *result);
336
337 static gboolean
338 run_command(const gchar *command, const guint npre,
339             const gchar **args, const gboolean sync, char **output_stdout);
340
341 static void
342 spawn(WebKitWebView *web_view, GArray *argv, GString *result);
343
344 static void
345 spawn_sh(WebKitWebView *web_view, GArray *argv, GString *result);
346
347 static void
348 spawn_sync(WebKitWebView *web_view, GArray *argv, GString *result);
349
350 static void
351 spawn_sh_sync(WebKitWebView *web_view, GArray *argv, GString *result);
352
353 static void
354 parse_command(const char *cmd, const char *param, GString *result);
355
356 static void
357 parse_cmd_line(const char *ctl_line, GString *result);
358
359 static gchar*
360 build_stream_name(int type, const gchar *dir);
361
362 static gboolean
363 control_fifo(GIOChannel *gio, GIOCondition condition);
364
365 static gchar*
366 init_fifo(gchar *dir);
367
368 static gboolean
369 control_stdin(GIOChannel *gio, GIOCondition condition);
370
371 static void
372 create_stdin();
373
374 static gchar*
375 init_socket(gchar *dir);
376
377 static gboolean
378 control_socket(GIOChannel *chan);
379
380 static gboolean
381 control_client_socket(GIOChannel *chan);
382
383 static void
384 update_title (void);
385
386 static gboolean
387 key_press_cb (GtkWidget* window, GdkEventKey* event);
388
389 static void
390 run_keycmd(const gboolean key_ret);
391
392 static void
393 exec_paramcmd(const Action* act, const guint i);
394
395 static GtkWidget*
396 create_browser ();
397
398 static GtkWidget*
399 create_mainbar ();
400
401 static
402 GtkWidget* create_window ();
403
404 static
405 GtkPlug* create_plug ();
406
407 static void
408 run_handler (const gchar *act, const gchar *args);
409
410 static void
411 add_binding (const gchar *key, const gchar *act);
412
413 static gchar*
414 get_xdg_var (XDG_Var xdg);
415
416 static gchar*
417 find_xdg_file (int xdg_type, char* filename);
418
419 static void
420 settings_init ();
421
422 static void
423 search_text (WebKitWebView *page, GArray *argv, const gboolean forward);
424
425 static void
426 search_forward_text (WebKitWebView *page, GArray *argv, GString *result);
427
428 static void
429 search_reverse_text (WebKitWebView *page, GArray *argv, GString *result);
430
431 static void
432 dehilight (WebKitWebView *page, GArray *argv, GString *result);
433
434 static void
435 run_js (WebKitWebView * web_view, GArray *argv, GString *result);
436
437 static void
438 run_external_js (WebKitWebView * web_view, GArray *argv, GString *result);
439
440 static void
441 eval_js(WebKitWebView * web_view, gchar *script, GString *result);
442
443 static void handle_cookies (SoupSession *session,
444                             SoupMessage *msg,
445                             gpointer     user_data);
446 static void
447 save_cookies (SoupMessage *msg,
448                 gpointer     user_data);
449
450 static void
451 set_var(WebKitWebView *page, GArray *argv, GString *result);
452
453 static void
454 act_bind(WebKitWebView *page, GArray *argv, GString *result);
455
456 static void
457 act_dump_config();
458
459 static void
460 render_html();
461
462 static void
463 set_timeout(int seconds);
464
465 static void
466 dump_var_hash(gpointer k, gpointer v, gpointer ud);
467
468 static void
469 dump_key_hash(gpointer k, gpointer v, gpointer ud);
470
471 static void
472 dump_config();
473
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 static void
483 cmd_load_uri();
484
485 static void
486 cmd_set_status();
487
488 static void
489 set_proxy_url();
490
491 static void
492 set_icon();
493
494 static void
495 cmd_cookie_handler();
496
497 static void
498 cmd_new_window();
499
500 static void
501 move_statusbar();
502
503 static void
504 cmd_always_insert_mode();
505
506 static void
507 cmd_http_debug();
508
509 static void
510 cmd_max_conns();
511
512 static void
513 cmd_max_conns_host();
514
515 /* exported WebKitWebSettings properties */
516
517 static void
518 cmd_font_size();
519
520 static void
521 cmd_zoom_level();
522
523 static void
524 cmd_disable_plugins();
525
526 static void
527 cmd_disable_scripts();
528
529 static void
530 cmd_minimum_font_size();
531
532 static void
533 cmd_fifo_dir();
534
535 static void
536 cmd_socket_dir();
537
538 static void
539 cmd_modkey();
540
541 static void
542 cmd_useragent() ;
543
544 static void
545 cmd_autoload_img();
546
547 static void
548 cmd_autoshrink_img();
549
550 static void
551 cmd_enable_spellcheck();
552
553 static void
554 cmd_enable_private();
555
556 static void
557 cmd_print_bg();
558
559 static void
560 cmd_style_uri();
561
562 static void
563 cmd_resizable_txt();
564
565 static void
566 cmd_default_encoding();
567
568 static void
569 cmd_enforce_96dpi();
570
571 static void
572 cmd_inject_html();
573
574 static void
575 cmd_caret_browsing();
576
577 /* vi: set et ts=4: */