include/fribidi/fribidi-deprecated.h

0001 /* FriBidi
0002  * fribidi-deprecated.h - Deprecated interfaces
0003  *
0004  * Author:
0005  *   Behdad Esfahbod, 2004, 2005
0006  *
0007  * Copyright (C) 2004 Sharif FarsiWeb, Inc
0008  * Copyright (C) 2004, 2005 Behdad Esfahbod
0009  *
0010  * This library is free software; you can redistribute it and/or
0011  * modify it under the terms of the GNU Lesser General Public
0012  * License as published by the Free Software Foundation; either
0013  * version 2.1 of the License, or (at your option) any later version.
0014  *
0015  * This library is distributed in the hope that it will be useful,
0016  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0018  * Lesser General Public License for more details.
0019  *
0020  * You should have received a copy of the GNU Lesser General Public License
0021  * along with this library, in a file named COPYING; if not, write to the
0022  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0023  * Boston, MA 02110-1301, USA
0024  *
0025  * For licensing issues, contact <fribidi.license@gmail.com>.
0026  */
0027 #ifndef _FRIBIDI_DEPRECATED_H
0028 #define _FRIBIDI_DEPRECATED_H
0029
0030 #include "fribidi-common.h"
0031
0032 #include "fribidi-types.h"
0033
0034 #include "fribidi-bidi-types.h"
0035
0036 #include "fribidi-begindecls.h"
0037
0038
0039
0040 /* fribidi_mirroring_status - get current mirroring status
0041  *
0042  * This function is deprecated and only used with other deprecated functions.
0043  */
0044 FRIBIDI_ENTRY fribidi_boolean fribidi_mirroring_status (
0045   void
0046 ) FRIBIDI_GNUC_DEPRECATED;
0047
0048 /* fribidi_set_mirroring - set mirroring on or off
0049  *
0050  * This function is used to turn character mirroring on or off.
0051  * Character mirroring is the act of replacing a mirrorable glyph
0052  * (character), eg. left parenthesis, with the matching glyph,
0053  * eg. right parenthesis, in a right-to-left resolved context.
0054  * If your rendering engine does mirroring itself, you may want to
0055  * turn it off here.
0056  *
0057  * This flag is on by default.
0058  * This function is deprecated and only used with other deprecated functions.
0059  *
0060  * Returns: the new mirroring status.
0061  */
0062 FRIBIDI_ENTRY fribidi_boolean fribidi_set_mirroring (
0063   fribidi_boolean state     /* new state to set */
0064 ) FRIBIDI_GNUC_DEPRECATED;
0065
0066
0067 /* fribidi_reorder_nsm_status - get current marks reordering status
0068  *
0069  * This function is deprecated and only used with other deprecated functions.
0070  */
0071 FRIBIDI_ENTRY fribidi_boolean fribidi_reorder_nsm_status (
0072   void
0073 ) FRIBIDI_GNUC_DEPRECATED;
0074
0075 /* fribidi_set_reorder_nsm - set marks reordering on or off
0076  *
0077  * This function is used to turn non-spacing marks reordering on or
0078  * off.  Reordering non-spacing marks is the act of placing non-spacing
0079  * marks (bidi class NSM) after their base character in a right-to-left
0080  * resolved context.  If your rendering engine expects non-spacing marks
0081  * always after the base character in the memory representation of the
0082  * visual string, you need this option on.  An example of where people
0083  * may need it off is when rendering in the console when non-spacing
0084  * marks cannot be applied on top of the base character.
0085  *
0086  * This flag is on by default.
0087  * This function is deprecated and only used with other deprecated functions.
0088  *
0089  * Returns: the new marks reordering status.
0090  */
0091 FRIBIDI_ENTRY fribidi_boolean fribidi_set_reorder_nsm (
0092   fribidi_boolean state     /* new state to set */
0093 ) FRIBIDI_GNUC_DEPRECATED;
0094
0095
0096
0097
0098 /* fribidi_log2vis_get_embedding_levels - get embedding levels
0099  *
0100  * Deprecated. Replaced by fribidi_get_par_embedding_levels_ex.
0101  */
0102 FRIBIDI_ENTRY FriBidiLevel
0103 fribidi_log2vis_get_embedding_levels (
0104   const FriBidiCharType *bidi_types,    /* input list of bidi types as returned by
0105                        fribidi_get_bidi_types() */
0106   const FriBidiStrIndex len,    /* input string length of the paragraph */
0107   FriBidiParType *pbase_dir,    /* requested and resolved paragraph
0108                  * base direction */
0109   FriBidiLevel *embedding_levels    /* output list of embedding levels */
0110 ) FRIBIDI_GNUC_DEPRECATED;
0111
0112 /* fribidi_get_type - get character bidi type
0113  *
0114  * Deprecated. Replaced by fribidi_get_bidi_type.
0115  */
0116 FRIBIDI_ENTRY FriBidiCharType
0117 fribidi_get_type (
0118   FriBidiChar ch        /* input character */
0119 ) FRIBIDI_GNUC_DEPRECATED;
0120
0121 /* fribidi_get_type_internal - get character bidi type
0122  *
0123  * Deprecated. Replaced by fribidi_get_bidi_type.
0124  */
0125 FRIBIDI_ENTRY FriBidiCharType
0126 fribidi_get_type_internal (
0127   FriBidiChar ch        /* input character */
0128 ) FRIBIDI_GNUC_DEPRECATED;
0129
0130 /* fribidi_get_par_embedding_levels - get bidi embedding levels of a paragraph
0131  *
0132  * Deprecated interface to fribidi_get_par_embedding_levels_ex(). Refer to
0133  * it for documentation.
0134  */
0135 FRIBIDI_ENTRY FriBidiLevel
0136 fribidi_get_par_embedding_levels (
0137   const FriBidiCharType *bidi_types,    /* input list of bidi types as returned by
0138                        fribidi_get_bidi_types() */
0139   const FriBidiStrIndex len,    /* input string length of the paragraph */
0140   FriBidiParType *pbase_dir,    /* requested and resolved paragraph
0141                  * base direction */
0142   FriBidiLevel *embedding_levels    /* output list of embedding levels */
0143 )
0144      FRIBIDI_GNUC_WARN_UNUSED FRIBIDI_GNUC_DEPRECATED;
0145
0146 #define UNI_MAX_BIDI_LEVEL  FRIBIDI_BIDI_MAX_EXPLICIT_LEVEL
0147 #define UNI_LRM         FRIBIDI_CHAR_LRM
0148 #define UNI_RLM         FRIBIDI_CHAR_RLM
0149 #define UNI_LRE         FRIBIDI_CHAR_LRE
0150 #define UNI_RLE         FRIBIDI_CHAR_RLE
0151 #define UNI_LRO         FRIBIDI_CHAR_LRO
0152 #define UNI_RLO         FRIBIDI_CHAR_RLO
0153 #define UNI_LS          FRIBIDI_CHAR_LS
0154 #define UNI_PS          FRIBIDI_CHAR_PS
0155 #define UNI_ZWNJ        FRIBIDI_CHAR_ZWNJ
0156 #define UNI_ZWJ         FRIBIDI_CHAR_ZWJ
0157 #define UNI_HEBREW_ALEF     FRIBIDI_CHAR_HEBREW_ALEF
0158 #define UNI_ARABIC_ALEF     FRIBIDI_CHAR_ARABIC_ALEF
0159 #define UNI_ARABIC_ZERO     FRIBIDI_CHAR_ARABIC_ZERO
0160 #define UNI_FARSI_ZERO      FRIBIDI_CHAR_PERSIAN_ZERO
0161
0162 #define FRIBIDI_TYPE_WL     FRIBIDI_PAR_WLTR
0163 #define FRIBIDI_TYPE_WR     FRIBIDI_PAR_WRTL
0164 #define FRIBIDI_TYPE_L      FRIBIDI_PAR_LTR
0165 #define FRIBIDI_TYPE_R      FRIBIDI_PAR_RTL
0166 #define FRIBIDI_TYPE_N      FRIBIDI_PAR_ON
0167 #define FRIBIDI_TYPE_B      FRIBIDI_TYPE_BS
0168 #define FRIBIDI_TYPE_S      FRIBIDI_TYPE_SS
0169
0170 #include "fribidi-enddecls.h"
0171
0172 #endif /* !_FRIBIDI_DEPRECATED_H */
0173 /* Editor directions:
0174  * vim:textwidth=78:tabstop=8:shiftwidth=2:autoindent:cindent
0175  */