cde/lib/DtHelp/FileUtilsI.h

   1 /* $XConsortium: FileUtilsI.h /main/5 1995/10/26 12:19:41 rswiston $ */
   2 /************************************<+>*************************************
   3  ****************************************************************************
   4  **
   5  **   File:        FileUtilsI.h
   6  **
   7  **   Project:     DtHelp Project
   8  **
   9  **   Description: File locating and handling utilities
  10  **
  11  **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  12  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  13  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  14  **  (c) Copyright 1993, 1994 Novell, Inc.
  15  **
  16  **
  17  **
  18  ****************************************************************************
  19  ************************************<+>*************************************/
  20 #ifndef _DtHelpFileUtilsI_h
  21 #define _DtHelpFileUtilsI_h
  22
  23 #define DtHelpVOLUME_TYPE "volumes"      /* dir for %T in XtResolvePathname */
  24 #define DtHelpCCDF_VOL_SUFFIX ".hv"      /* possible basename suffix */
  25 #define DtHelpSDL_VOL_SUFFIX ".sdl"      /* possible basename suffix */
  26
  27 /* array indices and size for use with _DtHelpFileGetSearchPaths() */
  28 #define _DtHELP_FILE_USER_PATH 0
  29 #define _DtHELP_FILE_SYS_PATH  1
  30 #define _DtHELP_FILE_HOME_PATH 2
  31 #define _DtHELP_FILE_NUM_PATHS 3
  32
  33 typedef struct _dtHelpCeDirStruct {
  34         char    *dir_name;
  35         int      type;
  36         int      user_flag;
  37         struct _dtHelpCeDirStruct *next_dir;
  38 } _DtHelpCeDirStruct;
  39
  40 /* list of suffixes that help volumes may have */
  41 extern const char * _DtHelpFileSuffixList[];
  42
  43 extern  int                      _DtHelpCeCheckAndCacheDir(char *dir);
  44 extern  void                     _DtHelpFileGetSearchPaths(
  45                                          char *  paths[],
  46                                          Boolean searchHomeDir);
  47 extern  char                     *_DtHelpFileLocate (
  48                                         char *       type,
  49                                         char *       base,
  50                                         const char * suffixList[],
  51                                         Boolean      searchCurDir,
  52                                         int          accessMode);
  53 extern  Boolean                  _DtHelpFileTraceLinks (
  54                                         char * *  pPathName);
  55 extern  Boolean                  _DtHelpFileTraceToFile (
  56                                         char * *  pPathName,
  57                                         int       accessMode,
  58                                         char * *  pFoundPath);
  59
  60 #endif /* _DtHelpFileUtilsI_h */
  61 /* DON'T ADD ANYTHING AFTER THIS #endif */
  62