Add typed data interface to Dart API, this only changes the C++ API as dicussed in a previous email…

include/dart_api.h

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #ifndef INCLUDE_DART_API_H_
 #define INCLUDE_DART_API_H_
 
 /** \mainpage Dart Embedding API Reference
  *
  * Dart is a class-based programming language for creating structured
@@ skipping 1613 matching lines @@
                                             intptr_t length);
 
 /**
  * May generate an unhandled exception error.
  */
 DART_EXPORT Dart_Handle Dart_ListSetAsBytes(Dart_Handle list,
                                             intptr_t offset,
                                             uint8_t* native_array,
                                             intptr_t length);
 
-// --- Scalar Lists ---
+// --- Typed Data ---
 
 typedef enum {
-  kByteArray = 0,
+  kByteData = 0,
   kInt8,
   kUint8,
   kUint8Clamped,
   kInt16,
   kUint16,
   kInt32,
   kUint32,
   kInt64,
   kUint64,
   kFloat32,
-  kFloat64
-} Dart_Scalar_Type;
+  kFloat64,
+  kInvalid
+} Dart_TypedData_Type;
 
 /**
- * Is this object a ByteArray?
+ * Is this object a TypedData?
+ *
+ * \return kInvalid if the object is not a TypedData object or the appropriate
+ *   Dart_TypedData_Type.
  */
-DART_EXPORT bool Dart_IsByteArray(Dart_Handle object);
+DART_EXPORT Dart_TypedData_Type Dart_IsTypedData(Dart_Handle object);

[Anton Muhin, 2013/02/14 12:53:05]

It's somewhat weird to have a method named _Is return anything different from
bool (esp. in the case of _IsExternalTypedData below).  Maybe something like
_GetType?  But up to you.

[siva, 2013/02/14 19:45:42]

Renamed to Dart_GetTypeOfTypedData and Dart_GetTypeOfExternalTypedData

On 2013/02/14 12:53:05, Anton Muhin wrote:

 
 /**
- * Is this object an external ByteArray?
+ * Is this object an external TypedData?
  *
- * An external ByteArray is a ByteArray which references a fixed array of
- * bytes which is external to the Dart heap.
+ * \return kInvalid if the object is not an external TypedData object or
+ *   the appropriate Dart_TypedData_Type.
  */
-DART_EXPORT bool Dart_IsByteArrayExternal(Dart_Handle object);
+DART_EXPORT Dart_TypedData_Type Dart_IsExternalTypedData(Dart_Handle object);
 
 /**
- * Returns a ByteArray of the desired length.
+ * Returns a TypedData object of the desired length and type.
  *
- * \param length The length of the array.
+ * \param type The type of the TypedData object.
+ * \param length The length of the TypedData object (length in type units).
  *
- * \return The ByteArray object if no error occurs. Otherwise returns
+ * \return The TypedData object if no error occurs. Otherwise returns
  *   an error handle.
  */
-DART_EXPORT Dart_Handle Dart_NewByteArray(intptr_t length);
+DART_EXPORT Dart_Handle Dart_NewTypedData(Dart_TypedData_Type type,
+                                          intptr_t length);
 
 /**
- * Returns a ByteArray which references an external array of 8-bit bytes.
+ * Returns a TypedData object which references an external data array.
  *
- * \param value An array of 8-bit bytes. This array must not move.
- * \param length The length of the array.
- * \param peer An external pointer to associate with this byte array.
+ * \param value A data array. This array must not move.
+ * \param type The type of the data array.
+ * \param length The length of the data array (length in type units).
+ * \param peer An external pointer to associate with this array.
  *
- * \return The ByteArray object if no error occurs. Otherwise returns
- *   an error handle. The ByteArray object is returned in a
+ * \return The TypedData object if no error occurs. Otherwise returns
+ *   an error handle. The TypedData object is returned in a
  *   WeakPersistentHandle which needs to be deleted in the specified callback
  *   using Dart_DeletePersistentHandle.
  */
