source: owl.h @ 18e28a4

barnowl_perlaimdebianrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 18e28a4 was 18e28a4, checked in by Eric C. Price <ecprice@mit.edu>, 13 years ago
Fixes for FreeBSD.
  • Property mode set to 100644
File size: 17.4 KB
Line 
1/*  Copyright (c) 2004 James Kretchmar. All rights reserved.
2 *
3 *  Redistribution and use in source and binary forms, with or without
4 *  modification, are permitted provided that the following conditions are
5 *  met:
6 * 
7 *    * Redistributions of source code must retain the above copyright
8 *      notice, this list of conditions and the following disclaimer.
9 * 
10 *    * Redistributions in binary form must reproduce the above copyright
11 *      notice, this list of conditions and the following disclaimer in
12 *      the documentation and/or other materials provided with the
13 *      distribution.
14 * 
15 *    * Redistributions in any form must be accompanied by information on
16 *      how to obtain complete source code for the Owl software and any
17 *      accompanying software that uses the Owl software. The source code
18 *      must either be included in the distribution or be available for no
19 *      more than the cost of distribution plus a nominal fee, and must be
20 *      freely redistributable under reasonable conditions. For an
21 *      executable file, complete source code means the source code for
22 *      all modules it contains. It does not include source code for
23 *      modules or files that typically accompany the major components of
24 *      the operating system on which the executable file runs.
25 * 
26 *
27 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
28 *  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
29 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
30 *  NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
31 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
34 *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
35 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
36 *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
37 *  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 */
39
40#ifndef INC_OWL_H
41#define INC_OWL_H
42
43#ifndef OWL_PERL
44#include <curses.h>
45#endif
46#include <sys/param.h>
47#include <EXTERN.h>
48#include <netdb.h>
49#include <regex.h>
50#include <time.h>
51#include <signal.h>
52#include <termios.h>
53#include <libfaim/aim.h>
54#include "config.h"
55#ifdef HAVE_LIBZEPHYR
56#include <zephyr/zephyr.h>
57#endif
58#ifdef HAVE_COM_ERR_H
59#include <com_err.h>
60#endif
61
62/* Perl and curses don't play nice. */
63#ifdef OWL_PERL
64typedef void WINDOW;
65/* logout is defined in FreeBSD. */
66#define logout logout_
67#include <perl.h>
68#undef logout
69#include "XSUB.h"
70#else
71typedef void SV;
72#endif
73
74static const char owl_h_fileIdent[] = "$Id$";
75
76#define STRINGIFY(x) _STRINGIFY(x)
77#define _STRINGIFY(x) #x
78
79#ifndef OWL_SVN_REVNO
80#define OWL_SVN_REVNO ????
81#endif
82
83#define OWL_VERSION_STRING "r" STRINGIFY(OWL_SVN_REVNO)
84
85
86/* Feature that is being tested to redirect stderr through a pipe.
87 * There may still be some portability problems with this. */
88#define OWL_STDERR_REDIR 1
89
90#define OWL_DEBUG 0
91#define OWL_DEBUG_FILE "/var/tmp/owldebug"
92
93#define OWL_CONFIG_DIR "/.owl"             /* this is relative to the user's home directory */
94#define OWL_STARTUP_FILE "/.owl/startup"   /* this is relative to the user's home directory */
95
96#define OWL_FMTEXT_ATTR_NONE      0
97#define OWL_FMTEXT_ATTR_BOLD      1
98#define OWL_FMTEXT_ATTR_REVERSE   2
99#define OWL_FMTEXT_ATTR_UNDERLINE 4
100
101#define OWL_COLOR_BLACK     0
102#define OWL_COLOR_RED       1
103#define OWL_COLOR_GREEN     2
104#define OWL_COLOR_YELLOW    3
105#define OWL_COLOR_BLUE      4
106#define OWL_COLOR_MAGENTA   5
107#define OWL_COLOR_CYAN      6
108#define OWL_COLOR_WHITE     7
109#define OWL_COLOR_DEFAULT   -1
110
111#define OWL_EDITWIN_STYLE_MULTILINE 0
112#define OWL_EDITWIN_STYLE_ONELINE   1
113
114#define OWL_PROTOCOL_ZEPHYR         0
115#define OWL_PROTOCOL_AIM            1
116#define OWL_PROTOCOL_JABBER         2
117#define OWL_PROTOCOL_ICQ            3
118#define OWL_PROTOCOL_YAHOO          4
119#define OWL_PROTOCOL_MSN            5
120
121#define OWL_MESSAGE_DIRECTION_NONE  0
122#define OWL_MESSAGE_DIRECTION_IN    1
123#define OWL_MESSAGE_DIRECTION_OUT   2
124
125#define OWL_MUX_READ   1
126#define OWL_MUX_WRITE  2
127#define OWL_MUX_EXCEPT 4
128
129#define OWL_DIRECTION_NONE      0
130#define OWL_DIRECTION_DOWNWARDS 1
131#define OWL_DIRECTION_UPWARDS   2
132
133#define OWL_LOGGING_DIRECTION_BOTH 0
134#define OWL_LOGGING_DIRECTION_IN   1
135#define OWL_LOGGING_DIRECTION_OUT  2
136
137#define OWL_SCROLLMODE_NORMAL      0
138#define OWL_SCROLLMODE_TOP         1
139#define OWL_SCROLLMODE_NEARTOP     2
140#define OWL_SCROLLMODE_CENTER      3
141#define OWL_SCROLLMODE_PAGED       4
142#define OWL_SCROLLMODE_PAGEDCENTER 5
143
144#define OWL_STYLE_TYPE_INTERNAL  0
145#define OWL_STYLE_TYPE_PERL      1
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_INCLUDE_REG_TESTS   1  /* whether to build in regression tests */
198
199#define OWL_CMD_ALIAS_SUMMARY_PREFIX "command alias to: "
200
201#define OWL_WEBZEPHYR_PRINCIPAL "daemon.webzephyr"
202#define OWL_WEBZEPHYR_CLASS     "webzephyr"
203#define OWL_WEBZEPHYR_OPCODE    "webzephyr"
204
205#define OWL_REGEX_QUOTECHARS    "+*.?[]^\\${}()"
206#define OWL_REGEX_QUOTEWITH     "\\"
207
208#if defined(HAVE_DES_STRING_TO_KEY) && defined(HAVE_DES_KEY_SCHED) && defined(HAVE_DES_ECB_ENCRYPT)
209#define OWL_ENABLE_ZCRYPT 1
210#endif
211
212#define OWL_META(key) ((key)|0200)
213/* OWL_CTRL is definied in kepress.c */
214
215#define LINE 2048
216
217typedef struct _owl_variable {
218  char *name;
219  int   type;  /* OWL_VARIABLE_* */
220  void *pval_default;  /* for types other and string */
221  int   ival_default;  /* for types int and bool     */
222  char *validsettings;          /* documentation of valid settings */
223  char *summary;                /* summary of usage */
224  char *description;            /* detailed description */
225  void *val;                    /* current value */
226  int  (*validate_fn)(struct _owl_variable *v, void *newval);
227                                /* returns 1 if newval is valid */
228  int  (*set_fn)(struct _owl_variable *v, void *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  int  (*set_fromstring_fn)(struct _owl_variable *v, char *newval);
235                                /* sets the variable to a value
236                                 * of the appropriate type.
237                                 * unless documented, this
238                                 * should make a copy.
239                                 * returns 0 on success. */
240  void *(*get_fn)(struct _owl_variable *v);
241                                /* returns a reference to the current value.
242                                 * WARNING:  this approach is hard to make
243                                 * thread-safe... */
244  int  (*get_tostring_fn)(struct _owl_variable *v, 
245                          char *buf, int bufsize, void *val); 
246                                /* converts val to a string
247                                 * and puts into buf */
248  void  (*free_fn)(struct _owl_variable *v);
249                                /* frees val as needed */
250} owl_variable;
251
252typedef struct _owl_fmtext {
253  int textlen;
254  int bufflen;
255  char *textbuff;
256  char *fmbuff;
257  short *fgcolorbuff;
258  short *bgcolorbuff;
259} owl_fmtext;
260
261typedef struct _owl_list {
262  int size;
263  int avail;
264  void **list;
265} owl_list;
266
267typedef struct _owl_dict_el {
268  char *k;                      /* key   */
269  void *v;                      /* value */
270} owl_dict_el;
271
272typedef struct _owl_dict {
273  int size;
274  int avail;
275  owl_dict_el *els;             /* invariant: sorted by k */
276} owl_dict;
277typedef owl_dict owl_vardict;   /* dict of variables */
278typedef owl_dict owl_cmddict;   /* dict of commands */
279
280typedef struct _owl_context {
281  int   mode;
282  void *data;           /* determined by mode */
283} owl_context;
284
285typedef struct _owl_cmd {       /* command */
286  char *name;
287
288  char *summary;                /* one line summary of command */
289  char *usage;                  /* usage synopsis */
290  char *description;            /* long description of command */
291
292  int validctx;                 /* bitmask of valid contexts */
293
294  /* we should probably have a type here that says which of
295   * the following is valid, and maybe make the below into a union... */
296
297  /* Only one of these may be non-NULL ... */
298
299  char *cmd_aliased_to;         /* what this command is aliased to... */
300 
301  /* These don't take any context */
302  char *(*cmd_args_fn)(int argc, char **argv, char *buff); 
303                                /* takes argv and the full command as buff.
304                                 * caller must free return value if !NULL */
305  void (*cmd_v_fn)(void);       /* takes no args */
306  void (*cmd_i_fn)(int i);      /* takes an int as an arg */
307
308  /* The following also take the active context if it's valid */
309  char *(*cmd_ctxargs_fn)(void *ctx, int argc, char **argv, char *buff); 
310                                /* takes argv and the full command as buff.
311                                 * caller must free return value if !NULL */
312  void (*cmd_ctxv_fn)(void *ctx);               /* takes no args */
313  void (*cmd_ctxi_fn)(void *ctx, int i);        /* takes an int as an arg */
314  SV *cmd_perl;                                /* Perl closure that takes a list of args */
315} owl_cmd;
316
317
318typedef struct _owl_zwrite {
319  char *class;
320  char *inst;
321  char *realm;
322  char *opcode;
323  char *zsig;
324  char *message;
325  owl_list recips;
326  int cc;
327  int noping;
328} owl_zwrite;
329
330typedef struct _owl_pair {
331  void *key;
332  void *value;
333} owl_pair;
334
335struct _owl_fmtext_cache;
336
337typedef struct _owl_message {
338  int id;
339  int direction;
340#ifdef HAVE_LIBZEPHYR
341  ZNotice_t notice;
342#endif
343  struct _owl_fmtext_cache * fmtext;
344  int delete;
345  char *hostname;
346  owl_list attributes;            /* this is a list of pairs */
347  char *timestr;
348  time_t time;
349  char *zwriteline;
350} owl_message;
351
352#define OWL_FMTEXT_CACHE_SIZE 1000
353/* We cache the saved fmtexts for the last bunch of messages we
354   rendered */
355typedef struct _owl_fmtext_cache {
356    owl_message * message;
357    owl_fmtext fmtext;
358} owl_fmtext_cache;
359
360typedef struct _owl_style {
361  char *name;
362  char *description;
363  int type;
364  char *perlfuncname;
365  void (*formatfunc) (owl_fmtext *fm, owl_message *m);
366} owl_style;
367
368typedef struct _owl_mainwin {
369  int curtruncated;
370  int lasttruncated;
371  int lastdisplayed;
372} owl_mainwin;
373
374typedef struct _owl_viewwin {
375  owl_fmtext fmtext;
376  int textlines;
377  int topline;
378  int rightshift;
379  int winlines, wincols;
380  WINDOW *curswin;
381  void (*onclose_hook) (struct _owl_viewwin *vwin, void *data);
382  void *onclose_hook_data;
383} owl_viewwin;
384 
385typedef struct _owl_popwin {
386  WINDOW *borderwin;
387  WINDOW *popwin;
388  int lines;
389  int cols;
390  int active;
391  int needsfirstrefresh;
392  void (*handler) (int ch);
393} owl_popwin;
394
395typedef struct _owl_popexec {
396  int refcount;
397  owl_viewwin *vwin;
398  int winactive;
399  int pid;                      /* or 0 if it has terminated */
400  int rfd; 
401} owl_popexec;
402
403typedef struct _owl_messagelist {
404  owl_list list;
405} owl_messagelist;
406
407typedef struct _owl_regex {
408  int negate;
409  char *string;
410  regex_t re;
411} owl_regex;
412
413typedef struct _owl_filterelement {
414  int (*match_message)(struct _owl_filterelement *fe, owl_message *m);
415  /* Append a string representation of the filterelement onto buf*/
416  void (*print_elt)(struct _owl_filterelement *fe, char * buf);
417  /* Operands for and,or,not*/
418  struct _owl_filterelement *left, *right;
419  /* For regex filters*/
420  owl_regex re;
421  /* Used by regexes, filter references, and perl */
422  char *field;
423} owl_filterelement;
424
425typedef struct _owl_filter {
426  char *name;
427  int polarity;
428  owl_filterelement * root;
429  int fgcolor;
430  int bgcolor;
431  int cachedmsgid;  /* cached msgid: should move into view eventually */
432} owl_filter;
433
434typedef struct _owl_view {
435  char *name;
436  owl_filter *filter;
437  owl_messagelist ml;
438  owl_style *style;
439} owl_view;
440
441typedef struct _owl_history {
442  owl_list hist;
443  int cur;
444  int touched;
445  int partial;
446  int repeats;
447} owl_history;
448
449typedef struct _owl_editwin {
450  char *buff;
451  owl_history *hist;
452  int bufflen;
453  int allocated;
454  int buffx, buffy;
455  int topline;
456  int winlines, wincols, fillcol, wrapcol;
457  WINDOW *curswin;
458  int style;
459  int lock;
460  int dotsend;
461  int echochar;
462
463  char *command;
464  void (*callback)(struct _owl_editwin*);
465  void *cbdata;
466} owl_editwin;
467
468typedef struct _owl_mux {
469  int handle;                   /* for referencing this */
470  int active;                   /* has this been deleted? */
471  int fd;                     
472  int eventmask;                /* bitmask of OWL_MUX_* */
473  void (*handler_fn)(int handle, int fd, int eventmask, void *data);
474  void *data;                   /* data reference to pass to callback */
475} owl_mux;
476typedef owl_list owl_muxevents;
477
478typedef struct _owl_keybinding {
479  int  *j;                      /* keypress stack (0-terminated) */ 
480  int   type;                   /* command or function? */
481  char *desc;                   /* description (or "*user*") */
482  char *command;                /* command, if of type command */
483  void (*function_fn)(void);    /* function ptr, if of type function */
484} owl_keybinding;
485
486typedef struct _owl_keymap {
487  char     *name;               /* name of keymap */
488  char     *desc;               /* description */
489  owl_list  bindings;           /* key bindings */
490  struct _owl_keymap *submap;   /* submap */
491  void (*default_fn)(int j);    /* default action (takes a keypress) */
492  void (*prealways_fn)(int j);  /* always called before a keypress is received */
493  void (*postalways_fn)(int j); /* always called after keypress is processed */
494} owl_keymap;
495
496typedef struct _owl_keyhandler {
497  owl_dict  keymaps;            /* dictionary of keymaps */
498  owl_keymap *active;           /* currently active keymap */
499  int       in_esc;             /* escape pressed? */
500  int       kpstack[OWL_KEYMAP_MAXSTACK+1]; /* current stack of keypresses */
501  int       kpstackpos;         /* location in stack (-1 = none) */
502} owl_keyhandler;
503
504typedef struct _owl_buddy {
505  int proto;
506  char *name;
507  int isidle;
508  int idlesince;
509} owl_buddy;
510
511typedef struct _owl_buddylist {
512  owl_list buddies;
513} owl_buddylist;
514
515typedef struct _owl_zbuddylist {
516  owl_list zusers;
517} owl_zbuddylist;
518
519typedef struct _owl_timer {
520  int direction;
521  time_t starttime;
522  int start;
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_obarray {
535  owl_list strings;
536} owl_obarray;
537
538typedef struct _owl_global {
539  owl_mainwin mw;
540  owl_popwin pw;
541  owl_history cmdhist;          /* command history */
542  owl_history msghist;          /* outgoing message history */
543  owl_keyhandler kh;
544  owl_list filterlist;
545  owl_list puntlist;
546  owl_muxevents muxevents;      /* fds to dispatch on */
547  owl_vardict vars;
548  owl_cmddict cmds;
549  owl_context ctx;
550  owl_errqueue errqueue;
551  int lines, cols;
552  int curmsg, topmsg;
553  int curmsg_vert_offset;
554  owl_view current_view;
555  owl_messagelist msglist;
556  WINDOW *recwin, *sepwin, *msgwin, *typwin;
557  int needrefresh;
558  int rightshift;
559  int resizepending;
560  int recwinlines;
561  int typwinactive;
562  char *thishost;
563  char *homedir;
564  char *confdir;
565  char *startupfile;
566  int direction;
567  int zaway;
568  char *cur_zaway_msg;
569  int haveconfig;
570  int config_format;
571  void *buffercbdata;
572  owl_editwin tw;
573  owl_viewwin vw;
574  void *perl;
575  int debug;
576  time_t starttime;
577  time_t lastinputtime;
578  char *startupargs;
579  int userclue;
580  int nextmsgid;
581  int hascolors;
582  int colorpairs;
583  owl_colorpair_mgr cpmgr;
584  int searchactive;
585  int newmsgproc_pid;
586  int malloced, freed;
587  char *searchstring;
588  aim_session_t aimsess;
589  aim_conn_t bosconn;
590  owl_timer aim_noop_timer;
591  owl_timer aim_ignorelogin_timer;
592  owl_timer aim_buddyinfo_timer;
593  int aim_loggedin;         /* true if currently logged into AIM */
594  int aim_doprocessing;     /* true if we should process AIM events (like pending login) */
595  char *aim_screenname;     /* currently logged in AIM screen name */
596  owl_buddylist buddylist;  /* list of logged in AIM buddies */
597  owl_list messagequeue;    /* for queueing up aim and other messages */
598  owl_dict styledict;       /* global dictionary of available styles */
599  char *response;           /* response to the last question asked */
600  int havezephyr;
601  int haveaim;
602  int got_err_signal;       /* 1 if we got an unexpected signal */
603  siginfo_t err_signal_info;
604  owl_zbuddylist zbuddies;
605  owl_timer zephyr_buddycheck_timer;
606  struct termios startup_tio;
607  owl_obarray obarray;
608} owl_global;
609
610/* globals */
611extern owl_global g;
612
613#include "owl_prototypes.h"
614
615/* these are missing from the zephyr includes for some reason */
616#ifdef HAVE_LIBZEPHYR
617int ZGetSubscriptions(ZSubscription_t *, int *);
618int ZGetLocations(ZLocations_t *,int *);
619#endif
620
621#endif /* INC_OWL_H */
Note: See TracBrowser for help on using the repository browser.