source: owl.h @ 3b9ca71

Last change on this file since 3b9ca71 was 3b9ca71, checked in by David Benjamin <davidben@mit.edu>, 8 years ago
Allow perl variables to participate in argumentless set/unset
  • Property mode set to 100644
File size: 18.7 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
269typedef struct _owl_variable_init_params {
270  const char *name;
271  int   type;  /* OWL_VARIABLE_* */
272  const char *pval_default;     /* for string */
273  int   ival_default;           /* for types int and bool     */
274  const char *validsettings;    /* documentation of valid settings */
275  const char *summary;          /* summary of usage */
276  const char *description;      /* detailed description */
277  void *val;                    /* current value */
278  GCallback validate_fn;
279                                /* returns 1 if newval is valid */
280  GCallback set_fn;
281                                /* sets the variable to a value
282                                 * of the appropriate type.
283                                 * unless documented, this
284                                 * should make a copy.
285                                 * returns 0 on success. */
286  GCallback set_fromstring_fn;
287                                /* sets the variable to a value
288                                 * of the appropriate type.
289                                 * unless documented, this
290                                 * should make a copy.
291                                 * returns 0 on success. */
292  GCallback get_fn;
293                                /* returns a reference to the current value.
294                                 * WARNING:  this approach is hard to make
295                                 * thread-safe... */
296  GCallback get_tostring_fn;
297                                /* converts val to a string;
298                                 * caller must free the result */
299} owl_variable_init_params;
300
301
302typedef struct _owl_input {
303  int ch;
304  gunichar uch;
305} owl_input;
306
307typedef struct _owl_fmtext {
308  GString *buff;
309} owl_fmtext;
310
311typedef struct _owl_dict_el {
312  char *k;                      /* key   */
313  void *v;                      /* value */
314} owl_dict_el;
315
316typedef struct _owl_dict {
317  int size;
318  int avail;
319  owl_dict_el *els;             /* invariant: sorted by k */
320} owl_dict;
321typedef owl_dict owl_vardict;   /* dict of variables */
322typedef owl_dict owl_cmddict;   /* dict of commands */
323
324typedef struct _owl_context {
325  int   mode;
326  void *data;           /* determined by mode */
327  char *keymap;
328  owl_window *cursor;
329  void (*deactivate_cb)(struct _owl_context*);
330  void (*delete_cb)(struct _owl_context*);
331  void *cbdata;
332} owl_context;
333
334typedef struct _owl_cmd {       /* command */
335  char *name;
336
337  char *summary;                /* one line summary of command */
338  char *usage;                  /* usage synopsis */
339  char *description;            /* long description of command */
340
341  int validctx;                 /* bitmask of valid contexts */
342
343  /* we should probably have a type here that says which of
344   * the following is valid, and maybe make the below into a union... */
345
346  /* Only one of these may be non-NULL ... */
347
348  char *cmd_aliased_to;         /* what this command is aliased to... */
349 
350  /* These don't take any context */
351  CALLER_OWN char *(*cmd_args_fn)(int argc, const char *const *argv, const char *buff);
352                                /* takes argv and the full command as buff.
353                                 * caller must free return value if !NULL */
354  void (*cmd_v_fn)(void);       /* takes no args */
355  void (*cmd_i_fn)(int i);      /* takes an int as an arg */
356
357  /* The following also take the active context if it's valid */
358  CALLER_OWN char *(*cmd_ctxargs_fn)(void *ctx, int argc, const char *const *argv, const char *buff);
359                                /* takes argv and the full command as buff.
360                                 * caller must free return value if !NULL */
361  void (*cmd_ctxv_fn)(void *ctx);               /* takes no args */
362  void (*cmd_ctxi_fn)(void *ctx, int i);        /* takes an int as an arg */
363  SV *cmd_perl;                                /* Perl closure that takes a list of args */
364} owl_cmd;
365
366
367typedef struct _owl_zwrite {
368  char *cmd;
369  char *zwriteline;
370  char *class;
371  char *inst;
372  char *realm;
373  char *opcode;
374  char *zsig;
375  char *message;
376  GPtrArray *recips;
377  int cc;
378  int noping;
379} owl_zwrite;
380
381typedef struct _owl_pair {
382  const char *key;
383  char *value;
384} owl_pair;
385
386struct _owl_fmtext_cache;
387
388typedef struct _owl_message {
389  int id;
390  int direction;
391#ifdef HAVE_LIBZEPHYR
392  bool has_notice;
393  ZNotice_t notice;
394#endif
395  struct _owl_fmtext_cache * fmtext;
396  int delete;
397  const char *hostname;
398  GPtrArray *attributes;          /* this is a list of pairs */
399  char *timestr;
400  time_t time;
401} owl_message;
402
403#define OWL_FMTEXT_CACHE_SIZE 1000
404/* We cache the saved fmtexts for the last bunch of messages we
405   rendered */
406typedef struct _owl_fmtext_cache {
407    owl_message * message;
408    owl_fmtext fmtext;
409} owl_fmtext_cache;
410
411typedef struct _owl_style {
412  char *name;
413  SV *perlobj;
414} owl_style;
415
416typedef struct _owl_mainwin {
417  int curtruncated;
418  int lasttruncated;
419  int lastdisplayed;
420  owl_window *window;
421} owl_mainwin;
422
423typedef struct _owl_editwin owl_editwin;
424typedef struct _owl_editwin_excursion owl_editwin_excursion;
425
426typedef struct _owl_viewwin {
427  owl_fmtext fmtext;
428  int textlines;
429  int topline;
430  int rightshift;
431  owl_window *window;
432  void (*onclose_hook) (struct _owl_viewwin *vwin, void *data);
433  void *onclose_hook_data;
434
435  gulong sig_resize_id;
436  owl_window *content;
437  gulong sig_content_redraw_id;
438  owl_window *status;
439  gulong sig_status_redraw_id;
440  owl_window *cmdwin;
441} owl_viewwin;
442 
443typedef struct _owl_popwin {
444  owl_window *border;
445  owl_window *content;
446  gulong sig_redraw_id;
447  gulong sig_resize_id;
448} owl_popwin;
449 
450typedef struct _owl_msgwin {
451  char *msg;
452  owl_window *window;
453  gulong redraw_id;
454} owl_msgwin;
455
456typedef struct _owl_messagelist {
457  GPtrArray *list;
458} owl_messagelist;
459
460typedef struct _owl_regex {
461  int negate;
462  char *string;
463  regex_t re;
464} owl_regex;
465
466typedef struct _owl_filterelement {
467  int (*match_message)(const struct _owl_filterelement *fe, const owl_message *m);
468  /* Append a string representation of the filterelement onto buf*/
469  void (*print_elt)(const struct _owl_filterelement *fe, GString *buf);
470  /* Operands for and,or,not*/
471  struct _owl_filterelement *left, *right;
472  /* For regex filters*/
473  owl_regex re;
474  /* Used by regexes, filter references, and perl */
475  char *field;
476} owl_filterelement;
477
478typedef struct _owl_filter {
479  char *name;
480  owl_filterelement * root;
481  int fgcolor;
482  int bgcolor;
483} owl_filter;
484
485typedef struct _owl_view {
486  char *name;
487  owl_filter *filter;
488  owl_messagelist *ml;
489  const owl_style *style;
490  int cachedmsgid;
491} owl_view;
492
493typedef struct _owl_history {
494  GQueue hist;
495  GList *cur;
496  bool partial;
497} owl_history;
498
499typedef struct _owl_mainpanel {
500  owl_window *panel;
501  owl_window *typwin;
502  owl_window *sepwin;
503  owl_window *msgwin;
504  owl_window *recwin;
505  int recwinlines;
506} owl_mainpanel;
507
508typedef struct _owl_keybinding {
509  int  *keys;                   /* keypress stack */
510  int   len;                    /* length of stack */
511  int   type;                   /* command or function? */
512  char *desc;                   /* description (or "*user*") */
513  char *command;                /* command, if of type command */
514  void (*function_fn)(void);    /* function ptr, if of type function */
515} owl_keybinding;
516
517typedef struct _owl_keymap {
518  char     *name;               /* name of keymap */
519  char     *desc;               /* description */
520  GPtrArray *bindings;          /* key bindings */
521  const struct _owl_keymap *parent;     /* parent */
522  void (*default_fn)(owl_input j);      /* default action (takes a keypress) */
523  void (*prealways_fn)(owl_input  j);   /* always called before a keypress is received */
524  void (*postalways_fn)(owl_input  j);  /* always called after keypress is processed */
525} owl_keymap;
526
527typedef struct _owl_keyhandler {
528  owl_dict  keymaps;            /* dictionary of keymaps */
529  const owl_keymap *active;             /* currently active keymap */
530  int       in_esc;             /* escape pressed? */
531  int       kpstack[OWL_KEYMAP_MAXSTACK+1]; /* current stack of keypresses */
532  int       kpstackpos;         /* location in stack (-1 = none) */
533} owl_keyhandler;
534
535typedef struct _owl_buddy {
536  int proto;
537  char *name;
538  int isidle;
539  int idlesince;
540} owl_buddy;
541
542typedef struct _owl_buddylist {
543  GPtrArray *buddies;
544} owl_buddylist;
545
546typedef struct _owl_zbuddylist {
547  GPtrArray *zusers;
548} owl_zbuddylist;
549
550typedef struct _owl_errqueue {
551  GPtrArray *errlist;
552} owl_errqueue;
553
554typedef struct _owl_colorpair_mgr {
555  int next;
556  short **pairs;
557  bool overflow;
558} owl_colorpair_mgr;
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  guint io_watch;
566} owl_popexec;
567
568typedef struct _owl_global {
569  owl_mainwin *mw;
570  owl_popwin *pw;
571  owl_msgwin msgwin;
572  owl_history cmdhist;          /* command history */
573  owl_history msghist;          /* outgoing message history */
574  owl_keyhandler kh;
575  owl_dict filters;
576  GList *filterlist;
577  GPtrArray *puntlist;
578  owl_vardict vars;
579  owl_cmddict cmds;
580  GList *context_stack;
581  owl_errqueue errqueue;
582  int lines, cols;
583  int curmsg, topmsg;
584  int markedmsgid;              /* for finding the marked message when it has moved. */
585  int curmsg_vert_offset;
586  owl_view current_view;
587  owl_messagelist *msglist;
588  WINDOW *input_pad;
589  owl_mainpanel mainpanel;
590  gulong typwin_erase_id;
591  int rightshift;
592  bool resizepending;
593  char *homedir;
594  char *confdir;
595  char *startupfile;
596  int direction;
597  int haveconfig;
598  int config_format;
599  owl_editwin *tw;
600  owl_viewwin *vw;
601  void *perl;
602  int debug;
603  time_t starttime;
604  time_t lastinputtime;
605  char *startupargs;
606  int nextmsgid;
607  owl_colorpair_mgr cpmgr;
608  pid_t newmsgproc_pid;
609  owl_regex search_re;
610  aim_session_t aimsess;
611  aim_conn_t bosconn;
612  int aim_loggedin;         /* true if currently logged into AIM */
613  GSource *aim_event_source; /* where we get our AIM events from */
614  char *aim_screenname;     /* currently logged in AIM screen name */
615  char *aim_screenname_for_filters;     /* currently logged in AIM screen name */
616  owl_buddylist buddylist;  /* list of logged in AIM buddies */
617  GQueue *messagequeue;     /* for queueing up aim and other messages */
618  owl_dict styledict;       /* global dictionary of available styles */
619  char *response;           /* response to the last question asked */
620  int havezephyr;
621  int haveaim;
622  int ignoreaimlogin;
623  owl_zbuddylist zbuddies;
624  GList *zaldlist;
625  int pseudologin_notify;
626  struct termios startup_tio;
627  guint aim_nop_timer;
628  int load_initial_subs;
629  FILE *debug_file;
630  char *kill_buffer;
631  int interrupt_count;
632#if GLIB_CHECK_VERSION(2, 31, 0)
633  GMutex interrupt_lock;
634#else
635  GMutex *interrupt_lock;
636#endif
637} owl_global;
638
639/* globals */
640extern owl_global g;
641
642#include "owl_prototypes.h"
643
644/* These were missing from the Zephyr includes before Zephyr 3. */
645#if defined HAVE_LIBZEPHYR && defined ZCONST
646int ZGetSubscriptions(ZSubscription_t *, int *);
647int ZGetLocations(ZLocations_t *,int *);
648#endif
649
650/* We have to dynamically bind these ourselves */
651extern gboolean (*gvalue_from_sv) (GValue * value, SV * sv);
652extern SV * (*sv_from_gvalue) (const GValue * value);
653extern GClosure * (*perl_closure_new) (SV * callback, SV * data, gboolean swap);
654
655
656#endif /* INC_BARNOWL_OWL_H */
Note: See TracBrowser for help on using the repository browser.