source: owl.h @ d70f45f

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