configure.in modules/arabic/Makefile.am added arabic shaper for FT2 ported

2002-01-24  Sven Neumann  <sven@gimp.org>

	* configure.in
	* modules/arabic/Makefile.am
	* modules/arabic/arabic-ft2.c: added arabic shaper for FT2 ported
	from arabic-xft.c by Andreas Bogk <andreas@convergence.de>.

10 files changed, 491 insertions, 5 deletions

diff --git a/ChangeLog b/ChangeLog
index a26b5a81..ae0681be 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2002-01-24  Sven Neumann  <sven@gimp.org>
+
+	* configure.in
+	* modules/arabic/Makefile.am
+	* modules/arabic/arabic-ft2.c: added arabic shaper for FT2 ported 
+	from arabic-xft.c by Andreas Bogk <andreas@convergence.de>.
+
 Wed Jan 23 16:49:24 2002  Owen Taylor  <otaylor@redhat.com>
 
 	* examples/viewer-ft2.c: Remove this file; pangofttopgm
diff --git a/ChangeLog.pre-1-0 b/ChangeLog.pre-1-0
index a26b5a81..ae0681be 100644
--- a/ChangeLog.pre-1-0
+++ b/ChangeLog.pre-1-0
@@ -1,3 +1,10 @@
+2002-01-24  Sven Neumann  <sven@gimp.org>
+
+	* configure.in
+	* modules/arabic/Makefile.am
+	* modules/arabic/arabic-ft2.c: added arabic shaper for FT2 ported 
+	from arabic-xft.c by Andreas Bogk <andreas@convergence.de>.
+
 Wed Jan 23 16:49:24 2002  Owen Taylor  <otaylor@redhat.com>
 
 	* examples/viewer-ft2.c: Remove this file; pangofttopgm
diff --git a/ChangeLog.pre-1-10 b/ChangeLog.pre-1-10
index a26b5a81..ae0681be 100644
--- a/ChangeLog.pre-1-10
+++ b/ChangeLog.pre-1-10
@@ -1,3 +1,10 @@
+2002-01-24  Sven Neumann  <sven@gimp.org>
+
+	* configure.in
+	* modules/arabic/Makefile.am
+	* modules/arabic/arabic-ft2.c: added arabic shaper for FT2 ported 
+	from arabic-xft.c by Andreas Bogk <andreas@convergence.de>.
+
 Wed Jan 23 16:49:24 2002  Owen Taylor  <otaylor@redhat.com>
 
 	* examples/viewer-ft2.c: Remove this file; pangofttopgm
diff --git a/ChangeLog.pre-1-2 b/ChangeLog.pre-1-2
index a26b5a81..ae0681be 100644
--- a/ChangeLog.pre-1-2
+++ b/ChangeLog.pre-1-2
@@ -1,3 +1,10 @@
+2002-01-24  Sven Neumann  <sven@gimp.org>
+
+	* configure.in
+	* modules/arabic/Makefile.am
+	* modules/arabic/arabic-ft2.c: added arabic shaper for FT2 ported 
+	from arabic-xft.c by Andreas Bogk <andreas@convergence.de>.
+
 Wed Jan 23 16:49:24 2002  Owen Taylor  <otaylor@redhat.com>
 
 	* examples/viewer-ft2.c: Remove this file; pangofttopgm
diff --git a/ChangeLog.pre-1-4 b/ChangeLog.pre-1-4
index a26b5a81..ae0681be 100644
--- a/ChangeLog.pre-1-4
+++ b/ChangeLog.pre-1-4
@@ -1,3 +1,10 @@
+2002-01-24  Sven Neumann  <sven@gimp.org>
+
+	* configure.in
+	* modules/arabic/Makefile.am
+	* modules/arabic/arabic-ft2.c: added arabic shaper for FT2 ported 
+	from arabic-xft.c by Andreas Bogk <andreas@convergence.de>.
+
 Wed Jan 23 16:49:24 2002  Owen Taylor  <otaylor@redhat.com>
 
 	* examples/viewer-ft2.c: Remove this file; pangofttopgm
