Merge branch 'dieter/experimental' into experimental
[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     gchar*   searchold;
112     struct utsname unameinfo; /* system info */
113     gboolean verbose;
114 } State;
115
116
117 /* networking */
118 typedef struct {
119     SoupSession *soup_session;
120     SoupLogger *soup_logger;
121     char *proxy_url;
122     char *useragent;
123     gint max_conns;
124     gint max_conns_host;
125 } Network;
126
127
128 /* behaviour */
129 typedef struct {
130     gchar*   load_finish_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     guint    default_font_size;
149     guint    minimum_font_size;
150     gchar*   shell_cmd;
151
152     /* command list: name -> Command  */
153     GHashTable* commands;
154 } Behaviour;
155
156
157 /* main uzbl data structure */
158 typedef struct {
159     GUI           gui;
160     State         state;
161     Network       net;
162     Behaviour     behave;
163     Communication comm;
164
165     Window        xwin;
166     GScanner      *scan;
167
168     /* group bindings: key -> action */
169     GHashTable* bindings;
170 } Uzbl;
171
172
173 typedef struct {
174     char* name;
175     char* param;
176 } Action;
177
178 typedef void sigfunc(int);
179
180 /* XDG Stuff */
181
182 typedef struct {
183     gchar* environmental;
184     gchar* default_value;
185 } XDG_Var;
186
187 XDG_Var XDG[] = 
188 {
189     { "XDG_CONFIG_HOME", "~/.config" },
190     { "XDG_DATA_HOME",   "~/.local/share" },
191     { "XDG_CACHE_HOME",  "~/.cache" },
192     { "XDG_CONFIG_DIRS", "/etc/xdg" },
193     { "XDG_DATA_DIRS",   "/usr/local/share/:/usr/share/" },
194 };
195
196 /* Functions */
197 static void
198 setup_scanner();
199
200 char *
201 itos(int val);
202
203 static char *
204 str_replace (const char* search, const char* replace, const char* string);
205
206 static gchar**
207 read_file_by_line (gchar *path);
208
209 static
210 gchar* parseenv (const char* string);
211
212 static void
213 clean_up(void);
214
215 static void
216 catch_sigterm(int s);
217
218 static sigfunc *
219 setup_signal(int signe, sigfunc *shandler);
220
221 static gboolean
222 new_window_cb (WebKitWebView *web_view, WebKitWebFrame *frame, WebKitNetworkRequest *request, WebKitWebNavigationAction *navigation_action, WebKitWebPolicyDecision *policy_decision, gpointer user_data);
223
224 WebKitWebView*
225 create_web_view_cb (WebKitWebView  *web_view, WebKitWebFrame *frame, gpointer user_data);
226
227 static gboolean
228 download_cb (WebKitWebView *web_view, GObject *download, gpointer user_data);
229
230 static void
231 toggle_status_cb (WebKitWebView* page, const char *param);
232
233 static void
234 link_hover_cb (WebKitWebView* page, const gchar* title, const gchar* link, gpointer data);
235
236 static void
237 title_change_cb (WebKitWebView* web_view, WebKitWebFrame* web_frame, const gchar* title, gpointer data);
238
239 static void
240 progress_change_cb (WebKitWebView* page, gint progress, gpointer data);
241
242 static void
243 load_commit_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
244
245 static void
246 load_finish_cb (WebKitWebView* page, WebKitWebFrame* frame, gpointer data);
247
248 static void
249 destroy_cb (GtkWidget* widget, gpointer data);
250
251 static void
252 log_history_cb ();
253
254 static void
255 commands_hash(void);
256
257 void
258 free_action(gpointer act);
259
260 Action*
261 new_action(const gchar *name, const gchar *param);
262
263 static bool
264 file_exists (const char * filename);
265
266 void
267 toggle_insert_mode(WebKitWebView *page, const gchar *param);
268
269 static void
270 load_uri (WebKitWebView * web_view, const gchar *param);
271
272 static void
273 new_window_load_uri (const gchar * uri);
274
275 static void
276 close_uzbl (WebKitWebView *page, const char *param);
277
278 static gboolean
279 run_command(const char *command, const char *args, const gboolean sync, char **stdout);
280
281 static void
282 spawn(WebKitWebView *web_view, const char *param);
283
284 static void
285 spawn_sh(WebKitWebView *web_view, const char *param);
286
287 static void
288 parse_command(const char *cmd, const char *param);
289
290 static void
291 runcmd(WebKitWebView *page, const char *param);
292
293 static void
294 parse_cmd_line(const char *ctl_line);
295
296 static gchar*
297 build_stream_name(int type, const gchar *dir);
298
299 static gboolean
300 var_is(const char *x, const char *y);
301
302 static gchar*
303 set_useragent(gchar *val);
304
305 static gboolean
306 control_fifo(GIOChannel *gio, GIOCondition condition);
307
308 static gchar*
309 init_fifo(gchar *dir);
310
311 static gboolean
312 control_stdin(GIOChannel *gio, GIOCondition condition);
313
314 static void
315 create_stdin();
316
317 static gchar*
318 init_socket(gchar *dir);
319
320 static gboolean
321 control_socket(GIOChannel *chan);
322
323 static void
324 update_title (void);
325
326 static gboolean
327 key_press_cb (WebKitWebView* page, GdkEventKey* event);
328
329 static void
330 run_keycmd(const gboolean key_ret);
331
332 static GtkWidget*
333 create_browser ();
334
335 static GtkWidget*
336 create_mainbar ();
337
338 static
339 GtkWidget* create_window ();
340
341 static void
342 add_binding (const gchar *key, const gchar *act);
343
344 static gchar*
345 get_xdg_var (XDG_Var xdg);
346
347 static gchar*
348 find_xdg_file (int xdg_type, char* filename);
349
350 static void
351 settings_init ();
352
353 static void
354 search_text (WebKitWebView *page, const char *param, const gboolean forward);
355
356 static void
357 search_forward_text (WebKitWebView *page, const char *param);
358
359 static void
360 search_reverse_text (WebKitWebView *page, const char *param);
361
362 static void
363 run_js (WebKitWebView * web_view, const gchar *param);
364
365 static void
366 run_external_js (WebKitWebView * web_view, const gchar *param);
367
368 static void handle_cookies (SoupSession *session,
369                                                         SoupMessage *msg,
370                                                         gpointer     user_data);
371 static void
372 save_cookies (SoupMessage *msg,
373                           gpointer     user_data);
374 /* vi: set et ts=4: */