cde/lib/DtHelp/AccessP.h

   1 /*
   2  * CDE - Common Desktop Environment
   3  *
   4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
   5  *
   6  * These libraries and programs are free software; you can
   7  * redistribute them and/or modify them under the terms of the GNU
   8  * Lesser General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * These libraries and programs are distributed in the hope that
  13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
  14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE. See the GNU Lesser General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with these librararies and programs; if not, write
  20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  21  * Floor, Boston, MA 02110-1301 USA
  22  */
  23 /* $XConsortium: AccessP.h /main/5 1995/12/18 16:30:01 cde-hp $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  **
  27  **   File:        AccessP.h
  28  **
  29  **   Project:     Run Time Project File Access
  30  **
  31  **
  32  **   Description: Private header file for Access.h
  33  **
  34  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  35  **
  36  **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  37  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  38  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  39  **  (c) Copyright 1993, 1994 Novell, Inc.
  40  **
  41  **
  42  ****************************************************************************
  43  ************************************<+>*************************************/
  44 #ifndef _DtAccessP_h
  45 #define _DtAccessP_h
  46
  47 #include <sys/stat.h>
  48 typedef void*   SdlVolumeHandle;
  49 typedef void*   CcdfVolumeHandle;
  50
  51 typedef union _dthelpVolumes {
  52         SdlVolumeHandle sdl_vol;
  53         CcdfVolumeHandle ccdf_vol;
  54 } DtHelpVols;
  55
  56 /*
  57  * The following structure holds loaded volumes.  The fields of this
  58  * structure should not be accessed by any code outside of the volume
  59  * module.
  60  */
  61 struct _DtHelpVolumeRec {
  62     short       sdl_flag;       /* The type of volume */
  63     char *volFile;              /* The name of the volume file in the */
  64                                 /* form it was passed to _DtVolumeOpen. */
  65
  66     char **keywords;            /* A pointer to a string array */
  67                                 /* containing all of the keywords in */
  68                                 /* sorted order.  This field is not loaded */
  69                                 /* until it is needed. */
  70
  71     char ***keywordTopics;      /* A pointer to an array of string */
  72                                 /* arrays.  Each string array specifies */
  73                                 /* the list of topics which contain the */
  74                                 /* corresponding keyword.  This field is  */
  75                                 /* not loaded until it is needed. */
  76
  77     DtHelpVols vols;            /* Handles to format specific volume info */
  78     int openCount;              /* A count of the number of times this */
  79                                 /* volume has been opened. */
  80
  81     time_t check_time;          /* Time this volume was last modified */
  82     struct _DtHelpVolumeRec *nextVol;
  83                                 /* A pointer to the next volume, used to */
  84                                 /* chain all of the open volumes together. */
  85 };
  86
  87 typedef struct _DtHelpVolumeRec *_DtHelpVolume;
  88
  89 #endif /* _DtAccessP_h */