dart::ArgumentsDescriptor Class Reference

#include <dart_entry.h>

Inheritance diagram for dart::ArgumentsDescriptor:

Public Types
enum	{ kCachedDescriptorCount = 32 }

Public Member Functions
	ArgumentsDescriptor (const Array &array)
intptr_t	TypeArgsLen () const
intptr_t	FirstArgIndex () const
intptr_t	CountWithTypeArgs () const
intptr_t	Count () const
intptr_t	Size () const
intptr_t	SizeWithTypeArgs () const
intptr_t	PositionalCount () const
intptr_t	NamedCount () const
StringPtr	NameAt (intptr_t i) const
intptr_t	PositionAt (intptr_t i) const
bool	MatchesNameAt (intptr_t i, const String &other) const
ArrayPtr	GetArgumentNames () const
void	PrintTo (BaseTextBuffer *buffer, bool show_named_positions=false) const
const char *	ToCString () const
Public Member Functions inherited from dart::ValueObject
	ValueObject ()
	~ValueObject ()

Static Public Member Functions
static intptr_t	type_args_len_offset ()
static intptr_t	count_offset ()
static intptr_t	size_offset ()
static intptr_t	positional_count_offset ()
static intptr_t	first_named_entry_offset ()
static intptr_t	name_offset ()
static intptr_t	position_offset ()
static intptr_t	named_entry_size ()
static ArrayPtr	NewBoxed (intptr_t type_args_len, intptr_t num_arguments, const Array &optional_arguments_names, Heap::Space space=Heap::kOld)
static ArrayPtr	New (intptr_t type_args_len, intptr_t num_arguments, intptr_t size_arguments, const Array &optional_arguments_names, Heap::Space space=Heap::kOld)
static ArrayPtr	NewBoxed (intptr_t type_args_len, intptr_t num_arguments, Heap::Space space=Heap::kOld)
static ArrayPtr	New (intptr_t type_args_len, intptr_t num_arguments, intptr_t size_arguments, Heap::Space space=Heap::kOld)
static void	Init ()
static void	Cleanup ()
static constexpr bool	ContainsCompressedPointers ()

Friends
class	VMSerializationRoots
class	VMDeserializationRoots

Detailed Description

Definition at line 31 of file dart_entry.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kCachedDescriptorCount

Definition at line 127 of file dart_entry.h.

{ kCachedDescriptorCount = 32 };

Constructor & Destructor Documentation

ArgumentsDescriptor()

dart::ArgumentsDescriptor::ArgumentsDescriptor ( const Array &  array )

explicit

Definition at line 357 of file dart_entry.cc.

: array_(array) {}

Member Function Documentation

Cleanup()

void dart::ArgumentsDescriptor::Cleanup ( )

static

Definition at line 576 of file dart_entry.cc.

                                  {
  for (int i = 0; i < kCachedDescriptorCount; i++) {
    // Don't free pointers to RawArray objects managed by the VM.
    cached_args_descriptors_[i] = nullptr;
  }
}

ContainsCompressedPointers()

static constexpr bool dart::ArgumentsDescriptor::ContainsCompressedPointers ( )

inlinestaticconstexpr

Definition at line 130 of file dart_entry.h.

                                                     {
    // Use the same state as the backing store.
    return Array::ContainsCompressedPointers();
  }

Count()

intptr_t dart::ArgumentsDescriptor::Count

(

)

const

Definition at line 363 of file dart_entry.cc.

                                          {
  return Smi::Value(Smi::RawCast(array_.At(kCountIndex)));
}

count_offset()

static intptr_t dart::ArgumentsDescriptor::count_offset ( )

inlinestatic

Definition at line 57 of file dart_entry.h.

{ return Array::element_offset(kCountIndex); }

CountWithTypeArgs()

intptr_t dart::ArgumentsDescriptor::CountWithTypeArgs ( ) const

inline

Definition at line 38 of file dart_entry.h.

