Flutter Engine
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
tonic::DartWrappable Class Referenceabstract

#include <dart_wrappable.h>

Inheritance diagram for tonic::DartWrappable:
flutter::RefCountedDartWrappable< Canvas > flutter::RefCountedDartWrappable< CanvasImage > flutter::RefCountedDartWrappable< CanvasPath > flutter::RefCountedDartWrappable< CanvasPathMeasure > flutter::RefCountedDartWrappable< Codec > flutter::RefCountedDartWrappable< ColorFilter > flutter::RefCountedDartWrappable< EngineLayer > flutter::RefCountedDartWrappable< FragmentProgram > flutter::RefCountedDartWrappable< ImageDescriptor > flutter::RefCountedDartWrappable< ImageFilter > flutter::RefCountedDartWrappable< ImmutableBuffer > flutter::RefCountedDartWrappable< NativeSemanticsFlags > flutter::RefCountedDartWrappable< NativeStringAttribute > flutter::RefCountedDartWrappable< Paragraph > flutter::RefCountedDartWrappable< ParagraphBuilder > flutter::RefCountedDartWrappable< Picture > flutter::RefCountedDartWrappable< PictureRecorder > flutter::RefCountedDartWrappable< RSuperellipse > flutter::RefCountedDartWrappable< Scene > flutter::RefCountedDartWrappable< SceneBuilder > flutter::RefCountedDartWrappable< SemanticsUpdate > flutter::RefCountedDartWrappable< SemanticsUpdateBuilder > flutter::RefCountedDartWrappable< Shader > flutter::RefCountedDartWrappable< Vertices > flutter::RefCountedDartWrappable< CommandBuffer > flutter::RefCountedDartWrappable< Context > flutter::RefCountedDartWrappable< DeviceBuffer > flutter::RefCountedDartWrappable< RenderPass > flutter::RefCountedDartWrappable< RenderPipeline > flutter::RefCountedDartWrappable< ShaderLibrary > flutter::RefCountedDartWrappable< Texture > flutter::RefCountedDartWrappable< MyNativeClass > flutter::RefCountedDartWrappable< T > zircon::dart::Handle zircon::dart::HandleDisposition zircon::dart::HandleWaiter zircon::dart::System

Public Types

enum  DartNativeFields {
  kPeerIndex ,
  kNumberOfNativeFields
}
 

Public Member Functions

 DartWrappable ()
 
virtual const DartWrapperInfo & GetDartWrapperInfo () const =0
 
virtual void RetainDartWrappableReference () const =0
 
virtual void ReleaseDartWrappableReference () const =0
 
Dart_Handle CreateDartWrapper (DartState *dart_state)
 
void AssociateWithDartWrapper (Dart_Handle wrappable)
 
void ClearDartWrapper ()
 
Dart_WeakPersistentHandle dart_wrapper () const
 

Protected Member Functions

virtual ~DartWrappable ()
 

Static Protected Member Functions

static Dart_PersistentHandle GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)
 

Detailed Description

Definition at line 22 of file dart_wrappable.h.

Member Enumeration Documentation

◆ DartNativeFields

enum tonic::DartWrappable::DartNativeFields
Enumerator
kPeerIndex 
kNumberOfNativeFields 

Definition at line 24 of file dart_wrappable.h.

24 {
25 kPeerIndex, // Must be first to work with Dart_GetNativeReceiver.
26 kNumberOfNativeFields,
27 };

Constructor & Destructor Documentation

◆ DartWrappable()

tonic::DartWrappable::DartWrappable ( )
inline

Definition at line 29 of file dart_wrappable.h.

29: dart_wrapper_(DartWeakPersistentValue()) {}

◆ ~DartWrappable()

tonic::DartWrappable::~DartWrappable ( )
protectedvirtual

Definition at line 14 of file dart_wrappable.cc.

14 {
15 // Calls the destructor of dart_wrapper_ to delete WeakPersistentHandle.
16}

Member Function Documentation

◆ AssociateWithDartWrapper()

void tonic::DartWrappable::AssociateWithDartWrapper ( Dart_Handle  wrappable)

