source: owl.h @ c5c5686

Last change on this file since c5c5686 was c5c5686, checked in by David Benjamin <davidben@mit.edu>, 13 years ago
And finally, remove owl_io_dispatch All uses have been replaced with a GIOChannel watch.
  • Property mode set to 100644
File size: 17.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#ifndef OWL_VERSION_STRING
69#ifdef  GIT_VERSION
70#define stringify(x)       __stringify(x)
71#define __stringify(x)     #x
72#define OWL_VERSION_STRING stringify(GIT_VERSION)
73#else
74#define OWL_VERSION_STRING PACKAGE_VERSION
75#endif
76#endif /* !OWL_VERSION_STRING */
77
78/* Feature that is being tested to redirect stderr through a pipe.
79 * There may still be some portability problems with this. */
80#define OWL_STDERR_REDIR 1
81
82#define OWL_DEBUG 0
83#define OWL_DEBUG_FILE "/var/tmp/barnowl-debug"
84
85#define OWL_CONFIG_DIR "/.owl"             /* this is relative to the user's home directory */
86#define OWL_STARTUP_FILE "/.owl/startup"   /* this is relative to the user's home directory */
87
88#define OWL_FMTEXT_ATTR_NONE      0
89#define OWL_FMTEXT_ATTR_BOLD      1
90#define OWL_FMTEXT_ATTR_REVERSE   2
91#define OWL_FMTEXT_ATTR_UNDERLINE 4
92
93#define OWL_FMTEXT_UC_BASE 0x100000 /* Unicode Plane 16 - Supplementary Private Use Area-B*/
94#define OWL_FMTEXT_UC_ATTR ( OWL_FMTEXT_UC_BASE | 0x800 )
95#define OWL_FMTEXT_UC_ATTR_MASK 0x7
96#define OWL_FMTEXT_UC_COLOR_BASE ( OWL_FMTEXT_UC_BASE | 0x400 )
97#define OWL_FMTEXT_UC_FGCOLOR OWL_FMTEXT_UC_COLOR_BASE
98#define OWL_FMTEXT_UC_BGCOLOR ( OWL_FMTEXT_UC_COLOR_BASE | 0x200 )
99#define OWL_FMTEXT_UC_DEFAULT_COLOR 0x100
100#define OWL_FMTEXT_UC_FGDEFAULT ( OWL_FMTEXT_UC_FGCOLOR | OWL_FMTEXT_UC_DEFAULT_COLOR )
101#define OWL_FMTEXT_UC_BGDEFAULT ( OWL_FMTEXT_UC_BGCOLOR | OWL_FMTEXT_UC_DEFAULT_COLOR )
102#define OWL_FMTEXT_UC_COLOR_MASK 0xFF
103#define OWL_FMTEXT_UC_ALLCOLOR_MASK ( OWL_FMTEXT_UC_COLOR_MASK | OWL_FMTEXT_UC_DEFAULT_COLOR | 0x200)
104#define OWL_FMTEXT_UC_STARTBYTE_UTF8 '\xf4'
105
106#define OWL_COLOR_BLACK     0
107#define OWL_COLOR_RED       1
108#define OWL_COLOR_GREEN     2
109#define OWL_COLOR_YELLOW    3
110#define OWL_COLOR_BLUE      4
111#define OWL_COLOR_MAGENTA   5
112#define OWL_COLOR_CYAN      6
113#define OWL_COLOR_WHITE     7
114#define OWL_COLOR_DEFAULT   -1
115#define OWL_COLOR_INVALID   -2
116
117#define OWL_TAB_WIDTH 8
118
119#define OWL_EDITWIN_STYLE_MULTILINE 0
120#define OWL_EDITWIN_STYLE_ONELINE   1
121
122#define OWL_PROTOCOL_ZEPHYR         0
123#define OWL_PROTOCOL_AIM            1
124#define OWL_PROTOCOL_JABBER         2
125#define OWL_PROTOCOL_ICQ            3
126#define OWL_PROTOCOL_YAHOO          4
127#define OWL_PROTOCOL_MSN            5
128
129#define OWL_MESSAGE_DIRECTION_NONE  0
130#define OWL_MESSAGE_DIRECTION_IN    1
131#define OWL_MESSAGE_DIRECTION_OUT   2
132
133#define OWL_DIRECTION_NONE      0
134#define OWL_DIRECTION_DOWNWARDS 1
135#define OWL_DIRECTION_UPWARDS   2
136
137#define OWL_LOGGING_DIRECTION_BOTH 0
138#define OWL_LOGGING_DIRECTION_IN   1
139#define OWL_LOGGING_DIRECTION_OUT  2
140
141#define OWL_SCROLLMODE_NORMAL      0
142#define OWL_SCROLLMODE_TOP         1
143#define OWL_SCROLLMODE_NEARTOP     2
144#define OWL_SCROLLMODE_CENTER      3
145#define OWL_SCROLLMODE_PAGED       4
146#define OWL_SCROLLMODE_PAGEDCENTER 5
147
148#define OWL_TAB               3  /* This *HAS* to be the size of TABSTR below */
149#define OWL_TABSTR        "   "
150#define OWL_MSGTAB            7
151#define OWL_TYPWIN_SIZE       8
152#define OWL_HISTORYSIZE       50
153
154/* Indicate current state, as well as what is allowed */
155#define OWL_CTX_ANY          0xffff
156/* Only one of these may be active at a time... */
157#define OWL_CTX_MODE_BITS    0x000f
158#define OWL_CTX_STARTUP      0x0001
159#define OWL_CTX_READCONFIG   0x0002
160#define OWL_CTX_INTERACTIVE  0x0004
161/* Only one of these may be active at a time... */
162#define OWL_CTX_ACTIVE_BITS  0xfff0
163#define OWL_CTX_POPWIN       0x00f0
164#define OWL_CTX_POPLESS      0x0010
165#define OWL_CTX_RECWIN       0x0f00
166#define OWL_CTX_RECV         0x0100
167#define OWL_CTX_TYPWIN       0xf000
168#define OWL_CTX_EDIT         0x7000
169#define OWL_CTX_EDITLINE     0x1000
170#define OWL_CTX_EDITMULTI    0x2000
171#define OWL_CTX_EDITRESPONSE 0x4000
172
173#define OWL_VARIABLE_OTHER      0
174#define OWL_VARIABLE_INT        1
175#define OWL_VARIABLE_BOOL       2
176#define OWL_VARIABLE_STRING     3
177
178#define OWL_OUTPUT_RETURN       0
179#define OWL_OUTPUT_POPUP        1
180#define OWL_OUTPUT_ADMINMSG     2
181
182#define OWL_FILTER_MAX_DEPTH    300
183
184#define OWL_KEYMAP_MAXSTACK     20
185
186#define OWL_KEYBINDING_NOOP     0   /* dummy binding that does nothing */
187#define OWL_KEYBINDING_COMMAND  1   /* command string */
188#define OWL_KEYBINDING_FUNCTION 2   /* function taking no args */
189
190#define OWL_DEFAULT_ZAWAYMSG    "I'm sorry, but I am currently away from the terminal and am\nnot able to receive your message.\n"
191#define OWL_DEFAULT_AAWAYMSG    "I'm sorry, but I am currently away from the terminal and am\nnot able to receive your message.\n"
192
193#define OWL_CMD_ALIAS_SUMMARY_PREFIX "command alias to: "
194
195#define OWL_WEBZEPHYR_PRINCIPAL "daemon/webzephyr.mit.edu"
196#define OWL_WEBZEPHYR_CLASS     "webzephyr"
197#define OWL_WEBZEPHYR_OPCODE    "webzephyr"
198
199#define OWL_ZEPHYR_NOSTRIP_HOST         "host/"
200#define OWL_ZEPHYR_NOSTRIP_RCMD         "rcmd."
201#define OWL_ZEPHYR_NOSTRIP_DAEMON5      "daemon/"
202#define OWL_ZEPHYR_NOSTRIP_DAEMON4      "daemon."
203
204#define OWL_REGEX_QUOTECHARS    "!+*.?[]^\\${}()|"
205#define OWL_REGEX_QUOTEWITH     "\\"
206
207#if defined(HAVE_DES_STRING_TO_KEY) && defined(HAVE_DES_KEY_SCHED) && defined(HAVE_DES_ECB_ENCRYPT)
208#define OWL_ENABLE_ZCRYPT 1
209#endif
210
211#define OWL_META(key) ((key)|010000)
212/* OWL_CTRL is definied in kepress.c */
213
214#define LINE 2048
215
216#ifdef HAVE_LIBZEPHYR
217/* libzephyr doesn't use const, so we appease the type system with this kludge.
218 * This just casts const char * to char * in a way that doesn't yield a warning
219 * from gcc -Wcast-qual. */
220static inline char *zstr(const char *str)
221{
222  union { char *rw; const char *ro; } u;
223  u.ro = str;
224  return u.rw;
225}
226#endif
227
228/* Convert char *const * into const char *const *.  This conversion is safe,
229 * and implicit in C++ (conv.qual 4) but for some reason not in C. */
230static inline const char *const *strs(char *const *pstr)
231{
232  return (const char *const *)pstr;
233}
234
235typedef struct _owl_variable {
236  char *name;
237  int   type;  /* OWL_VARIABLE_* */
238  void *pval_default;  /* for types other and string */
239  int   ival_default;  /* for types int and bool     */
240  char *validsettings;          /* documentation of valid settings */
241  char *summary;                /* summary of usage */
242  char *description;            /* detailed description */
243  void *val;                    /* current value */
244  int  (*validate_fn)(const struct _owl_variable *v, const void *newval);
245                                /* returns 1 if newval is valid */
246  int  (*set_fn)(struct _owl_variable *v, const void *newval); 
247                                /* sets the variable to a value
248                                 * of the appropriate type.
249                                 * unless documented, this
250                                 * should make a copy.
251                                 * returns 0 on success. */
252  int  (*set_fromstring_fn)(struct _owl_variable *v, const char *newval);
253                                /* sets the variable to a value
254                                 * of the appropriate type.
255                                 * unless documented, this
256                                 * should make a copy.
257                                 * returns 0 on success. */
258  const void *(*get_fn)(const struct _owl_variable *v);
259                                /* returns a reference to the current value.
260                                 * WARNING:  this approach is hard to make
261                                 * thread-safe... */
262  char *(*get_tostring_fn)(const struct _owl_variable *v, const void *val);
263                                /* converts val to a string;
264                                 * caller must free the result */
265  void (*delete_fn)(struct _owl_variable *v);
266                                /* frees val as needed */
267} owl_variable;
268
269typedef struct _owl_input {
270  int ch;
271  gunichar uch;
272} owl_input;
273
274typedef struct _owl_fmtext {
275  GString *buff;
276} owl_fmtext;
277
278typedef struct _owl_list {
279  int size;
280  int avail;
281  void **list;
282} owl_list;
283
284typedef struct _owl_dict_el {
285  char *k;                      /* key   */
286  void *v;                      /* value */
287} owl_dict_el;
288
289typedef struct _owl_dict {
290  int size;
291  int avail;
292  owl_dict_el *els;             /* invariant: sorted by k */
293} owl_dict;
294typedef owl_dict owl_vardict;   /* dict of variables */
295typedef owl_dict owl_cmddict;   /* dict of commands */
296
297typedef struct _owl_context {
298  int   mode;
299  void *data;           /* determined by mode */
300  char *keymap;
301  owl_window *cursor;
302  void (*deactivate_cb)(struct _owl_context*);
303  void (*delete_cb)(struct _owl_context*);
304  void *cbdata;
305} owl_context;
306
307typedef struct _owl_cmd {       /* command */
308  char *name;
309
310  char *summary;                /* one line summary of command */
311  char *usage;                  /* usage synopsis */
312  char *description;            /* long description of command */
313
314  int validctx;                 /* bitmask of valid contexts */
315
316  /* we should probably have a type here that says which of
317   * the following is valid, and maybe make the below into a union... */
318
319  /* Only one of these may be non-NULL ... */
320
321  char *cmd_aliased_to;         /* what this command is aliased to... */
322 
323  /* These don't take any context */
324  char *(*cmd_args_fn)(int argc, const char *const *argv, const char *buff); 
325                                /* takes argv and the full command as buff.
326                                 * caller must free return value if !NULL */
327  void (*cmd_v_fn)(void);       /* takes no args */
328  void (*cmd_i_fn)(int i);      /* takes an int as an arg */
329
330  /* The following also take the active context if it's valid */
331  char *(*cmd_ctxargs_fn)(void *ctx, 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_ctxv_fn)(void *ctx);               /* takes no args */
335  void (*cmd_ctxi_fn)(void *ctx, int i);        /* takes an int as an arg */
336  SV *cmd_perl;                                /* Perl closure that takes a list of args */
337} owl_cmd;
338
339
340typedef struct _owl_zwrite {
341  char *cmd;
342  char *zwriteline;
343  char *class;
344  char *inst;
345  char *realm;
346  char *opcode;
347  char *zsig;
348  char *message;
349  owl_list recips;
350  int cc;
351  int noping;
352} owl_zwrite;
353
354typedef struct _owl_pair {
355  const char *key;
356  char *value;
357} owl_pair;
358
359struct _owl_fmtext_cache;
360
361typedef struct _owl_message {
362  int id;
363  int direction;
364#ifdef HAVE_LIBZEPHYR
365  ZNotice_t notice;
366#endif
367  struct _owl_fmtext_cache * fmtext;
368  int delete;
369  const char *hostname;
370  owl_list attributes;            /* this is a list of pairs */
371  char *timestr;
372  time_t time;
373} owl_message;
374
375#define OWL_FMTEXT_CACHE_SIZE 1000
376/* We cache the saved fmtexts for the last bunch of messages we
377   rendered */
378typedef struct _owl_fmtext_cache {
379    owl_message * message;
380    owl_fmtext fmtext;
381} owl_fmtext_cache;
382
383typedef struct _owl_style {
384  char *name;
385  SV *perlobj;
386} owl_style;
387
388typedef struct _owl_mainwin {
389  int curtruncated;
390  int lasttruncated;
391  int lastdisplayed;
392  owl_window *window;
393} owl_mainwin;
394
395typedef struct _owl_editwin owl_editwin;
396typedef struct _owl_editwin_excursion owl_editwin_excursion;
397
398typedef struct _owl_viewwin {
399  owl_fmtext fmtext;
400  int textlines;
401  int topline;
402  int rightshift;
403  owl_window *window;
404  void (*onclose_hook) (struct _owl_viewwin *vwin, void *data);
405  void *onclose_hook_data;
406
407  gulong sig_resize_id;
408  owl_window *content;
409  gulong sig_content_redraw_id;
410  owl_window *status;
411  gulong sig_status_redraw_id;
412  owl_window *cmdwin;
413} owl_viewwin;
414 
415typedef struct _owl_popwin {
416  owl_window *border;
417  owl_window *content;
418  gulong sig_redraw_id;
419  gulong sig_resize_id;
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_mainpanel {
474  owl_window *panel;
475  owl_window *typwin;
476  owl_window *sepwin;
477  owl_window *msgwin;
478  owl_window *recwin;
479  int recwinlines;
480} owl_mainpanel;
481
482typedef struct _owl_keybinding {
483  int  *keys;                   /* keypress stack */
484  int   len;                    /* length of stack */
485  int   type;                   /* command or function? */
486  char *desc;                   /* description (or "*user*") */
487  char *command;                /* command, if of type command */
488  void (*function_fn)(void);    /* function ptr, if of type function */
489} owl_keybinding;
490
491typedef struct _owl_keymap {
492  char     *name;               /* name of keymap */
493  char     *desc;               /* description */
494  owl_list  bindings;           /* key bindings */
495  const struct _owl_keymap *parent;     /* parent */
496  void (*default_fn)(owl_input j);      /* default action (takes a keypress) */
497  void (*prealways_fn)(owl_input  j);   /* always called before a keypress is received */
498  void (*postalways_fn)(owl_input  j);  /* always called after keypress is processed */
499} owl_keymap;
500
501typedef struct _owl_keyhandler {
502  owl_dict  keymaps;            /* dictionary of keymaps */
503  const owl_keymap *active;             /* currently active keymap */
504  int       in_esc;             /* escape pressed? */
505  int       kpstack[OWL_KEYMAP_MAXSTACK+1]; /* current stack of keypresses */
506  int       kpstackpos;         /* location in stack (-1 = none) */
507} owl_keyhandler;
508
509typedef struct _owl_buddy {
510  int proto;
511  char *name;
512  int isidle;
513  int idlesince;
514} owl_buddy;
515
516typedef struct _owl_buddylist {
517  owl_list buddies;
518} owl_buddylist;
519
520typedef struct _owl_zbuddylist {
521  owl_list zusers;
522} owl_zbuddylist;
523
524typedef struct _owl_errqueue {
525  owl_list errlist;
526} owl_errqueue;
527
528typedef struct _owl_colorpair_mgr {
529  int next;
530  short **pairs;
531  bool overflow;
532} owl_colorpair_mgr;
533
534typedef struct _owl_popexec {
535  int refcount;
536  owl_viewwin *vwin;
537  int winactive;
538  pid_t pid;                    /* or 0 if it has terminated */
539  guint io_watch;
540} owl_popexec;
541
542typedef struct _owl_global {
543  owl_mainwin mw;
544  owl_popwin *pw;
545  owl_msgwin msgwin;
546  owl_history cmdhist;          /* command history */
547  owl_history msghist;          /* outgoing message history */
548  owl_keyhandler kh;
549  owl_dict filters;
550  GList *filterlist;
551  owl_list puntlist;
552  owl_vardict vars;
553  owl_cmddict cmds;
554  GList *context_stack;
555  owl_errqueue errqueue;
556  int lines, cols;
557  int curmsg, topmsg;
558  int markedmsgid;              /* for finding the marked message when it has moved. */
559  int curmsg_vert_offset;
560  owl_view current_view;
561  owl_messagelist msglist;
562  WINDOW *input_pad;
563  owl_mainpanel mainpanel;
564  gulong typwin_erase_id;
565  int rightshift;
566  bool resizepending;
567  char *homedir;
568  char *confdir;
569  char *startupfile;
570  int direction;
571  int zaway;
572  char *cur_zaway_msg;
573  int haveconfig;
574  int config_format;
575  owl_editwin *tw;
576  owl_viewwin *vw;
577  void *perl;
578  int debug;
579  time_t starttime;
580  time_t lastinputtime;
581  char *startupargs;
582  int nextmsgid;
583  owl_colorpair_mgr cpmgr;
584  pid_t newmsgproc_pid;
585  owl_regex search_re;
586  aim_session_t aimsess;
587  aim_conn_t bosconn;
588  int aim_loggedin;         /* true if currently logged into AIM */
589  GSource *aim_event_source; /* where we get our AIM events from */
590  char *aim_screenname;     /* currently logged in AIM screen name */
591  char *aim_screenname_for_filters;     /* currently logged in AIM screen name */
592  owl_buddylist buddylist;  /* list of logged in AIM buddies */
593  GQueue *messagequeue;     /* for queueing up aim and other messages */
594  owl_dict styledict;       /* global dictionary of available styles */
595  char *response;           /* response to the last question asked */
596  int havezephyr;
597  int haveaim;
598  int ignoreaimlogin;
599  owl_zbuddylist zbuddies;
600  GList *zaldlist;
601  int pseudologin_notify;
602  struct termios startup_tio;
603  guint aim_nop_timer;
604  int load_initial_subs;
605  FILE *debug_file;
606  char *kill_buffer;
607  int interrupt_count;
608  GMutex *interrupt_lock;
609} owl_global;
610
611/* globals */
612extern owl_global g;
613
614#include "owl_prototypes.h"
615
616/* These were missing from the Zephyr includes before Zephyr 3. */
617#if defined HAVE_LIBZEPHYR && defined ZCONST
618int ZGetSubscriptions(ZSubscription_t *, int *);
619int ZGetLocations(ZLocations_t *,int *);
620#endif
621
622#endif /* INC_BARNOWL_OWL_H */
Note: See TracBrowser for help on using the repository browser.