ICU-57166.0.1.tar.gz

[apple/icu.git] / icuSources / layout / LETypes.h

diff --git a/icuSources/layout/LETypes.h b/icuSources/layout/LETypes.h
index a5d9a750192fa1f94fb6ac997811b2ad32edb402..de8910ba6daccedab683a765140c9bd1ad7c19c3 100644 (file)
--- a/icuSources/layout/LETypes.h
+++ b/icuSources/layout/LETypes.h
@@ -1,6 +1,6 @@
 /*
  *
- * (C) Copyright IBM Corp. and others 1998-2013 - All Rights Reserved
+ * (C) Copyright IBM Corp. and others 1998-2014 - All Rights Reserved
  *
  */
 
@@ -29,42 +29,42 @@
 /**
  * A type used for signed, 32-bit integers.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef int32_t le_int32;
 
 /**
  * A type used for unsigned, 32-bit integers.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef uint32_t le_uint32;
 
 /**
  * A type used for signed, 16-bit integers.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef int16_t le_int16;
 
 /**
  * A type used for unsigned, 16-bit integers.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef uint16_t le_uint16;
 
 /**
  * A type used for signed, 8-bit integers.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef int8_t le_int8;
 
 /**
  * A type used for unsigned, 8-bit integers.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef uint8_t le_uint8;
 
@@ -72,7 +72,7 @@ typedef uint8_t le_uint8;
 /**
  * A type used for boolean values.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef UBool le_bool;
 
@@ -80,7 +80,7 @@ typedef UBool le_bool;
 /**
  * Used to represent empty pointers.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define NULL 0
 #endif
@@ -88,7 +88,7 @@ typedef UBool le_bool;
 /**
  * Used for four character tags.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef le_uint32 LETag;
 
@@ -96,7 +96,7 @@ typedef le_uint32 LETag;
  * Used for 16-bit glyph indices as they're represented
  * in TrueType font tables.
  *
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef le_uint16 TTGlyphID;
 
@@ -107,7 +107,7 @@ typedef le_uint16 TTGlyphID;
  * order 8 bits are client defined. The LayoutEngine
  * will never change or look at the client defined bits.
  *
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef le_uint32 LEGlyphID;
 
@@ -115,7 +115,7 @@ typedef le_uint32 LEGlyphID;
  * Used to mask off the glyph ID part of an LEGlyphID.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_GLYPH_MASK     0x0000FFFF
 
@@ -124,7 +124,7 @@ typedef le_uint32 LEGlyphID;
  * into the low-order bits.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_GLYPH_SHIFT    0
 
@@ -133,7 +133,7 @@ typedef le_uint32 LEGlyphID;
  * Used to mask off the sub-font ID part of an LEGlyphID.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_SUB_FONT_MASK  0x00FF0000
 
@@ -142,7 +142,7 @@ typedef le_uint32 LEGlyphID;
  * into the low-order bits.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_SUB_FONT_SHIFT 16
 
@@ -151,7 +151,7 @@ typedef le_uint32 LEGlyphID;
  * Used to mask off the client-defined part of an LEGlyphID.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_CLIENT_MASK    0xFF000000
 
@@ -160,7 +160,7 @@ typedef le_uint32 LEGlyphID;
  * into the low-order bits.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_CLIENT_SHIFT   24
 
@@ -169,7 +169,7 @@ typedef le_uint32 LEGlyphID;
  * A convenience macro to get the Glyph ID part of an LEGlyphID.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_GET_GLYPH(gid) ((gid & LE_GLYPH_MASK) >> LE_GLYPH_SHIFT)
 
@@ -177,7 +177,7 @@ typedef le_uint32 LEGlyphID;
  * A convenience macro to get the sub-font ID part of an LEGlyphID.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_GET_SUB_FONT(gid) ((gid & LE_SUB_FONT_MASK) >> LE_SUB_FONT_SHIFT)
 
@@ -185,7 +185,7 @@ typedef le_uint32 LEGlyphID;
  * A convenience macro to get the client-defined part of an LEGlyphID.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_GET_CLIENT(gid) ((gid & LE_CLIENT_MASK) >> LE_CLIENT_SHIFT)
 
@@ -194,7 +194,7 @@ typedef le_uint32 LEGlyphID;
  * A convenience macro to set the Glyph ID part of an LEGlyphID.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_SET_GLYPH(gid, glyph) ((gid & ~LE_GLYPH_MASK) | ((glyph << LE_GLYPH_SHIFT) & LE_GLYPH_MASK))
 
@@ -202,7 +202,7 @@ typedef le_uint32 LEGlyphID;
  * A convenience macro to set the sub-font ID part of an LEGlyphID.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_SET_SUB_FONT(gid, font) ((gid & ~LE_SUB_FONT_MASK) | ((font << LE_SUB_FONT_SHIFT) & LE_SUB_FONT_MASK))
 
@@ -210,7 +210,7 @@ typedef le_uint32 LEGlyphID;
  * A convenience macro to set the client-defined part of an LEGlyphID.
  *
  * @see LEGlyphID
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_SET_CLIENT(gid, client) ((gid & ~LE_CLIENT_MASK) | ((client << LE_CLIENT_SHIFT) & LE_CLIENT_MASK))
 
@@ -218,14 +218,14 @@ typedef le_uint32 LEGlyphID;
 /**
  * Used to represent 16-bit Unicode code points.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef UChar LEUnicode16;
 
 /**
  * Used to represent 32-bit Unicode code points.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef UChar32 LEUnicode32;
 
@@ -233,7 +233,7 @@ typedef UChar32 LEUnicode32;
 /**
  * Used to represent 16-bit Unicode code points.
  *
- * @deprecated since ICU 2.4. Use LEUnicode16 instead
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef UChar LEUnicode;
 #endif  /* U_HIDE_DEPRECATED_API */
