source: owl.h @ 72c210f

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