fribidi-deprecated.h 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. /* FriBidi
  2. * fribidi-deprecated.h - Deprecated interfaces
  3. *
  4. * Author:
  5. * Behdad Esfahbod, 2004, 2005
  6. *
  7. * Copyright (C) 2004 Sharif FarsiWeb, Inc
  8. * Copyright (C) 2004, 2005 Behdad Esfahbod
  9. *
  10. * This library is free software; you can redistribute it and/or
  11. * modify it under the terms of the GNU Lesser General Public
  12. * License as published by the Free Software Foundation; either
  13. * version 2.1 of the License, or (at your option) any later version.
  14. *
  15. * This library is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18. * Lesser General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Lesser General Public License
  21. * along with this library, in a file named COPYING; if not, write to the
  22. * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23. * Boston, MA 02110-1301, USA
  24. *
  25. * For licensing issues, contact <fribidi.license@gmail.com>.
  26. */
  27. #ifndef _FRIBIDI_DEPRECATED_H
  28. #define _FRIBIDI_DEPRECATED_H
  29. #include "fribidi-common.h"
  30. #include "fribidi-types.h"
  31. #include "fribidi-bidi-types.h"
  32. #include "fribidi-begindecls.h"
  33. /* fribidi_mirroring_status - get current mirroring status
  34. *
  35. * This function is deprecated and only used with other deprecated functions.
  36. */
  37. FRIBIDI_ENTRY fribidi_boolean fribidi_mirroring_status (
  38. void
  39. ) FRIBIDI_GNUC_DEPRECATED;
  40. /* fribidi_set_mirroring - set mirroring on or off
  41. *
  42. * This function is used to turn character mirroring on or off.
  43. * Character mirroring is the act of replacing a mirrorable glyph
  44. * (character), eg. left parenthesis, with the matching glyph,
  45. * eg. right parenthesis, in a right-to-left resolved context.
  46. * If your rendering engine does mirroring itself, you may want to
  47. * turn it off here.
  48. *
  49. * This flag is on by default.
  50. * This function is deprecated and only used with other deprecated functions.
  51. *
  52. * Returns: the new mirroring status.
  53. */
  54. FRIBIDI_ENTRY fribidi_boolean fribidi_set_mirroring (
  55. fribidi_boolean state /* new state to set */
  56. ) FRIBIDI_GNUC_DEPRECATED;
  57. /* fribidi_reorder_nsm_status - get current marks reordering status
  58. *
  59. * This function is deprecated and only used with other deprecated functions.
  60. */
  61. FRIBIDI_ENTRY fribidi_boolean fribidi_reorder_nsm_status (
  62. void
  63. ) FRIBIDI_GNUC_DEPRECATED;
  64. /* fribidi_set_reorder_nsm - set marks reordering on or off
  65. *
  66. * This function is used to turn non-spacing marks reordering on or
  67. * off. Reordering non-spacing marks is the act of placing non-spacing
  68. * marks (bidi class NSM) after their base character in a right-to-left
  69. * resolved context. If your rendering engine expects non-spacing marks
  70. * always after the base character in the memory representation of the
  71. * visual string, you need this option on. An example of where people
  72. * may need it off is when rendering in the console when non-spacing
  73. * marks cannot be applied on top of the base character.
  74. *
  75. * This flag is on by default.
  76. * This function is deprecated and only used with other deprecated functions.
  77. *
  78. * Returns: the new marks reordering status.
  79. */
  80. FRIBIDI_ENTRY fribidi_boolean fribidi_set_reorder_nsm (
  81. fribidi_boolean state /* new state to set */
  82. ) FRIBIDI_GNUC_DEPRECATED;
  83. /* fribidi_log2vis_get_embedding_levels - get embedding levels
  84. *
  85. * Deprecated. Replaced by fribidi_get_par_embedding_levels_ex.
  86. */
  87. FRIBIDI_ENTRY FriBidiLevel
  88. fribidi_log2vis_get_embedding_levels (
  89. const FriBidiCharType *bidi_types, /* input list of bidi types as returned by
  90. fribidi_get_bidi_types() */
  91. const FriBidiStrIndex len, /* input string length of the paragraph */
  92. FriBidiParType *pbase_dir, /* requested and resolved paragraph
  93. * base direction */
  94. FriBidiLevel *embedding_levels /* output list of embedding levels */
  95. ) FRIBIDI_GNUC_DEPRECATED;
  96. /* fribidi_get_type - get character bidi type
  97. *
  98. * Deprecated. Replaced by fribidi_get_bidi_type.
  99. */
  100. FRIBIDI_ENTRY FriBidiCharType
  101. fribidi_get_type (
  102. FriBidiChar ch /* input character */
  103. ) FRIBIDI_GNUC_DEPRECATED;
  104. /* fribidi_get_type_internal - get character bidi type
  105. *
  106. * Deprecated. Replaced by fribidi_get_bidi_type.
  107. */
  108. FRIBIDI_ENTRY FriBidiCharType
  109. fribidi_get_type_internal (
  110. FriBidiChar ch /* input character */
  111. ) FRIBIDI_GNUC_DEPRECATED;
  112. /* fribidi_get_par_embedding_levels - get bidi embedding levels of a paragraph
  113. *
  114. * Deprecated interface to fribidi_get_par_embedding_levels_ex(). Refer to
  115. * it for documentation.
  116. */
  117. FRIBIDI_ENTRY FriBidiLevel
  118. fribidi_get_par_embedding_levels (
  119. const FriBidiCharType *bidi_types, /* input list of bidi types as returned by
  120. fribidi_get_bidi_types() */
  121. const FriBidiStrIndex len, /* input string length of the paragraph */
  122. FriBidiParType *pbase_dir, /* requested and resolved paragraph
  123. * base direction */
  124. FriBidiLevel *embedding_levels /* output list of embedding levels */
  125. )
  126. FRIBIDI_GNUC_WARN_UNUSED FRIBIDI_GNUC_DEPRECATED;
  127. #define UNI_MAX_BIDI_LEVEL FRIBIDI_BIDI_MAX_EXPLICIT_LEVEL
  128. #define UNI_LRM FRIBIDI_CHAR_LRM
  129. #define UNI_RLM FRIBIDI_CHAR_RLM
  130. #define UNI_LRE FRIBIDI_CHAR_LRE
  131. #define UNI_RLE FRIBIDI_CHAR_RLE
  132. #define UNI_LRO FRIBIDI_CHAR_LRO
  133. #define UNI_RLO FRIBIDI_CHAR_RLO
  134. #define UNI_LS FRIBIDI_CHAR_LS
  135. #define UNI_PS FRIBIDI_CHAR_PS
  136. #define UNI_ZWNJ FRIBIDI_CHAR_ZWNJ
  137. #define UNI_ZWJ FRIBIDI_CHAR_ZWJ
  138. #define UNI_HEBREW_ALEF FRIBIDI_CHAR_HEBREW_ALEF
  139. #define UNI_ARABIC_ALEF FRIBIDI_CHAR_ARABIC_ALEF
  140. #define UNI_ARABIC_ZERO FRIBIDI_CHAR_ARABIC_ZERO
  141. #define UNI_FARSI_ZERO FRIBIDI_CHAR_PERSIAN_ZERO
  142. #define FRIBIDI_TYPE_WL FRIBIDI_PAR_WLTR
  143. #define FRIBIDI_TYPE_WR FRIBIDI_PAR_WRTL
  144. #define FRIBIDI_TYPE_L FRIBIDI_PAR_LTR
  145. #define FRIBIDI_TYPE_R FRIBIDI_PAR_RTL
  146. #define FRIBIDI_TYPE_N FRIBIDI_PAR_ON
  147. #define FRIBIDI_TYPE_B FRIBIDI_TYPE_BS
  148. #define FRIBIDI_TYPE_S FRIBIDI_TYPE_SS
  149. #include "fribidi-enddecls.h"
  150. #endif /* !_FRIBIDI_DEPRECATED_H */
  151. /* Editor directions:
  152. * vim:textwidth=78:tabstop=8:shiftwidth=2:autoindent:cindent
  153. */