source: owl.h @ 18fdd5f9

release-1.10release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 18fdd5f9 was 18fdd5f9, checked in by Alejandro R. Sedeño <asedeno@mit.edu>, 15 years ago
Switch C to the new I/O Dispatch API. Signed-off-by: Alejandro R. Sedeño <asedeno@mit.edu>
  • Property mode set to 100644
File size: 17.7 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_IO_READ   1
108#define OWL_IO_WRITE  2
109#define OWL_IO_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_CMD_ALIAS_SUMMARY_PREFIX "command alias to: "
177
178#define OWL_WEBZEPHYR_PRINCIPAL "daemon.webzephyr"
179#define OWL_WEBZEPHYR_CLASS     "webzephyr"
180#define OWL_WEBZEPHYR_OPCODE    "webzephyr"
181
182#define OWL_REGEX_QUOTECHARS    "+*.?[]^\\${}()"
183#define OWL_REGEX_QUOTEWITH     "\\"
184
185#if defined(HAVE_DES_STRING_TO_KEY) && defined(HAVE_DES_KEY_SCHED) && defined(HAVE_DES_ECB_ENCRYPT)
186#define OWL_ENABLE_ZCRYPT 1
187#endif
188
189#define OWL_META(key) ((key)|010000)
190/* OWL_CTRL is definied in kepress.c */
191
192#define LINE 2048
193
194#ifdef HAVE_LIBZEPHYR
195/* libzephyr doesn't use const, so we appease the type system with this kludge.
196 * This just casts const char * to char * in a way that doesn't yield a warning
197 * from gcc -Wcast-qual. */
198static inline char *zstr(const char *str)
199{
200  union { char *rw; const char *ro; } u;
201  u.ro = str;
202  return u.rw;
203}
204#endif
205
206/* Convert char *const * into const char *const *.  This conversion is safe,
207 * and implicit in C++ (conv.qual 4) but for some reason not in C. */
208static inline const char *const *strs(char *const *pstr)
209{
210  return (const char *const *)pstr;
211}
212
213typedef struct _owl_variable {
214  char *name;
215  int   type;  /* OWL_VARIABLE_* */
216  void *pval_default;  /* for types other and string */
217  int   ival_default;  /* for types int and bool     */
218  char *validsettings;          /* documentation of valid settings */
219  char *summary;                /* summary of usage */
220  char *description;            /* detailed description */
221  void *val;                    /* current value */
222  int  (*validate_fn)(const struct _owl_variable *v, const void *newval);
223                                /* returns 1 if newval is valid */
224  int  (*set_fn)(struct _owl_variable *v, const void *newval); 
225                                /* sets the variable to a value
226                                 * of the appropriate type.
227                                 * unless documented, this
228                                 * should make a copy.
229                                 * returns 0 on success. */
230  int  (*set_fromstring_fn)(struct _owl_variable *v, const char *newval);
231                                /* sets the variable to a value
232                                 * of the appropriate type.
233                                 * unless documented, this
234                                 * should make a copy.
235                                 * returns 0 on success. */
236  const void *(*get_fn)(const struct _owl_variable *v);
237                                /* returns a reference to the current value.
238                                 * WARNING:  this approach is hard to make
239                                 * thread-safe... */
240  int  (*get_tostring_fn)(const struct _owl_variable *v, 
241                          char *buf, int bufsize, const void *val); 
242                                /* converts val to a string
243                                 * and puts into buf */
244  void  (*free_fn)(struct _owl_variable *v);
245                                /* frees val as needed */
246} owl_variable;
247
248typedef struct _owl_input {
249  int ch;
250  gunichar uch;
251} owl_input;
252
253typedef struct _owl_fmtext {
254  int textlen;
255  int bufflen;
256  char *textbuff;
257  char default_attrs;
258  short default_fgcolor;
259  short default_bgcolor;
260} owl_fmtext;
261
262typedef struct _owl_list {
263  int size;
264  int avail;
265  void **list;
266} owl_list;
267
268typedef struct _owl_dict_el {
269  char *k;                      /* key   */
270  void *v;                      /* value */
271} owl_dict_el;
272
273typedef struct _owl_dict {
274  int size;
275  int avail;
276  owl_dict_el *els;             /* invariant: sorted by k */
277} owl_dict;
278typedef owl_dict owl_vardict;   /* dict of variables */
279typedef owl_dict owl_cmddict;   /* dict of commands */
280
281typedef struct _owl_context {
282  int   mode;
283  void *data;           /* determined by mode */
284} owl_context;
285
286typedef struct _owl_cmd {       /* command */
287  char *name;
288
289  char *summary;                /* one line summary of command */
290  char *usage;                  /* usage synopsis */
291  char *description;            /* long description of command */
292
293  int validctx;                 /* bitmask of valid contexts */
294
295  /* we should probably have a type here that says which of
296   * the following is valid, and maybe make the below into a union... */
297
298  /* Only one of these may be non-NULL ... */
299
300  char *cmd_aliased_to;         /* what this command is aliased to... */
301 
302  /* These don't take any context */
303  char *(*cmd_args_fn)(int argc, const char *const *argv, const char *buff); 
304                                /* takes argv and the full command as buff.
305                                 * caller must free return value if !NULL */
306  void (*cmd_v_fn)(void);       /* takes no args */
307  void (*cmd_i_fn)(int i);      /* takes an int as an arg */
308
309  /* The following also take the active context if it's valid */
310  char *(*cmd_ctxargs_fn)(void *ctx, int argc, const char *const *argv, const char *buff); 
311                                /* takes argv and the full command as buff.
312                                 * caller must free return value if !NULL */
313  void (*cmd_ctxv_fn)(void *ctx);               /* takes no args */
314  void (*cmd_ctxi_fn)(void *ctx, int i);        /* takes an int as an arg */
315  SV *cmd_perl;                                /* Perl closure that takes a list of args */
316} owl_cmd;
317
318
319typedef struct _owl_zwrite {
320  char *zwriteline;
321  char *class;
322  char *inst;
323  char *realm;
324  char *opcode;
325  char *zsig;
326  char *message;
327  owl_list recips;
328  int cc;
329  int noping;
330} owl_zwrite;
331
332typedef struct _owl_pair {
333  const char *key;
334  char *value;
335} owl_pair;
336
337struct _owl_fmtext_cache;
338
339typedef struct _owl_message {
340  int id;
341  int direction;
342#ifdef HAVE_LIBZEPHYR
343  ZNotice_t notice;
344#endif
345  struct _owl_fmtext_cache * fmtext;
346  int delete;
347  const char *hostname;
348  owl_list attributes;            /* this is a list of pairs */
349  char *timestr;
350  time_t time;
351} owl_message;
352
353#define OWL_FMTEXT_CACHE_SIZE 1000
354/* We cache the saved fmtexts for the last bunch of messages we
355   rendered */
356typedef struct _owl_fmtext_cache {
357    owl_message * message;
358    owl_fmtext fmtext;
359} owl_fmtext_cache;
360
361typedef struct _owl_style {
362  char *name;
363  SV *perlobj;
364} owl_style;
365
366typedef struct _owl_mainwin {
367  int curtruncated;
368  int lasttruncated;
369  int lastdisplayed;
370} owl_mainwin;
371
372typedef struct _owl_viewwin {
373  owl_fmtext fmtext;
374  int textlines;
375  int topline;
376  int rightshift;
377  int winlines, wincols;
378  WINDOW *curswin;
379  void (*onclose_hook) (struct _owl_viewwin *vwin, void *data);
380  void *onclose_hook_data;
381} owl_viewwin;
382 
383typedef struct _owl_popwin {
384  WINDOW *borderwin;
385  WINDOW *popwin;
386  int lines;
387  int cols;
388  int active;
389  int needsfirstrefresh;
390} owl_popwin;
391
392typedef struct _owl_messagelist {
393  owl_list list;
394} owl_messagelist;
395
396typedef struct _owl_regex {
397  int negate;
398  char *string;
399  regex_t re;
400} owl_regex;
401
402typedef struct _owl_filterelement {
403  int (*match_message)(const struct _owl_filterelement *fe, const owl_message *m);
404  /* Append a string representation of the filterelement onto buf*/
405  void (*print_elt)(const struct _owl_filterelement *fe, GString *buf);
406  /* Operands for and,or,not*/
407  struct _owl_filterelement *left, *right;
408  /* For regex filters*/
409  owl_regex re;
410  /* Used by regexes, filter references, and perl */
411  char *field;
412} owl_filterelement;
413
414typedef struct _owl_filter {
415  char *name;
416  owl_filterelement * root;
417  int fgcolor;
418  int bgcolor;
419  int cachedmsgid;  /* cached msgid: should move into view eventually */
420} owl_filter;
421
422typedef struct _owl_view {
423  char *name;
424  owl_filter *filter;
425  owl_messagelist ml;
426  const owl_style *style;
427} owl_view;
428
429typedef struct _owl_history {
430  owl_list hist;
431  int cur;
432  int touched;
433  int partial;
434  int repeats;
435} owl_history;
436
437typedef struct _owl_editwin owl_editwin;
438typedef struct _owl_editwin_excursion owl_editwin_excursion;
439
440typedef struct _owl_keybinding {
441  int  *keys;                   /* keypress stack */
442  int   len;                    /* length of stack */
443  int   type;                   /* command or function? */
444  char *desc;                   /* description (or "*user*") */
445  char *command;                /* command, if of type command */
446  void (*function_fn)(void);    /* function ptr, if of type function */
447} owl_keybinding;
448
449typedef struct _owl_keymap {
450  char     *name;               /* name of keymap */
451  char     *desc;               /* description */
452  owl_list  bindings;           /* key bindings */
453  const struct _owl_keymap *submap;     /* submap */
454  void (*default_fn)(owl_input j);      /* default action (takes a keypress) */
455  void (*prealways_fn)(owl_input  j);   /* always called before a keypress is received */
456  void (*postalways_fn)(owl_input  j);  /* always called after keypress is processed */
457} owl_keymap;
458
459typedef struct _owl_keyhandler {
460  owl_dict  keymaps;            /* dictionary of keymaps */
461  const owl_keymap *active;             /* currently active keymap */
462  int       in_esc;             /* escape pressed? */
463  int       kpstack[OWL_KEYMAP_MAXSTACK+1]; /* current stack of keypresses */
464  int       kpstackpos;         /* location in stack (-1 = none) */
465} owl_keyhandler;
466
467typedef struct _owl_buddy {
468  int proto;
469  char *name;
470  int isidle;
471  int idlesince;
472} owl_buddy;
473
474typedef struct _owl_buddylist {
475  owl_list buddies;
476} owl_buddylist;
477
478typedef struct _owl_zbuddylist {
479  owl_list zusers;
480} owl_zbuddylist;
481
482typedef struct _owl_timer {
483  time_t time;
484  int interval;
485  void (*callback)(struct _owl_timer *, void *);
486  void (*destroy)(struct _owl_timer *);
487  void *data;
488} owl_timer;
489
490typedef struct _owl_errqueue {
491  owl_list errlist;
492} owl_errqueue;
493
494typedef struct _owl_colorpair_mgr {
495  int next;
496  short **pairs;
497} owl_colorpair_mgr;
498
499typedef struct _owl_obarray {
500  owl_list strings;
501} owl_obarray;
502
503typedef struct _owl_dispatch {
504  int fd;                                 /* FD to watch for dispatch. */
505  int needs_gc;
506  void (*cfunc)(struct _owl_dispatch*);   /* C function to dispatch to. */
507  void (*destroy)(struct _owl_dispatch*); /* Destructor */
508  void *data;
509} owl_dispatch;
510
511typedef struct _owl_io_dispatch {
512  int fd;                                     /* FD to watch for dispatch. */
513  int mode;
514  int needs_gc;
515  void (*callback)(const struct _owl_io_dispatch *, void *); /* C function to dispatch to. */
516  void (*destroy)(const struct _owl_io_dispatch *);  /* Destructor */
517  void *data;
518} owl_io_dispatch;
519
520typedef struct _owl_ps_action {
521  int needs_gc;
522  int (*callback)(struct _owl_ps_action *, void *);
523  void (*destroy)(struct _owl_ps_action *);
524  void *data;
525} owl_ps_action;
526
527typedef struct _owl_popexec {
528  int refcount;
529  owl_viewwin *vwin;
530  int winactive;
531  pid_t pid;                    /* or 0 if it has terminated */
532  const owl_io_dispatch *dispatch;
533} owl_popexec;
534
535typedef struct _owl_global {
536  owl_mainwin mw;
537  owl_popwin pw;
538  owl_history cmdhist;          /* command history */
539  owl_history msghist;          /* outgoing message history */
540  owl_keyhandler kh;
541  owl_list filterlist;
542  owl_list puntlist;
543  owl_vardict vars;
544  owl_cmddict cmds;
545  owl_context ctx;
546  owl_errqueue errqueue;
547  int lines, cols;
548  int curmsg, topmsg;
549  int markedmsgid;              /* for finding the marked message when it has moved. */
550  int curmsg_vert_offset;
551  owl_view current_view;
552  owl_messagelist msglist;
553  WINDOW *recwin, *sepwin, *msgwin, *typwin;
554  int needrefresh;
555  int rightshift;
556  int resizepending;
557  int recwinlines;
558  int typwinactive;
559  char *thishost;
560  char *homedir;
561  char *confdir;
562  char *startupfile;
563  int direction;
564  int zaway;
565  char *cur_zaway_msg;
566  int haveconfig;
567  int config_format;
568  void *buffercbdata;
569  owl_editwin *tw;
570  owl_viewwin vw;
571  void *perl;
572  int debug;
573  time_t starttime;
574  time_t lastinputtime;
575  char *startupargs;
576  int userclue;
577  int nextmsgid;
578  int hascolors;
579  int colorpairs;
580  owl_colorpair_mgr cpmgr;
581  pid_t newmsgproc_pid;
582  int malloced, freed;
583  owl_regex search_re;
584  aim_session_t aimsess;
585  aim_conn_t bosconn;
586  owl_timer aim_noop_timer;
587  owl_timer aim_ignorelogin_timer;
588  int aim_loggedin;         /* true if currently logged into AIM */
589  int aim_doprocessing;     /* true if we should process AIM events (like pending login) */
590  char *aim_screenname;     /* currently logged in AIM screen name */
591  char *aim_screenname_for_filters;     /* currently logged in AIM screen name */
592  owl_buddylist buddylist;  /* list of logged in AIM buddies */
593  owl_list messagequeue;    /* for queueing up aim and other messages */
594  owl_dict styledict;       /* global dictionary of available styles */
595  char *response;           /* response to the last question asked */
596  int havezephyr;
597  int haveaim;
598  int ignoreaimlogin;
599  int got_err_signal;       /* 1 if we got an unexpected signal */
600  siginfo_t err_signal_info;
601  owl_zbuddylist zbuddies;
602  owl_timer zephyr_buddycheck_timer;
603  struct termios startup_tio;
604  owl_obarray obarray;
605  owl_list dispatchlist;
606  owl_list io_dispatch_list;
607  owl_list psa_list;
608  GList *timerlist;
609  owl_timer *aim_nop_timer;
610  int load_initial_subs;
611  int interrupted;
612  int got_sigtstp;
613} owl_global;
614
615/* globals */
616extern owl_global g;
617
618#include "owl_prototypes.h"
619
620/* these are missing from the zephyr includes for some reason */
621#ifdef HAVE_LIBZEPHYR
622int ZGetSubscriptions(ZSubscription_t *, int *);
623int ZGetLocations(ZLocations_t *,int *);
624#endif
625
626#endif /* INC_OWL_H */
Note: See TracBrowser for help on using the repository browser.