cde/lib/DtHelp/AccessI.h

   1 /* $XConsortium: AccessI.h /main/7 1995/12/18 16:29:56 cde-hp $ */
   2 /************************************<+>*************************************
   3  ****************************************************************************
   4  **
   5  **   File:        AccessI.h
   6  **
   7  **   Project:     Run Time Project File Access
   8  **
   9  **   Description: Header file for Access.h
  10  **
  11  **
  12  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  13  **
  14  **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  15  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  16  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  17  **  (c) Copyright 1993, 1994 Novell, Inc.
  18  **
  19  **
  20  ****************************************************************************
  21  ************************************<+>*************************************/
  22 #ifndef _DtHelpAccessI_h
  23 #define _DtHelpAccessI_h
  24
  25
  26 #ifndef _XtIntrinsic_h
  27 /*
  28  * typedef Boolean
  29  */
  30 #ifdef CRAY
  31 typedef long            Boolean;
  32 #else
  33 typedef char            Boolean;
  34 #endif
  35 #endif
  36
  37 #ifndef _XLIB_H_
  38 #ifndef True
  39 #define True    1
  40 #endif
  41 #ifndef TRUE
  42 #define TRUE    1
  43 #endif
  44 #ifndef False
  45 #define False   0
  46 #endif
  47 #ifndef FALSE
  48 #define FALSE   0
  49 #endif
  50 #endif
  51
  52 /******************************************************************************
  53  *                   Semi-Public Structures
  54  ******************************************************************************/
  55 typedef struct {
  56         char  match;
  57         char *substitution;
  58 } _DtSubstitutionRec;
  59
  60 typedef struct _dtHelpCeLockInfo {
  61         int             fd;
  62         _DtHelpVolumeHdl        volume;
  63 } _DtHelpCeLockInfo;
  64
  65 /******************************************************************************
  66  *                   Semi-Public Access Functions
  67  ******************************************************************************/
  68 extern  char    *_DtHelpCeExpandPathname (
  69                         char               *spec,
  70                         char               *filename,
  71                         char               *type,
  72                         char               *suffix,
  73                         char               *lang,
  74                         _DtSubstitutionRec *subs,
  75                         int                 num );
  76 extern  int      _DtHelpCeFileOpenAndSeek(
  77                         char            *filename,
  78                         int              offset,
  79                         int              fd,
  80                         BufFilePtr      *ret_file,
  81                         time_t          *ret_time);
  82 extern  int      _DtHelpCeGetDocStamp (
  83                         _DtHelpVolumeHdl  volume,
  84                         char            **ret_doc,
  85                         char            **ret_time);
  86 extern  int      _DtHelpCeGetLangSubParts (
  87                         char             *lang,
  88                         char            **subLang,
  89                         char            **subTer,
  90                         char            **subCodeSet );
  91 extern  int      _DtHelpCeGetTopicChildren(
  92                         _DtHelpVolumeHdl  volume,
  93                         char             *topic_id,
  94                         char            ***ret_childs);
  95 extern  int      _DtHelpGetTopicTitle(
  96                         _DtHelpVolumeHdl  volume,
  97                         char             *target_id,
  98                         char            **ret_title);
  99 extern  int      _DtHelpCeGetUncompressedFileName (
 100                         char              *name,
 101                         char             **ret_name);
 102 extern  const char *_DtHelpCeGetVolumeCharSet (
 103                         _DtHelpVolumeHdl  volume);
 104 extern  int      _DtHelpCeGetVolumeFlag (
 105                         _DtHelpVolumeHdl  volume);
 106 extern  int      _DtHelpCeIsTopTopic(
 107                         _DtHelpVolumeHdl   volume,
 108                         const char        *id);
 109 extern  int      _DtHelpCeLockVolume(
 110                         _DtHelpVolumeHdl   volume,
 111                         _DtHelpCeLockInfo *ret_info);
 112 extern  int      _DtHelpCeMapTargetToId (
 113                         _DtHelpVolumeHdl  volume,
 114                         char             *target_id,
 115                         char            **ret_id);
 116 extern  int      _DtHelpCeUnlockVolume(_DtHelpCeLockInfo lock_info);
 117 #endif /* _DtHelpAccessI_h */