diff --git a/ChangeLog.pre-1-6 b/ChangeLog.pre-1-6
index a26b5a81..ae0681be 100644
--- a/ChangeLog.pre-1-6
+++ b/ChangeLog.pre-1-6
@@ -1,3 +1,10 @@
+2002-01-24  Sven Neumann  <sven@gimp.org>
+
+	* configure.in
+	* modules/arabic/Makefile.am
+	* modules/arabic/arabic-ft2.c: added arabic shaper for FT2 ported 
+	from arabic-xft.c by Andreas Bogk <andreas@convergence.de>.
+
 Wed Jan 23 16:49:24 2002  Owen Taylor  <otaylor@redhat.com>
 
 	* examples/viewer-ft2.c: Remove this file; pangofttopgm
diff --git a/ChangeLog.pre-1-8 b/ChangeLog.pre-1-8
index a26b5a81..ae0681be 100644
--- a/ChangeLog.pre-1-8
+++ b/ChangeLog.pre-1-8
@@ -1,3 +1,10 @@
+2002-01-24  Sven Neumann  <sven@gimp.org>
+
+	* configure.in
+	* modules/arabic/Makefile.am
+	* modules/arabic/arabic-ft2.c: added arabic shaper for FT2 ported 
+	from arabic-xft.c by Andreas Bogk <andreas@convergence.de>.
+
 Wed Jan 23 16:49:24 2002  Owen Taylor  <otaylor@redhat.com>
 
 	* examples/viewer-ft2.c: Remove this file; pangofttopgm
diff --git a/configure.in b/configure.in
index bbc6dc9b..11f6b8ed 100644
--- a/configure.in
+++ b/configure.in
@@ -271,7 +271,7 @@ AC_MSG_CHECKING(modules to link statically)
 AC_ARG_WITH(included_modules, [ --with-included-modules=MODULE1,MODULE2,...     Build the given modules into Pango])
 
 indic_modules="gurmukhi-x,bengali-x,gujarati-x,devanagari-x,myanmar-x"
-all_modules="arabic-x,arabic-xft,hebrew-x,basic-x,basic-ft2,basic-xft,basic-win32,hangul-x,tamil-x,tamil-xft,thai-x,$indic_modules"
+all_modules="arabic-x,arabic-ft2,arabic-xft,hebrew-x,basic-x,basic-ft2,basic-xft,basic-win32,hangul-x,tamil-x,tamil-xft,thai-x,$indic_modules"
 
 included_modules=""
 if test "x$with_included_modules" != xno || test "x$with_included_modules" = x ; then
@@ -319,6 +319,7 @@ AC_SUBST(INCLUDED_FT2_MODULES)
 AC_SUBST(INCLUDED_WIN32_MODULES)
 
 AM_CONDITIONAL(INCLUDE_ARABIC_X,echo $included_modules | grep '\(^\|,\)arabic-x\($\|,\)' > /dev/null)
+AM_CONDITIONAL(INCLUDE_ARABIC_FT2,echo $included_modules | grep '\(^\|,\)arabic-ft2\($\|,\)' > /dev/null)
 AM_CONDITIONAL(INCLUDE_ARABIC_XFT,echo $included_modules | grep '\(^\|,\)arabic-xft\($\|,\)' > /dev/null)
 AM_CONDITIONAL(INCLUDE_BASIC_X,echo $included_modules | grep '\(^\|,\)basic-x\($\|,\)' > /dev/null)
 AM_CONDITIONAL(INCLUDE_BASIC_FT2,echo $included_modules | grep '\(^\|,\)basic-ft2\($\|,\)' > /dev/null)
diff --git a/modules/arabic/Makefile.am b/modules/arabic/Makefile.am
index 244a6156..2c513133 100644
--- a/modules/arabic/Makefile.am
+++ b/modules/arabic/Makefile.am
@@ -3,7 +3,7 @@
 pangolibs = $(top_builddir)/pango/libpango.la $(FRIBIDI_LIBS) $(GLIB_LIBS)
 pangoxlibs = $(top_builddir)/pango/libpangox.la $(X_LIBS) $(pangolibs)
 pangoxftlibs = $(top_builddir)/pango/libpangoxft.la $(XFT_LIBS) $(pangolibs)
