source: owl.h @ 41f0cf3

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