source: owl.h @ 1cfcab7

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