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