Add multi-byte ByteArray access methods to the Dart API.

runtime/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 1177 matching lines @@
  * \return The ByteArray object if no error occurs. Otherwise returns
  *   an error handle.
  */
 DART_EXPORT Dart_Handle Dart_NewByteArray(intptr_t length);
 
 /**
  * Returns a ByteArray which references an external array of 8-bit bytes.
  *
  * \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 ByteArray object if no error occurs. Otherwise returns
  *   an error handle.
  */
 DART_EXPORT Dart_Handle Dart_NewExternalByteArray(uint8_t* data,
                                                   intptr_t length,
                                                   void* peer,
                                                   Dart_PeerFinalizer callback);
 
 /**
  * Retrieves the peer pointer associated with an external ByteArray.
  */
 DART_EXPORT Dart_Handle Dart_ExternalByteArrayGetPeer(Dart_Handle object,
                                                       void** peer);
 
+/**
+ * Gets an int8_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the int8_t.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetInt8At(Dart_Handle array,
+                                                intptr_t offset,
+                                                int8_t* value);
+
+/**
+ * Sets an int8_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The int8_t to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetInt8At(Dart_Handle array,
+                                                intptr_t offset,
+                                                int8_t value);
+
+/**
+ * Gets a uint8_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the uint8_t.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetUint8At(Dart_Handle array,
+                                                 intptr_t offset,
+                                                 uint8_t* value);
+
+/**
+ * Sets a uint8_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The uint8_t to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetUint8At(Dart_Handle array,
+                                                 intptr_t offset,
+                                                 uint8_t value);
+
+/**
+ * Gets an int16_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the int16_t.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetInt16At(Dart_Handle array,
+                                                 intptr_t offset,
+                                                 int16_t* value);
+
+/**
+ * Sets an int16_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The int16_t to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetInt16At(Dart_Handle array,
+                                                 intptr_t offset,
+                                                 int16_t value);
+
+/**
+ * Gets a uint16_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the uint16_t.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetUint16At(Dart_Handle array,
+                                                  intptr_t offset,
+                                                  uint16_t* value);
+
+/**
+ * Sets a uint16_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The uint16_t to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetUint16At(Dart_Handle array,
+                                                  intptr_t offset,
+                                                  uint16_t value);
+
+/**
+ * Gets an int32_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the int32_t.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetInt32At(Dart_Handle array,
+                                                 intptr_t offset,
+                                                 int32_t* value);
+
+/**
+ * Sets an int32_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The int32_t to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetInt32At(Dart_Handle array,
+                                                 intptr_t offset,
+                                                 int32_t value);
+
+/**
+ * Gets a uint32_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the uint32_t.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetUint32At(Dart_Handle array,
+                                                  intptr_t offset,
+                                                  uint32_t* value);
+
+/**
+ * Sets a uint32_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The uint32_t to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetUint32At(Dart_Handle array,
+                                                  intptr_t offset,
+                                                  uint32_t value);
+
+/**
+ * Gets an int64_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the int64_t.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetInt64At(Dart_Handle array,
+                                                 intptr_t offset,
+                                                 int64_t* value);
+
+/**
+ * Sets an int64_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The int64_t to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetInt64At(Dart_Handle array,
+                                                 intptr_t offset,
+                                                 int64_t value);
+
+/**
+ * Gets a uint64_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the uint64_t.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetUint64At(Dart_Handle array,
+                                                  intptr_t offset,
+                                                  uint64_t* value);
+
+/**
+ * Sets a uint64_t at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The uint64_t to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetUint64At(Dart_Handle array,
+                                                  intptr_t offset,
+                                                  uint64_t value);
+
+/**
+ * Gets a float at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the float.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetFloat32At(Dart_Handle array,
+                                                   intptr_t offset,
+                                                   float* value);
+
+/**
+ * Sets a float at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The float to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetFloat32At(Dart_Handle array,
+                                                   intptr_t offset,
+                                                   float value);
+
+/**
+ * Gets a double from some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the List.
+ * \param value Returns the value of the double.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArrayGetFloat64At(Dart_Handle array,
+                                                   intptr_t offset,
+                                                   double* value);
+
+/**
+ * Sets a double at some byte offset in a ByteArray.
+ *
+ * If the byte offset is out of bounds, an error occurs.
+ *
+ * \param array A ByteArray.
+ * \param offset A valid byte offset into the ByteArray.
+ * \param value The double to put into the ByteArray.
+ *
+ * \return A valid handle if no error occurs during the operation.
+ */
+DART_EXPORT Dart_Handle Dart_ByteArraySetFloat64At(Dart_Handle array,
+                                                   intptr_t offset,
+                                                   double value);
+
 // --- Closures ---
 
 /**
  * Is this object a Closure?
  */
 DART_EXPORT bool Dart_IsClosure(Dart_Handle object);
 
 /**
  * Invokes a Closure with the given arguments.
  *
@@ skipping 277 matching lines @@
 
 // --- Profiling support ----
 
 // External pprof support for gathering and dumping symbolic
 // information that can be used for better profile reports for
 // dynamically generated code.
 DART_EXPORT void Dart_InitPprofSupport();
 DART_EXPORT void Dart_GetPprofSymbolInfo(void** buffer, int* buffer_size);
 
 #endif  // INCLUDE_DART_API_H_