Definition at line 47 of file dart_wrappable.cc.

47 {
48 if (!dart_wrapper_.is_empty()) {
49 // Any previously given out wrapper must have been GCed.
50 TONIC_DCHECK(Dart_IsNull(dart_wrapper_.Get()));
51 dart_wrapper_.Clear();
52 }
53
54 TONIC_CHECK(!CheckAndHandleError(wrapper));
55
56 TONIC_CHECK(!CheckAndHandleError(Dart_SetNativeInstanceField(
57 wrapper, kPeerIndex, reinterpret_cast<intptr_t>(this))));
58
59 this->RetainDartWrappableReference(); // Balanced in FinalizeDartWrapper.
60
61 DartState* dart_state = DartState::Current();
62 dart_wrapper_.Set(dart_state, wrapper, this, sizeof(*this),
63 &FinalizeDartWrapper);
64}
tonic::DartState::Current
static DartState * Current()
Definition dart_state.cc:56
tonic::DartWeakPersistentValue::Set
void Set(DartState *dart_state, Dart_Handle object, void *peer, intptr_t external_allocation_size, Dart_HandleFinalizer callback)
Definition dart_weak_persistent_value.cc:18
tonic::DartWrappable::RetainDartWrappableReference
virtual void RetainDartWrappableReference() const =0
tonic::CheckAndHandleError
bool CheckAndHandleError(Dart_Handle handle)
Definition dart_error.cc:33
TONIC_CHECK
#define TONIC_CHECK(condition)
Definition macros.h:23
TONIC_DCHECK
#define TONIC_DCHECK
Definition macros.h:32

References tonic::CheckAndHandleError(), tonic::DartWeakPersistentValue::Clear(), tonic::DartState::Current(), tonic::DartWeakPersistentValue::Get(), tonic::DartWeakPersistentValue::is_empty(), kPeerIndex, RetainDartWrappableReference(), tonic::DartWeakPersistentValue::Set(), TONIC_CHECK, and TONIC_DCHECK.

Referenced by flutter::ImmutableBuffer::init(), flutter::ImmutableBuffer::initFromAsset(), and flutter::ImmutableBuffer::initFromFile().

◆ ClearDartWrapper()

void tonic::DartWrappable::ClearDartWrapper ( )

Definition at line 66 of file dart_wrappable.cc.

66 {
67 TONIC_DCHECK(!dart_wrapper_.is_empty());
68 Dart_Handle wrapper = dart_wrapper_.Get();
69 TONIC_CHECK(!CheckAndHandleError(
70 Dart_SetNativeInstanceField(wrapper, kPeerIndex, 0)));
71 dart_wrapper_.Clear();
72 this->ReleaseDartWrappableReference();
73}
tonic::DartWrappable::ReleaseDartWrappableReference
virtual void ReleaseDartWrappableReference() const =0

References tonic::CheckAndHandleError(), tonic::DartWeakPersistentValue::Clear(), tonic::DartWeakPersistentValue::Get(), tonic::DartWeakPersistentValue::is_empty(), kPeerIndex, ReleaseDartWrappableReference(), TONIC_CHECK, and TONIC_DCHECK.

Referenced by flutter::ParagraphBuilder::build(), flutter::SceneBuilder::build(), flutter::SemanticsUpdateBuilder::build(), flutter::Scene::dispose(), flutter::Codec::dispose(), flutter::CanvasImage::dispose(), flutter::ImageDescriptor::dispose(), flutter::ImageShader::dispose(), flutter::ImmutableBuffer::dispose(), flutter::Picture::dispose(), flutter::SemanticsUpdate::dispose(), and flutter::PictureRecorder::endRecording().

◆ CreateDartWrapper()

Dart_Handle tonic::DartWrappable::CreateDartWrapper ( DartState *  dart_state)

Definition at line 19 of file dart_wrappable.cc.

