source: owl.h @ 712caac

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