ICU-6.2.10.tar.gz

[apple/icu.git] / icuSources / layout / LayoutEngine.cpp

diff --git a/icuSources/layout/LayoutEngine.cpp b/icuSources/layout/LayoutEngine.cpp
index 5861125b44255e0bb0f8189a63196587aab598a0..4a3d6bb0613706e3c9d19b9e448d381ab5f5f24f 100644 (file)
--- a/icuSources/layout/LayoutEngine.cpp
+++ b/icuSources/layout/LayoutEngine.cpp
@@ -1,8 +1,7 @@
 
 /*
 
 /*

- * %W% %E%

  *
  *

- * (C) Copyright IBM Corp. 1998-2003 - All Rights Reserved
+ * (C) Copyright IBM Corp. 1998-2004 - All Rights Reserved

  *
  */
 
  *
  */
 


@@ -12,11 +11,15 @@
 
 #include "LayoutEngine.h"
 #include "ArabicLayoutEngine.h"
 
 #include "LayoutEngine.h"
 #include "ArabicLayoutEngine.h"

+#include "CanonShaping.h"

 #include "HanLayoutEngine.h"
 #include "IndicLayoutEngine.h"
 #include "ThaiLayoutEngine.h"
 #include "GXLayoutEngine.h"
 #include "ScriptAndLanguageTags.h"
 #include "HanLayoutEngine.h"
 #include "IndicLayoutEngine.h"
 #include "ThaiLayoutEngine.h"
 #include "GXLayoutEngine.h"
 #include "ScriptAndLanguageTags.h"

+#include "CharSubstitutionFilter.h"
+
+#include "LEGlyphStorage.h"

 
 #include "OpenTypeUtilities.h"
 #include "GlyphSubstitutionTables.h"
 
 #include "OpenTypeUtilities.h"
 #include "GlyphSubstitutionTables.h"


@@ -82,142 +85,131 @@ LEUnicode32 DefaultCharMapper::mapChar(LEUnicode32 ch) const
     return ch;
 }
 
     return ch;
 }
 

-const char LayoutEngine::fgClassID=0;
+// This is here to get it out of LEGlyphFilter.h.
+// No particular reason to put it here, other than
+// this is a good central location...
+LEGlyphFilter::~LEGlyphFilter()
+{
+    // nothing to do
+}

 
 

-LayoutEngine::LayoutEngine(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode)
-    : fGlyphCount(0), fGlyphs(NULL), fCharIndices(NULL), fPositions(NULL),
-      fFontInstance(fontInstance), fScriptCode(scriptCode), fLanguageCode(languageCode)
+CharSubstitutionFilter::CharSubstitutionFilter(const LEFontInstance *fontInstance)
+  : fFontInstance(fontInstance)

 {
 {

-    // nothing else to do?
+    // nothing to do

 }
 
 }
 