-DART_EXPORT Dart_Handle Dart_NewExternalByteArray(
-    uint8_t* data,
+DART_EXPORT Dart_Handle Dart_NewExternalTypedData(
+    void* data,
+    Dart_TypedData_Type type,

[Anton Muhin, 2013/02/14 12:53:05]

absolutely minor, feel free to disregard, but I'd rather have type as a first
argument: _NewExternalTypedData(type, data, length): data + length conceptually
tied and type kind of rules the rest of semantics and somewhat mirrors generic
methods application.

Again, up to you to decide.

[siva, 2013/02/14 19:45:42]

Made type the first parameter.

On 2013/02/14 12:53:05, Anton Muhin wrote:

     intptr_t length,
     void* peer,
     Dart_WeakPersistentHandleFinalizer callback);
 
 /**
- * Returns a clamped ByteArray which references an external array of
- * 8-bit bytes.
- * A clamped ByteArray differs from ByteArray above in the indexed store
- * operation where negative values are clamped to 0 and values above 255 are
- * clamped to 255.
- *
- * \param value An array of 8-bit bytes. This array must not move.
- * \param length The length of the array.
- * \param peer An external pointer to associate with this byte array.
- *
- * \return The clamped ByteArray object if no error occurs. Otherwise returns
- *   an error handle. The clamped ByteArray object is returned in a
- *   WeakPersistentHandle which needs to be deleted in the specified callback
- *   using Dart_DeletePersistentHandle.
+ * Retrieves the peer pointer associated with an external TypedData object.
  */
-DART_EXPORT Dart_Handle Dart_NewExternalClampedByteArray(
-    uint8_t* data,
-    intptr_t length,
-    void* peer,
-    Dart_WeakPersistentHandleFinalizer callback);
-
-/**
- * Retrieves the data pointer associated with an external ByteArray.
- */
-DART_EXPORT Dart_Handle Dart_ExternalByteArrayGetData(Dart_Handle object,
-                                                      void** data);
-
-/**
- * Retrieves the peer pointer associated with an external ByteArray.
- */
-DART_EXPORT Dart_Handle Dart_ExternalByteArrayGetPeer(Dart_Handle object,
+DART_EXPORT Dart_Handle Dart_ExternalTypedDataGetPeer(Dart_Handle object,
                                                       void** peer);
 
 /**
- * Acquires access to the internal data address of a scalar list object.
+ * Acquires access to the internal data address of a TypedData object.
  *
- * \param array The scalar list object whose internal data address is to
+ * \param object The typed data object whose internal data address is to
  *    be accessed.
- * \param type The scalar type of the object is returned here.
+ * \param type The type of the object is returned here.
  * \param data The internal data address is returned here.
- * \param len Size of the byte array is returned here.
+ * \param len Size of the typed array is returned here.
  *
  * Note: When the internal address of the object is acquired any calls to a
  *       Dart API function that could potentially allocate an object or run
  *       any Dart code will return an error.
  *
  * \return Success if the internal data address is acquired successfully.
  *   Otherwise, returns an error handle.
  */
-DART_EXPORT Dart_Handle Dart_ScalarListAcquireData(Dart_Handle array,
-                                                   Dart_Scalar_Type* type,
-                                                   void** data,
-                                                   intptr_t* len);
+DART_EXPORT Dart_Handle Dart_TypedDataAcquireData(Dart_Handle object,
+                                                  Dart_TypedData_Type* type,
+                                                  void** data,
+                                                  intptr_t* len);
 
 /**
  * Releases access to the internal data address that was acquired earlier using
- * Dart_ByteArrayAcquireData.
+ * Dart_TypedDataAcquireData.
  *
- * \param array The scalar list object whose internal data address is to be
+ * \param object The typed data object whose internal data address is to be
  *   released.
  *
  * \return Success if the internal data address is released successfully.
  *   Otherwise, returns an error handle.
  */
-DART_EXPORT Dart_Handle Dart_ScalarListReleaseData(Dart_Handle array);
+DART_EXPORT Dart_Handle Dart_TypedDataReleaseData(Dart_Handle array);
 
 
 // --- Closures ---
 
 /**
  * Is this object a Closure?
  */
 DART_EXPORT bool Dart_IsClosure(Dart_Handle object);
 
 /**
@@ skipping 813 matching lines @@
  *
  * \param object An object.
  * \param peer A value to store in the peer field.
  *
  * \return Returns an error if 'object' is a subtype of Null, num, or
  *   bool.
  */
 DART_EXPORT Dart_Handle Dart_SetPeer(Dart_Handle object, void* peer);
 
 #endif  // INCLUDE_DART_API_H_