-pangoft2libs = $(top_builddir)/pango/libpangoft2.la $(FREETYPE_LIBS) $(pangolibs)
+pangoft2libs = $(top_builddir)/pango/libpangoft2.la $(top_builddir)/pango/opentype/libpango-ot.la $(FREETYPE_LIBS) $(pangolibs)
 
 if HAVE_XFT
 if INCLUDE_ARABIC_XFT
@@ -38,6 +38,11 @@ xft_sources = \
 	arabic-ot.c \
 	arabic-ot.h
 
+ft2_sources = \
+	arabic-ft2.c \
+	arabic-ot.c \
+	arabic-ot.h
+
 if HAVE_X
 if INCLUDE_ARABIC_X
 X_MODULES=
@@ -55,9 +60,26 @@ X_INCLUDED=
 X_PREFIX=
 endif
 
-noinst_LTLIBRARIES = $(X_INCLUDED) $(XFT_INCLUDED)
-module_LTLIBRARIES = $(X_MODULES) $(XFT_MODULES)
-moddefine = $(X_PREFIX) $(XFT_PREFIX)
+if HAVE_FREETYPE
+if INCLUDE_ARABIC_FT2
+FT2_MODULES=
+FT2_INCLUDED=libpango-arabic-ft2.la
+FT2_PREFIX=-DFT2_MODULE_PREFIX
+else
+FT2_MODULES=pango-arabic-ft2.la
+FT2_INCLUDED=
+FT2_PREFIX=
+arabic_ft2_libadd=$(pangoft2libs)
+endif
+else
+FT2_MODULES=
+FT2_INCLUDED=
+FT2_PREFIX=
+endif
+
+noinst_LTLIBRARIES = $(X_INCLUDED) $(XFT_INCLUDED) $(FT2_INCLUDED)
+module_LTLIBRARIES = $(X_MODULES) $(XFT_MODULES) $(FT2_MODULES)
+moddefine = $(X_PREFIX) $(XFT_PREFIX) $(FT2_PREFIX)
 moduledir = $(libdir)/pango/modules
 
 INCLUDES = -DPANGO_ENABLE_ENGINE -DG_DISABLE_DEPRECATED -I$(top_srcdir) -I$(top_srcdir)/pango/ $(moddefine) $(X_CFLAGS) $(FREETYPE_CFLAGS)
@@ -74,6 +96,12 @@ pango_arabic_xft_la_SOURCES = $(xft_sources)
 
 libpango_arabic_xft_la_SOURCES = $(xft_sources)
 
+pango_arabic_ft2_la_LDFLAGS = -export-dynamic -avoid-version -module
+pango_arabic_ft2_la_LIBADD = $(arabic_ft2_libadd)
+pango_arabic_ft2_la_SOURCES = $(ft2_sources)
+
+libpango_arabic_ft2_la_SOURCES = $(ft2_sources)
+
 included-modules: $(noinst_LTLIBRARIES)
 
 .PHONY: included-modules
