dart::Api Class Reference

#include <dart_api_impl.h>

Inheritance diagram for dart::Api:

Classes
class	Scope

Static Public Member Functions
static Dart_Handle	NewHandle (Thread *thread, ObjectPtr raw)
static ObjectPtr	UnwrapHandle (Dart_Handle object)
static const String &	UnwrapStringHandle (const ReusableObjectHandleScope &reused, Dart_Handle object)
static const Instance &	UnwrapInstanceHandle (const ReusableObjectHandleScope &reused, Dart_Handle object)
static Dart_Handle	CheckAndFinalizePendingClasses (Thread *thread)
static Dart_Isolate	CastIsolate (Isolate *isolate)
static Dart_IsolateGroup	CastIsolateGroup (IsolateGroup *isolate_group)
static Dart_Handle	Success ()
static bool	IsSmi (Dart_Handle handle)
static intptr_t	SmiValue (Dart_Handle handle)
static bool	IsInstance (Dart_Handle handle)
static bool	IsValid (Dart_Handle handle)
static bool	IsError (Dart_Handle handle)
static intptr_t	ClassId (Dart_Handle handle)
static Dart_Handle	NewError (const char *format,...) PRINTF_ATTRIBUTE(1
static Dart_Handle static Dart_Handle	NewArgumentError (const char *format,...) PRINTF_ATTRIBUTE(1
static Dart_Handle static Dart_Handle static Dart_Handle	Null ()
static Dart_Handle	True ()
static Dart_Handle	False ()
static Dart_Handle	EmptyString ()
static Dart_Handle	NoCallbacksError ()
static Dart_Handle	UnwindInProgressError ()
static bool	IsProtectedHandle (Dart_Handle object)
static ApiLocalScope *	TopScope (Thread *thread)
static void	Init ()
static void	InitHandles ()
static void	Cleanup ()
static bool	StringGetPeerHelper (NativeArguments *args, int arg_index, void **peer)
static bool	GetNativeReceiver (NativeArguments *args, intptr_t *value)
static bool	GetNativeBooleanArgument (NativeArguments *args, int arg_index, bool *value)
static bool	GetNativeIntegerArgument (NativeArguments *args, int arg_index, int64_t *value)
static bool	GetNativeDoubleArgument (NativeArguments *args, int arg_index, double *value)
static bool	GetNativeFieldsOfArgument (NativeArguments *args, int arg_index, int num_fields, intptr_t *field_values)
static void	SetReturnValue (NativeArguments *args, Dart_Handle retval)
static void	SetSmiReturnValue (NativeArguments *args, intptr_t retval)
static void	SetIntegerReturnValue (NativeArguments *args, int64_t retval)
static void	SetDoubleReturnValue (NativeArguments *args, double retval)
static void	SetWeakHandleReturnValue (NativeArguments *args, Dart_WeakPersistentHandle retval)
static StringPtr	GetEnvironmentValue (Thread *thread, const String &name)
static bool	IsFfiEnabled ()

Friends
class	ApiNativeScope

Detailed Description

Definition at line 133 of file dart_api_impl.h.

Member Function Documentation

CastIsolate()

Dart_Isolate dart::Api::CastIsolate ( Isolate *  isolate )

static

Definition at line 433 of file dart_api_impl.cc.

                                              {
  return reinterpret_cast<Dart_Isolate>(isolate);
}

CastIsolateGroup()

Dart_IsolateGroup dart::Api::CastIsolateGroup ( IsolateGroup *  isolate_group )

static

Definition at line 437 of file dart_api_impl.cc.

                                                                   {
  return reinterpret_cast<Dart_IsolateGroup>(isolate_group);
}

CheckAndFinalizePendingClasses()

Dart_Handle dart::Api::CheckAndFinalizePendingClasses ( Thread *  thread )

static

Definition at line 420 of file dart_api_impl.cc.

                                                              {
  Isolate* isolate = thread->isolate();
  if (!isolate->AllowClassFinalization()) {
    // Class finalization is blocked for the isolate. Do nothing.
    return Api::Success();
  }
  if (ClassFinalizer::ProcessPendingClasses()) {
    return Api::Success();
  }
  ASSERT(thread->sticky_error() != Object::null());
  return Api::NewHandle(thread, thread->sticky_error());
}

ClassId()

static intptr_t dart::Api::ClassId ( Dart_Handle  handle )

inlinestatic

Definition at line 212 of file dart_api_impl.h.

                                              {
    ObjectPtr raw = UnwrapHandle(handle);
    if (!raw->IsHeapObject()) {
      return kSmiCid;
    }
    return raw->GetClassId();
  }

Cleanup()

void dart::Api::Cleanup ( )

static

Definition at line 552 of file dart_api_impl.cc.

                  {
  true_handle_ = nullptr;
  false_handle_ = nullptr;
  null_handle_ = nullptr;
  empty_string_handle_ = nullptr;
  no_callbacks_error_handle_ = nullptr;
  unwind_in_progress_error_handle_ = nullptr;
}

EmptyString()

static Dart_Handle dart::Api::EmptyString ( )

inlinestatic

Definition at line 235 of file dart_api_impl.h.

{ return empty_string_handle_; }

False()

static Dart_Handle dart::Api::False ( )

inlinestatic

Definition at line 232 of file dart_api_impl.h.

{ return false_handle_; }

GetEnvironmentValue()

StringPtr dart::Api::GetEnvironmentValue ( Thread *  thread, const String &  name  )

static

Definition at line 5258 of file dart_api_impl.cc.

                                                                     {
  String& result = String::Handle(CallEnvironmentCallback(thread, name));
  if (result.IsNull()) {
    // Every 'dart:X' library introduces an environment variable
    // 'dart.library.X' that is set to 'true'.
    // We just need to make sure to hide private libraries (starting with
    // "_", and the mirrors library, if it is not supported.
 
    if (!FLAG_enable_mirrors && name.Equals(Symbols::DartLibraryMirrors())) {
      return Symbols::False().ptr();
    }
 
    if (!Api::IsFfiEnabled() && name.Equals(Symbols::DartLibraryFfi())) {
      return Symbols::False().ptr();
    }
 
    if (name.Equals(Symbols::DartVMProduct())) {
#ifdef PRODUCT
      return Symbols::True().ptr();
#else
      return Symbols::False().ptr();
#endif
    }
 
    if (name.Equals(Symbols::DartDeveloperTimeline())) {
#ifdef SUPPORT_TIMELINE
      return Symbols::True().ptr();
#else
      return Symbols::False().ptr();
#endif
    }
 
    const String& prefix = Symbols::DartLibrary();
    if (name.StartsWith(prefix)) {
      const String& library_name =
          String::Handle(String::SubString(name, prefix.Length()));
 
      // Private libraries (starting with "_") are not exposed to the user.
      if (!library_name.IsNull() && library_name.CharAt(0) != '_') {
        const String& dart_library_name =
            String::Handle(String::Concat(Symbols::DartScheme(), library_name));
        const Library& library =
            Library::Handle(Library::LookupLibrary(thread, dart_library_name));
        if (!library.IsNull()) {
          return Symbols::True().ptr();
        }
      }
    }
    // Check for default VM provided values. If it was not overridden on the
    // command line.
    if (Symbols::DartIsVM().Equals(name)) {
      return Symbols::True().ptr();
    }
  }
  return result.ptr();
}

GetNativeBooleanArgument()

bool dart::Api::GetNativeBooleanArgument ( NativeArguments *  args, int  arg_index, bool *  value  )

static

Definition at line 600 of file dart_api_impl.cc.

                                                {
  NoSafepointScope no_safepoint_scope;
  ObjectPtr raw_obj = arguments->NativeArgAt(arg_index);
  if (raw_obj->IsHeapObject()) {
    intptr_t cid = raw_obj->GetClassId();
    if (cid == kBoolCid) {
      *value = (raw_obj == Object::bool_true().ptr());
      return true;
    }
    if (cid == kNullCid) {
      *value = false;
      return true;
    }
  }
  return false;
}

GetNativeDoubleArgument()

bool dart::Api::GetNativeDoubleArgument ( NativeArguments *  args, int  arg_index, double *  value  )

static

Definition at line 636 of file dart_api_impl.cc.

                                                 {
  NoSafepointScope no_safepoint_scope;
  ObjectPtr raw_obj = arguments->NativeArgAt(arg_index);
  if (raw_obj->IsHeapObject()) {
    intptr_t cid = raw_obj->GetClassId();
    if (cid == kDoubleCid) {
      *value = static_cast<DoublePtr>(raw_obj)->untag()->value_;
      return true;
    }
    if (cid == kMintCid) {
      *value =
          static_cast<double>(static_cast<MintPtr>(raw_obj)->untag()->value_);
      return true;
    }
    return false;
  }
  *value = static_cast<double>(Smi::Value(static_cast<SmiPtr>(raw_obj)));
  return true;
}

GetNativeFieldsOfArgument()

bool dart::Api::GetNativeFieldsOfArgument ( NativeArguments *  args, int  arg_index, int  num_fields, intptr_t *  field_values  )

static

Definition at line 658 of file dart_api_impl.cc.

                                                            {
  NoSafepointScope no_safepoint_scope;
  ObjectPtr raw_obj = arguments->NativeArgAt(arg_index);
  intptr_t cid = raw_obj->GetClassIdMayBeSmi();
  int class_num_fields = arguments->thread()
                             ->isolate_group()
                             ->class_table()
                             ->At(cid)
                             ->untag()
                             ->num_native_fields_;
  if (num_fields != class_num_fields) {
    // No native fields or mismatched native field count.
    return false;
  }
  TypedDataPtr native_fields =
      reinterpret_cast<CompressedTypedDataPtr*>(
          UntaggedObject::ToAddr(raw_obj) + sizeof(UntaggedObject))
          ->Decompress(raw_obj->heap_base());
  if (native_fields == TypedData::null()) {
    // Native fields not initialized.
    memset(field_values, 0, (num_fields * sizeof(field_values[0])));
    return true;
  }
  ASSERT(class_num_fields == Smi::Value(native_fields->untag()->length()));
  intptr_t* native_values =
      reinterpret_cast<intptr_t*>(native_fields->untag()->data());
  memmove(field_values, native_values, (num_fields * sizeof(field_values[0])));
  return true;
}

GetNativeIntegerArgument()

bool dart::Api::GetNativeIntegerArgument ( NativeArguments *  args, int  arg_index, int64_t *  value  )

static

Definition at line 619 of file dart_api_impl.cc.

                                                   {
  NoSafepointScope no_safepoint_scope;
  ObjectPtr raw_obj = arguments->NativeArgAt(arg_index);
  if (raw_obj->IsHeapObject()) {
    intptr_t cid = raw_obj->GetClassId();
    if (cid == kMintCid) {
      *value = static_cast<MintPtr>(raw_obj)->untag()->value_;
      return true;
    }
    return false;
  }
  *value = Smi::Value(static_cast<SmiPtr>(raw_obj));
  return true;
}

GetNativeReceiver()

bool dart::Api::GetNativeReceiver ( NativeArguments *  args, intptr_t *  value  )

static

Definition at line 578 of file dart_api_impl.cc.

                                                                       {
  NoSafepointScope no_safepoint_scope;
  ObjectPtr raw_obj = arguments->NativeArg0();
  if (raw_obj->IsHeapObject()) {
    intptr_t cid = raw_obj->GetClassId();
    if (cid >= kNumPredefinedCids) {
      ASSERT(Instance::Cast(Object::Handle(raw_obj)).IsValidNativeIndex(0));
      TypedDataPtr native_fields =
          reinterpret_cast<CompressedTypedDataPtr*>(
              UntaggedObject::ToAddr(raw_obj) + sizeof(UntaggedObject))
              ->Decompress(raw_obj->heap_base());
      if (native_fields == TypedData::null()) {
        *value = 0;
      } else {
        *value = *bit_cast<intptr_t*, uint8_t*>(native_fields->untag()->data());
      }
      return true;
    }
  }
  return false;
}

Init()

void dart::Api::Init ( )

static

Definition at line 510 of file dart_api_impl.cc.

               {
  if (api_native_key_ == kUnsetThreadLocalKey) {
    api_native_key_ = OSThread::CreateThreadLocal();
  }
  ASSERT(api_native_key_ != kUnsetThreadLocalKey);
}

InitHandles()

void dart::Api::InitHandles ( )

static

Definition at line 524 of file dart_api_impl.cc.

                      {
  Isolate* isolate = Isolate::Current();
  ASSERT(isolate != nullptr);
  ASSERT(isolate == Dart::vm_isolate());
  ApiState* state = isolate->group()->api_state();
  ASSERT(state != nullptr);
 
  ASSERT(true_handle_ == nullptr);
  true_handle_ = InitNewReadOnlyApiHandle(Bool::True().ptr());
 
  ASSERT(false_handle_ == nullptr);
  false_handle_ = InitNewReadOnlyApiHandle(Bool::False().ptr());
 
  ASSERT(null_handle_ == nullptr);
  null_handle_ = InitNewReadOnlyApiHandle(Object::null());
 
  ASSERT(empty_string_handle_ == nullptr);
  empty_string_handle_ = InitNewReadOnlyApiHandle(Symbols::Empty().ptr());
 
  ASSERT(no_callbacks_error_handle_ == nullptr);
  no_callbacks_error_handle_ =
      InitNewReadOnlyApiHandle(Object::no_callbacks_error().ptr());
 
  ASSERT(unwind_in_progress_error_handle_ == nullptr);
  unwind_in_progress_error_handle_ =
      InitNewReadOnlyApiHandle(Object::unwind_in_progress_error().ptr());
}

IsError()

static bool dart::Api::IsError ( Dart_Handle  handle )

inlinestatic

Definition at line 208 of file dart_api_impl.h.

                                          {
    return IsErrorClassId(ClassId(handle));
  }

IsFfiEnabled()

static bool dart::Api::IsFfiEnabled ( )

inlinestatic

Definition at line 312 of file dart_api_impl.h.

{ return FLAG_enable_ffi; }

IsInstance()

static bool dart::Api::IsInstance ( Dart_Handle  handle )

inlinestatic

Definition at line 200 of file dart_api_impl.h.

                                             {
    return !IsInternalOnlyClassId(ClassId(handle));
  }

IsProtectedHandle()

static bool dart::Api::IsProtectedHandle ( Dart_Handle  object )

inlinestatic

Definition at line 245 of file dart_api_impl.h.

                                                    {
    if (object == nullptr) return false;
    return (object == true_handle_) || (object == false_handle_) ||
           (object == null_handle_) || (object == empty_string_handle_) ||
           (object == no_callbacks_error_handle_) ||
           (object == unwind_in_progress_error_handle_);
  }

IsSmi()

static bool dart::Api::IsSmi ( Dart_Handle  handle )

inlinestatic

Definition at line 184 of file dart_api_impl.h.

                                        {
    // Important: we do not require current thread to be in VM state because
    // we do not dereference the handle.
    ObjectPtr raw = *(reinterpret_cast<ObjectPtr*>(handle));
    return !raw->IsHeapObject();
  }

IsValid()

bool dart::Api::IsValid ( Dart_Handle  handle )

static

Definition at line 486 of file dart_api_impl.cc.

                                    {
  Isolate* isolate = Isolate::Current();
  Thread* thread = Thread::Current();
  ASSERT(thread->IsDartMutatorThread());
  CHECK_ISOLATE(isolate);
 
  // Check against all of the handles in the current isolate as well as the
  // read-only handles.
  return thread->IsValidHandle(handle) ||
         isolate->group()->api_state()->IsActivePersistentHandle(
             reinterpret_cast<Dart_PersistentHandle>(handle)) ||
         isolate->group()->api_state()->IsActiveWeakPersistentHandle(
             reinterpret_cast<Dart_WeakPersistentHandle>(handle)) ||
         Dart::IsReadOnlyApiHandle(handle) ||
         Dart::IsReadOnlyHandle(reinterpret_cast<uword>(handle));
}

NewArgumentError()

Dart_Handle dart::Api::NewArgumentError ( const char *  format,   ...  )

static

Definition at line 459 of file dart_api_impl.cc.

                                                         {
  Thread* T = Thread::Current();
  CHECK_API_SCOPE(T);
  CHECK_CALLBACK_STATE(T);
  // Ensure we transition safepoint state to VM if we are not already in
  // that state.
  TransitionToVM transition(T);
  HANDLESCOPE(T);
 
  va_list args;
  va_start(args, format);
  char* buffer = OS::VSCreate(Z, format, args);
  va_end(args);
 
  const String& message = String::Handle(Z, String::New(buffer));
  const Array& arguments = Array::Handle(Z, Array::New(1));
  arguments.SetAt(0, message);
  Object& error = Object::Handle(
      Z, DartLibraryCalls::InstanceCreate(
             Library::Handle(Z, Library::CoreLibrary()),
             Symbols::ArgumentError(), Symbols::Dot(), arguments));
  if (!error.IsError()) {
    error = UnhandledException::New(Instance::Cast(error), Instance::Handle());
  }
  return Api::NewHandle(T, error.ptr());
}

NewError()

Dart_Handle dart::Api::NewError ( const char *  format,   ...  )

static

Definition at line 441 of file dart_api_impl.cc.

                                                 {
  Thread* T = Thread::Current();
  CHECK_API_SCOPE(T);
  CHECK_CALLBACK_STATE(T);
  // Ensure we transition safepoint state to VM if we are not already in
  // that state.
  TransitionToVM transition(T);
  HANDLESCOPE(T);
 
  va_list args;
  va_start(args, format);
  char* buffer = OS::VSCreate(Z, format, args);
  va_end(args);
 
  const String& message = String::Handle(Z, String::New(buffer));
  return Api::NewHandle(T, ApiError::New(message));
}

NewHandle()

Dart_Handle dart::Api::NewHandle ( Thread *  thread, ObjectPtr  raw  )

static

Definition at line 362 of file dart_api_impl.cc.

                                                        {
  if (raw == Object::null()) {
    return Null();
  }
  if (raw == Bool::True().ptr()) {
    return True();
  }
  if (raw == Bool::False().ptr()) {
    return False();
  }
  ASSERT(thread->execution_state() == Thread::kThreadInVM);
  return InitNewHandle(thread, raw);
}

NoCallbacksError()

static Dart_Handle dart::Api::NoCallbacksError ( )

inlinestatic

Definition at line 238 of file dart_api_impl.h.

{ return no_callbacks_error_handle_; }

Null()

static Dart_Handle static Dart_Handle static Dart_Handle dart::Api::Null ( )

inlinestatic

Definition at line 226 of file dart_api_impl.h.

{ return null_handle_; }

SetDoubleReturnValue()

static void dart::Api::SetDoubleReturnValue ( NativeArguments *  args, double  retval  )

inlinestatic

Definition at line 304 of file dart_api_impl.h.

                                                                         {
    args->SetReturnUnsafe(Double::New(retval));
  }

SetIntegerReturnValue()

static void dart::Api::SetIntegerReturnValue ( NativeArguments *  args, int64_t  retval  )

inlinestatic

Definition at line 301 of file dart_api_impl.h.

                                                                           {
    args->SetReturnUnsafe(Integer::New(retval));
  }

SetReturnValue()

static void dart::Api::SetReturnValue ( NativeArguments *  args, Dart_Handle  retval  )

inlinestatic

Definition at line 295 of file dart_api_impl.h.

                                                                        {
    args->SetReturnUnsafe(UnwrapHandle(retval));
  }

SetSmiReturnValue()

static void dart::Api::SetSmiReturnValue ( NativeArguments *  args, intptr_t  retval  )

inlinestatic

Definition at line 298 of file dart_api_impl.h.

                                                                        {
    args->SetReturnUnsafe(Smi::New(retval));
  }

SetWeakHandleReturnValue()

void dart::Api::SetWeakHandleReturnValue ( NativeArguments *  args, Dart_WeakPersistentHandle  retval  )

static

Definition at line 691 of file dart_api_impl.cc.

                                                                     {
  args->SetReturnUnsafe(FinalizablePersistentHandle::Cast(retval)->ptr());
}

SmiValue()

static intptr_t dart::Api::SmiValue ( Dart_Handle  handle )

inlinestatic

Definition at line 192 of file dart_api_impl.h.

                                               {
    // Important: we do not require current thread to be in VM state because
    // we do not dereference the handle.
    ObjectPtr value = *(reinterpret_cast<ObjectPtr*>(handle));
    return Smi::Value(static_cast<SmiPtr>(value));
  }

StringGetPeerHelper()

bool dart::Api::StringGetPeerHelper ( NativeArguments *  args, int  arg_index, void **  peer  )

static

Definition at line 561 of file dart_api_impl.cc.

                                           {
  NoSafepointScope no_safepoint_scope;
  ObjectPtr raw_obj = arguments->NativeArgAt(arg_index);
  if (!raw_obj->IsHeapObject()) {
    return false;
  }
  intptr_t cid = raw_obj->GetClassId();
  if (cid == kOneByteStringCid || cid == kTwoByteStringCid) {
    auto isolate_group = arguments->thread()->isolate_group();
    *peer = isolate_group->heap()->GetPeer(raw_obj);
    return (*peer != nullptr);
  }
  return false;
}

Success()

static Dart_Handle dart::Api::Success ( )

inlinestatic

Definition at line 181 of file dart_api_impl.h.

{ return Api::True(); }

TopScope()

ApiLocalScope * dart::Api::TopScope ( Thread *  thread )

static

Definition at line 503 of file dart_api_impl.cc.

                                           {
  ASSERT(thread != nullptr);
  ApiLocalScope* scope = thread->api_top_scope();
  ASSERT(scope != nullptr);
  return scope;
}

True()

static Dart_Handle dart::Api::True ( )

inlinestatic

Definition at line 229 of file dart_api_impl.h.

{ return true_handle_; }

UnwindInProgressError()

static Dart_Handle dart::Api::UnwindInProgressError ( )

inlinestatic

Definition at line 241 of file dart_api_impl.h.

                                             {
    return unwind_in_progress_error_handle_;
  }

UnwrapHandle()

ObjectPtr dart::Api::UnwrapHandle ( Dart_Handle  object )

static

Definition at line 376 of file dart_api_impl.cc.

                                              {
#if defined(DEBUG)
  Thread* thread = Thread::Current();
  ASSERT(thread->execution_state() == Thread::kThreadInVM);
  ASSERT(thread->IsDartMutatorThread());
  ASSERT(thread->isolate() != nullptr);
  ASSERT(FinalizablePersistentHandle::ptr_offset() == 0 &&
         PersistentHandle::ptr_offset() == 0 && LocalHandle::ptr_offset() == 0);
#endif
  return (reinterpret_cast<LocalHandle*>(object))->ptr();
}

UnwrapInstanceHandle()

const Instance & dart::Api::UnwrapInstanceHandle ( const ReusableObjectHandleScope &  reused, Dart_Handle  object  )

static

Definition at line 409 of file dart_api_impl.cc.

                             {
  Object& ref = reuse.Handle();
  ref = Api::UnwrapHandle(dart_handle);
  if (ref.IsInstance()) {
    return Instance::Cast(ref);
  }
  return Object::null_instance();
}

UnwrapStringHandle()

const String & dart::Api::UnwrapStringHandle ( const ReusableObjectHandleScope &  reused, Dart_Handle  object  )

static

Definition at line 399 of file dart_api_impl.cc.

                                                               {
  Object& ref = reuse.Handle();
  ref = Api::UnwrapHandle(dart_handle);
  if (ref.IsString()) {
    return String::Cast(ref);
  }
  return Object::null_string();
}

Friends And Related Symbol Documentation

ApiNativeScope

friend class ApiNativeScope

friend

Definition at line 329 of file dart_api_impl.h.

---

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

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