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