{ return FirstArgIndex() + Count(); }

first_named_entry_offset()

static intptr_t dart::ArgumentsDescriptor::first_named_entry_offset ( )

inlinestatic

Definition at line 65 of file dart_entry.h.

                                             {
    return Array::element_offset(kFirstNamedEntryIndex);
  }

FirstArgIndex()

intptr_t dart::ArgumentsDescriptor::FirstArgIndex ( ) const

inline

Definition at line 37 of file dart_entry.h.

{ return TypeArgsLen() > 0 ? 1 : 0; }

GetArgumentNames()

ArrayPtr dart::ArgumentsDescriptor::GetArgumentNames

(

)

const

Definition at line 394 of file dart_entry.cc.

                                                     {
  const intptr_t num_named_args = NamedCount();
  if (num_named_args == 0) {
    return Array::null();
  }
 
  Zone* zone = Thread::Current()->zone();
  const Array& names =
      Array::Handle(zone, Array::New(num_named_args, Heap::kOld));
  String& name = String::Handle(zone);
  const intptr_t num_pos_args = PositionalCount();
  for (intptr_t i = 0; i < num_named_args; ++i) {
    const intptr_t index = PositionAt(i) - num_pos_args;
    name = NameAt(i);
    ASSERT(names.At(index) == Object::null());
    names.SetAt(index, name);
  }
  return names.ptr();
}

Init()

void dart::ArgumentsDescriptor::Init ( )

static

Definition at line 569 of file dart_entry.cc.

                               {
  for (int i = 0; i < kCachedDescriptorCount; i++) {
    cached_args_descriptors_[i] =
        NewNonCached(/*type_args_len=*/0, i, i, false, Heap::kOld);
  }
}

MatchesNameAt()

bool dart::ArgumentsDescriptor::MatchesNameAt	(	intptr_t	i,
		const String &	other
	)		const

Definition at line 389 of file dart_entry.cc.

                                                                   {
  return NameAt(index) == other.ptr();
}

name_offset()

static intptr_t dart::ArgumentsDescriptor::name_offset ( )

inlinestatic

Definition at line 69 of file dart_entry.h.

{ return kNameOffset * kCompressedWordSize; }

NameAt()

StringPtr dart::ArgumentsDescriptor::NameAt

(

intptr_t

i

)

const

Definition at line 375 of file dart_entry.cc.

                                                          {
  const intptr_t offset =
      kFirstNamedEntryIndex + (index * kNamedEntrySize) + kNameOffset;
  String& result = String::Handle();
  result ^= array_.At(offset);
  return result.ptr();
}

named_entry_size()

static intptr_t dart::ArgumentsDescriptor::named_entry_size ( )

inlinestatic

Definition at line 73 of file dart_entry.h.

                                     {
    return kNamedEntrySize * kCompressedWordSize;
  }

NamedCount()

intptr_t dart::ArgumentsDescriptor::NamedCount ( ) const

inline

Definition at line 43 of file dart_entry.h.

{ return Count() - PositionalCount(); }

New() [1/2]

ArrayPtr dart::ArgumentsDescriptor::New ( intptr_t  type_args_len, intptr_t  num_arguments, intptr_t  size_arguments, const Array &  optional_arguments_names, Heap::Space  space = Heap::kOld  )

static

