source: owl.h

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