source: owl.h @ 86f740e

release-1.7release-1.8release-1.9
Last change on this file since 86f740e was d40ad8b, checked in by David Benjamin <davidben@mit.edu>, 11 years ago
Punt OWL_WEBBROWSER_* and userclue That code hasn't been used for quite some time, and only one of those browsers is still in active development anyway.
  • Property mode set to 100644
File size: 18.0 KB
Line 
1/*  Copyright (c) 2006-2010 The BarnOwl Developers. All rights reserved.
2 *  Copyright (c) 2004 James Kretchmar. All rights reserved.
3 *
4 *  This program is free software. You can redistribute it and/or
5 *  modify under the terms of the Sleepycat License. See the COPYING
6 *  file included with the distribution for more information.
7 */
8
9#ifndef INC_OWL_H
10#define INC_OWL_H
11
12#ifdef HAVE_STDBOOL_H
13#include <stdbool.h>
14#else
15#ifndef HAVE__BOOL
16#define _Bool signed char
17#endif
18#define bool _Bool
19#define false 0
20#define true 1
21#define __bool_true_false_are_defined 1
22#endif  /* HAVE_STDBOOL_H */
23
24#ifndef OWL_PERL
25#include <curses.h>
26#include <panel.h>
27#endif
28#include <sys/param.h>
29#include <EXTERN.h>
30#include <netdb.h>
31#include <regex.h>
32#include <time.h>
33#include <signal.h>
34#include <termios.h>
35#include "libfaim/aim.h"
36#include <wchar.h>
37#include "config.h"
38#include "glib.h"
39#ifdef HAVE_LIBZEPHYR
40#include <zephyr/zephyr.h>
41#endif
42#ifdef HAVE_COM_ERR_H
43#include <com_err.h>
44#endif
45
46/* Perl and curses don't play nice. */
47#ifdef OWL_PERL
48typedef void WINDOW;
49typedef void PANEL;
50/* logout is defined in FreeBSD. */
51#define logout logout_
52#define HAS_BOOL
53#include <perl.h>
54#include "owl_perl.h"
55#undef logout
56#include "XSUB.h"
57#else
58typedef void SV;
59typedef void AV;
60typedef void HV;
61#endif
62
63#include "window.h"
64
65#ifdef  GIT_VERSION
66#define stringify(x)       __stringify(x)
67#define __stringify(x)     #x
68#define OWL_VERSION_STRING stringify(GIT_VERSION)
69#else
70#define OWL_VERSION_STRING PACKAGE_VERSION
71#endif
72
73/* Feature that is being tested to redirect stderr through a pipe.
74 * There may still be some portability problems with this. */
75#define OWL_STDERR_REDIR 1
76
77#define OWL_DEBUG 0
78#define OWL_DEBUG_FILE "/var/tmp/barnowl-debug"
79
80#define OWL_CONFIG_DIR "/.owl"             /* this is relative to the user's home directory */
81#define OWL_STARTUP_FILE "/.owl/startup"   /* this is relative to the user's home directory */
82
83#define OWL_FMTEXT_ATTR_NONE      0
84#define OWL_FMTEXT_ATTR_BOLD      1
85#define OWL_FMTEXT_ATTR_REVERSE   2
86#define OWL_FMTEXT_ATTR_UNDERLINE 4
87
88#define OWL_FMTEXT_UC_BASE 0x100000 /* Unicode Plane 16 - Supplementary Private Use Area-B*/
89#define OWL_FMTEXT_UC_ATTR ( OWL_FMTEXT_UC_BASE | 0x800 )
90#define OWL_FMTEXT_UC_ATTR_MASK 0x7
91#define OWL_FMTEXT_UC_COLOR_BASE ( OWL_FMTEXT_UC_BASE | 0x400 )
92#define OWL_FMTEXT_UC_FGCOLOR OWL_FMTEXT_UC_COLOR_BASE
93#define OWL_FMTEXT_UC_BGCOLOR ( OWL_FMTEXT_UC_COLOR_BASE | 0x200 )
94#define OWL_FMTEXT_UC_DEFAULT_COLOR 0x100
95#define OWL_FMTEXT_UC_FGDEFAULT ( OWL_FMTEXT_UC_FGCOLOR | OWL_FMTEXT_UC_DEFAULT_COLOR )
96#define OWL_FMTEXT_UC_BGDEFAULT ( OWL_FMTEXT_UC_BGCOLOR | OWL_FMTEXT_UC_DEFAULT_COLOR )
97#define OWL_FMTEXT_UC_COLOR_MASK 0xFF
98#define OWL_FMTEXT_UC_ALLCOLOR_MASK ( OWL_FMTEXT_UC_COLOR_MASK | OWL_FMTEXT_UC_DEFAULT_COLOR | 0x200)
99#define OWL_FMTEXT_UC_STARTBYTE_UTF8 '\xf4'
100
101#define OWL_FMTEXT_UTF8_ATTR_NONE "\xf4\x80\xa0\x80"
102#define OWL_FMTEXT_UTF8_FGDEFAULT "\xf4\x80\x94\x80"
103#define OWL_FMTEXT_UTF8_BGDEFAULT "\xf4\x80\x9C\x80"
104
105#define OWL_COLOR_BLACK     0
106#define OWL_COLOR_RED       1
107#define OWL_COLOR_GREEN     2
108#define OWL_COLOR_YELLOW    3
109#define OWL_COLOR_BLUE      4
110#define OWL_COLOR_MAGENTA   5
111#define OWL_COLOR_CYAN      6
112#define OWL_COLOR_WHITE     7
113#define OWL_COLOR_DEFAULT   -1
114#define OWL_COLOR_INVALID   -2
115
116#define OWL_TAB_WIDTH 8
117
118#define OWL_EDITWIN_STYLE_MULTILINE 0
119#define OWL_EDITWIN_STYLE_ONELINE   1
120
121#define OWL_PROTOCOL_ZEPHYR         0
122#define OWL_PROTOCOL_AIM            1
123#define OWL_PROTOCOL_JABBER         2
124#define OWL_PROTOCOL_ICQ            3
125#define OWL_PROTOCOL_YAHOO          4
126#define OWL_PROTOCOL_MSN            5
127
128#define OWL_MESSAGE_DIRECTION_NONE  0
129#define OWL_MESSAGE_DIRECTION_IN    1
130#define OWL_MESSAGE_DIRECTION_OUT   2
131
132#define OWL_IO_READ   1
133#define OWL_IO_WRITE  2
134#define OWL_IO_EXCEPT 4
135
136#define OWL_DIRECTION_NONE      0
137#define OWL_DIRECTION_DOWNWARDS 1
138#define OWL_DIRECTION_UPWARDS   2
139
140#define OWL_LOGGING_DIRECTION_BOTH 0
141#define OWL_LOGGING_DIRECTION_IN   1
142#define OWL_LOGGING_DIRECTION_OUT  2
143
144#define OWL_SCROLLMODE_NORMAL      0
145#define OWL_SCROLLMODE_TOP         1
146#define OWL_SCROLLMODE_NEARTOP     2
147#define OWL_SCROLLMODE_CENTER      3
148#define OWL_SCROLLMODE_PAGED       4
149#define OWL_SCROLLMODE_PAGEDCENTER 5
150
151#define OWL_TAB               3  /* This *HAS* to be the size of TABSTR below */
152#define OWL_TABSTR        "   "
153#define OWL_MSGTAB            7
154#define OWL_TYPWIN_SIZE       8
155#define OWL_HISTORYSIZE       50
156
157/* Indicate current state, as well as what is allowed */
158#define OWL_CTX_ANY          0xffff
159/* Only one of these may be active at a time... */
160#define OWL_CTX_MODE_BITS    0x000f
161#define OWL_CTX_STARTUP      0x0001
162#define OWL_CTX_READCONFIG   0x0002
163#define OWL_CTX_INTERACTIVE  0x0004
164/* Only one of these may be active at a time... */
165#define OWL_CTX_ACTIVE_BITS  0xfff0
166#define OWL_CTX_POPWIN       0x00f0
167#define OWL_CTX_POPLESS      0x0010
168#define OWL_CTX_RECWIN       0x0f00
169#define OWL_CTX_RECV         0x0100
170#define OWL_CTX_TYPWIN       0xf000
171#define OWL_CTX_EDIT         0x7000
172#define OWL_CTX_EDITLINE     0x1000
173#define OWL_CTX_EDITMULTI    0x2000
174#define OWL_CTX_EDITRESPONSE 0x4000
175
176#define OWL_VARIABLE_OTHER      0
177#define OWL_VARIABLE_INT        1
178#define OWL_VARIABLE_BOOL       2
179#define OWL_VARIABLE_STRING     3
180
181#define OWL_OUTPUT_RETURN       0
182#define OWL_OUTPUT_POPUP        1
183#define OWL_OUTPUT_ADMINMSG     2
184
185#define OWL_FILTER_MAX_DEPTH    300
186
187#define OWL_KEYMAP_MAXSTACK     20
188
189#define OWL_KEYBINDING_COMMAND  1   /* command string */
190#define OWL_KEYBINDING_FUNCTION 2   /* function taking no args */
191
192#define OWL_DEFAULT_ZAWAYMSG    "I'm sorry, but I am currently away from the terminal and am\nnot able to receive your message.\n"
193#define OWL_DEFAULT_AAWAYMSG    "I'm sorry, but I am currently away from the terminal and am\nnot able to receive your message.\n"
194
195#define OWL_CMD_ALIAS_SUMMARY_PREFIX "command alias to: "
196
197#define OWL_WEBZEPHYR_PRINCIPAL "daemon.webzephyr"
198#define OWL_WEBZEPHYR_CLASS     "webzephyr"
199#define OWL_WEBZEPHYR_OPCODE    "webzephyr"
200
201#define OWL_REGEX_QUOTECHARS    "+*.?[]^\\${}()"
202#define OWL_REGEX_QUOTEWITH     "\\"
203
204#if defined(HAVE_DES_STRING_TO_KEY) && defined(HAVE_DES_KEY_SCHED) && defined(HAVE_DES_ECB_ENCRYPT)
205#define OWL_ENABLE_ZCRYPT 1
206#endif
207
208#define OWL_META(key) ((key)|010000)
209/* OWL_CTRL is definied in kepress.c */
210
211#define LINE 2048
212
213#ifdef HAVE_LIBZEPHYR
214/* libzephyr doesn't use const, so we appease the type system with this kludge.
215 * This just casts const char * to char * in a way that doesn't yield a warning
216 * from gcc -Wcast-qual. */
217static inline char *zstr(const char *str)
218{
219  union { char *rw; const char *ro; } u;
220  u.ro = str;
221  return u.rw;
222}
223#endif
224
225/* Convert char *const * into const char *const *.  This conversion is safe,
226 * and implicit in C++ (conv.qual 4) but for some reason not in C. */
227static inline const char *const *strs(char *const *pstr)
228{
229  return (const char *const *)pstr;
230}
231
232typedef struct _owl_variable {
233  char *name;
234  int   type;  /* OWL_VARIABLE_* */
235  void *pval_default;  /* for types other and string */
236  int   ival_default;  /* for types int and bool     */
237  char *validsettings;          /* documentation of valid settings */
238  char *summary;                /* summary of usage */
239  char *description;            /* detailed description */
240  void *val;                    /* current value */
241  int  (*validate_fn)(const struct _owl_variable *v, const void *newval);
242                                /* returns 1 if newval is valid */
243  int  (*set_fn)(struct _owl_variable *v, const void *newval); 
244                                /* sets the variable to a value
245                                 * of the appropriate type.
246                                 * unless documented, this
247                                 * should make a copy.
248                                 * returns 0 on success. */
249  int  (*set_fromstring_fn)(struct _owl_variable *v, const char *newval);
250                                /* sets the variable to a value
251                                 * of the appropriate type.
252                                 * unless documented, this
253                                 * should make a copy.
254                                 * returns 0 on success. */
255  const void *(*get_fn)(const struct _owl_variable *v);
256                                /* returns a reference to the current value.
257                                 * WARNING:  this approach is hard to make
258                                 * thread-safe... */
259  int  (*get_tostring_fn)(const struct _owl_variable *v, 
260                          char *buf, int bufsize, const void *val); 
261                                /* converts val to a string
262                                 * and puts into buf */
263  void (*delete_fn)(struct _owl_variable *v);
264                                /* frees val as needed */
265} owl_variable;
266
267typedef struct _owl_input {
268  int ch;
269  gunichar uch;
270} owl_input;
271
272typedef struct _owl_fmtext {
273  int textlen;
274  int bufflen;
275  char *textbuff;
276  char default_attrs;
277  short default_fgcolor;
278  short default_bgcolor;
279} owl_fmtext;
280
281typedef struct _owl_list {
282  int size;
283  int avail;
284  void **list;
285} owl_list;
286
287typedef struct _owl_dict_el {
288  char *k;                      /* key   */
289  void *v;                      /* value */
290} owl_dict_el;
291
292typedef struct _owl_dict {
293  int size;
294  int avail;
295  owl_dict_el *els;             /* invariant: sorted by k */
296} owl_dict;
297typedef owl_dict owl_vardict;   /* dict of variables */
298typedef owl_dict owl_cmddict;   /* dict of commands */
299
300typedef struct _owl_context {
301  int   mode;
302  void *data;           /* determined by mode */
303  char *keymap;
304  owl_window *cursor;
305} owl_context;
306
307typedef struct _owl_cmd {       /* command */
308  char *name;
309
310  char *summary;                /* one line summary of command */
311  char *usage;                  /* usage synopsis */
312  char *description;            /* long description of command */
313
314  int validctx;                 /* bitmask of valid contexts */
315
316  /* we should probably have a type here that says which of
317   * the following is valid, and maybe make the below into a union... */
318
319  /* Only one of these may be non-NULL ... */
320
321  char *cmd_aliased_to;         /* what this command is aliased to... */
322 
323  /* These don't take any context */
324  char *(*cmd_args_fn)(int argc, const char *const *argv, const char *buff); 
325                                /* takes argv and the full command as buff.
326                                 * caller must free return value if !NULL */
327  void (*cmd_v_fn)(void);       /* takes no args */
328  void (*cmd_i_fn)(int i);      /* takes an int as an arg */
329
330  /* The following also take the active context if it's valid */
331  char *(*cmd_ctxargs_fn)(void *ctx, int argc, const char *const *argv, const char *buff); 
332                                /* takes argv and the full command as buff.
333                                 * caller must free return value if !NULL */
334  void (*cmd_ctxv_fn)(void *ctx);               /* takes no args */
335  void (*cmd_ctxi_fn)(void *ctx, int i);        /* takes an int as an arg */
336  SV *cmd_perl;                                /* Perl closure that takes a list of args */
337} owl_cmd;
338
339
340typedef struct _owl_zwrite {
341  char *cmd;
342  char *zwriteline;
343  char *class;
344  char *inst;
345  char *realm;
346  char *opcode;
347  char *zsig;
348  char *message;
349  owl_list recips;
350  int cc;
351  int noping;
352} owl_zwrite;
353
354typedef struct _owl_pair {
355  const char *key;
356  char *value;
357} owl_pair;
358
359struct _owl_fmtext_cache;
360
361typedef struct _owl_message {
362  int id;
363  int direction;
364#ifdef HAVE_LIBZEPHYR
365  ZNotice_t notice;
366#endif
367  struct _owl_fmtext_cache * fmtext;
368  int delete;
369  const char *hostname;
370  owl_list attributes;            /* this is a list of pairs */
371  char *timestr;
372  time_t time;
373} owl_message;
374
375#define OWL_FMTEXT_CACHE_SIZE 1000
376/* We cache the saved fmtexts for the last bunch of messages we
377   rendered */
378typedef struct _owl_fmtext_cache {
379    owl_message * message;
380    owl_fmtext fmtext;
381} owl_fmtext_cache;
382
383typedef struct _owl_style {
384  char *name;
385  SV *perlobj;
386} owl_style;
387
388typedef struct _owl_mainwin {
389  int curtruncated;
390  int lasttruncated;
391  int lastdisplayed;
392  owl_window *window;
393} owl_mainwin;
394
395typedef struct _owl_viewwin {
396  owl_fmtext fmtext;
397  int textlines;
398  int topline;
399  int rightshift;
400  owl_window *window;
401  gulong sig_redraw_id;
402  void (*onclose_hook) (struct _owl_viewwin *vwin, void *data);
403  void *onclose_hook_data;
404} owl_viewwin;
405 
406typedef struct _owl_popwin {
407  owl_window *border;
408  owl_window *content;
409  int active;
410} owl_popwin;
411 
412typedef struct _owl_msgwin {
413  char *msg;
414  owl_window *window;
415  gulong redraw_id;
416} owl_msgwin;
417
418typedef struct _owl_messagelist {
419  owl_list list;
420} owl_messagelist;
421
422typedef struct _owl_regex {
423  int negate;
424  char *string;
425  regex_t re;
426} owl_regex;
427
428typedef struct _owl_filterelement {
429  int (*match_message)(const struct _owl_filterelement *fe, const owl_message *m);
430  /* Append a string representation of the filterelement onto buf*/
431  void (*print_elt)(const struct _owl_filterelement *fe, GString *buf);
432  /* Operands for and,or,not*/
433  struct _owl_filterelement *left, *right;
434  /* For regex filters*/
435  owl_regex re;
436  /* Used by regexes, filter references, and perl */
437  char *field;
438} owl_filterelement;
439
440typedef struct _owl_filter {
441  char *name;
442  owl_filterelement * root;
443  int fgcolor;
444  int bgcolor;
445} owl_filter;
446
447typedef struct _owl_view {
448  char *name;
449  owl_filter *filter;
450  owl_messagelist ml;
451  const owl_style *style;
452  int cachedmsgid;
453} owl_view;
454
455typedef struct _owl_history {
456  owl_list hist;
457  int cur;
458  int touched;
459  int partial;
460  int repeats;
461} owl_history;
462
463typedef struct _owl_editwin owl_editwin;
464typedef struct _owl_editwin_excursion owl_editwin_excursion;
465
466typedef struct _owl_mainpanel {
467  owl_window *panel;
468  owl_window *typwin;
469  owl_window *sepwin;
470  owl_window *msgwin;
471  owl_window *recwin;
472  int recwinlines;
473} owl_mainpanel;
474
475typedef struct _owl_keybinding {
476  int  *keys;                   /* keypress stack */
477  int   len;                    /* length of stack */
478  int   type;                   /* command or function? */
479  char *desc;                   /* description (or "*user*") */
480  char *command;                /* command, if of type command */
481  void (*function_fn)(void);    /* function ptr, if of type function */
482} owl_keybinding;
483
484typedef struct _owl_keymap {
485  char     *name;               /* name of keymap */
486  char     *desc;               /* description */
487  owl_list  bindings;           /* key bindings */
488  const struct _owl_keymap *parent;     /* parent */
489  void (*default_fn)(owl_input j);      /* default action (takes a keypress) */
490  void (*prealways_fn)(owl_input  j);   /* always called before a keypress is received */
491  void (*postalways_fn)(owl_input  j);  /* always called after keypress is processed */
492} owl_keymap;
493
494typedef struct _owl_keyhandler {
495  owl_dict  keymaps;            /* dictionary of keymaps */
496  const owl_keymap *active;             /* currently active keymap */
497  int       in_esc;             /* escape pressed? */
498  int       kpstack[OWL_KEYMAP_MAXSTACK+1]; /* current stack of keypresses */
499  int       kpstackpos;         /* location in stack (-1 = none) */
500} owl_keyhandler;
501
502typedef struct _owl_buddy {
503  int proto;
504  char *name;
505  int isidle;
506  int idlesince;
507} owl_buddy;
508
509typedef struct _owl_buddylist {
510  owl_list buddies;
511} owl_buddylist;
512
513typedef struct _owl_zbuddylist {
514  owl_list zusers;
515} owl_zbuddylist;
516
517typedef struct _owl_timer {
518  time_t time;
519  int interval;
520  void (*callback)(struct _owl_timer *, void *);
521  void (*destroy)(struct _owl_timer *);
522  void *data;
523} owl_timer;
524
525typedef struct _owl_errqueue {
526  owl_list errlist;
527} owl_errqueue;
528
529typedef struct _owl_colorpair_mgr {
530  int next;
531  short **pairs;
532} owl_colorpair_mgr;
533
534typedef struct _owl_io_dispatch {
535  int fd;                                     /* FD to watch for dispatch. */
536  int mode;
537  int needs_gc;
538  void (*callback)(const struct _owl_io_dispatch *, void *); /* C function to dispatch to. */
539  void (*destroy)(const struct _owl_io_dispatch *);  /* Destructor */
540  void *data;
541} owl_io_dispatch;
542
543typedef struct _owl_ps_action {
544  int needs_gc;
545  int (*callback)(struct _owl_ps_action *, void *);
546  void (*destroy)(struct _owl_ps_action *);
547  void *data;
548} owl_ps_action;
549
550typedef struct _owl_popexec {
551  int refcount;
552  owl_viewwin *vwin;
553  int winactive;
554  pid_t pid;                    /* or 0 if it has terminated */
555  const owl_io_dispatch *dispatch;
556} owl_popexec;
557
558typedef struct _OwlGlobalNotifier OwlGlobalNotifier;
559
560typedef struct _owl_global {
561  owl_mainwin mw;
562  owl_popwin pw;
563  owl_msgwin msgwin;
564  owl_history cmdhist;          /* command history */
565  owl_history msghist;          /* outgoing message history */
566  owl_keyhandler kh;
567  owl_dict filters;
568  GList *filterlist;
569  owl_list puntlist;
570  owl_vardict vars;
571  owl_cmddict cmds;
572  GList *context_stack;
573  owl_errqueue errqueue;
574  int lines, cols;
575  int curmsg, topmsg;
576  int markedmsgid;              /* for finding the marked message when it has moved. */
577  int curmsg_vert_offset;
578  owl_view current_view;
579  owl_messagelist msglist;
580  WINDOW *input_pad;
581  owl_mainpanel mainpanel;
582  gulong typwin_erase_id;
583  int rightshift;
584  volatile sig_atomic_t resizepending;
585  char *thishost;
586  char *homedir;
587  char *confdir;
588  char *startupfile;
589  int direction;
590  int zaway;
591  char *cur_zaway_msg;
592  int haveconfig;
593  int config_format;
594  void *buffercbdata;
595  owl_editwin *tw;
596  owl_viewwin vw;
597  void *perl;
598  int debug;
599  time_t starttime;
600  time_t lastinputtime;
601  char *startupargs;
602  int nextmsgid;
603  int hascolors;
604  int colorpairs;
605  owl_colorpair_mgr cpmgr;
606  pid_t newmsgproc_pid;
607  owl_regex search_re;
608  aim_session_t aimsess;
609  aim_conn_t bosconn;
610  owl_timer aim_noop_timer;
611  owl_timer aim_ignorelogin_timer;
612  int aim_loggedin;         /* true if currently logged into AIM */
613  int aim_doprocessing;     /* true if we should process AIM events (like pending login) */
614  char *aim_screenname;     /* currently logged in AIM screen name */
615  char *aim_screenname_for_filters;     /* currently logged in AIM screen name */
616  owl_buddylist buddylist;  /* list of logged in AIM buddies */
617  GQueue *messagequeue;     /* for queueing up aim and other messages */
618  owl_dict styledict;       /* global dictionary of available styles */
619  char *response;           /* response to the last question asked */
620  int havezephyr;
621  int haveaim;
622  int ignoreaimlogin;
623  volatile sig_atomic_t got_err_signal; /* 1 if we got an unexpected signal */
624  volatile siginfo_t err_signal_info;
625  owl_zbuddylist zbuddies;
626  owl_timer zephyr_buddycheck_timer;
627  GList *zaldlist;
628  int pseudologin_notify;
629  struct termios startup_tio;
630  owl_list io_dispatch_list;
631  owl_list psa_list;
632  GList *timerlist;
633  owl_timer *aim_nop_timer;
634  int load_initial_subs;
635  volatile sig_atomic_t interrupted;
636  FILE *debug_file;
637} owl_global;
638
639/* globals */
640extern owl_global g;
641
642#include "owl_prototypes.h"
643
644/* these are missing from the zephyr includes for some reason */
645#ifdef HAVE_LIBZEPHYR
646int ZGetSubscriptions(ZSubscription_t *, int *);
647int ZGetLocations(ZLocations_t *,int *);
648#endif
649
650#endif /* INC_OWL_H */
Note: See TracBrowser for help on using the repository browser.