dart::JSONStream Class Reference

#include <json_stream.h>

Inheritance diagram for dart::JSONStream:

Public Member Functions
	JSONStream (intptr_t buf_size=256)
void	Setup (Zone *zone, Dart_Port reply_port, const Instance &seq, const String &method, const Array &param_keys, const Array &param_values, bool parameters_are_dart_objects=false)
void	SetupError ()
void	PrintError (intptr_t code, const char *details_format,...) PRINTF_ATTRIBUTE(3
void void	PostReply ()
void	set_id_zone (ServiceIdZone *id_zone)
ServiceIdZone *	id_zone ()
TextBuffer *	buffer ()
const char *	ToCString ()
void	Steal (char **buffer, intptr_t *buffer_length)
void	set_reply_port (Dart_Port port)
bool	include_private_members () const
void	set_include_private_members (bool include_private_members)
bool	IsAllowableKey (const char *key)
void	SetParams (const char **param_keys, const char **param_values, intptr_t num_params)
Dart_Port	reply_port () const
intptr_t	NumObjectParameters () const
ObjectPtr	GetObjectParameterKey (intptr_t i) const
ObjectPtr	GetObjectParameterValue (intptr_t i) const
ObjectPtr	LookupObjectParam (const char *key) const
intptr_t	num_params () const
const char *	GetParamKey (intptr_t i) const
const char *	GetParamValue (intptr_t i) const
const char *	LookupParam (const char *key) const
bool	HasParam (const char *key) const
bool	ParamIs (const char *key, const char *value) const
const char *	method () const
const char **	param_keys () const
const char **	param_values () const
void	set_offset (intptr_t value)
void	set_count (intptr_t value)
void	ComputeOffsetAndCount (intptr_t length, intptr_t *offset, intptr_t *count)
void	AppendBytes (const uint8_t *buffer, intptr_t buffer_length)
void	AppendSerializedObject (const char *serialized_object)
void	AppendSerializedObject (const char *property_name, const char *serialized_object)
void	PrintCommaIfNeeded ()
JSONWriter *	writer ()

Friends
class	JSONObject
class	JSONArray
class	JSONBase64String
class	TimelineEvent

Detailed Description

Definition at line 76 of file json_stream.h.

Constructor & Destructor Documentation

JSONStream()

dart::JSONStream::JSONStream ( intptr_t  buf_size = 256 )

explicit

Definition at line 26 of file json_stream.cc.

    : writer_(buf_size),
      default_id_zone_(),
      id_zone_(&default_id_zone_),
      reply_port_(ILLEGAL_PORT),
      seq_(nullptr),
      parameter_keys_(nullptr),
      parameter_values_(nullptr),
      method_(""),
      param_keys_(nullptr),
      param_values_(nullptr),
      num_params_(0),
      offset_(0),
      count_(-1),
      include_private_members_(true),
      ignore_object_depth_(0) {
  ObjectIdRing* ring = nullptr;
  Isolate* isolate = Isolate::Current();
  if (isolate != nullptr) {
    ring = isolate->EnsureObjectIdRing();
  }
  default_id_zone_.Init(ring, ObjectIdRing::kAllocateId);
}

Member Function Documentation

AppendBytes()

void dart::JSONStream::AppendBytes ( const uint8_t *  buffer, intptr_t  buffer_length  )

inline

Definition at line 160 of file json_stream.h.

                                                                  {
    writer_.AppendBytes(buffer, buffer_length);
  }

AppendSerializedObject() [1/2]

void dart::JSONStream::AppendSerializedObject ( const char *  property_name, const char *  serialized_object  )

inline

Definition at line 170 of file json_stream.h.

                                                             {
    writer_.AppendSerializedObject(property_name, serialized_object);
  }

AppendSerializedObject() [2/2]

void dart::JSONStream::AppendSerializedObject ( const char *  serialized_object )

inline

Definition at line 165 of file json_stream.h.

                                                             {
    writer_.AppendSerializedObject(serialized_object);
  }

buffer()

TextBuffer * dart::JSONStream::buffer ( )

inline

Definition at line 97 of file json_stream.h.

{ return writer_.buffer(); }

ComputeOffsetAndCount()

void dart::JSONStream::ComputeOffsetAndCount	(	intptr_t	length,
		intptr_t *	offset,
		intptr_t *	count
	)

Definition at line 294 of file json_stream.cc.

                                                        {
  // This function is written to avoid adding (count + offset) in case
  // that triggers an integer overflow.
  *offset = offset_;
  if (*offset > length) {
    *offset = length;
  }
  intptr_t remaining = length - *offset;
  *count = count_;
  if (*count < 0 || *count > remaining) {
    *count = remaining;
  }
}

GetObjectParameterKey()

ObjectPtr dart::JSONStream::GetObjectParameterKey

(

intptr_t

i

)

const

Definition at line 456 of file json_stream.cc.

                                                            {
  ASSERT((i >= 0) && (i < NumObjectParameters()));
  return parameter_keys_->At(i);
}

GetObjectParameterValue()

ObjectPtr dart::JSONStream::GetObjectParameterValue

(

intptr_t

i

)

const

Definition at line 461 of file json_stream.cc.

                                                              {
  ASSERT((i >= 0) && (i < NumObjectParameters()));
  return parameter_values_->At(i);
}

GetParamKey()

const char * dart::JSONStream::GetParamKey ( intptr_t  i ) const

inline

Definition at line 130 of file json_stream.h.

{ return param_keys_[i]; }

GetParamValue()

const char * dart::JSONStream::GetParamValue ( intptr_t  i ) const

inline

Definition at line 131 of file json_stream.h.

{ return param_values_[i]; }

HasParam()

bool dart::JSONStream::HasParam

(

const char *

key

)

const

Definition at line 282 of file json_stream.cc.

                                               {
  ASSERT(key);
  return LookupParam(key) != nullptr;
}

id_zone()

ServiceIdZone * dart::JSONStream::id_zone ( )

inline

Definition at line 95 of file json_stream.h.

{ return id_zone_; }

include_private_members()

bool dart::JSONStream::include_private_members ( ) const

inline

Definition at line 106 of file json_stream.h.

{ return include_private_members_; }

IsAllowableKey()

bool dart::JSONStream::IsAllowableKey ( const char *  key )

inline

Definition at line 111 of file json_stream.h.

                                       {
    if (include_private_members_) {
      return true;
    }
    return *key != '_';
  }

LookupObjectParam()

ObjectPtr dart::JSONStream::LookupObjectParam

(

const char *

key

)

const

Definition at line 466 of file json_stream.cc.

                                                               {
  const String& key = String::Handle(String::New(c_key));
  Object& test = Object::Handle();
  const intptr_t num_object_parameters = NumObjectParameters();
  for (intptr_t i = 0; i < num_object_parameters; i++) {
    test = GetObjectParameterKey(i);
    if (test.IsString() && String::Cast(test).Equals(key)) {
      return GetObjectParameterValue(i);
    }
  }
  return Object::null();
}

LookupParam()

const char * dart::JSONStream::LookupParam

(

const char *

key

)

const

Definition at line 273 of file json_stream.cc.

                                                         {
  for (int i = 0; i < num_params(); i++) {
    if (strcmp(key, param_keys_[i]) == 0) {
      return param_values_[i];
    }
  }
  return nullptr;
}

method()

const char * dart::JSONStream::method ( ) const

inline

Definition at line 141 of file json_stream.h.

{ return method_; }

num_params()

intptr_t dart::JSONStream::num_params ( ) const

inline

Definition at line 129 of file json_stream.h.

{ return num_params_; }

NumObjectParameters()

intptr_t dart::JSONStream::NumObjectParameters

(

)

const

Definition at line 447 of file json_stream.cc.

                                               {
  if (parameter_keys_ == nullptr) {
    return 0;
  }
  ASSERT(parameter_keys_ != nullptr);
  ASSERT(parameter_values_ != nullptr);
  return parameter_keys_->Length();
}

param_keys()

const char ** dart::JSONStream::param_keys ( ) const

inline

Definition at line 142 of file json_stream.h.

{ return param_keys_; }

param_values()

const char ** dart::JSONStream::param_values ( ) const

inline

Definition at line 143 of file json_stream.h.

{ return param_values_; }

ParamIs()

bool dart::JSONStream::ParamIs	(	const char *	key,
		const char *	value
	)		const

Definition at line 287 of file json_stream.cc.

                                                                 {
  ASSERT(key);
  ASSERT(value);
  const char* key_value = LookupParam(key);
  return (key_value != nullptr) && (strcmp(key_value, value) == 0);
}

PostReply()

void dart::JSONStream::PostReply

(

)

Definition at line 196 of file json_stream.cc.

                           {
  ASSERT(seq_ != nullptr);
  Dart_Port port = reply_port();
  set_reply_port(ILLEGAL_PORT);  // Prevent double replies.
  if (seq_->IsString()) {
    const String& str = String::Cast(*seq_);
    PrintProperty("id", str.ToCString());
  } else if (seq_->IsInteger()) {
    const Integer& integer = Integer::Cast(*seq_);
    PrintProperty64("id", integer.AsInt64Value());
  } else if (seq_->IsDouble()) {
    const Double& dbl = Double::Cast(*seq_);
    PrintProperty("id", dbl.value());
  } else if (seq_->IsNull()) {
    if (port == ILLEGAL_PORT) {
      // This path is only used in tests.
      buffer()->AddChar('}');  // Finish our message.
      char* cstr;
      intptr_t length;
      Steal(&cstr, &length);
      OS::PrintErr("-----\nDropping reply:\n%s\n-----\n", cstr);
      free(cstr);
    }
    // JSON-RPC 2.0 says that a request with a null ID shouldn't get a reply.
    PostNullReply(port);
    return;
  }
  ASSERT(port != ILLEGAL_PORT);
 
  buffer()->AddChar('}');  // Finish our message.
  char* cstr;
  intptr_t length;
  Steal(&cstr, &length);
 
  bool result;
  {
    TransitionVMToNative transition(Thread::Current());
    Dart_CObject bytes;
    bytes.type = Dart_CObject_kExternalTypedData;
    bytes.value.as_external_typed_data.type = Dart_TypedData_kUint8;
    bytes.value.as_external_typed_data.length = length;
    bytes.value.as_external_typed_data.data = reinterpret_cast<uint8_t*>(cstr);
    bytes.value.as_external_typed_data.peer = cstr;
    bytes.value.as_external_typed_data.callback = Finalizer;
    Dart_CObject* elements[1];
    elements[0] = &bytes;
    Dart_CObject message;
    message.type = Dart_CObject_kArray;
    message.value.as_array.length = 1;
    message.value.as_array.values = elements;
    result = Dart_PostCObject(port, &message);
  }
 
  if (!result) {
    free(cstr);
  }
 
  if (FLAG_trace_service) {
    Isolate* isolate = Isolate::Current();
    ASSERT(isolate != nullptr);
    int64_t main_port = static_cast<int64_t>(isolate->main_port());
    const char* isolate_name = isolate->name();
    int64_t total_time = OS::GetCurrentTimeMicros() - setup_time_micros_;
    if (result) {
      OS::PrintErr("[+%" Pd64 "ms] Isolate (%" Pd64
                   ") %s processed service request %s (%" Pd64 "us)\n",
                   Dart::UptimeMillis(), main_port, isolate_name, method_,
                   total_time);
    } else {
      OS::PrintErr("[+%" Pd64 "ms] Isolate (%" Pd64
                   ") %s processed service request %s (%" Pd64 "us) FAILED\n",
                   Dart::UptimeMillis(), main_port, isolate_name, method_,
                   total_time);
    }
  }
}

PrintCommaIfNeeded()

void dart::JSONStream::PrintCommaIfNeeded ( )

inline

Definition at line 175 of file json_stream.h.

{ writer_.PrintCommaIfNeeded(); }

PrintError()

void dart::JSONStream::PrintError	(	intptr_t	code,
		const char *	details_format,
			...
	)

Definition at line 163 of file json_stream.cc.

                                                                          {
  SetupError();
  JSONObject jsobj(this);
  jsobj.AddProperty("code", code);
  jsobj.AddProperty("message", GetJSONRpcErrorMessage(code));
  {
    JSONObject data(&jsobj, "data");
    PrintRequest(&data, this);
    if (details_format != nullptr) {
      va_list measure_args;
      va_start(measure_args, details_format);
      intptr_t len = Utils::VSNPrint(nullptr, 0, details_format, measure_args);
      va_end(measure_args);
 
      char* buffer = Thread::Current()->zone()->Alloc<char>(len + 1);
      va_list print_args;
      va_start(print_args, details_format);
      Utils::VSNPrint(buffer, (len + 1), details_format, print_args);
      va_end(print_args);
      data.AddProperty("details", buffer);
    }
  }
}

reply_port()

Dart_Port dart::JSONStream::reply_port ( ) const

inline

Definition at line 122 of file json_stream.h.

{ return reply_port_; }

set_count()

void dart::JSONStream::set_count ( intptr_t  value )

inline

Definition at line 150 of file json_stream.h.

                                 {
    ASSERT(value > 0);
    count_ = value;
  }

set_id_zone()

void dart::JSONStream::set_id_zone ( ServiceIdZone *  id_zone )

inline

Definition at line 94 of file json_stream.h.

{ id_zone_ = id_zone; }

set_include_private_members()

void dart::JSONStream::set_include_private_members ( bool  include_private_members )

inline

Definition at line 107 of file json_stream.h.

                                                                 {
    include_private_members_ = include_private_members;
  }

set_offset()

void dart::JSONStream::set_offset ( intptr_t  value )

inline

Definition at line 145 of file json_stream.h.

                                  {
    ASSERT(value > 0);
    offset_ = value;
  }

set_reply_port()

void dart::JSONStream::set_reply_port

(

Dart_Port

port

)

Definition at line 443 of file json_stream.cc.

                                              {
  reply_port_ = port;
}

SetParams()

void dart::JSONStream::SetParams	(	const char **	param_keys,
		const char **	param_values,
		intptr_t	num_params
	)

Definition at line 479 of file json_stream.cc.

                                                {
  param_keys_ = param_keys;
  param_values_ = param_values;
  num_params_ = num_params;
}

Setup()

void dart::JSONStream::Setup	(	Zone *	zone,
		Dart_Port	reply_port,
		const Instance &	seq,
		const String &	method,
		const Array &	param_keys,
		const Array &	param_values,
		bool	parameters_are_dart_objects = false
	)

Definition at line 50 of file json_stream.cc.

                                                         {
  set_reply_port(reply_port);
  seq_ = &Instance::ZoneHandle(seq.ptr());
  method_ = method.ToCString();
 
  if (parameters_are_dart_objects) {
    parameter_keys_ = &Array::ZoneHandle(param_keys.ptr());
    parameter_values_ = &Array::ZoneHandle(param_values.ptr());
    ASSERT(parameter_keys_->Length() == parameter_values_->Length());
  } else if (param_keys.Length() > 0) {
    String& string_iterator = String::Handle();
    ASSERT(param_keys.Length() == param_values.Length());
    const char** param_keys_native =
        zone->Alloc<const char*>(param_keys.Length());
    const char** param_values_native =
        zone->Alloc<const char*>(param_keys.Length());
    for (intptr_t i = 0; i < param_keys.Length(); i++) {
      string_iterator ^= param_keys.At(i);
      param_keys_native[i] =
          zone->MakeCopyOfString(string_iterator.ToCString());
      string_iterator ^= param_values.At(i);
      param_values_native[i] =
          zone->MakeCopyOfString(string_iterator.ToCString());
    }
    SetParams(param_keys_native, param_values_native, param_keys.Length());
  }
 
  if (FLAG_trace_service) {
    Isolate* isolate = Isolate::Current();
    ASSERT(isolate != nullptr);
    int64_t main_port = static_cast<int64_t>(isolate->main_port());
    const char* isolate_name = isolate->name();
    setup_time_micros_ = OS::GetCurrentTimeMicros();
    OS::PrintErr("[+%" Pd64 "ms] Isolate (%" Pd64
                 ") %s processing service "
                 "request %s\n",
                 Dart::UptimeMillis(), main_port, isolate_name, method_);
  }
  const char* kIncludePrivateMembersKey = "_includePrivateMembers";
  if (HasParam(kIncludePrivateMembersKey)) {
    include_private_members_ = ParamIs(kIncludePrivateMembersKey, "true");
  }
  buffer()->Printf("{\"jsonrpc\":\"2.0\", \"result\":");
}

SetupError()

void dart::JSONStream::SetupError

(

)

Definition at line 101 of file json_stream.cc.

                            {
  Clear();
  buffer()->Printf("{\"jsonrpc\":\"2.0\", \"error\":");
}

Steal()

void dart::JSONStream::Steal ( char **  buffer, intptr_t *  buffer_length  )

inline

Definition at line 100 of file json_stream.h.

                                                     {
    writer_.Steal(buffer, buffer_length);
  }

ToCString()

const char * dart::JSONStream::ToCString ( )

inline

Definition at line 98 of file json_stream.h.

{ return writer_.ToCString(); }

writer()

JSONWriter * dart::JSONStream::writer ( )

inline

Definition at line 176 of file json_stream.h.

{ return &writer_; }

Friends And Related Symbol Documentation

JSONArray

friend class JSONArray

friend

Definition at line 363 of file json_stream.h.

JSONBase64String

friend class JSONBase64String

friend

Definition at line 364 of file json_stream.h.

JSONObject

friend class JSONObject

friend

Definition at line 362 of file json_stream.h.

TimelineEvent

friend class TimelineEvent

friend

Definition at line 365 of file json_stream.h.

---

The documentation for this class was generated from the following files:

• third_party/dart-lang/sdk/runtime/vm/json_stream.h
• third_party/dart-lang/sdk/runtime/vm/json_stream.cc