@@ -241,21 +241,21 @@ typedef UChar LEUnicode;
 /**
  * Used to hold a pair of (x, y) values which represent a point.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 struct LEPoint
 {
     /**
      * The x coordinate of the point.
      *
-     * @stable ICU 2.4
+     * @deprecated ICU 54. See {@link icu::LayoutEngine}
      */
     float fX;
 
     /**
      * The y coordinate of the point.
      *
-     * @stable ICU 2.4
+     * @deprecated ICU 54. See {@link icu::LayoutEngine}
      */
     float fY;
 };
@@ -264,13 +264,54 @@ struct LEPoint
 /**
  * Used to hold a pair of (x, y) values which represent a point.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef struct LEPoint LEPoint;
 #endif
 
 
 #ifndef U_HIDE_INTERNAL_API
+
+/**
+ * \def
+ * @internal
+ */
+#ifndef LE_ASSERT_BAD_FONT
+#define LE_ASSERT_BAD_FONT 0
+#endif
+
+/**
+ * \def LE_DEBUG_BAD_FONT
+ * @internal
+ */
+#if LE_ASSERT_BAD_FONT
+#include <stdio.h>
+#define LE_DEBUG_BAD_FONT(x) fprintf(stderr,"%s:%d: BAD FONT: %s\n", __FILE__, __LINE__, (x));
+#else
+#define LE_DEBUG_BAD_FONT(x)
+#endif
+
+/**
+ * \def LE_UINTPTR_MAX
+ * Max value representable by a uintptr
+ */
+
+#ifndef UINT32_MAX
+#define LE_UINT32_MAX 0xFFFFFFFFU
+#else
+#define LE_UINT32_MAX UINT32_MAX
+#endif
+
+#ifndef UINTPTR_MAX
+#define LE_UINTPTR_MAX LE_UINT32_MAX
+#else
+#define LE_UINTPTR_MAX UINTPTR_MAX
+#endif
+
+/**
+ * Range check for overflow
+ */
+#define LE_RANGE_CHECK(type, count, ptrfn) (( (LE_UINTPTR_MAX / sizeof(type)) < (size_t)count ) ? NULL : (ptrfn))
 /**
  * A convenience macro to get the length of an array.
  *
@@ -292,7 +333,7 @@ typedef struct LEPoint LEPoint;
  *
  * @internal
  */
-#define LE_NEW_ARRAY(type, count) (type *) uprv_malloc((count) * sizeof(type))
+#define LE_NEW_ARRAY(type, count) (type *)  LE_RANGE_CHECK(type,count,uprv_malloc((count) * sizeof(type)))
 
 /**
  * Re-allocate an array of basic types. This is used to isolate the rest of
@@ -336,7 +377,7 @@ typedef struct LEPoint LEPoint;
  *
  * @internal
  */
-#define LE_NEW_ARRAY(type, count) (type *) malloc((count) * sizeof(type))
+#define LE_NEW_ARRAY(type, count) LE_RANGE_CHECK(type,count,(type *) malloc((count) * sizeof(type)))
 
 /**
  * Re-allocate an array of basic types. This is used to isolate the rest of
@@ -365,7 +406,7 @@ typedef struct LEPoint LEPoint;
  * WARNING: THIS MACRO WILL ONLY WORK CORRECTLY IF
  * THE ARGUMENT CHARACTERS ARE ASCII.
  *
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_MAKE_TAG(a, b, c, d) \
     (((le_uint32)(a) << 24) |   \
@@ -377,7 +418,7 @@ typedef struct LEPoint LEPoint;
  * This enumeration defines constants for the standard
  * TrueType, OpenType and AAT table tags.
  *
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 enum LETableTags {
     LE_ACNT_TABLE_TAG = 0x61636E74UL, /**< 'acnt' */
@@ -439,7 +480,7 @@ enum LETableTags {
  * This enumeration defines constants for all
  * the common OpenType feature tags.
  *
- * @stable ICU 3.2
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 enum LEFeatureTags {
     LE_AALT_FEATURE_TAG = 0x61616C74UL, /**< 'aalt' */
@@ -636,10 +677,12 @@ enum LEFeatureENUMs {
  * @}
  */
 
+#define LE_DEFAULT_FEATURE_FLAG (LE_Kerning_FEATURE_FLAG | LE_Ligatures_FEATURE_FLAG) /**< default features */
+
 /**
  * Error codes returned by the LayoutEngine.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 enum LEErrorCode {
     /* informational */
@@ -662,7 +705,7 @@ enum LEErrorCode {
 /**
  * Error codes returned by the LayoutEngine.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 typedef enum LEErrorCode LEErrorCode;
 #endif
@@ -670,15 +713,16 @@ typedef enum LEErrorCode LEErrorCode;
 /**
  * A convenience macro to test for the success of a LayoutEngine call.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_SUCCESS(code) (U_SUCCESS((UErrorCode)code))
 
 /**
  * A convenience macro to test for the failure of a LayoutEngine call.
  *
- * @stable ICU 2.4
+ * @deprecated ICU 54. See {@link icu::LayoutEngine}
  */
 #define LE_FAILURE(code) (U_FAILURE((UErrorCode)code))
 
+
 #endif