source: owl.h @ f271129

release-1.9
Last change on this file since f271129 was f271129, checked in by Jason Gross <jgross@mit.edu>, 10 years ago
Fix up headers The additions to owl.h and some of the removals were done by Alejandro Sedeño <asedeno@mit.edu> in commit 77a0258b3919468fc9d7f7602588ac427ab36e6c. Notes: * I think owl.c lost the need for sys/time.h when we punted select() in favor of glib's main loop. * We don't actually need to include things like stdarg.h, stdio.h, glib/gstdio.h, glib-object.h. I think they get indirectly included via owl.h and/or glib.h. They're left in (or added in to) the files that use functions/types from them. * I'm not entirely sure what sys/socket.h is doing in message.c. It is there from the initial commit. I suspect it might have had something to do with the call to getnameinfo. message.c compiles without it, but http://pubs.opengroup.org/onlinepubs/009695399/functions/getnameinfo.html suggests that we're supposed to include it? *shrugs* I'm leaving it in, for now. (Rather, I'll leave one copy of the #include in.)
  • 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 <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 void WINDOW;
50typedef void 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 void SV;
60typedef void AV;
61typedef void 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  void *pval_default;  /* for types other and string */
238  int   ival_default;  /* for types int and bool     */
239  const char *validsettings;    /* documentation of valid settings */
240  char *summary;                /* summary of usage */
241  char *description;            /* detailed description */
242  void *val;                    /* current value */
243  int  (*validate_fn)(const struct _owl_variable *v, const void *newval);
244                                /* returns 1 if newval is valid */
245  int  (*set_fn)(struct _owl_variable *v, const void *newval); 
246                                /* sets the variable to a value
247                                 * of the appropriate type.
248                                 * unless documented, this
249                                 * should make a copy.
250                                 * returns 0 on success. */
251  int  (*set_fromstring_fn)(struct _owl_variable *v, const char *newval);
252                                /* sets the variable to a value
253                                 * of the appropriate type.
254                                 * unless documented, this
255                                 * should make a copy.
256                                 * returns 0 on success. */
257  const void *(*get_fn)(const struct _owl_variable *v);
258                                /* returns a reference to the current value.
259                                 * WARNING:  this approach is hard to make
260                                 * thread-safe... */
261  CALLER_OWN char *(*get_tostring_fn)(const struct _owl_variable *v, const void *val);
262                                /* converts val to a string;
263                                 * caller must free the result */
264  void (*delete_fn)(struct _owl_variable *v);
265                                /* frees val as needed */
266} owl_variable;
267
268typedef struct _owl_input {
269  int ch;
270  gunichar uch;
271} owl_input;
272
273typedef struct _owl_fmtext {
274  GString *buff;
275} owl_fmtext;
276
277typedef struct _owl_dict_el {
278  char *k;                      /* key   */
279  void *v;                      /* value */
280} owl_dict_el;
281
282typedef struct _owl_dict {
283  int size;
284  int avail;
285  owl_dict_el *els;             /* invariant: sorted by k */
286} owl_dict;
287typedef owl_dict owl_vardict;   /* dict of variables */
288typedef owl_dict owl_cmddict;   /* dict of commands */
289
290typedef struct _owl_context {
291  int   mode;
292  void *data;           /* determined by mode */
293  char *keymap;
294  owl_window *cursor;
295  void (*deactivate_cb)(struct _owl_context*);
296  void (*delete_cb)(struct _owl_context*);
297  void *cbdata;
298} owl_context;
299
300typedef struct _owl_cmd {       /* command */
301  char *name;
302
303  char *summary;                /* one line summary of command */
304  char *usage;                  /* usage synopsis */
305  char *description;            /* long description of command */
306
307  int validctx;                 /* bitmask of valid contexts */
308
309  /* we should probably have a type here that says which of
310   * the following is valid, and maybe make the below into a union... */
311
312  /* Only one of these may be non-NULL ... */
313
314  char *cmd_aliased_to;         /* what this command is aliased to... */
315 
316  /* These don't take any context */
317  CALLER_OWN char *(*cmd_args_fn)(int argc, const char *const *argv, const char *buff);
318                                /* takes argv and the full command as buff.
319                                 * caller must free return value if !NULL */
320  void (*cmd_v_fn)(void);       /* takes no args */
321  void (*cmd_i_fn)(int i);      /* takes an int as an arg */
322
323  /* The following also take the active context if it's valid */
324  CALLER_OWN char *(*cmd_ctxargs_fn)(void *ctx, 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_ctxv_fn)(void *ctx);               /* takes no args */
328  void (*cmd_ctxi_fn)(void *ctx, int i);        /* takes an int as an arg */
329  SV *cmd_perl;                                /* Perl closure that takes a list of args */
330} owl_cmd;
331
332
333typedef struct _owl_zwrite {
334  char *cmd;
335  char *zwriteline;
336  char *class;
337  char *inst;
338  char *realm;
339  char *opcode;
340  char *zsig;
341  char *message;
342  GPtrArray *recips;
343  int cc;
344  int noping;
345} owl_zwrite;
346
347typedef struct _owl_pair {
348  const char *key;
349  char *value;
350} owl_pair;
351
352struct _owl_fmtext_cache;
353
354typedef struct _owl_message {
355  int id;
356  int direction;
357#ifdef HAVE_LIBZEPHYR
358  ZNotice_t notice;
359#endif
360  struct _owl_fmtext_cache * fmtext;
361  int delete;
362  const char *hostname;
363  GPtrArray *attributes;          /* this is a list of pairs */
364  char *timestr;
365  time_t time;
366} owl_message;
367
368#define OWL_FMTEXT_CACHE_SIZE 1000
369/* We cache the saved fmtexts for the last bunch of messages we
370   rendered */
371typedef struct _owl_fmtext_cache {
372    owl_message * message;
373    owl_fmtext fmtext;
374} owl_fmtext_cache;
375
376typedef struct _owl_style {
377  char *name;
378  SV *perlobj;
379} owl_style;
380
381typedef struct _owl_mainwin {
382  int curtruncated;
383  int lasttruncated;
384  int lastdisplayed;
385  owl_window *window;
386} owl_mainwin;
387
388typedef struct _owl_editwin owl_editwin;
389typedef struct _owl_editwin_excursion owl_editwin_excursion;
390
391typedef struct _owl_viewwin {
392  owl_fmtext fmtext;
393  int textlines;
394  int topline;
395  int rightshift;
396  owl_window *window;
397  void (*onclose_hook) (struct _owl_viewwin *vwin, void *data);
398  void *onclose_hook_data;
399
400  gulong sig_resize_id;
401  owl_window *content;
402  gulong sig_content_redraw_id;
403  owl_window *status;
404  gulong sig_status_redraw_id;
405  owl_window *cmdwin;
406} owl_viewwin;
407 
408typedef struct _owl_popwin {
409  owl_window *border;
410  owl_window *content;
411  gulong sig_redraw_id;
412  gulong sig_resize_id;
413} owl_popwin;
414 
415typedef struct _owl_msgwin {
416  char *msg;
417  owl_window *window;
418  gulong redraw_id;
419} owl_msgwin;
420
421typedef struct _owl_messagelist {
422  GPtrArray *list;
423} owl_messagelist;
424
425typedef struct _owl_regex {
426  int negate;
427  char *string;
428  regex_t re;
429} owl_regex;
430
431typedef struct _owl_filterelement {
432  int (*match_message)(const struct _owl_filterelement *fe, const owl_message *m);
433  /* Append a string representation of the filterelement onto buf*/
434  void (*print_elt)(const struct _owl_filterelement *fe, GString *buf);
435  /* Operands for and,or,not*/
436  struct _owl_filterelement *left, *right;
437  /* For regex filters*/
438  owl_regex re;
439  /* Used by regexes, filter references, and perl */
440  char *field;
441} owl_filterelement;
442
443typedef struct _owl_filter {
444  char *name;
445  owl_filterelement * root;
446  int fgcolor;
447  int bgcolor;
448} owl_filter;
449
450typedef struct _owl_view {
451  char *name;
452  owl_filter *filter;
453  owl_messagelist ml;
454  const owl_style *style;
455  int cachedmsgid;
456} owl_view;
457
458typedef struct _owl_history {
459  GQueue hist;
460  GList *cur;
461  bool partial;
462} owl_history;
463
464typedef struct _owl_mainpanel {
465  owl_window *panel;
466  owl_window *typwin;
467  owl_window *sepwin;
468  owl_window *msgwin;
469  owl_window *recwin;
470  int recwinlines;
471} owl_mainpanel;
472
473typedef struct _owl_keybinding {
474  int  *keys;                   /* keypress stack */
475  int   len;                    /* length of stack */
476  int   type;                   /* command or function? */
477  char *desc;                   /* description (or "*user*") */
478  char *command;                /* command, if of type command */
479  void (*function_fn)(void);    /* function ptr, if of type function */
480} owl_keybinding;
481
482typedef struct _owl_keymap {
483  char     *name;               /* name of keymap */
484  char     *desc;               /* description */
485  GPtrArray *bindings;          /* key bindings */
486  const struct _owl_keymap *parent;     /* parent */
487  void (*default_fn)(owl_input j);      /* default action (takes a keypress) */
488  void (*prealways_fn)(owl_input  j);   /* always called before a keypress is received */
489  void (*postalways_fn)(owl_input  j);  /* always called after keypress is processed */
490} owl_keymap;
491
492typedef struct _owl_keyhandler {
493  owl_dict  keymaps;            /* dictionary of keymaps */
494  const owl_keymap *active;             /* currently active keymap */
495  int       in_esc;             /* escape pressed? */
496  int       kpstack[OWL_KEYMAP_MAXSTACK+1]; /* current stack of keypresses */
497  int       kpstackpos;         /* location in stack (-1 = none) */
498} owl_keyhandler;
499
500typedef struct _owl_buddy {
501  int proto;
502  char *name;
503  int isidle;
504  int idlesince;
505} owl_buddy;
506
507typedef struct _owl_buddylist {
508  GPtrArray *buddies;
509} owl_buddylist;
510
511typedef struct _owl_zbuddylist {
512  GPtrArray *zusers;
513} owl_zbuddylist;
514
515typedef struct _owl_errqueue {
516  GPtrArray *errlist;
517} owl_errqueue;
518
519typedef struct _owl_colorpair_mgr {
520  int next;
521  short **pairs;
522  bool overflow;
523} owl_colorpair_mgr;
524
525typedef struct _owl_popexec {
526  int refcount;
527  owl_viewwin *vwin;
528  int winactive;
529  pid_t pid;                    /* or 0 if it has terminated */
530  guint io_watch;
531} owl_popexec;
532
533typedef struct _owl_global {
534  owl_mainwin mw;
535  owl_popwin *pw;
536  owl_msgwin msgwin;
537  owl_history cmdhist;          /* command history */
538  owl_history msghist;          /* outgoing message history */
539  owl_keyhandler kh;
540  owl_dict filters;
541  GList *filterlist;
542  GPtrArray *puntlist;
543  owl_vardict vars;
544  owl_cmddict cmds;
545  GList *context_stack;
546  owl_errqueue errqueue;
547  int lines, cols;
548  int curmsg, topmsg;
549  int markedmsgid;              /* for finding the marked message when it has moved. */
550  int curmsg_vert_offset;
551  owl_view current_view;
552  owl_messagelist msglist;
553  WINDOW *input_pad;
554  owl_mainpanel mainpanel;
555  gulong typwin_erase_id;
556  int rightshift;
557  bool resizepending;
558  char *homedir;
559  char *confdir;
560  char *startupfile;
561  int direction;
562  int haveconfig;
563  int config_format;
564  owl_editwin *tw;
565  owl_viewwin *vw;
566  void *perl;
567  int debug;
568  time_t starttime;
569  time_t lastinputtime;
570  char *startupargs;
571  int nextmsgid;
572  owl_colorpair_mgr cpmgr;
573  pid_t newmsgproc_pid;
574  owl_regex search_re;
575  aim_session_t aimsess;
576  aim_conn_t bosconn;
577  int aim_loggedin;         /* true if currently logged into AIM */
578  GSource *aim_event_source; /* where we get our AIM events from */
579  char *aim_screenname;     /* currently logged in AIM screen name */
580  char *aim_screenname_for_filters;     /* currently logged in AIM screen name */
581  owl_buddylist buddylist;  /* list of logged in AIM buddies */
582  GQueue *messagequeue;     /* for queueing up aim and other messages */
583  owl_dict styledict;       /* global dictionary of available styles */
584  char *response;           /* response to the last question asked */
585  int havezephyr;
586  int haveaim;
587  int ignoreaimlogin;
588  owl_zbuddylist zbuddies;
589  GList *zaldlist;
590  int pseudologin_notify;
591  struct termios startup_tio;
592  guint aim_nop_timer;
593  int load_initial_subs;
594  FILE *debug_file;
595  char *kill_buffer;
596  int interrupt_count;
597  GMutex *interrupt_lock;
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#endif /* INC_BARNOWL_OWL_H */
Note: See TracBrowser for help on using the repository browser.