-void LayoutEngine::getCharIndices(le_int32 charIndices[], le_int32 indexBase, LEErrorCode &success) const
+CharSubstitutionFilter::~CharSubstitutionFilter()

 {
 {

-    le_int32 i;
+    // nothing to do
+}

 
 

-    if LE_FAILURE(success) {
-        return;
-    }

 
 

-    if (charIndices == NULL) {
-        success = LE_ILLEGAL_ARGUMENT_ERROR;
-        return;
-    }
+UOBJECT_DEFINE_RTTI_IMPLEMENTATION(LayoutEngine)

 
 

-    if (fCharIndices == NULL) {
-        success = LE_NO_LAYOUT_ERROR;
-        return;
-    }
+static const LETag emptyTag = 0x00000000;

 
 

-    for (i = 0; i < fGlyphCount; i += 1) {
-        charIndices[i] = fCharIndices[i] + indexBase;
-    }
+static const LETag ccmpFeatureTag = LE_CCMP_FEATURE_TAG;
+
+static const LETag canonFeatures[] = {ccmpFeatureTag, emptyTag};
+
+LayoutEngine::LayoutEngine(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode)
+    : fGlyphStorage(NULL), fFontInstance(fontInstance), fScriptCode(scriptCode), fLanguageCode(languageCode)
+{
+    fGlyphStorage = new LEGlyphStorage();
+}
+
+le_int32 LayoutEngine::getGlyphCount() const
+{
+    return fGlyphStorage->getGlyphCount();
+};
+
+void LayoutEngine::getCharIndices(le_int32 charIndices[], le_int32 indexBase, LEErrorCode &success) const
+{
+    fGlyphStorage->getCharIndices(charIndices, indexBase, success);

 }
 
 void LayoutEngine::getCharIndices(le_int32 charIndices[], LEErrorCode &success) const
 {
 }
 
 void LayoutEngine::getCharIndices(le_int32 charIndices[], LEErrorCode &success) const
 {

-    if LE_FAILURE(success) {
-      return;
-    }
-    
-    if (charIndices == NULL) {
-      success = LE_ILLEGAL_ARGUMENT_ERROR;
-      return;
-    }
-    
-    if (fCharIndices == NULL) {
-      success = LE_NO_LAYOUT_ERROR;
-      return;
-    }
-    
-    LE_ARRAY_COPY(charIndices, fCharIndices, fGlyphCount);
+    fGlyphStorage->getCharIndices(charIndices, success);

 }
 
 // Copy the glyphs into caller's (32-bit) glyph array, OR in extraBits
 void LayoutEngine::getGlyphs(le_uint32 glyphs[], le_uint32 extraBits, LEErrorCode &success) const
 {
 }
 
 // Copy the glyphs into caller's (32-bit) glyph array, OR in extraBits
 void LayoutEngine::getGlyphs(le_uint32 glyphs[], le_uint32 extraBits, LEErrorCode &success) const
 {

-    le_int32 i;
-
-    if (LE_FAILURE(success)) {
-        return;
-    }
-
-    if (glyphs == NULL) {
-        success = LE_ILLEGAL_ARGUMENT_ERROR;
-        return;
-    }
-
-    if (fGlyphs == NULL) {
-        success = LE_NO_LAYOUT_ERROR;
-        return;
-    }
-
-    for (i = 0; i < fGlyphCount; i += 1) {
-        glyphs[i] = fGlyphs[i] | extraBits;
-    }
+    fGlyphStorage->getGlyphs(glyphs, extraBits, success);

 }
 
 void LayoutEngine::getGlyphs(LEGlyphID glyphs[], LEErrorCode &success) const
 {
 }
 
 void LayoutEngine::getGlyphs(LEGlyphID glyphs[], LEErrorCode &success) const
 {

-    if (LE_FAILURE(success)) {
-      return;
-    }
-    
-    if (glyphs == NULL) {
-      success = LE_ILLEGAL_ARGUMENT_ERROR;
-      return;
-    }
-    
-    if (fGlyphs == NULL) {
-      success = LE_NO_LAYOUT_ERROR;
-    }
-    
-    LE_ARRAY_COPY(glyphs, fGlyphs, fGlyphCount);
+    fGlyphStorage->getGlyphs(glyphs, success);

 }
 
 
 void LayoutEngine::getGlyphPositions(float positions[], LEErrorCode &success) const
 {
 }
 
 
 void LayoutEngine::getGlyphPositions(float positions[], LEErrorCode &success) const
 {

-    if LE_FAILURE(success) {
-      return;
-    }
-  
-    if (positions == NULL) {
-      success = LE_ILLEGAL_ARGUMENT_ERROR;
-      return;
-    }
-    
-    if (fPositions == NULL) {
-      success = LE_NO_LAYOUT_ERROR;
-      return;
-    }
-    
-    LE_ARRAY_COPY(positions, fPositions, fGlyphCount * 2 + 2);
+    fGlyphStorage->getGlyphPositions(positions, success);

 }
 
 void LayoutEngine::getGlyphPosition(le_int32 glyphIndex, float &x, float &y, LEErrorCode &success) const
 }
 
 void LayoutEngine::getGlyphPosition(le_int32 glyphIndex, float &x, float &y, LEErrorCode &success) const

