source: owl.h @ 820e852

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