Add Instance::ToUserCString.

runtime/vm/object.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 VM_OBJECT_H_
 #define VM_OBJECT_H_
 
 #include "include/dart_api.h"
 #include "platform/assert.h"
 #include "platform/utils.h"
@@ skipping 3944 matching lines @@
   // class implementing a 'call' method, return true and set the function
   // (if not NULL) to call and the context (if not NULL) to pass to the
   // function.
   bool IsCallable(Function* function, Context* context) const;
 
   // Evaluate the given expression as if it appeared in an instance
   // method of this instance and return the resulting value, or an
   // error object if evaluating the expression fails.
   RawObject* Evaluate(const String& expr) const;
 
+  // Returns this a string representation of this instance in a form
+  // that is suitable for an end user.
+  virtual const char* ToUserCString() const;

[hausner, 2013/12/09 16:53:38]

DBC: should ToUserCString() take a maxLen parameter so that the caller can
decide where to cut off long strings?

[turnidge, 2013/12/09 19:44:14]

Done, and I've added a test for this case.

+
   static intptr_t InstanceSize() {
     return RoundedAllocationSize(sizeof(RawInstance));
   }
 
   static RawInstance* New(const Class& cls, Heap::Space space = Heap::kNew);
 
  private:
   RawObject** FieldAddrAtOffset(intptr_t offset) const {
     ASSERT(IsValidFieldOffset(offset));
     return reinterpret_cast<RawObject**>(raw_value() - kHeapObjectTag + offset);
@@ skipping 912 matching lines @@
   // Copies the string characters into the provided external array
   // and morphs the string object into an external string object.
   // The remaining unused part of the original string object is marked as
   // an Array object or a regular Object so that it can be traversed during
   // garbage collection.
   RawString* MakeExternal(void* array,
                           intptr_t length,
                           void* peer,
                           Dart_PeerFinalizer cback) const;
 
+  // Produces a quoted, escaped, (possibly) truncated string.
+  const char* ToUserCString() const;
+
   // Creates a new String object from a C string that is assumed to contain
   // UTF-8 encoded characters and '\0' is considered a termination character.
   // TODO(7123) - Rename this to FromCString(....).
   static RawString* New(const char* cstr, Heap::Space space = Heap::kNew);
 
   // Creates a new String object from an array of UTF-8 encoded characters.
   static RawString* FromUTF8(const uint8_t* utf8_array,
                              intptr_t array_len,
                              Heap::Space space = Heap::kNew);
 
@@ skipping 104 matching lines @@
   }
 
   template<typename HandleType, typename ElementType, typename CallbackType>
   static void ReadFromImpl(SnapshotReader* reader,
                            String* str_obj,
                            intptr_t len,
                            intptr_t tags,
                            CallbackType new_symbol,
                            Snapshot::Kind kind);
 
+  intptr_t EscapedString(char* buffer, int maxLen) const;
+  intptr_t EscapedStringLen(intptr_t tooLong) const;
+
   FINAL_HEAP_OBJECT_IMPLEMENTATION(String, Instance);
 
   friend class Class;
   friend class Symbols;
   friend class OneByteString;
   friend class TwoByteString;
   friend class ExternalOneByteString;
   friend class ExternalTwoByteString;
   // So that the MarkingVisitor can print a debug string from a NoHandleScope.
   friend class MarkingVisitor;
@@ skipping 1406 matching lines @@
 
 
 RawObject* MegamorphicCache::GetTargetFunction(const Array& array,
                                                intptr_t index) {
   return array.At((index * kEntryLength) + kTargetFunctionIndex);
 }
 
 }  // namespace dart
 
 #endif  // VM_OBJECT_H_