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