added callback based uzbl 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 STATUS_DEFAULT "<span background=\"darkblue\" foreground=\"white\"> MODE </span> <span background=\"red\" foreground=\"white\">KEYCMD</span> (LOAD_PROGRESS%)  <b>TITLE</b>  - Uzbl browser"
15 #define TITLE_LONG_DEFAULT "KEYCMD MODE TITLE - Uzbl browser <NAME> > SELECTED_URI"
16 #define TITLE_SHORT_DEFAULT "TITLE - Uzbl browser <NAME>"
17
18
19 enum {
20   /* statusbar symbols */
21   SYM_TITLE, SYM_URI, SYM_NAME,
22   SYM_LOADPRGS, SYM_LOADPRGSBAR,
23   SYM_KEYCMD, SYM_MODE, SYM_MSG,
24   SYM_SELECTED_URI,
25   /* useragent symbols */
26   SYM_WK_MAJ, SYM_WK_MIN, SYM_WK_MIC,
27   SYM_SYSNAME, SYM_NODENAME,
28   SYM_KERNREL, SYM_KERNVER,
29   SYM_ARCHSYS, SYM_ARCHUZBL,
30   SYM_DOMAINNAME, SYM_COMMIT
31 };
32
33 const struct {
34     gchar *symbol_name;
35     guint symbol_token;
36 } symbols[] = {
37     {"NAME",                 SYM_NAME},
38     {"URI",                  SYM_URI},
39     {"TITLE",                SYM_TITLE},
40     {"SELECTED_URI",         SYM_SELECTED_URI},
41     {"KEYCMD",               SYM_KEYCMD},
42     {"MODE",                 SYM_MODE},
43     {"MSG",                  SYM_MSG},
44     {"LOAD_PROGRESS",        SYM_LOADPRGS},
45     {"LOAD_PROGRESSBAR",     SYM_LOADPRGSBAR},
46
47     {"WEBKIT_MAJOR",         SYM_WK_MAJ},
48     {"WEBKIT_MINOR",         SYM_WK_MIN},
49     {"WEBKIT_MICRO",         SYM_WK_MIC},
50     {"SYSNAME",              SYM_SYSNAME},
51     {"NODENAME",             SYM_NODENAME},
52     {"KERNREL",              SYM_KERNREL},
53     {"KERNVER",              SYM_KERNVER},
54     {"ARCH_SYSTEM",          SYM_ARCHSYS},
55     {"ARCH_UZBL",            SYM_ARCHUZBL},
56     {"DOMAINNAME",           SYM_DOMAINNAME},
57     {"COMMIT",               SYM_COMMIT},
58     {NULL,                   0}
59 }, *symp = symbols;
60
61 /* status bar elements */
62 typedef struct {
63     gint           load_progress;
64     gchar          *msg;
65 } StatusBar;
66
67
68 /* gui elements */
69 typedef struct {
70     GtkWidget*     main_window;
71     GtkWidget*     scrolled_win;
72     GtkWidget*     vbox;
73     GtkWidget*     mainbar;
74     GtkWidget*     mainbar_label;
75     GtkScrollbar*  scbar_v;   // Horizontal and Vertical Scrollbar
76     GtkScrollbar*  scbar_h;   // (These are still hidden)
77     GtkAdjustment* bar_v; // Information about document length
78     GtkAdjustment* bar_h; // and scrolling position
79     WebKitWebView* web_view;
80     gchar*         main_title;
81
82     StatusBar sbar;
83 } GUI;
84
85
86 /* external communication*/
87 enum { FIFO, SOCKET};
88 typedef struct {
89     gchar          *fifo_path;
90     gchar          *socket_path;
91     /* stores (key)"variable name" -> (value)"pointer to this var*/
92     GHashTable     *proto_var;
93     /* command parsing regexes */
94     GRegex         *set_regex;
95     GRegex         *act_regex;
96     GRegex         *keycmd_regex;
97     GRegex         *get_regex;
98     GRegex         *bind_regex;
99 } Communication;
100
101
102 /* internal state */
103 typedef struct {
104     gchar    *uri;
105     gchar    *config_file;
106     char    *instance_name;
107     gchar    *selected_url;
108     gchar    *executable_path;
109     GString* keycmd;
110     gchar    *searchtx;
111     struct utsname unameinfo; /* system info */
112     gboolean verbose;
113 } State;
114
115
116 /* networking */
117 typedef struct {
118     SoupSession *soup_session;
119     SoupLogger *soup_logger;
120     char *proxy_url;
121     char *useragent;
122     gint max_conns;
123     gint max_conns_host;
124 } Network;
125
126
127 /* behaviour */
128 typedef struct {
129     gchar*   load_finish_handler;
130     gchar*   load_start_handler;
131     gchar*   load_commit_handler;
132     gchar*   status_format;
133     gchar*   title_format_short;
134     gchar*   title_format_long;
135     gchar*   status_background;
136     gchar*   history_handler;
137     gchar*   fifo_dir;
138     gchar*   socket_dir;
139     gchar*   download_handler;
140     gchar*   cookie_handler;
141     gboolean always_insert_mode;
142     gboolean show_status;
143     gboolean insert_mode;
144     gboolean status_top;
145     gboolean reset_command_mode;
146     gchar*   modkey;
147     guint    modmask;
148     guint    http_debug;
149     guint    default_font_size;
150     guint    minimum_font_size;
151     gchar*   shell_cmd;
152
153     /* command list: name -> Command  */
154     GHashTable* commands;
155 } Behaviour;
156
157
158 /* main uzbl data structure */
159 typedef struct {
160     GUI           gui;
161     State         state;
162     Network       net;
163     Behaviour     behave;
164     Communication comm;
165
166     Window        xwin;
167     GScanner      *scan;
168
169     /* group bindings: key -> action */
170     GHashTable* bindings;
171 } Uzbl;
172
173
174 typedef struct {
175     char* name;
176     char* param;
177 } Action;
178
179 typedef void sigfunc(int);
180
181 /* XDG Stuff */
182
183 typedef struct {
184     gchar* environmental;
185     gchar* default_value;
186 } XDG_Var;
187
188 XDG_Var XDG[] = 
189 {
190     { "XDG_CONFIG_HOME", "~/.config" },
191     { "XDG_DATA_HOME",   "~/.local/share" },
192     { "XDG_CACHE_HOME",  "~/.cache" },
193     { "XDG_CONFIG_DIRS", "/etc/xdg" },
194     { "XDG_DATA_DIRS",   "/usr/local/share/:/usr/share/" },
195 };
196
197 /* Functions */
198 static void
199 setup_scanner();
200
201 char *
202 itos(int val);
203
204 static char *
205 str_replace (const char* search, const char* replace, const char* string);
206
207 static void
208 clean_up(void);
209
210 static void
211 catch_sigterm(int s);
212
213 static sigfunc *
214 setup_signal(int signe, sigfunc *shandler);
215
216 static gboolean
217 new_window_cb (WebKitWebView *web_view, WebKitWebFrame *frame, WebKitNetworkRequest *request, WebKitWebNavigationAction *navigation_action, WebKitWebPolicyDecision *policy_decision, gpointer user_data);
218
219 WebKitWebView*
220 create_web_view_cb (WebKitWebView  *web_view, WebKitWebFrame *frame, gpointer user_data);
221
222 static gboolean
223 download_cb (WebKitWebView *web_view, GObject *download, gpointer user_data);
224
225 static void
226 toggle_status_cb (WebKitWebView* page, const char *param);
227
228 static void
229 link_hover_cb (WebKitWebView* page, const gchar* title, const gchar* link, gpointer data);
230
231 static void
232 title_change_cb (WebKitWebView* web_view, WebKitWebFrame* web_frame, const gchar* title, gpointer data);
233
234 static void
235 progress_change_cb (WebKitWebView* page, gint progress, gpointer data);
236
237 static void
238 load_commit_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
239
240 static void
241 load_start_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
242
243 static void
244 load_finish_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
245
246 static void
247 destroy_cb (GtkWidget* widget, gpointer data);
248
249 static void
250 log_history_cb ();
251
252 static void
253 commands_hash(void);
254
255 void
256 free_action(gpointer act);
257
258 Action*
259 new_action(const gchar *name, const gchar *param);
260
261 static bool
262 file_exists (const char * filename);
263
264 static void
265 set_insert_mode(WebKitWebView *page, const gchar *param);
266
267 static void
268 load_uri (WebKitWebView * web_view, const gchar *param);
269
270 static void
271 new_window_load_uri (const gchar * uri);
272
273 static void
274 close_uzbl (WebKitWebView *page, const char *param);
275
276 static gboolean
277 run_command(const gchar *command, const guint npre,
278             const gchar **args, const gboolean sync, char **stdout);
279
280 static void
281 spawn(WebKitWebView *web_view, const char *param);
282
283 static void
284 spawn_sh(WebKitWebView *web_view, const char *param);
285
286 static void
287 parse_command(const char *cmd, const char *param);
288
289 static void
290 runcmd(WebKitWebView *page, const char *param);
291
292 static void
293 parse_cmd_line(const char *ctl_line);
294
295 static gchar*
296 build_stream_name(int type, const gchar *dir);
297
298 static gboolean
299 var_is(const char *x, const char *y);
300
301 static gchar*
302 set_useragent(gchar *val);
303
304 static gboolean
305 control_fifo(GIOChannel *gio, GIOCondition condition);
306
307 static gchar*
308 init_fifo(gchar *dir);
309
310 static gboolean
311 control_stdin(GIOChannel *gio, GIOCondition condition);
312
313 static void
314 create_stdin();
315
316 static gchar*
317 init_socket(gchar *dir);
318
319 static gboolean
320 control_socket(GIOChannel *chan);
321
322 static void
323 update_title (void);
324
325 static gboolean
326 key_press_cb (WebKitWebView* page, GdkEventKey* event);
327
328 static void
329 run_keycmd(const gboolean key_ret);
330
331 static GtkWidget*
332 create_browser ();
333
334 static GtkWidget*
335 create_mainbar ();
336
337 static
338 GtkWidget* create_window ();
339
340 static void
341 run_handler (const gchar *act, const gchar *args);
342
343 static void
344 add_binding (const gchar *key, const gchar *act);
345
346 static gchar*
347 get_xdg_var (XDG_Var xdg);
348
349 static gchar*
350 find_xdg_file (int xdg_type, char* filename);
351
352 static void
353 settings_init ();
354
355 static void
356 search_text (WebKitWebView *page, const char *param, const gboolean forward);
357
358 static void
359 search_forward_text (WebKitWebView *page, const char *param);
360
361 static void
362 search_reverse_text (WebKitWebView *page, const char *param);
363
364 static void
365 run_js (WebKitWebView * web_view, const gchar *param);
366
367 static void handle_cookies (SoupSession *session,
368                                                         SoupMessage *msg,
369                                                         gpointer     user_data);
370 static void
371 save_cookies (SoupMessage *msg,
372                           gpointer     user_data);
373
374 /* Command callbacks */
375 static void
376 cmd_load_uri();
377
378 static void
379 cmd_set_status();
380
381 static void
382 set_proxy_url();
383
384 static void
385 move_statusbar();
386 /* vi: set et ts=4: */