19 {
20 if (!dart_wrapper_.is_empty()) {
21 // Any previously given out wrapper must have been GCed.
22 TONIC_DCHECK(Dart_IsNull(dart_wrapper_.Get()));
23 dart_wrapper_.Clear();
24 }
25
26 const DartWrapperInfo& info = GetDartWrapperInfo();
27
28 Dart_PersistentHandle type = dart_state->class_library().GetClass(info);
29 TONIC_DCHECK(!CheckAndHandleError(type));
30
31 Dart_Handle wrapper =
32 Dart_New(type, dart_state->private_constructor_name(), 0, nullptr);
33
34 TONIC_DCHECK(!CheckAndHandleError(wrapper));
35
36 Dart_Handle res = Dart_SetNativeInstanceField(
37 wrapper, kPeerIndex, reinterpret_cast<intptr_t>(this));
38 TONIC_DCHECK(!CheckAndHandleError(res));
39
40 this->RetainDartWrappableReference(); // Balanced in FinalizeDartWrapper.
41 dart_wrapper_.Set(dart_state, wrapper, this, sizeof(*this),
42 &FinalizeDartWrapper);
43
44 return wrapper;
45}
type
GLenum type
Definition blit_command_gles.cc:153
tonic::DartWrappable::GetDartWrapperInfo
virtual const DartWrapperInfo & GetDartWrapperInfo() const =0

References tonic::CheckAndHandleError(), tonic::DartState::class_library(), tonic::DartWeakPersistentValue::Clear(), tonic::DartWeakPersistentValue::Get(), tonic::DartClassLibrary::GetClass(), GetDartWrapperInfo(), tonic::DartWeakPersistentValue::is_empty(), kPeerIndex, tonic::DartState::private_constructor_name(), RetainDartWrappableReference(), tonic::DartWeakPersistentValue::Set(), TONIC_DCHECK, and type.

Referenced by tonic::DartConverter< T *, typename std::enable_if< std::is_convertible< T *, const DartWrappable * >::value >::type >::SetReturnValue(), and tonic::DartConverter< T *, typename std::enable_if< std::is_convertible< T *, const DartWrappable * >::value >::type >::ToDart().

◆ dart_wrapper()

Dart_WeakPersistentHandle tonic::DartWrappable::dart_wrapper ( ) const
inline

Definition at line 47 of file dart_wrappable.h.

47 {
48 return dart_wrapper_.value();
49 }
tonic::DartWeakPersistentValue::value
Dart_WeakPersistentHandle value() const
Definition dart_weak_persistent_value.h:26

References tonic::DartWeakPersistentValue::value().

Referenced by flutter::FragmentProgram::initFromAsset(), tonic::DartConverter< T *, typename std::enable_if< std::is_convertible< T *, const DartWrappable * >::value >::type >::SetReturnValue(), and tonic::DartConverter< T *, typename std::enable_if< std::is_convertible< T *, const DartWrappable * >::value >::type >::ToDart().

◆ GetDartWrapperInfo()

virtual const DartWrapperInfo & tonic::DartWrappable::GetDartWrapperInfo ( ) const
pure virtual

Referenced by CreateDartWrapper().

◆ GetTypeForWrapper()

Dart_PersistentHandle tonic::DartWrappable::GetTypeForWrapper ( tonic::DartState *  dart_state,
const tonic::DartWrapperInfo &  wrapper_info 
)
staticprotected

Definition at line 81 of file dart_wrappable.cc.

83 {
84 return dart_state->class_library().GetClass(wrapper_info);
85}
tonic::DartClassLibrary::GetClass
Dart_PersistentHandle GetClass(const DartWrapperInfo &info)
Definition dart_class_library.cc:20
tonic::DartState::class_library
DartClassLibrary & class_library()
Definition dart_state.h:60

References tonic::DartState::class_library(), and tonic::DartClassLibrary::GetClass().

◆ ReleaseDartWrappableReference()

virtual void tonic::DartWrappable::ReleaseDartWrappableReference ( ) const
pure virtual