+{
+    fGlyphStorage->getGlyphPosition(glyphIndex, x, y, success);
+}
+
+le_int32 LayoutEngine::characterProcessing(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft,
+                LEUnicode *&outChars, LEGlyphStorage &glyphStorage, LEErrorCode &success)

 {
     if (LE_FAILURE(success)) {
 {
     if (LE_FAILURE(success)) {

-      return;
+        return 0;

     }
     }

-    
-    if (glyphIndex > fGlyphCount) {
-      success = LE_INDEX_OUT_OF_BOUNDS_ERROR;
-      return;
+
+    if (offset < 0 || count < 0 || max < 0 || offset >= max || offset + count > max) {
+        success = LE_ILLEGAL_ARGUMENT_ERROR;
+        return 0;

     }
     }

-    
-    if (fPositions == NULL) {
-      success = LE_NO_LAYOUT_ERROR;
-      return;
+
+    const GlyphSubstitutionTableHeader *canonGSUBTable = (GlyphSubstitutionTableHeader *) CanonShaping::glyphSubstitutionTable;
+    LETag scriptTag  = OpenTypeLayoutEngine::getScriptTag(fScriptCode);
+    LETag langSysTag = OpenTypeLayoutEngine::getLangSysTag(fLanguageCode);
+    le_int32 i, dir = 1, out = 0, outCharCount = count;
+
+    if (canonGSUBTable->coversScript(scriptTag)) {
+        CharSubstitutionFilter *substitutionFilter = new CharSubstitutionFilter(fFontInstance);
+
+        glyphStorage.allocateGlyphArray(count, rightToLeft, success);
+        glyphStorage.allocateAuxData(success);
+
+        if (LE_FAILURE(success)) {
+            return 0;
+        }
+
+        if (rightToLeft) {
+            out = count - 1;
+            dir = -1;
+        }
+
+        for (i = 0; i < count; i += 1, out += dir) {
+            glyphStorage[out] = (LEGlyphID) chars[offset + i];
+            glyphStorage.setAuxData(out, (void *) canonFeatures, success);
+        }
+
+        outCharCount = canonGSUBTable->process(glyphStorage, rightToLeft, scriptTag, langSysTag, NULL, substitutionFilter, NULL);
+
+        out = (rightToLeft? count - 1 : 0);
+
+        outChars = LE_NEW_ARRAY(LEUnicode, outCharCount);
+        for (i = 0; i < outCharCount; i += 1, out += dir) {
+            outChars[out] = (LEUnicode) LE_GET_GLYPH(glyphStorage[i]);
+        }
+
+        delete substitutionFilter;

     }
     }

-    
-    x = fPositions[glyphIndex * 2];
-    y = fPositions[glyphIndex * 2 + 1];
-}

 
 

+    return outCharCount;
+}

 
 le_int32 LayoutEngine::computeGlyphs(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft,
 
 le_int32 LayoutEngine::computeGlyphs(const LEUnicode chars[], le_int32 offset, le_int32 count, le_int32 max, le_bool rightToLeft,

-                                            LEGlyphID *&glyphs, le_int32 *&charIndices, LEErrorCode &success)
+                                            LEGlyphStorage &glyphStorage, LEErrorCode &success)

 {
     if (LE_FAILURE(success)) {
         return 0;
 {
     if (LE_FAILURE(success)) {
         return 0;


@@ -228,133 +220,159 @@ le_int32 LayoutEngine::computeGlyphs(const LEUnicode chars[], le_int32 offset, l
         return 0;
     }
 
         return 0;
     }
 

-    mapCharsToGlyphs(chars, offset, count, rightToLeft, rightToLeft, glyphs, charIndices, success);
+    LEUnicode *outChars = NULL;
+    le_int32 outCharCount = characterProcessing(chars, offset, count, max, rightToLeft, outChars, glyphStorage, success);

 
 

-    return count;
+    if (outChars != NULL) {
+        mapCharsToGlyphs(outChars, 0, outCharCount, rightToLeft, rightToLeft, glyphStorage, success);
+        LE_DELETE_ARRAY(outChars); // FIXME: a subclass may have allocated this, in which case this delete might not work...
+    } else {
+        mapCharsToGlyphs(chars, offset, count, rightToLeft, rightToLeft, glyphStorage, success);
+    }
+
+    return glyphStorage.getGlyphCount();

 }
 
 // Input: glyphs
 // Output: positions
 }
 
 // Input: glyphs
 // Output: positions

-void LayoutEngine::positionGlyphs(const LEGlyphID glyphs[], le_int32 glyphCount, float x, float y, float *&positions, LEErrorCode &success)
+void LayoutEngine::positionGlyphs(LEGlyphStorage &glyphStorage, float x, float y, LEErrorCode &success)

 {
     if (LE_FAILURE(success)) {
         return;
     }
 
 {
     if (LE_FAILURE(success)) {
         return;
     }
 

-    if (glyphCount < 0) {
-        success = LE_ILLEGAL_ARGUMENT_ERROR;
-        return;
-    }
+    glyphStorage.allocatePositions(success);

 
 

-    if (positions == NULL) {
-        positions = LE_NEW_ARRAY(float, 2 * (glyphCount + 1));
-
-        if (positions == NULL) {
-            success = LE_MEMORY_ALLOCATION_ERROR;
-            return;
-        }
+    if (LE_FAILURE(success)) {
+        return;

     }
 
     }
 

-    le_int32 i;
+    le_int32 i, glyphCount = glyphStorage.getGlyphCount();

 
     for (i = 0; i < glyphCount; i += 1) {
         LEPoint advance;
 
 
     for (i = 0; i < glyphCount; i += 1) {
         LEPoint advance;
 

-        positions[i * 2] = x;
-        positions[i * 2 + 1] = y;
+        glyphStorage.setPosition(i, x, y, success);

 
 

-        fFontInstance->getGlyphAdvance(glyphs[i], advance);
+        fFontInstance->getGlyphAdvance(glyphStorage[i], advance);

         x += advance.fX;
         y += advance.fY;
     }
 
         x += advance.fX;
         y += advance.fY;
     }
 

-    positions[glyphCount * 2] = x;
-    positions[glyphCount * 2 + 1] = y;
+    glyphStorage.setPosition(glyphCount, x, y, success);

 }
 
 }
 

-void LayoutEngine::adjustMarkGlyphs(const LEGlyphID glyphs[], le_int32 glyphCount, le_bool reverse, LEGlyphFilter *markFilter,
-                                    float positions[], LEErrorCode &success)
+void LayoutEngine::adjustGlyphPositions(const LEUnicode chars[], le_int32 offset, le_int32 count, le_bool /*reverse*/,
+                                        LEGlyphStorage &/*glyphStorage*/, LEErrorCode &success)
+{
+    if (LE_FAILURE(success)) {
+        return;
+    }
+
+    if (chars == NULL || offset < 0 || count < 0) {
+        success = LE_ILLEGAL_ARGUMENT_ERROR;
+        return;
+    }
+
+    // default is no adjustments
+    return;
+}
+
+void LayoutEngine::adjustMarkGlyphs(LEGlyphStorage &glyphStorage, LEGlyphFilter *markFilter, LEErrorCode &success)

 {
     float xAdjust = 0;
 {
     float xAdjust = 0;

-    le_int32 g = 0, direction = 1;
-    le_int32 p;
+    le_int32 p, glyphCount = glyphStorage.getGlyphCount();

 
     if (LE_FAILURE(success)) {
         return;
     }
 
 
     if (LE_FAILURE(success)) {
         return;
     }
 

-    if (positions == NULL || markFilter == NULL) {
+    if (markFilter == NULL) {

         success = LE_ILLEGAL_ARGUMENT_ERROR;
         return;
     }
 
         success = LE_ILLEGAL_ARGUMENT_ERROR;
         return;
     }
 

-    if (reverse) {
-        g = glyphCount - 1;
-        direction = -1;
-    }
+    float ignore, prev;

 
 

-    for (p = 0; p < glyphCount; p += 1, g += direction) {
-        float xAdvance = positions[(p + 1) * 2] - positions[p * 2];
+    glyphStorage.getGlyphPosition(0, prev, ignore, success);

 
 

-        positions[p * 2] += xAdjust;
+    for (p = 0; p < glyphCount; p += 1) {
+        float next, xAdvance;
+        
+        glyphStorage.getGlyphPosition(p + 1, next, ignore, success);

 
 

-        if (markFilter->accept(glyphs[g])) {
+        xAdvance = next - prev;
+        glyphStorage.adjustPosition(p, xAdjust, 0, success);
+
+        if (markFilter->accept(glyphStorage[p])) {

             xAdjust -= xAdvance;
         }
             xAdjust -= xAdvance;
         }

+
+        prev = next;

     }
 
     }
 

-    positions[glyphCount * 2] += xAdjust;
+    glyphStorage.adjustPosition(glyphCount, xAdjust, 0, success);

 }
 
 }
 

-const void *LayoutEngine::getFontTable(LETag tableTag) const
+void LayoutEngine::adjustMarkGlyphs(const LEUnicode chars[], le_int32 charCount, le_bool reverse, LEGlyphStorage &glyphStorage, LEGlyphFilter *markFilter, LEErrorCode &success)

 {
 {

-    return fFontInstance->getFontTable(tableTag);
-}
+    float xAdjust = 0;
+    le_int32 c = 0, direction = 1, p;
+    le_int32 glyphCount = glyphStorage.getGlyphCount();

 
 

-void LayoutEngine::mapCharsToGlyphs(const LEUnicode chars[], le_int32 offset, le_int32 count, le_bool reverse, le_bool mirror,
-                                    LEGlyphID *&glyphs, le_int32 *&charIndices, LEErrorCode &success)
-{

     if (LE_FAILURE(success)) {
         return;
     }
 
     if (LE_FAILURE(success)) {
         return;
     }
 

-    if (chars == NULL || offset < 0 || count < 0) {
+    if (markFilter == NULL) {

         success = LE_ILLEGAL_ARGUMENT_ERROR;
         return;
     }
 
         success = LE_ILLEGAL_ARGUMENT_ERROR;
         return;
     }
 

-    if (glyphs == NULL) {
-        glyphs = LE_NEW_ARRAY(LEGlyphID, count);
-
-        if (glyphs == NULL) {
-            success = LE_MEMORY_ALLOCATION_ERROR;
-            return;
-        }
+    if (reverse) {
+        c = glyphCount - 1;
+        direction = -1;

     }
 
     }
 

-    if (charIndices == NULL) {
-        le_int32 i, dir = 1, out = 0;
+    float ignore, prev;

 
 

-        if (reverse) {
-            out = count - 1;
-            dir = -1;
-        }
+    glyphStorage.getGlyphPosition(0, prev, ignore, success);

 
 

-        charIndices = LE_NEW_ARRAY(le_int32, count);
+    for (p = 0; p < charCount; p += 1, c += direction) {
+        float next, xAdvance;
+        
+        glyphStorage.getGlyphPosition(p + 1, next, ignore, success);

 
 

-        if (charIndices == NULL) {
-            success = LE_MEMORY_ALLOCATION_ERROR;
-            return;
-        }
+        xAdvance = next - prev;
+        glyphStorage.adjustPosition(p, xAdjust, 0, success);

 
 

-        for (i = 0; i < count; i += 1, out += dir) {
-            charIndices[out] = i;
+        if (markFilter->accept(chars[c])) {
+            xAdjust -= xAdvance;

         }
         }

+
+        prev = next;
+    }
+
+    glyphStorage.adjustPosition(glyphCount, xAdjust, 0, success);
+}
+
+const void *LayoutEngine::getFontTable(LETag tableTag) const
+{
+    return fFontInstance->getFontTable(tableTag);
+}
+
+void LayoutEngine::mapCharsToGlyphs(const LEUnicode chars[], le_int32 offset, le_int32 count, le_bool reverse, le_bool mirror,
+                                    LEGlyphStorage &glyphStorage, LEErrorCode &success)
+{
+    if (LE_FAILURE(success)) {
+        return;

     }
 
     }
 

-    DefaultCharMapper charMapper(true, mirror);
+    glyphStorage.allocateGlyphArray(count, reverse, success);

 
 

-    fFontInstance->mapCharsToGlyphs(chars, offset, count, reverse, &charMapper, glyphs);
+    DefaultCharMapper charMapper(TRUE, mirror);
+
+    fFontInstance->mapCharsToGlyphs(chars, offset, count, reverse, &charMapper, glyphStorage);

 }
 
 // Input: characters, font?
 }
 
 // Input: characters, font?


@@ -372,37 +390,24 @@ le_int32 LayoutEngine::layoutChars(const LEUnicode chars[], le_int32 offset, le_
         return 0;
     }
 
         return 0;
     }
 

