help.h

   1   /********************************************************************\
   2   * BitlBee -- An IRC to other IM-networks gateway                     *
   3   *                                                                    *
   4   * Copyright 2002-2004 Wilmer van der Gaast and others                *
   5   \********************************************************************/
   6
   7 /* Help file control                                                    */
   8
   9 /*
  10   This program is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU General Public License as published by
  12   the Free Software Foundation; either version 2 of the License, or
  13   (at your option) any later version.
  14
  15   This program is distributed in the hope that it will be useful,
  16   but WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18   GNU General Public License for more details.
  19
  20   You should have received a copy of the GNU General Public License with
  21   the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
  22   if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  23   Suite 330, Boston, MA  02111-1307  USA
  24 */
  25
  26 #ifndef _HELP_H
  27 #define _HELP_H
  28
  29 typedef union
  30 {
  31         off_t file_offset;
  32         char *mem_offset;
  33 } help_off_t;
  34
  35 typedef struct help
  36 {
  37         int fd;
  38         time_t mtime;
  39         char *title;
  40         help_off_t offset;
  41         int length;
  42         struct help *next;
  43 } help_t;
  44
  45 G_GNUC_MALLOC help_t *help_init( help_t **help, const char *helpfile );
  46 void help_free( help_t **help );
  47 char *help_get( help_t **help, char *title );
  48 int help_add_mem( help_t **help, const char *title, const char *content_ );
  49 char *help_get_whatsnew( help_t **help, int old );
  50
  51 #endif