Implement external strings.

runtime/vm/object.h

 // Copyright (c) 2011, 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 VM_OBJECT_H_
 #define VM_OBJECT_H_
 
 #include "vm/assert.h"
 #include "vm/dart.h"
 #include "vm/globals.h"
@@ skipping 2360 matching lines @@
   void set_value(double value) const;
 
   HEAP_OBJECT_IMPLEMENTATION(Double, Number);
   friend class Class;
 };
 
 
 // String may not be '\0' terminated.
 class String : public Instance {
  public:
+  typedef void (*PeerFinalizer)(void *peer);

[siva, 2011/11/18 23:26:09]

dart_api.h is included in this file so can we use the same typedef that is
already defined in that file?

[cshapiro, 2011/11/19 01:08:29]

Good idea.  I am thinking of getting rid of this typedef when I provide
finalization for ExternalArrays.  I will delete this constant and use the Dart
API one when that happens.

+
   // We use 30 bits for the hash code so that we consistently use a
   // 32bit Smi representation for the hash code on all architectures.
   static const intptr_t kHashBits = 30;
 
+  static const intptr_t kOneByteChar = 1;
+  static const intptr_t kTwoByteChar = 2;
+  static const intptr_t kFourByteChar = 4;
+
   intptr_t Length() const { return Smi::Value(raw_ptr()->length_); }
   static intptr_t length_offset() { return OFFSET_OF(RawString, length_); }
 
   virtual intptr_t Hash() const;
   static intptr_t hash_offset() { return OFFSET_OF(RawString, hash_); }
   static intptr_t Hash(const String& str, intptr_t begin_index, intptr_t len);
   static intptr_t Hash(const uint8_t* characters, intptr_t len);
   static intptr_t Hash(const uint16_t* characters, intptr_t len);
   static intptr_t Hash(const uint32_t* characters, intptr_t len);
 
   virtual int32_t CharAt(intptr_t index) const;
 
+  virtual intptr_t CharSize() const;
+
   bool Equals(const String& str, intptr_t begin_index, intptr_t len) const;
   bool Equals(const char* str) const;
   bool Equals(const uint8_t* characters, intptr_t len) const;
   bool Equals(const uint16_t* characters, intptr_t len) const;
   bool Equals(const uint32_t* characters, intptr_t len) const;
 
   virtual bool Equals(const Instance& other) const;
 
   intptr_t CompareTo(const String& other) const;
 
   bool StartsWith(const String& other) const;
 
   virtual RawInstance* Canonicalize() const;
 
   bool IsSymbol() const;
 
   static RawString* New(const char* str, Heap::Space space = Heap::kNew);
   static RawString* New(const uint8_t* characters,
                         intptr_t len,
                         Heap::Space space = Heap::kNew);
   static RawString* New(const uint16_t* characters,
                         intptr_t len,
                         Heap::Space space = Heap::kNew);
   static RawString* New(const uint32_t* characters,
                         intptr_t len,
                         Heap::Space space = Heap::kNew);
   static RawString* New(const String& str, Heap::Space space = Heap::kNew);
 
+  static RawString* NewExternal(const uint8_t* characters,
+                                intptr_t len,
+                                void* peer,
+                                PeerFinalizer callback,
+                                Heap::Space = Heap::kNew);
+  static RawString* NewExternal(const uint16_t* characters,
+                                intptr_t len,
+                                void* peer,
+                                PeerFinalizer callback,
+                                Heap::Space = Heap::kNew);
+  static RawString* NewExternal(const uint32_t* characters,
+                                intptr_t len,
+                                void* peer,
+                                PeerFinalizer callback,
+                                Heap::Space = Heap::kNew);
+
   static void Copy(const String& dst,
                    intptr_t dst_offset,
                    const uint8_t* characters,
                    intptr_t len);
   static void Copy(const String& dst,
                    intptr_t dst_offset,
                    const uint16_t* characters,
                    intptr_t len);
   static void Copy(const String& dst,
                    intptr_t dst_offset,
@@ skipping 57 matching lines @@
   HEAP_OBJECT_IMPLEMENTATION(String, Instance);
 };
 
 
 class OneByteString : public String {
  public:
   virtual int32_t CharAt(intptr_t index) const {
     return *CharAddr(index);
   }
 
+  virtual intptr_t CharSize() const {
+    return kOneByteChar;
+  }
+
   static intptr_t data_offset() { return OFFSET_OF(RawOneByteString, data_); }
 
   static intptr_t InstanceSize() {
     ASSERT(sizeof(RawOneByteString) == OFFSET_OF(RawOneByteString, data_));
     return 0;
   }
 
   static intptr_t InstanceSize(intptr_t len) {
     return RoundedAllocationSize(sizeof(RawOneByteString) + len);
   }
@@ skipping 12 matching lines @@
   static RawOneByteString* New(const OneByteString& str,
                                Heap::Space space);
 
   static RawOneByteString* Concat(const String& str1,
                                   const String& str2,
                                   Heap::Space space);
   static RawOneByteString* ConcatAll(const Array& strings,
                                      intptr_t len,
                                      Heap::Space space);
 
-  static RawString* SubString(const OneByteString& str,
-                              intptr_t begin_index,
-                              intptr_t length,
-                              Heap::Space space);
-
   static RawOneByteString* Transform(int32_t (*mapping)(int32_t ch),
                                      const String& str,
                                      Heap::Space space);
 
  private:
   uint8_t* CharAddr(intptr_t index) const {
     // TODO(iposva): Determine if we should throw an exception here.
     ASSERT((index >= 0) && (index < Length()));
     return &raw_ptr()->data_[index];
   }
 
   HEAP_OBJECT_IMPLEMENTATION(OneByteString, String);
   friend class Class;
   friend class String;
 };
 
 
 class TwoByteString : public String {
  public:
   virtual int32_t CharAt(intptr_t index) const {
     return *CharAddr(index);
   }
 
+  virtual intptr_t CharSize() const {
+    return kTwoByteChar;
+  }
+
   static intptr_t InstanceSize() {
     ASSERT(sizeof(RawTwoByteString) == OFFSET_OF(RawTwoByteString, data_));
     return 0;
   }
 
   static intptr_t InstanceSize(intptr_t len) {
     return RoundedAllocationSize(sizeof(RawTwoByteString) + (2 * len));
   }
 
   static RawTwoByteString* New(intptr_t len,
                                Heap::Space space);
   static RawTwoByteString* New(const uint16_t* characters,
                                intptr_t len,
                                Heap::Space space);
   static RawTwoByteString* New(const uint32_t* characters,
                                intptr_t len,
                                Heap::Space space);
   static RawTwoByteString* New(const TwoByteString& str,
                                Heap::Space space);
 
   static RawTwoByteString* Concat(const String& str1,
                                   const String& str2,
                                   Heap::Space space);
   static RawTwoByteString* ConcatAll(const Array& strings,
                                      intptr_t len,
                                      Heap::Space space);
 
-  static RawString* SubString(const TwoByteString& str,
-                              intptr_t begin_index,
-                              intptr_t length,
-                              Heap::Space space);
-
   static RawTwoByteString* Transform(int32_t (*mapping)(int32_t ch),
                                      const String& str,
                                      Heap::Space space);
 
  private:
   uint16_t* CharAddr(intptr_t index) const {
     ASSERT((index >= 0) && (index < Length()));
     return &raw_ptr()->data_[index];
   }
 
   HEAP_OBJECT_IMPLEMENTATION(TwoByteString, String);
   friend class Class;
   friend class String;
 };
 
 
 class FourByteString : public String {
  public:
   virtual int32_t CharAt(intptr_t index) const {
     return *CharAddr(index);
   }
 
+  virtual intptr_t CharSize() const {
+    return kFourByteChar;
+  }
+
   static intptr_t InstanceSize() {
     ASSERT(sizeof(RawFourByteString) == OFFSET_OF(RawFourByteString, data_));
     return 0;
   }
 
   static intptr_t InstanceSize(intptr_t len) {
     return RoundedAllocationSize(sizeof(RawFourByteString) + (4 * len));
   }
 
   static RawFourByteString* New(intptr_t len,
                                 Heap::Space space);
   static RawFourByteString* New(const uint32_t* characters,
                                 intptr_t len,
                                 Heap::Space space);
   static RawFourByteString* New(const FourByteString& str,
                                 Heap::Space space);
 
   static RawFourByteString* Concat(const String& str1,
                                    const String& str2,
                                    Heap::Space space);
   static RawFourByteString* ConcatAll(const Array& strings,
                                       intptr_t len,
                                       Heap::Space space);
 
-  static RawString* SubString(const FourByteString& str,
-                              intptr_t begin_index,
-                              intptr_t length,
-                              Heap::Space space);
-
   static RawFourByteString* Transform(int32_t (*mapping)(int32_t ch),
                                       const String& str,
                                       Heap::Space space);
 
  private:
   uint32_t* CharAddr(intptr_t index) const {
     ASSERT((index >= 0) && (index < Length()));
     return &raw_ptr()->data_[index];
   }
 
   HEAP_OBJECT_IMPLEMENTATION(FourByteString, String);
   friend class Class;
   friend class String;
 };
 
 
+class ExternalOneByteString : public String {
+ public:
+  virtual int32_t CharAt(intptr_t index) const {
+    return *CharAddr(index);
+  }
+
+  virtual intptr_t CharSize() const {
+    return kOneByteChar;
+  }
+
+  static intptr_t InstanceSize() {
+    return RoundedAllocationSize(sizeof(RawExternalOneByteString));
+  }
+
+  static RawExternalOneByteString* New(const uint8_t* characters,
+                                       intptr_t len,
+                                       void* peer,
+                                       PeerFinalizer callback,
+                                       Heap::Space space);
+
+ private:
+  const uint8_t* CharAddr(intptr_t index) const {
+    // TODO(iposva): Determine if we should throw an exception here.
+    ASSERT((index >= 0) && (index < Length()));
+    return &raw_ptr()->external_data_->data_[index];

[siva, 2011/11/18 23:26:09]

I normally put a paren around as follows:
return &(raw_ptr()->external_data_->data_[index]);
to be more explicit but feel free to ignore this comment.

[cshapiro, 2011/11/19 01:08:29]

Sure, why not?  Fixed here and in the two cases below as well.

+  }
+
+  void SetExternalData(RawExternalStringData<uint8_t>* data) {
+    raw_ptr()->external_data_ = data;
+  }
+
+  HEAP_OBJECT_IMPLEMENTATION(ExternalOneByteString, String);
+  friend class Class;
+  friend class String;
+};
+
+
+class ExternalTwoByteString : public String {
+ public:
+  virtual int32_t CharAt(intptr_t index) const {
+    return *CharAddr(index);
+  }
+
+  virtual intptr_t CharSize() const {
+    return kTwoByteChar;
+  }
+
+  static intptr_t InstanceSize() {
+    return RoundedAllocationSize(sizeof(RawExternalTwoByteString));
+  }
+
+  static RawExternalTwoByteString* New(const uint16_t* characters,
+                                       intptr_t len,
+                                       void* peer,
+                                       PeerFinalizer callback,
+                                       Heap::Space space = Heap::kNew);
+
+ private:
+  const uint16_t* CharAddr(intptr_t index) const {
+    // TODO(iposva): Determine if we should throw an exception here.
+    ASSERT((index >= 0) && (index < Length()));
+    return &raw_ptr()->external_data_->data_[index];
+  }
+
+  void SetExternalData(RawExternalStringData<uint16_t>* data) {
+    raw_ptr()->external_data_ = data;
+  }
+
+  HEAP_OBJECT_IMPLEMENTATION(ExternalTwoByteString, String);
+  friend class Class;
+  friend class String;
+};
+
+
+class ExternalFourByteString : public String {
+ public:
+  virtual int32_t CharAt(intptr_t index) const {
+    return *CharAddr(index);
+  }
+
+  virtual intptr_t CharSize() const {
+    return kFourByteChar;
+  }
+
+  static intptr_t InstanceSize() {
+    return RoundedAllocationSize(sizeof(RawExternalFourByteString));
+  }
+
+  static RawExternalFourByteString* New(const uint32_t* characters,
+                                        intptr_t len,
+                                        void* peer,
+                                        PeerFinalizer callback,
+                                        Heap::Space space = Heap::kNew);
+
+ private:
+  const uint32_t* CharAddr(intptr_t index) const {
+    // TODO(iposva): Determine if we should throw an exception here.
+    ASSERT((index >= 0) && (index < Length()));
+    return &raw_ptr()->external_data_->data_[index];
+  }
+
+  void SetExternalData(RawExternalStringData<uint32_t>* data) {
+    raw_ptr()->external_data_ = data;
+  }
+
+  HEAP_OBJECT_IMPLEMENTATION(ExternalFourByteString, String);
+  friend class Class;
+  friend class String;
+};
+
+
 class Bool : public Instance {
  public:
   bool value() const {
     return raw_ptr()->value_;
   }
 
   static intptr_t InstanceSize() {
     return RoundedAllocationSize(sizeof(RawBool));
   }
 
@@ skipping 318 matching lines @@
 }
 
 
 void Context::SetAt(intptr_t index, const Instance& value) const {
   StorePointer(InstanceAddr(index), value.raw());
 }
 
 }  // namespace dart
 
 #endif  // VM_OBJECT_H_