cde/lib/DtHelp/Access.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: Access.h /main/7 1995/12/18 16:29:36 cde-hp $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  **
  27  **   File:        Access.h
  28  **
  29  **   Project:     Run Time Project File Access
  30  **
  31  **   Description: Header file for Access.h
  32  **
  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 _DtHelpAccess_h
  45 #define _DtHelpAccess_h
  46
  47 /****************************************************************************
  48  *                      Public Defines
  49  ****************************************************************************/
  50 #ifndef True
  51 #define True    1
  52 #endif
  53 #ifndef TRUE
  54 #define TRUE    1
  55 #endif
  56 #ifndef False
  57 #define False   0
  58 #endif
  59 #ifndef FALSE
  60 #define FALSE   0
  61 #endif
  62
  63 typedef void*   _DtHelpVolumeHdl;
  64
  65 /****************************************************************************
  66  *                      Semi-Private Externals
  67  ****************************************************************************/
  68 extern  int      _DtHelpCeCompressPathname ( char *basePath );
  69 extern  char    *_DtHelpCeTraceFilenamePath ( char *file_path );
  70 extern  char    *_DtHelpCeTracePathName ( char *path );
  71
  72 /****************************************************************************
  73  *                      Semi-Public Externals
  74  ****************************************************************************/
  75 extern  int      _DtHelpCloseVolume (
  76                                 _DtHelpVolumeHdl vol );
  77 extern  int      _DtHelpCeFindId (
  78                                 _DtHelpVolumeHdl  vol,
  79                                 char             *target_id,
  80                                 int               fd,
  81                                 char            **ret_name,
  82                                 int              *ret_offset );
  83 extern  int      _DtHelpCeFindKeyword (
  84                                 _DtHelpVolumeHdl   vol,
  85                                 char              *target,
  86                                 char            ***ret_ids );
  87 extern  int      _DtHelpCeGetKeywordList (
  88                                 _DtHelpVolumeHdl   vol,
  89                                 char            ***ret_keywords );
  90 extern  int      _DtHelpCeGetTopTopicId (
  91                                 _DtHelpVolumeHdl  vol,
  92                                 char            **ret_idString );
  93 extern  char    *_DtHelpCeGetVolumeName(
  94                                 _DtHelpVolumeHdl   vol);
  95 extern  char    *_DtHelpGetVolumeLocale (
  96                                 _DtHelpVolumeHdl  volume);
  97 extern  int      _DtHelpOpenVolume (
  98                                 char            *volFile,
  99                                 _DtHelpVolumeHdl*retVol );
 100 extern  int      _DtHelpCeUpVolumeOpenCnt (
 101                                 _DtHelpVolumeHdl   volume);
 102 #endif /* _DtHelpAccess_h */