Definition at line 444 of file dart_entry.cc.

                                                   {
  const intptr_t num_named_args =
      optional_arguments_names.IsNull() ? 0 : optional_arguments_names.Length();
  if (num_named_args == 0) {
    return ArgumentsDescriptor::New(type_args_len, num_arguments,
                                    size_arguments, space);
  }
  ASSERT(type_args_len >= 0);
  ASSERT(num_arguments >= 0);
  const intptr_t num_pos_args = num_arguments - num_named_args;
 
  // Build the arguments descriptor array, which consists of the type
  // argument vector length (0 if none); total argument count; the positional
  // argument count; a sequence of (name, position) pairs, sorted by name, for
  // each named optional argument; and a terminating null to simplify iterating
  // in generated code.
  Thread* thread = Thread::Current();
  Zone* zone = thread->zone();
  const intptr_t descriptor_len = LengthFor(num_named_args);
  Array& descriptor = Array::Handle(zone, Array::New(descriptor_len, space));
 
  // Set length of type argument vector.
  descriptor.SetAt(kTypeArgsLenIndex, Smi::Handle(Smi::New(type_args_len)));
  // Set total number of passed arguments.
  descriptor.SetAt(kCountIndex, Smi::Handle(Smi::New(num_arguments)));
  // Set total number of passed arguments.
  descriptor.SetAt(kSizeIndex, Smi::Handle(Smi::New(size_arguments)));
 
  // Set number of positional arguments.
  descriptor.SetAt(kPositionalCountIndex, Smi::Handle(Smi::New(num_pos_args)));
 
  // Set alphabetically sorted entries for named arguments.
  String& name = String::Handle(zone);
  Smi& pos = Smi::Handle(zone);
  String& previous_name = String::Handle(zone);
  Smi& previous_pos = Smi::Handle(zone);
  for (intptr_t i = 0; i < num_named_args; i++) {
    name ^= optional_arguments_names.At(i);
    pos = Smi::New(num_pos_args + i);
    intptr_t insert_index = kFirstNamedEntryIndex + (kNamedEntrySize * i);
    // Shift already inserted pairs with "larger" names.
    while (insert_index > kFirstNamedEntryIndex) {
      intptr_t previous_index = insert_index - kNamedEntrySize;
      previous_name ^= descriptor.At(previous_index + kNameOffset);
      intptr_t result = name.CompareTo(previous_name);
      ASSERT(result != 0);  // Duplicate argument names checked in parser.
      if (result > 0) break;
      previous_pos ^= descriptor.At(previous_index + kPositionOffset);
      descriptor.SetAt(insert_index + kNameOffset, previous_name);
      descriptor.SetAt(insert_index + kPositionOffset, previous_pos);
      insert_index = previous_index;
    }
    // Insert pair in descriptor array.
    descriptor.SetAt(insert_index + kNameOffset, name);
    descriptor.SetAt(insert_index + kPositionOffset, pos);
  }
  // Set terminating null.
  descriptor.SetAt(descriptor_len - 1, Object::null_object());
 
  // Share the immutable descriptor when possible by canonicalizing it.
  descriptor.MakeImmutable();
  descriptor ^= descriptor.Canonicalize(thread);
  ASSERT(!descriptor.IsNull());
  return descriptor.ptr();
}

New() [2/2]

ArrayPtr dart::ArgumentsDescriptor::New ( intptr_t  type_args_len, intptr_t  num_arguments, intptr_t  size_arguments, Heap::Space  space = Heap::kOld  )

static

Definition at line 514 of file dart_entry.cc.

                                                   {
  ASSERT(type_args_len >= 0);
  ASSERT(num_arguments >= 0);
 
  if ((type_args_len == 0) && (num_arguments < kCachedDescriptorCount) &&
      (num_arguments == size_arguments)) {
    return cached_args_descriptors_[num_arguments];
  }
  return NewNonCached(type_args_len, num_arguments, size_arguments, true,
                      space);
}

NewBoxed() [1/2]

static ArrayPtr dart::ArgumentsDescriptor::NewBoxed ( intptr_t  type_args_len, intptr_t  num_arguments, const Array &  optional_arguments_names, Heap::Space  space = Heap::kOld  )

inlinestatic

Definition at line 83 of file dart_entry.h.

                                                       {
    return New(type_args_len, num_arguments, num_arguments,
               optional_arguments_names, space);
  }

NewBoxed() [2/2]

static ArrayPtr dart::ArgumentsDescriptor::NewBoxed ( intptr_t  type_args_len, intptr_t  num_arguments, Heap::Space  space = Heap::kOld  )

