cde/lib/DtHelp/UtilSDLI.h

   1 /* $XConsortium: UtilSDLI.h /main/8 1996/01/29 12:21:37 cde-hp $ */
   2 /*************************************<+>*************************************
   3  *****************************************************************************
   4  **
   5  **  File:        UtilSDLI.h
   6  **
   7  **  Project:     Cde Help System
   8  **
   9  **  Description: Internal header file for UtilSDL.c
  10  **
  11  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  12  **
  13  **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  14  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  15  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  16  **  (c) Copyright 1993, 1994 Novell, Inc.
  17  **
  18  *****************************************************************************
  19  *************************************<+>*************************************/
  20 #ifndef _DtHelpUtilSDLI_h
  21 #define _DtHelpUtilSDLI_h
  22
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /********     Private Define Declarations    ********/
  29 #define DTD_NAMELEN     64
  30 /******** End Private Define Declarations    ********/
  31
  32 enum    _sdlFontMode
  33   {
  34     _SdlFontModeResolve,
  35     _SdlFontModeSave,
  36     _SdlFontModeNone
  37   };
  38
  39 typedef enum _sdlFontMode  _SdlFontMode;
  40
  41 /********    Private Macro Declarations    ********/
  42
  43 #define _SdlContainerPtrOfSeg(x)        (&((x)->handle.container))
  44
  45 /********    Private Function Declarations    ********/
  46
  47 extern  int     _DtHelpCeAllocateFontStruct (
  48                         int               num,
  49                         _DtHelpFontHints **ret_ptr);
  50 extern  _DtCvString *_DtHelpCeAllocStrStruct(void);
  51 extern  void    _DtHelpCeAddSegToList(
  52                         _DtCvSegment       *seg_ptr,
  53                         _DtCvSegment      **seg_list,
  54                         _DtCvSegment      **last_seg);
  55 extern  int     _DtHelpCeAllocSegment (
  56                         int                 malloc_size,
  57                         int                *alloc_size,
  58                         _DtCvSegment      **next_seg,
  59                         _DtCvSegment      **ret_seg);
  60 extern  int     _DtHelpCeFindSkipSdlElementEnd(
  61                         BufFilePtr        f);
  62 extern  int     _DtHelpCeGetSdlAttribute (
  63                         BufFilePtr       f,
  64                         int              max_len,
  65                         char            *attribute_name);
  66 extern  int     _DtHelpCeGetSdlAttributeCdata (
  67                         BufFilePtr        f,
  68                         _DtCvValue        limit,
  69                         char            **string);
  70 extern  int     _DtHelpCeGetSdlCdata (
  71                         BufFilePtr        f,
  72                         SdlOption         type,
  73                         int               char_len,
  74                         _DtCvValue        nl_to_space,
  75                         _DtCvValue       *cur_space,
  76                         _DtCvValue       *cur_nl,
  77                         _DtCvValue       *cur_mb,
  78                         char             *non_break_char,
  79                         char            **string,
  80                         int              *str_max);
  81 extern  int     _DtHelpCeGetSdlId (
  82                         BufFilePtr        f,
  83                         char            **id_value);
  84 extern  int     _DtHelpCeGetSdlNumber (
  85                         BufFilePtr       f,
  86                         char            *number_string);
  87 extern  int     _DtHelpCeMatchSdlElement (
  88                         BufFilePtr       f,
  89                         const char      *element_str,
  90                         int              sig_chars);
  91 extern  _DtCvSegment *_DtHelpCeMatchSemanticStyle (
  92                         _DtCvSegment    *toss,
  93                         SdlOption        clan,
  94                         int              level,
  95                         char            *ssi);
  96 extern  void    _DtHelpCeMergeSdlAttribInfo(
  97                         _DtCvSegment           *src_toss,
  98                         _DtCvSegment        *dst_contain,
  99                         _DtHelpFontHints    *dst_fonts,
 100                         void                *el_info,
 101                         unsigned long       *str1_values,
 102                         unsigned long       *str2_values);
 103 extern  int     _DtHelpCeReturnSdlElement (
 104                         BufFilePtr        f,
 105                         const SDLElementInfo *el_list,
 106                         _DtCvValue        cdata_flag,
 107                         enum SdlElement *ret_el_define,
 108                         char            **ret_data,
 109                         _DtCvValue       *ret_end_flag);
 110 extern  int     _DtHelpCeSaveString (
 111                         _DtCvPointer        client_data,
 112                         _DtCvSegment      **seg_list,
 113                         _DtCvSegment      **last_seg,
 114                         _DtCvSegment      **prev_seg,
 115                         char               *string,
 116                         _DtHelpFontHints   *font_specs,
 117                         int                 link_index,
 118                         int                 multi_len,
 119                         int                 flags,
 120                         void               (*load_font)(),
 121                         _SdlFontMode        resolve_font,
 122                         _DtCvValue          newline);
 123 extern  int     _DtHelpCeSkipCdata (
 124                         BufFilePtr      f,
 125                         _DtCvValue      flag);
 126
 127 #ifdef __cplusplus
 128 }  /* Close scope of 'extern "C"' declaration which encloses file. */
 129 #endif
 130
 131 #endif /* _DtHelpUtilSDLI_h */
 132 /* DON'T ADD ANYTHING AFTER THIS #endif */