CCDFUtilI.h 4.6 KB

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