inlinestatic

Definition at line 106 of file dart_entry.h.

                                                       {
    return New(type_args_len, num_arguments, num_arguments, space);
  }

position_offset()

static intptr_t dart::ArgumentsDescriptor::position_offset ( )

inlinestatic

Definition at line 70 of file dart_entry.h.

                                    {
    return kPositionOffset * kCompressedWordSize;
  }

positional_count_offset()

static intptr_t dart::ArgumentsDescriptor::positional_count_offset ( )

inlinestatic

Definition at line 61 of file dart_entry.h.

                                            {
    return Array::element_offset(kPositionalCountIndex);
  }

PositionalCount()

intptr_t dart::ArgumentsDescriptor::PositionalCount

(

)

const

Definition at line 371 of file dart_entry.cc.

                                                    {
  return Smi::Value(Smi::RawCast(array_.At(kPositionalCountIndex)));
}

PositionAt()

intptr_t dart::ArgumentsDescriptor::PositionAt

(

intptr_t

i

)

const

Definition at line 383 of file dart_entry.cc.

                                                             {
  const intptr_t offset =
      kFirstNamedEntryIndex + (index * kNamedEntrySize) + kPositionOffset;
  return Smi::Value(Smi::RawCast(array_.At(offset)));
}

PrintTo()

void dart::ArgumentsDescriptor::PrintTo	(	BaseTextBuffer *	buffer,
		bool	show_named_positions = false
	)		const

Definition at line 414 of file dart_entry.cc.

                                                                   {
  if (TypeArgsLen() > 0) {
    buffer->Printf("<%" Pd ">", TypeArgsLen());
  }
  buffer->Printf("(%" Pd "", Count());
  if (NamedCount() > 0) {
    buffer->AddString(" {");
    auto& str = String::Handle();
    for (intptr_t i = 0; i < NamedCount(); i++) {
      if (i != 0) {
        buffer->AddString(", ");
      }
      str = NameAt(i);
      buffer->Printf("%s", str.ToCString());
      if (show_named_positions) {
        buffer->Printf(" (%" Pd ")", PositionAt(i));
      }
    }
    buffer->Printf("}");
  }
  buffer->Printf(")");
}

Size()

intptr_t dart::ArgumentsDescriptor::Size

(

)

const

Definition at line 367 of file dart_entry.cc.

                                         {
  return Smi::Value(Smi::RawCast(array_.At(kSizeIndex)));
}

size_offset()

static intptr_t dart::ArgumentsDescriptor::size_offset ( )

inlinestatic

Definition at line 59 of file dart_entry.h.

{ return Array::element_offset(kSizeIndex); }

SizeWithTypeArgs()

intptr_t dart::ArgumentsDescriptor::SizeWithTypeArgs ( ) const

inline

Definition at line 41 of file dart_entry.h.

{ return FirstArgIndex() + Size(); }

ToCString()

const char * dart::ArgumentsDescriptor::ToCString

(

)

const

Definition at line 438 of file dart_entry.cc.

                                                 {
  ZoneTextBuffer buf(Thread::Current()->zone());
  PrintTo(&buf);
  return buf.buffer();
}

type_args_len_offset()

static intptr_t dart::ArgumentsDescriptor::type_args_len_offset ( )

inlinestatic

Definition at line 53 of file dart_entry.h.

                                         {
    return Array::element_offset(kTypeArgsLenIndex);
  }

TypeArgsLen()

intptr_t dart::ArgumentsDescriptor::TypeArgsLen

(

)

const

Definition at line 359 of file dart_entry.cc.

                                                {
  return Smi::Value(Smi::RawCast(array_.At(kTypeArgsLenIndex)));
}

Friends And Related Function Documentation

VMDeserializationRoots

friend class VMDeserializationRoots

friend

Definition at line 183 of file dart_entry.h.

VMSerializationRoots

friend class VMSerializationRoots

friend

Definition at line 182 of file dart_entry.h.

---

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

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