cde/lib/DtHelp/FormatSDLI.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 libraries 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: FormatSDLI.h /main/5 1995/10/26 12:22:04 rswiston $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  **  File:  FormatSDLI.h
  27  **  Project:  Common Desktop Environment
  28  **
  29  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  30  **
  31  **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  32  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  33  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  34  **  (c) Copyright 1993, 1994 Novell, Inc.
  35  ****************************************************************************
  36  ************************************<+>*************************************/
  37 #ifndef _DtHelpFormatSDLI_h
  38 #define _DtHelpFormatSDLI_h
  39
  40 #include <sys/stat.h>
  41
  42 /********    Semi-Private Function Declarations    ********/
  43 extern  int                      _DtHelpCeFrmtSDLTitleToAscii(
  44                                         _DtHelpVolumeHdl volume_handle,
  45                                         int              offset,
  46                                         char            **ret_title,
  47                                         char            **ret_abbrev);
  48 extern  char                    *_DtHelpCeFrmtSdlVolumeAbstractToAscii(
  49                                         _DtHelpVolumeHdl volume);
  50 extern  int                      _DtHelpCeFrmtSdlPathAndChildren(
  51                                         _DtHelpVolumeHdl volume,
  52                                         _FrmtUiInfo     *ui_info,
  53                                         int              fd,
  54                                         char            *target_id,
  55                                         _DtCvTopicPtr   *ret_handle);
  56 extern  int                      _DtHelpCeGetSdlTitleChunks(
  57                                         _DtHelpVolumeHdl volume,
  58                                         char            *loc_id,
  59                                         _FrmtUiInfo     *ui_info,
  60                                         void            ***ret_chunks);
  61 extern  int                      _DtHelpCeGetSdlVolIds(
  62                                         _DtHelpVolumeHdl volume,
  63                                         int              fd,
  64                                         _DtCvSegment    **ret_loids);
  65 extern  int                      _DtHelpCeGetSdlVolIndex(
  66                                         _DtHelpVolumeHdl         volume);
  67 extern  int                      _DtHelpCeGetSdlVolTitleChunks(
  68                                         _DtHelpVolumeHdl volume,
  69                                         _FrmtUiInfo     *ui_info,
  70                                         void            ***ret_chunks);
  71 extern  int                      _DtHelpCeFrmtSDLVolTitleToAscii(
  72                                         _DtHelpVolumeHdl volume,
  73                                         _FrmtUiInfo     *ui_info,
  74                                         char            **ret_title);
  75 extern  _DtCvSegment            *_DtHelpCeGetSdlVolToss(
  76                                         _DtHelpVolumeHdl volume,
  77                                         int              fd);
  78 extern  _DtCvSegment            *_DtHelpCeMapIdToLoidEntry(
  79                                         _DtCvSegment       *id_segs,
  80                                         char            *target_id);
  81 extern  int                      _DtHelpCeFrmtSdlVolumeInfo(
  82                                         char            *filename,
  83                                         _DtHelpVolumeHdl volume,
  84                                         time_t          *ret_time);
  85 extern  const SDLAttribute      *_DtHelpCeGetSdlAttributeList(void);
  86 extern  int                      _DtHelpCeParseSdlTopic(
  87                                         _DtHelpVolumeHdl volume,
  88                                         _FrmtUiInfo     *ui_info,
  89                                         int              fd,
  90                                         int              offset,
  91                                         char            *id_string,
  92                                         int              rich_text,
  93                                         _DtCvTopicPtr   *ret_handle);
  94
  95 /********    End Public Function Declarations    ********/
  96
  97 #endif /* _DtHelpFormatSDLI_h */