source: owl.h @ 335413f1

release-1.7release-1.8release-1.9
Last change on this file since 335413f1 was 2b83ad6, checked in by David Benjamin <davidben@mit.edu>, 11 years ago
Add owl_fmtext_expand_tabs with test case
  • Property mode set to 100644
File size: 18.3 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/barnowl-debug"
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_TAB_WIDTH 8
117
118#define OWL_EDITWIN_STYLE_MULTILINE 0
119#define OWL_EDITWIN_STYLE_ONELINE   1
120
121#define OWL_PROTOCOL_ZEPHYR         0
122#define OWL_PROTOCOL_AIM            1
123#define OWL_PROTOCOL_JABBER         2
124#define OWL_PROTOCOL_ICQ            3
125#define OWL_PROTOCOL_YAHOO          4
126#define OWL_PROTOCOL_MSN            5
127
128#define OWL_MESSAGE_DIRECTION_NONE  0
129#define OWL_MESSAGE_DIRECTION_IN    1
130#define OWL_MESSAGE_DIRECTION_OUT   2
131
132#define OWL_IO_READ   1
133#define OWL_IO_WRITE  2
134#define OWL_IO_EXCEPT 4
135
136#define OWL_DIRECTION_NONE      0
137#define OWL_DIRECTION_DOWNWARDS 1
138#define OWL_DIRECTION_UPWARDS   2
139
140#define OWL_LOGGING_DIRECTION_BOTH 0
141#define OWL_LOGGING_DIRECTION_IN   1
142#define OWL_LOGGING_DIRECTION_OUT  2
143
144#define OWL_SCROLLMODE_NORMAL      0
145#define OWL_SCROLLMODE_TOP         1
146#define OWL_SCROLLMODE_NEARTOP     2
147#define OWL_SCROLLMODE_CENTER      3
148#define OWL_SCROLLMODE_PAGED       4
149#define OWL_SCROLLMODE_PAGEDCENTER 5
150
151#define OWL_TAB               3  /* This *HAS* to be the size of TABSTR below */
152#define OWL_TABSTR        "   "
153#define OWL_MSGTAB            7
154#define OWL_TYPWIN_SIZE       8
155#define OWL_HISTORYSIZE       50
156
157/* Indicate current state, as well as what is allowed */
158#define OWL_CTX_ANY          0xffff
159/* Only one of these may be active at a time... */
160#define OWL_CTX_MODE_BITS    0x000f
161#define OWL_CTX_STARTUP      0x0001
162#define OWL_CTX_READCONFIG   0x0002
163#define OWL_CTX_INTERACTIVE  0x0004
164/* Only one of these may be active at a time... */
165#define OWL_CTX_ACTIVE_BITS  0xfff0
166#define OWL_CTX_POPWIN       0x00f0
167#define OWL_CTX_POPLESS      0x0010
168#define OWL_CTX_RECWIN       0x0f00
169#define OWL_CTX_RECV         0x0100
170#define OWL_CTX_TYPWIN       0xf000
171#define OWL_CTX_EDIT         0x7000
172#define OWL_CTX_EDITLINE     0x1000
173#define OWL_CTX_EDITMULTI    0x2000
174#define OWL_CTX_EDITRESPONSE 0x4000
175
176#define OWL_USERCLUE_NONE       0
177#define OWL_USERCLUE_CLASSES    1
178#define OWL_USERCLUE_FOOBAR     2
179#define OWL_USERCLUE_BAZ        4
180
181#define OWL_WEBBROWSER_NONE     0
182#define OWL_WEBBROWSER_NETSCAPE 1
183#define OWL_WEBBROWSER_GALEON   2
184#define OWL_WEBBROWSER_OPERA    3
185
186#define OWL_VARIABLE_OTHER      0
187#define OWL_VARIABLE_INT        1
188#define OWL_VARIABLE_BOOL       2
189#define OWL_VARIABLE_STRING     3
190
191#define OWL_OUTPUT_RETURN       0
192#define OWL_OUTPUT_POPUP        1
193#define OWL_OUTPUT_ADMINMSG     2
194
195#define OWL_FILTER_MAX_DEPTH    300
196
197#define OWL_KEYMAP_MAXSTACK     20
198
199#define OWL_KEYBINDING_COMMAND  1   /* command string */
200#define OWL_KEYBINDING_FUNCTION 2   /* function taking no args */
201
202#define OWL_DEFAULT_ZAWAYMSG    "I'm sorry, but I am currently away from the terminal and am\nnot able to receive your message.\n"
203#define OWL_DEFAULT_AAWAYMSG    "I'm sorry, but I am currently away from the terminal and am\nnot able to receive your message.\n"
204
205#define OWL_CMD_ALIAS_SUMMARY_PREFIX "command alias to: "
206
207#define OWL_WEBZEPHYR_PRINCIPAL "daemon.webzephyr"
208#define OWL_WEBZEPHYR_CLASS     "webzephyr"
209#define OWL_WEBZEPHYR_OPCODE    "webzephyr"
210
211#define OWL_REGEX_QUOTECHARS    "+*.?[]^\\${}()"
212#define OWL_REGEX_QUOTEWITH     "\\"
213
214#if defined(HAVE_DES_STRING_TO_KEY) && defined(HAVE_DES_KEY_SCHED) && defined(HAVE_DES_ECB_ENCRYPT)
215#define OWL_ENABLE_ZCRYPT 1
216#endif
217
218#define OWL_META(key) ((key)|010000)
219/* OWL_CTRL is definied in kepress.c */
220
221#define LINE 2048
222
223#ifdef HAVE_LIBZEPHYR
224/* libzephyr doesn't use const, so we appease the type system with this kludge.
225 * This just casts const char * to char * in a way that doesn't yield a warning
226 * from gcc -Wcast-qual. */
227static inline char *zstr(const char *str)
228{
229  union { char *rw; const char *ro; } u;
230  u.ro = str;
231  return u.rw;
232}
233#endif
234
235/* Convert char *const * into const char *const *.  This conversion is safe,
236 * and implicit in C++ (conv.qual 4) but for some reason not in C. */
237static inline const char *const *strs(char *const *pstr)
238{
239  return (const char *const *)pstr;
240}
241
242typedef struct _owl_variable {
243  char *name;
244  int   type;  /* OWL_VARIABLE_* */
245  void *pval_default;  /* for types other and string */
246  int   ival_default;  /* for types int and bool     */
247  char *validsettings;          /* documentation of valid settings */
248  char *summary;                /* summary of usage */
249  char *description;            /* detailed description */
250  void *val;                    /* current value */
251  int  (*validate_fn)(const struct _owl_variable *v, const void *newval);
252                                /* returns 1 if newval is valid */
253  int  (*set_fn)(struct _owl_variable *v, const void *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  int  (*set_fromstring_fn)(struct _owl_variable *v, const char *newval);
260                                /* sets the variable to a value
261                                 * of the appropriate type.
262                                 * unless documented, this
263                                 * should make a copy.
264                                 * returns 0 on success. */
265  const void *(*get_fn)(const struct _owl_variable *v);
266                                /* returns a reference to the current value.
267                                 * WARNING:  this approach is hard to make
268                                 * thread-safe... */
269  int  (*get_tostring_fn)(const struct _owl_variable *v, 
270                          char *buf, int bufsize, const void *val); 
271                                /* converts val to a string
272                                 * and puts into buf */
273  void (*delete_fn)(struct _owl_variable *v);
274                                /* frees val as needed */
275} owl_variable;
276
277typedef struct _owl_input {
278  int ch;
279  gunichar uch;
280} owl_input;
281
282typedef struct _owl_fmtext {
283  int textlen;
284  int bufflen;
285  char *textbuff;
286  char default_attrs;
287  short default_fgcolor;
288  short default_bgcolor;
289} owl_fmtext;
290
291typedef struct _owl_list {
292  int size;
293  int avail;
294  void **list;
295} owl_list;
296
297typedef struct _owl_dict_el {
298  char *k;                      /* key   */
299  void *v;                      /* value */
300} owl_dict_el;
301
302typedef struct _owl_dict {
303  int size;
304  int avail;
305  owl_dict_el *els;             /* invariant: sorted by k */
306} owl_dict;
307typedef owl_dict owl_vardict;   /* dict of variables */
308typedef owl_dict owl_cmddict;   /* dict of commands */
309
310typedef struct _owl_context {
311  int   mode;
312  void *data;           /* determined by mode */
313  char *keymap;
314  owl_window *cursor;
315} owl_context;
316
317typedef struct _owl_cmd {       /* command */
318  char *name;
319
320  char *summary;                /* one line summary of command */
321  char *usage;                  /* usage synopsis */
322  char *description;            /* long description of command */
323
324  int validctx;                 /* bitmask of valid contexts */
325
326  /* we should probably have a type here that says which of
327   * the following is valid, and maybe make the below into a union... */
328
329  /* Only one of these may be non-NULL ... */
330
331  char *cmd_aliased_to;         /* what this command is aliased to... */
332 
333  /* These don't take any context */
334  char *(*cmd_args_fn)(int argc, const char *const *argv, const char *buff); 
335                                /* takes argv and the full command as buff.
336                                 * caller must free return value if !NULL */
337  void (*cmd_v_fn)(void);       /* takes no args */
338  void (*cmd_i_fn)(int i);      /* takes an int as an arg */
339
340  /* The following also take the active context if it's valid */
341  char *(*cmd_ctxargs_fn)(void *ctx, int argc, const char *const *argv, const char *buff); 
342                                /* takes argv and the full command as buff.
343                                 * caller must free return value if !NULL */
344  void (*cmd_ctxv_fn)(void *ctx);               /* takes no args */
345  void (*cmd_ctxi_fn)(void *ctx, int i);        /* takes an int as an arg */
346  SV *cmd_perl;                                /* Perl closure that takes a list of args */
347} owl_cmd;
348
349
350typedef struct _owl_zwrite {
351  char *cmd;
352  char *zwriteline;
353  char *class;
354  char *inst;
355  char *realm;
356  char *opcode;
357  char *zsig;
358  char *message;
359  owl_list recips;
360  int cc;
361  int noping;
362} owl_zwrite;
363
364typedef struct _owl_pair {
365  const char *key;
366  char *value;
367} owl_pair;
368
369struct _owl_fmtext_cache;
370
371typedef struct _owl_message {
372  int id;
373  int direction;
374#ifdef HAVE_LIBZEPHYR
375  ZNotice_t notice;
376#endif
377  struct _owl_fmtext_cache * fmtext;
378  int delete;
379  const char *hostname;
380  owl_list attributes;            /* this is a list of pairs */
381  char *timestr;
382  time_t time;
383} owl_message;
384
385#define OWL_FMTEXT_CACHE_SIZE 1000
386/* We cache the saved fmtexts for the last bunch of messages we
387   rendered */
388typedef struct _owl_fmtext_cache {
389    owl_message * message;
390    owl_fmtext fmtext;
391} owl_fmtext_cache;
392
393typedef struct _owl_style {
394  char *name;
395  SV *perlobj;
396} owl_style;
397
398typedef struct _owl_mainwin {
399  int curtruncated;
400  int lasttruncated;
401  int lastdisplayed;
402  owl_window *window;
403} owl_mainwin;
404
405typedef struct _owl_viewwin {
406  owl_fmtext fmtext;
407  int textlines;
408  int topline;
409  int rightshift;
410  owl_window *window;
411  gulong sig_redraw_id;
412  void (*onclose_hook) (struct _owl_viewwin *vwin, void *data);
413  void *onclose_hook_data;
414} owl_viewwin;
415 
416typedef struct _owl_popwin {
417  owl_window *border;
418  owl_window *content;
419  int active;
420} owl_popwin;
421 
422typedef struct _owl_msgwin {
423  char *msg;
424  owl_window *window;
425  gulong redraw_id;
426} owl_msgwin;
427
428typedef struct _owl_messagelist {
429  owl_list list;
430} owl_messagelist;
431
432typedef struct _owl_regex {
433  int negate;
434  char *string;
435  regex_t re;
436} owl_regex;
437
438typedef struct _owl_filterelement {
439  int (*match_message)(const struct _owl_filterelement *fe, const owl_message *m);
440  /* Append a string representation of the filterelement onto buf*/
441  void (*print_elt)(const struct _owl_filterelement *fe, GString *buf);
442  /* Operands for and,or,not*/
443  struct _owl_filterelement *left, *right;
444  /* For regex filters*/
445  owl_regex re;
446  /* Used by regexes, filter references, and perl */
447  char *field;
448} owl_filterelement;
449
450typedef struct _owl_filter {
451  char *name;
452  owl_filterelement * root;
453  int fgcolor;
454  int bgcolor;
455} owl_filter;
456
457typedef struct _owl_view {
458  char *name;
459  owl_filter *filter;
460  owl_messagelist ml;
461  const owl_style *style;
462  int cachedmsgid;
463} owl_view;
464
465typedef struct _owl_history {
466  owl_list hist;
467  int cur;
468  int touched;
469  int partial;
470  int repeats;
471} owl_history;
472
473typedef struct _owl_editwin owl_editwin;
474typedef struct _owl_editwin_excursion owl_editwin_excursion;
475
476typedef struct _owl_mainpanel {
477  owl_window *panel;
478  owl_window *typwin;
479  owl_window *sepwin;
480  owl_window *msgwin;
481  owl_window *recwin;
482  int recwinlines;
483} owl_mainpanel;
484
485typedef struct _owl_keybinding {
486  int  *keys;                   /* keypress stack */
487  int   len;                    /* length of stack */
488  int   type;                   /* command or function? */
489  char *desc;                   /* description (or "*user*") */
490  char *command;                /* command, if of type command */
491  void (*function_fn)(void);    /* function ptr, if of type function */
492} owl_keybinding;
493
494typedef struct _owl_keymap {
495  char     *name;               /* name of keymap */
496  char     *desc;               /* description */
497  owl_list  bindings;           /* key bindings */
498  const struct _owl_keymap *parent;     /* parent */
499  void (*default_fn)(owl_input j);      /* default action (takes a keypress) */
500  void (*prealways_fn)(owl_input  j);   /* always called before a keypress is received */
501  void (*postalways_fn)(owl_input  j);  /* always called after keypress is processed */
502} owl_keymap;
503
504typedef struct _owl_keyhandler {
505  owl_dict  keymaps;            /* dictionary of keymaps */
506  const owl_keymap *active;             /* currently active keymap */
507  int       in_esc;             /* escape pressed? */
508  int       kpstack[OWL_KEYMAP_MAXSTACK+1]; /* current stack of keypresses */
509  int       kpstackpos;         /* location in stack (-1 = none) */
510} owl_keyhandler;
511
512typedef struct _owl_buddy {
513  int proto;
514  char *name;
515  int isidle;
516  int idlesince;
517} owl_buddy;
518
519typedef struct _owl_buddylist {
520  owl_list buddies;
521} owl_buddylist;
522
523typedef struct _owl_zbuddylist {
524  owl_list zusers;
525} owl_zbuddylist;
526
527typedef struct _owl_timer {
528  time_t time;
529  int interval;
530  void (*callback)(struct _owl_timer *, void *);
531  void (*destroy)(struct _owl_timer *);
532  void *data;
533} owl_timer;
534
535typedef struct _owl_errqueue {
536  owl_list errlist;
537} owl_errqueue;
538
539typedef struct _owl_colorpair_mgr {
540  int next;
541  short **pairs;
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 *thishost;
596  char *homedir;
597  char *confdir;
598  char *startupfile;
599  int direction;
600  int zaway;
601  char *cur_zaway_msg;
602  int haveconfig;
603  int config_format;
604  void *buffercbdata;
605  owl_editwin *tw;
606  owl_viewwin vw;
607  void *perl;
608  int debug;
609  time_t starttime;
610  time_t lastinputtime;
611  char *startupargs;
612  int userclue;
613  int nextmsgid;
614  int hascolors;
615  int colorpairs;
616  owl_colorpair_mgr cpmgr;
617  pid_t newmsgproc_pid;
618  owl_regex search_re;
619  aim_session_t aimsess;
620  aim_conn_t bosconn;
621  owl_timer aim_noop_timer;
622  owl_timer aim_ignorelogin_timer;
623  int aim_loggedin;         /* true if currently logged into AIM */
624  int aim_doprocessing;     /* true if we should process AIM events (like pending login) */
625  char *aim_screenname;     /* currently logged in AIM screen name */
626  char *aim_screenname_for_filters;     /* currently logged in AIM screen name */
627  owl_buddylist buddylist;  /* list of logged in AIM buddies */
628  GQueue *messagequeue;     /* for queueing up aim and other messages */
629  owl_dict styledict;       /* global dictionary of available styles */
630  char *response;           /* response to the last question asked */
631  int havezephyr;
632  int haveaim;
633  int ignoreaimlogin;
634  volatile sig_atomic_t got_err_signal; /* 1 if we got an unexpected signal */
635  volatile siginfo_t err_signal_info;
636  owl_zbuddylist zbuddies;
637  owl_timer zephyr_buddycheck_timer;
638  GList *zaldlist;
639  int pseudologin_notify;
640  struct termios startup_tio;
641  owl_list io_dispatch_list;
642  owl_list psa_list;
643  GList *timerlist;
644  owl_timer *aim_nop_timer;
645  int load_initial_subs;
646  volatile sig_atomic_t interrupted;
647  FILE *debug_file;
648} owl_global;
649
650/* globals */
651extern owl_global g;
652
653#include "owl_prototypes.h"
654
655/* these are missing from the zephyr includes for some reason */
656#ifdef HAVE_LIBZEPHYR
657int ZGetSubscriptions(ZSubscription_t *, int *);
658int ZGetLocations(ZLocations_t *,int *);
659#endif
660
661#endif /* INC_OWL_H */
Note: See TracBrowser for help on using the repository browser.