dali-windows-backend/ExInclude/fribidi/fribidi-joining.h

   1 /* FriBidi
   2  * fribidi-joining.h - Arabic joining algorithm
   3  *
   4  * $Id: fribidi-joining.h,v 1.3 2004/06/21 21:15:31 behdad Exp $
   5  * $Author: behdad $
   6  * $Date: 2004/06/21 21:15:31 $
   7  * $Revision: 1.3 $
   8  * $Source: /cvs/fribidi/fribidi2/lib/fribidi-joining.h,v $
   9  *
  10  * Authors:
  11  *   Behdad Esfahbod, 2004
  12  *
  13  * Copyright (C) 2004 Sharif FarsiWeb, Inc
  14  * Copyright (C) 2004 Behdad Esfahbod
  15  *
  16  * This library is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU Lesser General Public
  18  * License as published by the Free Software Foundation; either
  19  * version 2.1 of the License, or (at your option) any later version.
  20  *
  21  * This library is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24  * Lesser General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU Lesser General Public License
  27  * along with this library, in a file named COPYING; if not, write to the
  28  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  29  * Boston, MA 02111-1307, USA
  30  *
  31  * For licensing issues, contact <license@farsiweb.info>.
  32  */
  33 #ifndef _FRIBIDI_JOINING_H
  34 #define _FRIBIDI_JOINING_H
  35
  36 #include "fribidi-common.h"
  37
  38 #include "fribidi-types.h"
  39 #include "fribidi-bidi-types.h"
  40 #include "fribidi-joining-types.h"
  41
  42 #include "fribidi-begindecls.h"
  43
  44 #define fribidi_join_arabic FRIBIDI_NAMESPACE(join_arabic)
  45 /* fribidi_join_arabic - do Arabic joining
  46  *
  47  * This function does the Arabic joining algorithm.  Means, given Arabic
  48  * joining types of the characters in ar_props (don't worry,
  49  * FriBidiJoiningType can be casted to FriBidiArabicProp automagically), this
  50  * function modifies this properties to grasp the effect of neighboring
  51  * characters.  You probably need this information later to do Arabic shaping.
  52  *
  53  * This function implements rules R1 to R7 inclusive (all rules) of the Arabic
  54  * Cursive Joining algorithm of the Unicode standard as available at
  55  * http://www.unicode.org/versions/Unicode4.0.0/ch08.pdf#G7462.  It also
  56  * interacts correctly with the bidirection algorithm as defined in Section
  57  * 3.5 Shaping of the Unicode Bidirectional Algorithm available at
  58  * http://www.unicode.org/reports/tr9/#Shaping.
  59  *
  60  * There are a few macros defined in fribidi-joining-types.h for querying the
  61  * Arabic properties computed by this function.
  62  */
  63 FRIBIDI_ENTRY void fribidi_join_arabic (
  64   const FriBidiCharType *bidi_types,    /* input list of bidi types as
  65                                            returned by
  66                                            fribidi_get_bidi_types() */
  67   const FriBidiStrIndex len,    /* input string length */
  68   const FriBidiLevel *embedding_levels, /* input list of embedding
  69                                            levels, as returned by
  70                                            fribidi_get_par_embedding_levels */
  71   FriBidiArabicProp *ar_props   /* Arabic properties to analyze, initilized by
  72                                    joining types, as returned by
  73                                    fribidi_get_joining_types */
  74 );
  75
  76 #include "fribidi-enddecls.h"
  77
  78 #endif /* !_FRIBIDI_JOINING_H */
  79 /* Editor directions:
  80  * vim:textwidth=78:tabstop=8:shiftwidth=2:autoindent:cindent
  81  */