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