cde/lib/DtHelp/CCDFUtilI.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: CCDFUtilI.h /main/5 1995/10/26 12:17:26 rswiston $ */
  24 /*************************************<+>*************************************
  25  ****************************************************************************
  26  **
  27  **   File:        CCDFUtilI.h
  28  **
  29  **   Project:     Un*x Desktop Help
  30  **
  31  **   Description: Header file for CCDFUtil.c
  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 _CECCDFUtilI_h
  45 #define _CECCDFUtilI_h
  46
  47 /*****************************************************************************
  48  *  Parsing flags and macros
  49  *****************************************************************************/
  50 #define CCDF_ABBREV_CMD          (1 <<  0)
  51 #define CCDF_FIGURE_CMD          (1 <<  1)
  52 #define CCDF_FONT_CMD            (1 <<  2)
  53 #define CCDF_FORMAT_END          (1 <<  3)
  54 #define CCDF_GRAPHIC_CMD         (1 <<  4)
  55 #define CCDF_ID_CMD              (1 <<  5)
  56 #define CCDF_LABEL_CMD           (1 <<  6)
  57 #define CCDF_LINK_CMD            (1 <<  7)
  58 #define CCDF_NEWLINE_CMD         (1 <<  8)
  59 #define CCDF_OCTAL_CMD           (1 <<  9)
  60 #define CCDF_PARAGRAPH_CMD       (1 << 10)
  61 #define CCDF_TITLE_CMD           (1 << 11)
  62 #define CCDF_TOPIC_CMD           (1 << 12)
  63
  64 #define CCDF_NO_CMDS                 0
  65 #define CCDF_ALL_CMDS              ~(0)
  66 #define CCDF_ALLOW_CMD(x, y)             ((x) & (y))
  67 #define CCDF_NOT_ALLOW_CMD(x, y)         ((~(x)) & (y))
  68
  69 /****************************************************************************
  70  *                      Semi Public Routines
  71  ****************************************************************************/
  72 extern  int     _DtHelpCeGetCcdfAbbrevCmd(
  73                         BufFilePtr       in_file,
  74                         char            *in_buf,
  75                         int              in_size,
  76                         int              cur_mb_len,
  77                         char            **in_ptr,
  78                         char            **ret_string);
  79 extern  int     _DtHelpCeSkipCcdfAbbrev(
  80                         BufFilePtr       in_file,
  81                         char            *in_buf,
  82                         char            **in_ptr,
  83                         int              in_size,
  84                         int              cur_mb_len);
  85 extern  int     _DtHelpCeCheckNextCcdfCmd(
  86                         char            *token,
  87                         BufFilePtr       in_file,
  88                         char            *in_buf,
  89                         int              in_size,
  90                         int              cur_mb_len,
  91                         char            **in_ptr);
  92 extern  int     _DtHelpCeGetCcdfEndMark(
  93                         BufFilePtr        file,
  94                         char             *buffer,
  95                         char            **buf_ptr,
  96                         int               buf_size,
  97                         int               cur_mb_len);
  98 extern  int     _DtHelpCeGetCcdfFontType(
  99                         char            *code);
 100 extern  int     _DtHelpCeGetCcdfValueParam(
 101                         BufFilePtr       in_file,
 102                         char            *in_buf,
 103                         int              in_size,
 104                         char            **in_ptr,
 105                         _DtCvValue       flag,
 106                         int              cur_mb_len,
 107                         int             *ret_value);
 108 extern  int     _DtHelpCeGetCcdfStrParam(
 109                         BufFilePtr       in_file,
 110                         char            *in_buf,
 111                         int              in_size,
 112                         int              cur_mb_len,
 113                         char            **in_ptr,
 114                         _DtCvValue       flag,
 115                         _DtCvValue       eat_escape,
 116                         _DtCvValue       ignore_quotes,
 117                         _DtCvValue       less_test,
 118                         char            **ret_string);
 119 extern  int     _DtHelpCeGetCcdfTopicAbbrev(
 120                         void            *dpy,
 121                         BufFilePtr       in_file,
 122                         char            *in_buf,
 123                         char            **in_ptr,
 124                         int              in_size,
 125                         int              cur_mb_len,
 126                         char            **ret_title,
 127                         char            **ret_charSet,
 128                         char            **ret_abbrev);
 129 extern  int     _DtHelpCeGetCcdfTopicCmd(
 130                         void            *dpy,
 131                         BufFilePtr       in_file,
 132                         char            *in_buf,
 133                         char            **in_ptr,
 134                         int              in_size,
 135                         int              cur_mb_len,
 136                         char            **ret_charSet);
 137 extern  int     _DtHelpCeGetCcdfCmd(
 138                         int              current,
 139                         char            *in_buf,
 140                         char            **in_ptr,
 141                         BufFilePtr       in_file,
 142                         int              size,
 143                         int              allowed);
 144 extern  int     _DtHelpCeSkipToNextCcdfToken(
 145                         BufFilePtr       in_file,
 146                         char            *in_buf,
 147                         int              in_size,
 148                         int              cur_mb_len,
 149                         char            **in_ptr,
 150                         _DtCvValue       flag );
 151
 152 #endif /* _CECCDFUtilI_h */