Implemented in flutter::RefCountedDartWrappable< T >, flutter::RefCountedDartWrappable< Canvas >, flutter::RefCountedDartWrappable< CanvasImage >, flutter::RefCountedDartWrappable< CanvasPath >, flutter::RefCountedDartWrappable< CanvasPathMeasure >, flutter::RefCountedDartWrappable< Codec >, flutter::RefCountedDartWrappable< ColorFilter >, flutter::RefCountedDartWrappable< CommandBuffer >, flutter::RefCountedDartWrappable< Context >, flutter::RefCountedDartWrappable< DeviceBuffer >, flutter::RefCountedDartWrappable< EngineLayer >, flutter::RefCountedDartWrappable< FragmentProgram >, flutter::RefCountedDartWrappable< ImageDescriptor >, flutter::RefCountedDartWrappable< ImageFilter >, flutter::RefCountedDartWrappable< ImmutableBuffer >, flutter::RefCountedDartWrappable< MyNativeClass >, flutter::RefCountedDartWrappable< NativeSemanticsFlags >, flutter::RefCountedDartWrappable< NativeStringAttribute >, flutter::RefCountedDartWrappable< Paragraph >, flutter::RefCountedDartWrappable< ParagraphBuilder >, flutter::RefCountedDartWrappable< Picture >, flutter::RefCountedDartWrappable< PictureRecorder >, flutter::RefCountedDartWrappable< RenderPass >, flutter::RefCountedDartWrappable< RenderPipeline >, flutter::RefCountedDartWrappable< RSuperellipse >, flutter::RefCountedDartWrappable< Scene >, flutter::RefCountedDartWrappable< SceneBuilder >, flutter::RefCountedDartWrappable< SemanticsUpdate >, flutter::RefCountedDartWrappable< SemanticsUpdateBuilder >, flutter::RefCountedDartWrappable< Shader >, flutter::RefCountedDartWrappable< ShaderLibrary >, flutter::RefCountedDartWrappable< Texture >, and flutter::RefCountedDartWrappable< Vertices >.

Referenced by ClearDartWrapper().

◆ RetainDartWrappableReference()

virtual void tonic::DartWrappable::RetainDartWrappableReference ( ) const
pure virtual

Implemented in flutter::RefCountedDartWrappable< T >, flutter::RefCountedDartWrappable< Canvas >, flutter::RefCountedDartWrappable< CanvasImage >, flutter::RefCountedDartWrappable< CanvasPath >, flutter::RefCountedDartWrappable< CanvasPathMeasure >, flutter::RefCountedDartWrappable< Codec >, flutter::RefCountedDartWrappable< ColorFilter >, flutter::RefCountedDartWrappable< CommandBuffer >, flutter::RefCountedDartWrappable< Context >, flutter::RefCountedDartWrappable< DeviceBuffer >, flutter::RefCountedDartWrappable< EngineLayer >, flutter::RefCountedDartWrappable< FragmentProgram >, flutter::RefCountedDartWrappable< ImageDescriptor >, flutter::RefCountedDartWrappable< ImageFilter >, flutter::RefCountedDartWrappable< ImmutableBuffer >, flutter::RefCountedDartWrappable< MyNativeClass >, flutter::RefCountedDartWrappable< NativeSemanticsFlags >, flutter::RefCountedDartWrappable< NativeStringAttribute >, flutter::RefCountedDartWrappable< Paragraph >, flutter::RefCountedDartWrappable< ParagraphBuilder >, flutter::RefCountedDartWrappable< Picture >, flutter::RefCountedDartWrappable< PictureRecorder >, flutter::RefCountedDartWrappable< RenderPass >, flutter::RefCountedDartWrappable< RenderPipeline >, flutter::RefCountedDartWrappable< RSuperellipse >, flutter::RefCountedDartWrappable< Scene >, flutter::RefCountedDartWrappable< SceneBuilder >, flutter::RefCountedDartWrappable< SemanticsUpdate >, flutter::RefCountedDartWrappable< SemanticsUpdateBuilder >, flutter::RefCountedDartWrappable< Shader >, flutter::RefCountedDartWrappable< ShaderLibrary >, flutter::RefCountedDartWrappable< Texture >, and flutter::RefCountedDartWrappable< Vertices >.

Referenced by AssociateWithDartWrapper(), and CreateDartWrapper().

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