source: owl.h @ 9e5c9f3

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