diff --git a/modules/arabic/arabic-ft2.c b/modules/arabic/arabic-ft2.c
new file mode 100644
index 00000000..2eb895ef
--- /dev/null
+++ b/modules/arabic/arabic-ft2.c
@@ -0,0 +1,408 @@
+/* Pango
+ * arabic-ft2.c:
+ *
+ * Copyright (C) 2001 convergence integrated media GmbH
+ * Author: Andreas Bogk <andreas@convergence.de>
+ *
+ * Based on xft code for arabic:
+ * 
+ * Copyright (C) 2000 Red Hat Software
+ * Author: Owen Taylor <otaylor@redhat.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#include <string.h>
+
+#include "arabic-ot.h"
+
+#include "pangoft2.h"
+#include "pango-engine.h"
+#include "pango-utils.h"
+
+#define SCRIPT_ENGINE_NAME "ArabicScriptEngineFt2"
+
+static PangoEngineRange arabic_ranges[] = {
+  /* Language characters */
+  { 0x060c, 0x06f9, "*" }, /* Arabic */
+};
+
+static PangoEngineInfo script_engines[] = {
+  {
+    SCRIPT_ENGINE_NAME,
+    PANGO_ENGINE_TYPE_SHAPE,
+    PANGO_RENDER_TYPE_FT2,
+    arabic_ranges, G_N_ELEMENTS(arabic_ranges)
+  }
+};
+
+void
+maybe_add_feature (PangoOTRuleset *ruleset,
+		   PangoOTInfo    *info,
+		   guint           script_index,
+		   PangoOTTag      tag,
+		   gulong          property_bit)
+{
+  guint feature_index;
+  
+  /* 0xffff == default language system */
+  if (pango_ot_info_find_feature (info, PANGO_OT_TABLE_GSUB,
+				  tag, script_index, 0xffff, &feature_index))
+    pango_ot_ruleset_add_feature (ruleset, PANGO_OT_TABLE_GSUB, feature_index,
+				  property_bit);
+}
+
+static PangoOTRuleset *
+get_ruleset (PangoFont *font)
+{
+  PangoOTRuleset *ruleset;
+  static GQuark ruleset_quark = 0;
+  PangoOTInfo *info;
+
+  if (!ruleset_quark)
+    ruleset_quark = g_quark_from_string ("pango-arabic-ruleset");
+  
+  ruleset = g_object_get_qdata (G_OBJECT (font), ruleset_quark);
+
+  if (!ruleset)
+    {
+      PangoOTTag arab_tag = FT_MAKE_TAG ('a', 'r', 'a', 'b');
+      guint script_index;
+      FT_Face face;
+      
+      face = pango_ft2_font_get_face (font);
+      if (!face) 
+        {
+          g_warning ("Couldn't get face for font"); 
+          return NULL;
+        }
+	    
+      info = pango_ot_info_new (face);
+      ruleset = pango_ot_ruleset_new (info);
+      
+      if (!info)
+        return NULL;
+
+      if (pango_ot_info_find_script (info, PANGO_OT_TABLE_GSUB,
+                                     arab_tag, &script_index))
+        {
+          maybe_add_feature (ruleset, info, script_index, FT_MAKE_TAG ('i','s','o','l'), isolated);
+          maybe_add_feature (ruleset, info, script_index, FT_MAKE_TAG ('i','n','i','t'), initial);
+          maybe_add_feature (ruleset, info, script_index, FT_MAKE_TAG ('m','e','d','i'), medial);
+          maybe_add_feature (ruleset, info, script_index, FT_MAKE_TAG ('f','i','n','a'), final);
+          maybe_add_feature (ruleset, info, script_index, FT_MAKE_TAG ('l','i','g','a'), 0xFFFF);
+
+          g_object_set_qdata_full (G_OBJECT (font), ruleset_quark, ruleset,
+                                   (GDestroyNotify) g_object_unref);
+        }
+      else
+        {
+          g_object_unref (ruleset);
+          ruleset = NULL;
+        }
+    }
+
+  return ruleset;
+}
+
+/*
+ * FT2 system script engine portion
+ */
+
+static PangoGlyph 
+find_char (PangoFont *font,
+	   gunichar   wc)
+{
+  FT_Face face;
+  FT_UInt index;
+
+  face = pango_ft2_font_get_face (font);
+  index = FT_Get_Char_Index (face, wc);
+  if (index && index <= face->num_glyphs)
+    return index;
+
+  return 0;
+}
+
+static void
+swap_range (PangoGlyphString *glyphs, int start, int end)
+{
+  int i, j;
+  
+  for (i = start, j = end - 1; i < j; i++, j--)
+    {
+      PangoGlyphInfo glyph_info;
+      gint log_cluster;
+      
+      glyph_info = glyphs->glyphs[i];
+      glyphs->glyphs[i] = glyphs->glyphs[j];
+      glyphs->glyphs[j] = glyph_info;
+      
+      log_cluster = glyphs->log_clusters[i];
+      glyphs->log_clusters[i] = glyphs->log_clusters[j];
+      glyphs->log_clusters[j] = log_cluster;
+    }
+}
+
+static void
+set_glyph (PangoFont        *font,
+	   PangoGlyphString *glyphs,
+	   int               i,
+	   int               offset,
+	   PangoGlyph        glyph)
+{
+  PangoRectangle logical_rect;
+
+  glyphs->glyphs[i].glyph = glyph;
+  
+  glyphs->glyphs[i].geometry.x_offset = 0;
+  glyphs->glyphs[i].geometry.y_offset = 0;
+
+  glyphs->log_clusters[i] = offset;
+
+  pango_font_get_glyph_extents (font, 
+                                glyphs->glyphs[i].glyph, NULL, &logical_rect);
+  glyphs->glyphs[i].geometry.width = logical_rect.width;
+
+  if (i > 0)
+    {
+      glyphs->glyphs[i-1].geometry.width +=
+	pango_ft2_font_get_kerning (font,
+				    glyphs->glyphs[i-1].glyph,
+				    glyphs->glyphs[i].glyph);
+    }
+}
+
+static void 
+arabic_engine_shape (PangoFont        *font,
+		    const char       *text,
+		    gint              length,
+		    PangoAnalysis    *analysis,
+		    PangoGlyphString *glyphs)
+{
+  int n_chars;
+  int i;
+  const char *p;
+  gulong *properties = NULL;
+  gunichar *wcs = NULL;
+  PangoOTRuleset *ruleset;
+
+  g_return_if_fail (font != NULL);
+  g_return_if_fail (text != NULL);
+  g_return_if_fail (length >= 0);
+  g_return_if_fail (analysis != NULL);
+
+  n_chars = g_utf8_strlen (text, length);
+  pango_glyph_string_set_size (glyphs, n_chars);
+
+  ruleset = get_ruleset (font);
+  if (ruleset)
+    {
+      wcs = g_utf8_to_ucs4_fast (text, length, NULL);
+      properties = g_new0 (gulong, n_chars);
+      
+      Assign_Arabic_Properties (wcs, properties, n_chars);
+    }
+  
+  p = text;
+  for (i=0; i < n_chars; i++)
+    {
+      gunichar wc;
+      gunichar mirrored_ch;
+      PangoGlyph index;
+      char buf[6];
+      const char *input;
+
+      wc = g_utf8_get_char (p);
+
+      input = p;
+      if (analysis->level % 2)
+	if (pango_get_mirror_char (wc, &mirrored_ch))
+	  {
+	    wc = mirrored_ch;
+	    
+	    g_unichar_to_utf8 (wc, buf);
+	    input = buf;
+	  }
+
+      if (wc >= 0x200B && wc <= 0x200F)	/* Zero-width characters */
+	{
+	  set_glyph (font, glyphs, i, p - text, 0);
+	}
+      else
+	{
+	  /* Hack - Microsoft fonts are strange and don't contain the
+	   * correct rules to shape ARABIC LETTER FARSI YEH in
+	   * medial/initial position. It looks identical to ARABIC LETTER
+	   * YEH in these positions, so we substitute
+	   */
+	  if (wc == 0x6cc && ruleset &&
+	      ((properties[i] & (initial | medial)) != (initial | medial)))
+	    wc = 0x64a;
+	  
+	  index = find_char (font, wc);
+
+	  if (!index)
+	    {
+	      set_glyph (font, glyphs, i, p - text,
+			 pango_ft2_get_unknown_glyph (font));
+	    }
+	  else
+	    {
+	      set_glyph (font, glyphs, i, p - text, index);
+	      
+	      if (g_unichar_type (wc) == G_UNICODE_NON_SPACING_MARK)
+		{
+		  if (i > 0)
+		    {
+		      glyphs->log_clusters[i] = glyphs->log_clusters[i-1];
+#if 0		      
+		      PangoRectangle logical_rect, ink_rect;
+		      
+		      glyphs->glyphs[i].geometry.width = MAX (glyphs->glyphs[i-1].geometry.width,
+							      glyphs->glyphs[i].geometry.width);
+		      glyphs->glyphs[i-1].geometry.width = 0;
+		      
+		      /* Some heuristics to try to guess how overstrike glyphs
+		       * are done and compensate
+		       */
+		      pango_font_get_glyph_extents (font, 
+                                                    glyphs->glyphs[i].glyph, 
+                                                    &ink_rect, &logical_rect);
+		      if (logical_rect.width == 0 && ink_rect.x == 0)
+			glyphs->glyphs[i].geometry.x_offset = (glyphs->glyphs[i].geometry.width - ink_rect.width) / 2;
+#endif
+		    }
+		}
+	    }
+	}
+      
+      p = g_utf8_next_char (p);
+    }
+
+  ruleset = get_ruleset (font);
+
+  if (ruleset)
+    {
+      pango_ot_ruleset_shape (ruleset, glyphs, properties);
+
+      g_free (wcs);
+      g_free (properties);
+
+    }
+
+  for (i = 0; i < glyphs->num_glyphs; i++)
+    {
+
+      if (glyphs->glyphs[i].glyph)
+	{
+	  PangoRectangle logical_rect;
+	  
+	  pango_font_get_glyph_extents (font, glyphs->glyphs[i].glyph, 
+                                        NULL, &logical_rect);
+	  glyphs->glyphs[i].geometry.width = logical_rect.width;
+	}
+      else
+	glyphs->glyphs[i].geometry.width = 0;
+  
+      glyphs->glyphs[i].geometry.x_offset = 0;
+      glyphs->glyphs[i].geometry.y_offset = 0;
+    }
+
+  /* Simple bidi support */
+
+  if (analysis->level % 2)
+    {
+      int start, end;
+
+      /* Swap all glyphs */
+      swap_range (glyphs, 0, glyphs->num_glyphs);
+      
+      /* Now reorder glyphs within each cluster back to LTR */
+      for (start=0; start<glyphs->num_glyphs;)
+	{
+	  end = start;
+	  while (end < glyphs->num_glyphs &&
+		 glyphs->log_clusters[end] == glyphs->log_clusters[start])
+	    end++;
+
+	  if (end > start + 1)
+	    swap_range (glyphs, start, end);
+	  start = end;
+	}
+    }
+}
+
+static PangoCoverage *
+arabic_engine_get_coverage (PangoFont  *font,
+                            PangoLanguage *lang)
+{
+  return pango_font_get_coverage (font, lang);
+}
+
+static PangoEngine *
+arabic_engine_ft2_new ()
+{
+  PangoEngineShape *result;
+  
+  result = g_new (PangoEngineShape, 1);
+
+  result->engine.id = SCRIPT_ENGINE_NAME;
+  result->engine.type = PANGO_ENGINE_TYPE_SHAPE;
+  result->engine.length = sizeof (result);
+  result->script_shape = arabic_engine_shape;
+  result->get_coverage = arabic_engine_get_coverage;
+
+  return (PangoEngine *)result;
+}
+
+/* The following three functions provide the public module API for
+ * Pango. If we are compiling it is a module, then we name the
+ * entry points script_engine_list, etc. But if we are compiling
+ * it for inclusion directly in Pango, then we need them to
+ * to have distinct names for this module, so we prepend
+ * _pango_arabic_
+ */
+#ifdef FT2_MODULE_PREFIX
+#define MODULE_ENTRY(func) _pango_arabic_ft2_##func
+#else
+#define MODULE_ENTRY(func) func
+#endif
+
+/* List the engines contained within this module
+ */
+void 
+MODULE_ENTRY(script_engine_list) (PangoEngineInfo **engines, gint *n_engines)
+{
+  *engines = script_engines;
+  *n_engines = G_N_ELEMENTS (script_engines);
+}
+
+/* Load a particular engine given the ID for the engine
+ */
+PangoEngine *
+MODULE_ENTRY(script_engine_load) (const char *id)
+{
+  if (!strcmp (id, SCRIPT_ENGINE_NAME))
+    return arabic_engine_ft2_new ();
+  else
+    return NULL;
+}
+
+void 
+MODULE_ENTRY(script_engine_unload) (PangoEngine *engine)
+{
+}