source: owl.h @ 5f7eadf

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