-    fGlyphCount = computeGlyphs(chars, offset, count, max, rightToLeft, fGlyphs, fCharIndices, success);
-    positionGlyphs(fGlyphs, fGlyphCount, x, y, fPositions, success);
-    adjustGlyphPositions(chars, offset, count, rightToLeft, fGlyphs, fGlyphCount, fPositions, success);
+    le_int32 glyphCount;
+    
+    glyphCount = computeGlyphs(chars, offset, count, max, rightToLeft, *fGlyphStorage, success);
+    positionGlyphs(*fGlyphStorage, x, y, success);
+    adjustGlyphPositions(chars, offset, count, rightToLeft, *fGlyphStorage, success);

 
 

-    return fGlyphCount;
+    return glyphCount;

 }
 
 void LayoutEngine::reset()
 {
 }
 
 void LayoutEngine::reset()
 {

-    fGlyphCount = 0;
-
-    if (fGlyphs != NULL) {
-        LE_DELETE_ARRAY(fGlyphs);
-        fGlyphs = NULL;
-    }
-
-    if (fCharIndices != NULL) {
-        LE_DELETE_ARRAY(fCharIndices);
-        fCharIndices = NULL;
-    }
-
-    if (fPositions != NULL) {
-        LE_DELETE_ARRAY(fPositions);
-        fPositions = NULL;
-    }
+    fGlyphStorage->reset();

 }
     
 LayoutEngine *LayoutEngine::layoutEngineFactory(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode, LEErrorCode &success)
 {
 }
     
 LayoutEngine *LayoutEngine::layoutEngineFactory(const LEFontInstance *fontInstance, le_int32 scriptCode, le_int32 languageCode, LEErrorCode &success)
 {

-    static le_uint32 gsubTableTag = LE_GSUB_TABLE_TAG;
-    static le_uint32 mortTableTag = LE_MORT_TABLE_TAG;
+    static const le_uint32 gsubTableTag = LE_GSUB_TABLE_TAG;
+    static const le_uint32 mortTableTag = LE_MORT_TABLE_TAG;

 
     if (LE_FAILURE(success)) {
         return NULL;
 
     if (LE_FAILURE(success)) {
         return NULL;


@@ -439,7 +444,7 @@ LayoutEngine *LayoutEngine::layoutEngineFactory(const LEFontInstance *fontInstan
             case janLanguageCode:
             case zhtLanguageCode:
             case zhsLanguageCode:
             case janLanguageCode:
             case zhtLanguageCode:
             case zhsLanguageCode:

-                if (gsubTable->coversScriptAndLanguage(scriptTag, languageTag)) {
+                if (gsubTable->coversScriptAndLanguage(scriptTag, languageTag, TRUE)) {

                     result = new HanOpenTypeLayoutEngine(fontInstance, scriptCode, languageCode, gsubTable);
                     break;
                 }
                     result = new HanOpenTypeLayoutEngine(fontInstance, scriptCode, languageCode, gsubTable);
                     break;
                 }


@@ -478,7 +483,7 @@ LayoutEngine *LayoutEngine::layoutEngineFactory(const LEFontInstance *fontInstan
             }
 
             case arabScriptCode:
             }
 
             case arabScriptCode:

-            case hebrScriptCode:
+            //case hebrScriptCode:

                 result = new UnicodeArabicOpenTypeLayoutEngine(fontInstance, scriptCode, languageCode);
                 break;
 
                 result = new UnicodeArabicOpenTypeLayoutEngine(fontInstance, scriptCode, languageCode);
                 break;