source: owl.h @ 7155955

release-1.10
Last change on this file since 7155955 was bbc31e4, checked in by David Benjamin <davidben@mit.edu>, 12 years ago
Whitespace that I don't feel like rebasing Sigh. Tabs and spaces.
  • Property mode set to 100644
File size: 17.8 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#include <stdbool.h>
17
18#ifndef OWL_PERL
19#define NCURSES_ENABLE_STDBOOL_H 1
20#include <ncursesw/curses.h>
21#include <ncursesw/panel.h>
22#endif
23#include <sys/param.h>
24#include <sys/types.h>
25#include <ctype.h>
26#include <errno.h>
27#include <EXTERN.h>
28#include <fcntl.h>
29#include <netdb.h>
30#include <regex.h>
31#include <time.h>
32#include <signal.h>
33#include <stdlib.h>
34#include <string.h>
35#include <termios.h>
36#include <unistd.h>
37#include "libfaim/aim.h"
38#include <wchar.h>
39#include <glib.h>
40#ifdef HAVE_LIBZEPHYR
41#include <zephyr/zephyr.h>
42#endif
43#ifdef HAVE_COM_ERR_H
44#include <com_err.h>
45#endif
46
47/* Perl and curses don't play nice. */
48#ifdef OWL_PERL
49typedef struct _owl_fake_WINDOW WINDOW;
50typedef struct _owl_fake_PANEL PANEL;
51/* logout is defined in FreeBSD. */
52#define logout logout_
53#define HAS_BOOL
54#include <perl.h>
55#include "owl_perl.h"
56#undef logout
57#include "XSUB.h"
58#else
59typedef struct _owl_fake_SV SV;
60typedef struct _owl_fake_AV AV;
61typedef struct _owl_fake_HV HV;
62#endif
63
64#include "window.h"
65
66#ifndef OWL_VERSION_STRING
67#ifdef  GIT_VERSION
68#define stringify(x)       __stringify(x)
69#define __stringify(x)     #x
70#define OWL_VERSION_STRING stringify(GIT_VERSION)
71#else
72#define OWL_VERSION_STRING PACKAGE_VERSION
73#endif
74#endif /* !OWL_VERSION_STRING */
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
85#define OWL_FMTEXT_ATTR_NONE      0
86#define OWL_FMTEXT_ATTR_BOLD      1
87#define OWL_FMTEXT_ATTR_REVERSE   2
88#define OWL_FMTEXT_ATTR_UNDERLINE 4
89
90#define OWL_FMTEXT_UC_BASE 0x100000 /* Unicode Plane 16 - Supplementary Private Use Area-B*/
91#define OWL_FMTEXT_UC_ATTR ( OWL_FMTEXT_UC_BASE | 0x800 )
92#define OWL_FMTEXT_UC_ATTR_MASK 0x7
93#define OWL_FMTEXT_UC_COLOR_BASE ( OWL_FMTEXT_UC_BASE | 0x400 )
94#define OWL_FMTEXT_UC_FGCOLOR OWL_FMTEXT_UC_COLOR_BASE
95#define OWL_FMTEXT_UC_BGCOLOR ( OWL_FMTEXT_UC_COLOR_BASE | 0x200 )
96#define OWL_FMTEXT_UC_DEFAULT_COLOR 0x100
97#define OWL_FMTEXT_UC_FGDEFAULT ( OWL_FMTEXT_UC_FGCOLOR | OWL_FMTEXT_UC_DEFAULT_COLOR )
98#define OWL_FMTEXT_UC_BGDEFAULT ( OWL_FMTEXT_UC_BGCOLOR | OWL_FMTEXT_UC_DEFAULT_COLOR )
99#define OWL_FMTEXT_UC_COLOR_MASK 0xFF
100#define OWL_FMTEXT_UC_ALLCOLOR_MASK ( OWL_FMTEXT_UC_COLOR_MASK | OWL_FMTEXT_UC_DEFAULT_COLOR | 0x200)
101#define OWL_FMTEXT_UC_STARTBYTE_UTF8 '\xf4'
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_TAB_WIDTH 8
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_DIRECTION_NONE      0
131#define OWL_DIRECTION_DOWNWARDS 1
132#define OWL_DIRECTION_UPWARDS   2
133
134#define OWL_LOGGING_DIRECTION_BOTH 0
135#define OWL_LOGGING_DIRECTION_IN   1
136#define OWL_LOGGING_DIRECTION_OUT  2
137
138#define OWL_SCROLLMODE_NORMAL      0
139#define OWL_SCROLLMODE_TOP         1
140#define OWL_SCROLLMODE_NEARTOP     2
141#define OWL_SCROLLMODE_CENTER      3
142#define OWL_SCROLLMODE_PAGED       4
143#define OWL_SCROLLMODE_PAGEDCENTER 5
144
145#define OWL_TAB               3  /* This *HAS* to be the size of TABSTR below */
146#define OWL_TABSTR        "   "
147#define OWL_MSGTAB            7
148#define OWL_TYPWIN_SIZE       8
149#define OWL_HISTORYSIZE       50
150
151/* Indicate current state, as well as what is allowed */
152#define OWL_CTX_ANY          0xffff
153/* Only one of these may be active at a time... */
154#define OWL_CTX_MODE_BITS    0x000f
155#define OWL_CTX_STARTUP      0x0001
156#define OWL_CTX_READCONFIG   0x0002
157#define OWL_CTX_INTERACTIVE  0x0004
158/* Only one of these may be active at a time... */
159#define OWL_CTX_ACTIVE_BITS  0xfff0
160#define OWL_CTX_POPWIN       0x00f0
161#define OWL_CTX_POPLESS      0x0010
162#define OWL_CTX_RECWIN       0x0f00
163#define OWL_CTX_RECV         0x0100
164#define OWL_CTX_TYPWIN       0xf000
165#define OWL_CTX_EDIT         0x7000
166#define OWL_CTX_EDITLINE     0x1000
167#define OWL_CTX_EDITMULTI    0x2000
168#define OWL_CTX_EDITRESPONSE 0x4000
169
170#define OWL_VARIABLE_OTHER      0
171#define OWL_VARIABLE_INT        1
172#define OWL_VARIABLE_BOOL       2
173#define OWL_VARIABLE_STRING     3
174
175#define OWL_OUTPUT_RETURN       0
176#define OWL_OUTPUT_POPUP        1
177#define OWL_OUTPUT_ADMINMSG     2
178
179#define OWL_FILTER_MAX_DEPTH    300
180
181#define OWL_KEYMAP_MAXSTACK     20
182
183#define OWL_KEYBINDING_NOOP     0   /* dummy binding that does nothing */
184#define OWL_KEYBINDING_COMMAND  1   /* command string */
185#define OWL_KEYBINDING_FUNCTION 2   /* function taking no args */
186
187#define OWL_DEFAULT_ZAWAYMSG    "I'm sorry, but I am currently away from the terminal and am\nnot able to receive your message.\n"
188#define OWL_DEFAULT_AAWAYMSG    "I'm sorry, but I am currently away from the terminal and am\nnot able to receive your message.\n"
189
190#define OWL_CMD_ALIAS_SUMMARY_PREFIX "command alias to: "
191
192#define OWL_WEBZEPHYR_PRINCIPAL "daemon/webzephyr.mit.edu"
193#define OWL_WEBZEPHYR_CLASS     "webzephyr"
194#define OWL_WEBZEPHYR_OPCODE    "webzephyr"
195
196#define OWL_ZEPHYR_NOSTRIP_HOST         "host/"
197#define OWL_ZEPHYR_NOSTRIP_RCMD         "rcmd."
198#define OWL_ZEPHYR_NOSTRIP_DAEMON5      "daemon/"
199#define OWL_ZEPHYR_NOSTRIP_DAEMON4      "daemon."
200
201#define OWL_REGEX_QUOTECHARS    "!+*.?[]^\\${}()|"
202#define OWL_REGEX_QUOTEWITH     "\\"
203
204#if defined(HAVE_DES_STRING_TO_KEY) && defined(HAVE_DES_KEY_SCHED) && defined(HAVE_DES_ECB_ENCRYPT)
205#define OWL_ENABLE_ZCRYPT 1
206#endif
207
208/* Annotate functions in which the caller owns the return value and is
209 * responsible for ensuring it is freed. */
210#define CALLER_OWN G_GNUC_WARN_UNUSED_RESULT
211
212#define OWL_META(key) ((key)|010000)
213/* OWL_CTRL is definied in kepress.c */
214
215#ifdef HAVE_LIBZEPHYR
216/* libzephyr doesn't use const, so we appease the type system with this kludge.
217 * This just casts const char * to char * in a way that doesn't yield a warning
218 * from gcc -Wcast-qual. */
219static inline char *zstr(const char *str)
220{
221  union { char *rw; const char *ro; } u;
222  u.ro = str;
223  return u.rw;
224}
225#endif
226
227/* Convert char *const * into const char *const *.  This conversion is safe,
228 * and implicit in C++ (conv.qual 4) but for some reason not in C. */
229static inline const char *const *strs(char *const *pstr)
230{
231  return (const char *const *)pstr;
232}
233
234typedef struct _owl_variable {
235  char *name;
236  int   type;  /* OWL_VARIABLE_* */
237  char *default_str;            /* the default value as a string */
238  char *validsettings;          /* documentation of valid settings */
239  char *summary;                /* summary of usage */
240  char *description;            /* detailed description */
241  bool takes_on_off;            /* allow passing on/off in argument-less set/unset */
242  GClosure *set_fromstring_fn;
243                                /* sets the variable to a value
244                                 * of the appropriate type.
245                                 * unless documented, this
246                                 * should make a copy.
247                                 * returns 0 on success. */
248  GClosure *get_tostring_fn;
249                                /* converts val to a string;
250                                 * caller must free the result */
251
252  /* These are only valid for OWL_VARIABLE_{INT,BOOL,STRING} */
253  GValue val;                   /* current value, if default get_fn/set_fn */
254
255  GCallback get_fn;
256                                /* returns a reference to the current value.
257                                 * WARNING:  this approach is hard to make
258                                 * thread-safe... */
259  GCallback validate_fn;
260                                /* returns 1 if newval is valid */
261  GCallback set_fn;
262                                /* sets the variable to a value
263                                 * of the appropriate type.
264                                 * unless documented, this
265                                 * should make a copy.
266                                 * returns 0 on success. */
267} owl_variable;
268
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_dict_el {
280  char *k;                      /* key   */
281  void *v;                      /* value */
282} owl_dict_el;
283
284typedef struct _owl_dict {
285  int size;
286  int avail;
287  owl_dict_el *els;             /* invariant: sorted by k */
288} owl_dict;
289typedef owl_dict owl_vardict;   /* dict of variables */
290typedef owl_dict owl_cmddict;   /* dict of commands */
291
292typedef struct _owl_context {
293  int   mode;
294  void *data;           /* determined by mode */
295  char *keymap;
296  owl_window *cursor;
297  void (*deactivate_cb)(struct _owl_context*);
298  void (*delete_cb)(struct _owl_context*);
299  void *cbdata;
300} owl_context;
301
302typedef struct _owl_cmd {       /* command */
303  char *name;
304
305  char *summary;                /* one line summary of command */
306  char *usage;                  /* usage synopsis */
307  char *description;            /* long description of command */
308
309  int validctx;                 /* bitmask of valid contexts */
310
311  /* we should probably have a type here that says which of
312   * the following is valid, and maybe make the below into a union... */
313
314  /* Only one of these may be non-NULL ... */
315
316  char *cmd_aliased_to;         /* what this command is aliased to... */
317 
318  /* These don't take any context */
319  CALLER_OWN char *(*cmd_args_fn)(int argc, const char *const *argv, const char *buff);
320                                /* takes argv and the full command as buff.
321                                 * caller must free return value if !NULL */
322  void (*cmd_v_fn)(void);       /* takes no args */
323  void (*cmd_i_fn)(int i);      /* takes an int as an arg */
324
325  /* The following also take the active context if it's valid */
326  CALLER_OWN char *(*cmd_ctxargs_fn)(void *ctx, int argc, const char *const *argv, const char *buff);
327                                /* takes argv and the full command as buff.
328                                 * caller must free return value if !NULL */
329  void (*cmd_ctxv_fn)(void *ctx);               /* takes no args */
330  void (*cmd_ctxi_fn)(void *ctx, int i);        /* takes an int as an arg */
331  SV *cmd_perl;                                /* Perl closure that takes a list of args */
332} owl_cmd;
333
334
335typedef struct _owl_zwrite {
336  char *cmd;
337  char *zwriteline;
338  char *class;
339  char *inst;
340  char *realm;
341  char *opcode;
342  char *zsig;
343  char *message;
344  GPtrArray *recips;
345  int cc;
346  int noping;
347} owl_zwrite;
348
349typedef struct _owl_pair {
350  const char *key;
351  char *value;
352} owl_pair;
353
354struct _owl_fmtext_cache;
355
356typedef struct _owl_message {
357  int id;
358  int direction;
359#ifdef HAVE_LIBZEPHYR
360  bool has_notice;
361  ZNotice_t notice;
362#endif
363  struct _owl_fmtext_cache * fmtext;
364  int delete;
365  const char *hostname;
366  GPtrArray *attributes;          /* this is a list of pairs */
367  char *timestr;
368  time_t time;
369} owl_message;
370
371#define OWL_FMTEXT_CACHE_SIZE 1000
372/* We cache the saved fmtexts for the last bunch of messages we
373   rendered */
374typedef struct _owl_fmtext_cache {
375    owl_message * message;
376    owl_fmtext fmtext;
377} owl_fmtext_cache;
378
379typedef struct _owl_style {
380  char *name;
381  SV *perlobj;
382} owl_style;
383
384typedef struct _owl_mainwin {
385  int curtruncated;
386  int lasttruncated;
387  int lastdisplayed;
388  owl_window *window;
389} owl_mainwin;
390
391typedef struct _owl_editwin owl_editwin;
392typedef struct _owl_editwin_excursion owl_editwin_excursion;
393
394typedef struct _owl_viewwin {
395  owl_fmtext fmtext;
396  int textlines;
397  int topline;
398  int rightshift;
399  owl_window *window;
400  void (*onclose_hook) (struct _owl_viewwin *vwin, void *data);
401  void *onclose_hook_data;
402
403  gulong sig_resize_id;
404  owl_window *content;
405  gulong sig_content_redraw_id;
406  owl_window *status;
407  gulong sig_status_redraw_id;
408  owl_window *cmdwin;
409} owl_viewwin;
410 
411typedef struct _owl_popwin {
412  owl_window *border;
413  owl_window *content;
414  gulong sig_redraw_id;
415  gulong sig_resize_id;
416} owl_popwin;
417 
418typedef struct _owl_msgwin {
419  char *msg;
420  owl_window *window;
421  gulong redraw_id;
422} owl_msgwin;
423
424typedef struct _owl_messagelist {
425  GPtrArray *list;
426} owl_messagelist;
427
428typedef struct _owl_regex {
429  int negate;
430  char *string;
431  regex_t re;
432} owl_regex;
433
434typedef struct _owl_filterelement {
435  int (*match_message)(const struct _owl_filterelement *fe, const owl_message *m);
436  /* Append a string representation of the filterelement onto buf*/
437  void (*print_elt)(const struct _owl_filterelement *fe, GString *buf);
438  /* Operands for and,or,not*/
439  struct _owl_filterelement *left, *right;
440  /* For regex filters*/
441  owl_regex re;
442  /* Used by regexes, filter references, and perl */
443  char *field;
444} owl_filterelement;
445
446typedef struct _owl_filter {
447  char *name;
448  owl_filterelement * root;
449  int fgcolor;
450  int bgcolor;
451} owl_filter;
452
453typedef struct _owl_view {
454  char *name;
455  owl_filter *filter;
456  owl_messagelist *ml;
457  const owl_style *style;
458  int cachedmsgid;
459} owl_view;
460
461typedef struct _owl_history {
462  GQueue hist;
463  GList *cur;
464  bool partial;
465} owl_history;
466
467typedef struct _owl_mainpanel {
468  owl_window *panel;
469  owl_window *typwin;
470  owl_window *sepwin;
471  owl_window *msgwin;
472  owl_window *recwin;
473  int recwinlines;
474} owl_mainpanel;
475
476typedef struct _owl_keybinding {
477  int  *keys;                   /* keypress stack */
478  int   len;                    /* length of stack */
479  int   type;                   /* command or function? */
480  char *desc;                   /* description (or "*user*") */
481  char *command;                /* command, if of type command */
482  void (*function_fn)(void);    /* function ptr, if of type function */
483} owl_keybinding;
484
485typedef struct _owl_keymap {
486  char     *name;               /* name of keymap */
487  char     *desc;               /* description */
488  GPtrArray *bindings;          /* key bindings */
489  const struct _owl_keymap *parent;     /* parent */
490  void (*default_fn)(owl_input j);      /* default action (takes a keypress) */
491  void (*prealways_fn)(owl_input  j);   /* always called before a keypress is received */
492  void (*postalways_fn)(owl_input  j);  /* always called after keypress is processed */
493} owl_keymap;
494
495typedef struct _owl_keyhandler {
496  owl_dict  keymaps;            /* dictionary of keymaps */
497  const owl_keymap *active;             /* currently active keymap */
498  int       in_esc;             /* escape pressed? */
499  int       kpstack[OWL_KEYMAP_MAXSTACK+1]; /* current stack of keypresses */
500  int       kpstackpos;         /* location in stack (-1 = none) */
501} owl_keyhandler;
502
503typedef struct _owl_buddy {
504  int proto;
505  char *name;
506  int isidle;
507  int idlesince;
508} owl_buddy;
509
510typedef struct _owl_buddylist {
511  GPtrArray *buddies;
512} owl_buddylist;
513
514typedef struct _owl_zbuddylist {
515  GPtrArray *zusers;
516} owl_zbuddylist;
517
518typedef struct _owl_errqueue {
519  GPtrArray *errlist;
520} owl_errqueue;
521
522typedef struct _owl_colorpair_mgr {
523  int next;
524  short **pairs;
525  bool overflow;
526} owl_colorpair_mgr;
527
528typedef struct _owl_popexec {
529  int refcount;
530  owl_viewwin *vwin;
531  int winactive;
532  pid_t pid;                    /* or 0 if it has terminated */
533  guint io_watch;
534} owl_popexec;
535
536typedef struct _owl_global {
537  owl_mainwin *mw;
538  owl_popwin *pw;
539  owl_msgwin msgwin;
540  owl_history cmdhist;          /* command history */
541  owl_history msghist;          /* outgoing message history */
542  owl_keyhandler kh;
543  owl_dict filters;
544  GList *filterlist;
545  GPtrArray *puntlist;
546  owl_vardict vars;
547  owl_cmddict cmds;
548  GList *context_stack;
549  owl_errqueue errqueue;
550  int lines, cols;
551  int curmsg, topmsg;
552  int markedmsgid;              /* for finding the marked message when it has moved. */
553  int curmsg_vert_offset;
554  owl_view current_view;
555  owl_messagelist *msglist;
556  WINDOW *input_pad;
557  owl_mainpanel mainpanel;
558  gulong typwin_erase_id;
559  int rightshift;
560  bool resizepending;
561  char *homedir;
562  char *confdir;
563  char *startupfile;
564  int direction;
565  int haveconfig;
566  int config_format;
567  owl_editwin *tw;
568  owl_viewwin *vw;
569  void *perl;
570  int debug;
571  time_t starttime;
572  time_t lastinputtime;
573  char *startupargs;
574  int nextmsgid;
575  owl_colorpair_mgr cpmgr;
576  pid_t newmsgproc_pid;
577  owl_regex search_re;
578  aim_session_t aimsess;
579  aim_conn_t bosconn;
580  int aim_loggedin;         /* true if currently logged into AIM */
581  GSource *aim_event_source; /* where we get our AIM events from */
582  char *aim_screenname;     /* currently logged in AIM screen name */
583  char *aim_screenname_for_filters;     /* currently logged in AIM screen name */
584  owl_buddylist buddylist;  /* list of logged in AIM buddies */
585  GQueue *messagequeue;     /* for queueing up aim and other messages */
586  owl_dict styledict;       /* global dictionary of available styles */
587  char *response;           /* response to the last question asked */
588  int havezephyr;
589  int haveaim;
590  int ignoreaimlogin;
591  owl_zbuddylist zbuddies;
592  GList *zaldlist;
593  int pseudologin_notify;
594  struct termios startup_tio;
595  guint aim_nop_timer;
596  int load_initial_subs;
597  FILE *debug_file;
598  char *kill_buffer;
599  int interrupt_count;
600#if GLIB_CHECK_VERSION(2, 31, 0)
601  GMutex interrupt_lock;
602#else
603  GMutex *interrupt_lock;
604#endif
605} owl_global;
606
607/* globals */
608extern owl_global g;
609
610#include "owl_prototypes.h"
611
612/* These were missing from the Zephyr includes before Zephyr 3. */
613#if defined HAVE_LIBZEPHYR && defined ZCONST
614int ZGetSubscriptions(ZSubscription_t *, int *);
615int ZGetLocations(ZLocations_t *,int *);
616#endif
617
618/* We have to dynamically bind these ourselves */
619extern gboolean (*gvalue_from_sv) (GValue * value, SV * sv);
620extern SV * (*sv_from_gvalue) (const GValue * value);
621extern GClosure * (*perl_closure_new) (SV * callback, SV * data, gboolean swap);
622
623
624#endif /* INC_BARNOWL_OWL_H */
Note: See TracBrowser for help on using the repository browser.