reset
[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
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 gboolean
256 new_window_cb (WebKitWebView *web_view, WebKitWebFrame *frame, WebKitNetworkRequest *request, WebKitWebNavigationAction *navigation_action, WebKitWebPolicyDecision *policy_decision, gpointer user_data);
257
258 static gboolean
259 mime_policy_cb(WebKitWebView *web_view, WebKitWebFrame *frame, WebKitNetworkRequest *request, gchar *mime_type,  WebKitWebPolicyDecision *policy_decision, gpointer user_data);
260
261 WebKitWebView*
262 create_web_view_cb (WebKitWebView  *web_view, WebKitWebFrame *frame, gpointer user_data);
263
264 static gboolean
265 download_cb (WebKitWebView *web_view, GObject *download, gpointer user_data);
266
267 static void
268 link_hover_cb (WebKitWebView* page, const gchar* title, const gchar* link, gpointer data);
269
270 static void
271 title_change_cb (WebKitWebView* web_view, WebKitWebFrame* web_frame, const gchar* title, gpointer data);
272
273 static void
274 progress_change_cb (WebKitWebView* page, gint progress, gpointer data);
275
276 static void
277 load_commit_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
278
279 static void
280 load_start_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
281
282 static void
283 load_finish_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
284
285 static void
286 destroy_cb (GtkWidget* widget, gpointer data);
287
288 static void
289 log_history_cb ();
290
291 static void
292 commands_hash(void);
293
294 void
295 free_action(gpointer act);
296
297 Action*
298 new_action(const gchar *name, const gchar *param);
299
300 static bool
301 file_exists (const char * filename);
302
303 static void
304 new_window_load_uri (const gchar * uri);
305
306 static gboolean
307 run_command(const gchar *command, const guint npre,
308             const gchar **args, const gboolean sync, char **output_stdout);
309
310 static void
311 parse_command(const char *cmd, const char *param, GString *result);
312
313 static void
314 parse_cmd_line(const char *ctl_line, GString *result);
315
316 static gchar*
317 build_stream_name(int type, const gchar *dir);
318
319 static gboolean
320 control_fifo(GIOChannel *gio, GIOCondition condition);
321
322 static gchar*
323 init_fifo(gchar *dir);
324
325 static gboolean
326 control_stdin(GIOChannel *gio, GIOCondition condition);
327
328 static void
329 create_stdin();
330
331 static gchar*
332 init_socket(gchar *dir);
333
334 static gboolean
335 control_socket(GIOChannel *chan);
336
337 static gboolean
338 control_client_socket(GIOChannel *chan);
339
340 static void
341 update_title (void);
342
343 static gboolean
344 key_press_cb (GtkWidget* window, GdkEventKey* event);
345
346 static void
347 run_keycmd(const gboolean key_ret);
348
349 static void
350 exec_paramcmd(const Action* act, const guint i);
351
352 static GtkWidget*
353 create_browser ();
354
355 static GtkWidget*
356 create_mainbar ();
357
358 static
359 GtkWidget* create_window ();
360
361 static
362 GtkPlug* create_plug ();
363
364 static void
365 run_handler (const gchar *act, const gchar *args);
366
367 static void
368 add_binding (const gchar *key, const gchar *act);
369
370 static gchar*
371 get_xdg_var (XDG_Var xdg);
372
373 static gchar*
374 find_xdg_file (int xdg_type, char* filename);
375
376 static void
377 settings_init ();
378
379 static void
380 search_text (WebKitWebView *page, GArray *argv, const gboolean forward);
381
382 static void handle_cookies (SoupSession *session,
383                             SoupMessage *msg,
384                             gpointer     user_data);
385 static void
386 save_cookies (SoupMessage *msg,
387                 gpointer     user_data);
388
389 static void
390 act_dump_config();
391
392 static void
393 render_html();
394
395 static void
396 set_timeout(int seconds);
397
398 static void
399 dump_var_hash(gpointer k, gpointer v, gpointer ud);
400
401 static void
402 dump_key_hash(gpointer k, gpointer v, gpointer ud);
403
404 static void
405 dump_config();
406
407
408 /* Commands */
409
410 typedef void (*Command)(WebKitWebView*, GArray *argv, GString *result);
411 typedef struct {
412     Command function;
413     gboolean no_split;
414 } CommandInfo;
415
416 static void
417 print(WebKitWebView *page, GArray *argv, GString *result);
418
419 static void
420 toggle_zoom_type (WebKitWebView* page, GArray *argv, GString *result);
421
422 static void
423 toggle_status_cb (WebKitWebView* page, GArray *argv, GString *result);
424
425 static void
426 toggle_insert_mode(WebKitWebView *page, GArray *argv, GString *result);
427
428 static void
429 load_uri (WebKitWebView * web_view, GArray *argv, GString *result);
430
431 static void
432 chain (WebKitWebView *page, GArray *argv, GString *result);
433
434 static void
435 keycmd (WebKitWebView *page, GArray *argv, GString *result);
436
437 static void
438 keycmd_nl (WebKitWebView *page, GArray *argv, GString *result);
439
440 static void
441 keycmd_bs (WebKitWebView *page, GArray *argv, GString *result);
442
443 static void
444 close_uzbl (WebKitWebView *page, GArray *argv, GString *result);
445
446 static void
447 spawn(WebKitWebView *web_view, GArray *argv, GString *result);
448
449 static void
450 spawn_sh(WebKitWebView *web_view, GArray *argv, GString *result);
451
452 static void
453 spawn_sync(WebKitWebView *web_view, GArray *argv, GString *result);
454
455 static void
456 spawn_sh_sync(WebKitWebView *web_view, GArray *argv, GString *result);
457
458 static void
459 search_forward_text (WebKitWebView *page, GArray *argv, GString *result);
460
461 static void
462 search_reverse_text (WebKitWebView *page, GArray *argv, GString *result);
463
464 static void
465 dehilight (WebKitWebView *page, GArray *argv, GString *result);
466
467 static void
468 eval_js(WebKitWebView * web_view, gchar *script, GString *result);
469
470 static void
471 run_js (WebKitWebView * web_view, GArray *argv, GString *result);
472
473 static void
474 run_external_js (WebKitWebView * web_view, GArray *argv, GString *result);
475
476 static void
477 set_var(WebKitWebView *page, GArray *argv, GString *result);
478
479 static void
480 act_bind(WebKitWebView *page, GArray *argv, GString *result);
481
482
483 /* Command callbacks */
484 static void
485 cmd_load_uri();
486
487 static void
488 cmd_set_status();
489
490 static void
491 set_proxy_url();
492
493 static void
494 set_icon();
495
496 static void
497 cmd_cookie_handler();
498
499 static void
500 move_statusbar();
501
502 static void
503 cmd_always_insert_mode();
504
505 static void
506 cmd_http_debug();
507
508 static void
509 cmd_max_conns();
510
511 static void
512 cmd_max_conns_host();
513
514 /* exported WebKitWebSettings properties */
515
516 static void
517 cmd_font_size();
518
519 static void
520 cmd_zoom_level();
521
522 static void
523 cmd_disable_plugins();
524
525 static void
526 cmd_disable_scripts();
527
528 static void
529 cmd_minimum_font_size();
530
531 static void
532 cmd_fifo_dir();
533
534 static void
535 cmd_socket_dir();
536
537 static void
538 cmd_modkey();
539
540 static void
541 cmd_useragent() ;
542
543 static void
544 cmd_autoload_img();
545
546 static void
547 cmd_autoshrink_img();
548
549 static void
550 cmd_enable_spellcheck();
551
552 static void
553 cmd_enable_private();
554
555 static void
556 cmd_print_bg();
557
558 static void 
559 cmd_style_uri();
560
561 static void 
562 cmd_resizable_txt();
563
564 static void 
565 cmd_default_encoding();
566
567 static void 
568 cmd_enforce_96dpi();
569
570 static void
571 cmd_inject_html();
572
573 static void 
574 cmd_caret_browsing();
575
576 /* vi: set et ts=4: */