flutter::UIDartState Class Reference

#include <ui_dart_state.h>

Inheritance diagram for flutter::UIDartState:

Classes
struct	Context
	The subset of state which is owned by the shell or engine and passed through the RuntimeController into DartIsolates. If a shell-owned resource needs to be exposed to the framework via UIDartState, a pointer to the resource can be added to this struct with appropriate default construction. More...

Public Member Functions
Dart_Port	main_port () const
bool	IsRootIsolate () const
void	SetDebugName (const std::string &name)
const std::string &	debug_name () const
const std::string &	logger_prefix () const
PlatformConfiguration *	platform_configuration () const
void	SetPlatformMessageHandler (std::weak_ptr< PlatformMessageHandler > handler)
Dart_Handle	HandlePlatformMessage (std::unique_ptr< PlatformMessage > message)
const TaskRunners &	GetTaskRunners () const
void	ScheduleMicrotask (Dart_Handle handle)
void	FlushMicrotasksNow ()
fml::WeakPtr< IOManager >	GetIOManager () const
fml::RefPtr< flutter::SkiaUnrefQueue >	GetSkiaUnrefQueue () const
std::shared_ptr< VolatilePathTracker >	GetVolatilePathTracker () const
std::shared_ptr< fml::ConcurrentTaskRunner >	GetConcurrentTaskRunner () const
fml::TaskRunnerAffineWeakPtr< SnapshotDelegate >	GetSnapshotDelegate () const
fml::WeakPtr< ImageDecoder >	GetImageDecoder () const
fml::WeakPtr< ImageGeneratorRegistry >	GetImageGeneratorRegistry () const
std::shared_ptr< IsolateNameServer >	GetIsolateNameServer () const
tonic::DartErrorHandleType	GetLastError ()
void	LogMessage (const std::string &tag, const std::string &message) const
UnhandledExceptionCallback	unhandled_exception_callback () const
int64_t	GetRootIsolateToken () const
bool	IsImpellerEnabled () const
	Whether Impeller is enabled for this application.
impeller::RuntimeStageBackend	GetRuntimeStageBackend () const
	The expected type for runtime stage shaders.
virtual Dart_Isolate	CreatePlatformIsolate (Dart_Handle entry_point, char **error)
Public Member Functions inherited from tonic::DartState
	DartState (int dirfd=-1, std::function< void(Dart_Handle)> message_epilogue=nullptr)
virtual	~DartState ()
std::weak_ptr< DartState >	GetWeakPtr ()
Dart_Isolate	isolate ()
void	SetIsolate (Dart_Isolate isolate)
Dart_PersistentHandle	private_constructor_name ()
DartClassLibrary &	class_library ()
DartMessageHandler &	message_handler ()
FileLoader &	file_loader ()
void	MessageEpilogue (Dart_Handle message_result)
void	SetReturnCode (uint32_t return_code)
void	SetReturnCodeCallback (std::function< void(uint32_t)> callback)
bool	has_set_return_code () const
void	SetIsShuttingDown ()
bool	IsShuttingDown ()

Static Public Member Functions
static UIDartState *	Current ()
static void	ThrowIfUIOperationsProhibited ()
Static Public Member Functions inherited from tonic::DartState
static DartState *	From (Dart_Isolate isolate)
static DartState *	Current ()
static Dart_Handle	HandleLibraryTag (Dart_LibraryTag tag, Dart_Handle library, Dart_Handle url)

Protected Member Functions
	UIDartState (TaskObserverAdd add_callback, TaskObserverRemove remove_callback, std::string logger_prefix, UnhandledExceptionCallback unhandled_exception_callback, LogMessageCallback log_message_callback, std::shared_ptr< IsolateNameServer > isolate_name_server, bool is_root_isolate_, const UIDartState::Context &context)
	~UIDartState () override
void	SetPlatformConfiguration (std::unique_ptr< PlatformConfiguration > platform_configuration)
const std::string &	GetAdvisoryScriptURI () const
Protected Member Functions inherited from tonic::DartState
Dart_Isolate	isolate () const
	TONIC_DISALLOW_COPY_AND_ASSIGN (DartState)

Private Member Functions
void	DidSetIsolate () override

Detailed Description

Definition at line 36 of file ui_dart_state.h.

Constructor & Destructor Documentation

UIDartState()

flutter::UIDartState::UIDartState ( TaskObserverAdd  add_callback, TaskObserverRemove  remove_callback, std::string  logger_prefix, UnhandledExceptionCallback  unhandled_exception_callback, LogMessageCallback  log_message_callback, std::shared_ptr< IsolateNameServer >  isolate_name_server, bool  is_root_isolate_, const UIDartState::Context &  context  )

protected

Definition at line 58 of file ui_dart_state.cc.

    : add_callback_(std::move(add_callback)),
      remove_callback_(std::move(remove_callback)),
      logger_prefix_(std::move(logger_prefix)),
      is_root_isolate_(is_root_isolate),
      unhandled_exception_callback_(std::move(unhandled_exception_callback)),
      log_message_callback_(std::move(log_message_callback)),
      isolate_name_server_(std::move(isolate_name_server)),
      context_(context) {
  AddOrRemoveTaskObserver(true /* add */);
}

~UIDartState()

flutter::UIDartState::~UIDartState ( )

overrideprotected

Definition at line 78 of file ui_dart_state.cc.

                          {
  AddOrRemoveTaskObserver(false /* remove */);
}

Member Function Documentation

CreatePlatformIsolate()

Dart_Isolate flutter::UIDartState::CreatePlatformIsolate ( Dart_Handle  entry_point, char **  error  )

virtual

Reimplemented in flutter::DartIsolate.

Definition at line 265 of file ui_dart_state.cc.

                                                              {
  FML_UNREACHABLE();
  return nullptr;
}

Current()

UIDartState * flutter::UIDartState::Current ( )

static

Definition at line 119 of file ui_dart_state.cc.

                                  {
  return static_cast<UIDartState*>(DartState::Current());
}

debug_name()

const std::string & flutter::UIDartState::debug_name ( ) const

inline

Definition at line 116 of file ui_dart_state.h.

{ return debug_name_; }

DidSetIsolate()

void flutter::UIDartState::DidSetIsolate ( )

overrideprivatevirtual

Reimplemented from tonic::DartState.

Definition at line 94 of file ui_dart_state.cc.

                                {
  main_port_ = Dart_GetMainPortId();
  std::ostringstream debug_name;
  // main.dart$main-1234
  debug_name << context_.advisory_script_uri << "$"
             << context_.advisory_script_entrypoint << "-" << main_port_;
  SetDebugName(debug_name.str());
}

FlushMicrotasksNow()

void flutter::UIDartState::FlushMicrotasksNow

(

)

Definition at line 169 of file ui_dart_state.cc.

                                     {
  microtask_queue_.RunMicrotasks();
}

GetAdvisoryScriptURI()

const std::string & flutter::UIDartState::GetAdvisoryScriptURI ( ) const

protected

Definition at line 82 of file ui_dart_state.cc.

                                                         {
  return context_.advisory_script_uri;
}

GetConcurrentTaskRunner()

std::shared_ptr< fml::ConcurrentTaskRunner > flutter::UIDartState::GetConcurrentTaskRunner

(

)

const

Definition at line 157 of file ui_dart_state.cc.

                                           {
  return context_.concurrent_task_runner;
}

GetImageDecoder()

fml::WeakPtr< ImageDecoder > flutter::UIDartState::GetImageDecoder

(

)

const

Definition at line 194 of file ui_dart_state.cc.

                                                            {
  return context_.image_decoder;
}

GetImageGeneratorRegistry()

fml::WeakPtr< ImageGeneratorRegistry > flutter::UIDartState::GetImageGeneratorRegistry

(

)

const

Definition at line 198 of file ui_dart_state.cc.

          {
  return context_.image_generator_registry;
}

GetIOManager()

fml::WeakPtr< IOManager > flutter::UIDartState::GetIOManager

(

)

const

Definition at line 143 of file ui_dart_state.cc.

                                                      {
  return context_.io_manager;
}

GetIsolateNameServer()

std::shared_ptr< IsolateNameServer > flutter::UIDartState::GetIsolateNameServer

(

)

const

Definition at line 203 of file ui_dart_state.cc.

                                                                         {
  return isolate_name_server_;
}

GetLastError()

tonic::DartErrorHandleType flutter::UIDartState::GetLastError

(

)

Definition at line 207 of file ui_dart_state.cc.

                                                   {
  tonic::DartErrorHandleType error = message_handler().isolate_last_error();
  if (error == tonic::kNoError) {
    error = microtask_queue_.GetLastError();
  }
  return error;
}

GetRootIsolateToken()

int64_t flutter::UIDartState::GetRootIsolateToken

(

)

const

Returns a enumeration that uniquely represents this root isolate. Returns 0 if called from a non-root isolate.

Definition at line 261 of file ui_dart_state.cc.

                                               {
  return IsRootIsolate() ? reinterpret_cast<int64_t>(this) : 0;
}

GetRuntimeStageBackend()

impeller::RuntimeStageBackend flutter::UIDartState::GetRuntimeStageBackend

(

)

const

The expected type for runtime stage shaders.

Definition at line 90 of file ui_dart_state.cc.

                                                                      {
  return context_.runtime_stage_backend;
}

GetSkiaUnrefQueue()

fml::RefPtr< flutter::SkiaUnrefQueue > flutter::UIDartState::GetSkiaUnrefQueue

(

)

const

Definition at line 147 of file ui_dart_state.cc.

                                                                      {
  return context_.unref_queue;
}

GetSnapshotDelegate()

fml::TaskRunnerAffineWeakPtr< SnapshotDelegate > flutter::UIDartState::GetSnapshotDelegate

(

)

const

Definition at line 190 of file ui_dart_state.cc.

                                       {
  return context_.snapshot_delegate;
}

GetTaskRunners()

const TaskRunners & flutter::UIDartState::GetTaskRunners

(

)

const

Definition at line 139 of file ui_dart_state.cc.

                                                     {
  return context_.task_runners;
}

GetVolatilePathTracker()

std::shared_ptr< VolatilePathTracker > flutter::UIDartState::GetVolatilePathTracker

(

)

const

Definition at line 151 of file ui_dart_state.cc.

          {
  return context_.volatile_path_tracker;
}

HandlePlatformMessage()

Dart_Handle flutter::UIDartState::HandlePlatformMessage

(

std::unique_ptr< PlatformMessage >

message

)

Definition at line 242 of file ui_dart_state.cc.

                                            {
  if (platform_configuration_) {
    platform_configuration_->client()->HandlePlatformMessage(
        std::move(message));
  } else {
    std::shared_ptr<PlatformMessageHandler> handler =
        platform_message_handler_.lock();
    if (handler) {
      handler->HandlePlatformMessage(std::move(message));
    } else {
      return tonic::ToDart(
          "No platform channel handler registered for background isolate.");
    }
  }
 
  return Dart_Null();
}

IsImpellerEnabled()

bool flutter::UIDartState::IsImpellerEnabled

(

)

const

Whether Impeller is enabled for this application.

Definition at line 86 of file ui_dart_state.cc.

                                          {
  return context_.enable_impeller;
}

IsRootIsolate()

bool flutter::UIDartState::IsRootIsolate ( ) const

inline

Definition at line 111 of file ui_dart_state.h.

{ return is_root_isolate_; }

logger_prefix()

const std::string & flutter::UIDartState::logger_prefix ( ) const

inline

Definition at line 118 of file ui_dart_state.h.

{ return logger_prefix_; }

LogMessage()

void flutter::UIDartState::LogMessage	(	const std::string &	tag,
		const std::string &	message
	)		const

Definition at line 215 of file ui_dart_state.cc.

                                                             {
  if (log_message_callback_) {
    log_message_callback_(tag, message);
  } else {
    // Fall back to previous behavior if unspecified.
#if defined(FML_OS_ANDROID)
    __android_log_print(ANDROID_LOG_INFO, tag.c_str(), "%.*s",
                        static_cast<int>(message.size()), message.c_str());
#elif defined(FML_OS_IOS)
    std::stringstream stream;
    if (!tag.empty()) {
      stream << tag << ": ";
    }
    stream << message;
    std::string log = stream.str();
    syslog(1 /* LOG_ALERT */, "%.*s", static_cast<int>(log.size()),
           log.c_str());
#else
    if (!tag.empty()) {
      std::cout << tag << ": ";
    }
    std::cout << message << std::endl;
#endif
  }
}

main_port()

Dart_Port flutter::UIDartState::main_port ( ) const

inline

Definition at line 109 of file ui_dart_state.h.

{ return main_port_; }

platform_configuration()

PlatformConfiguration * flutter::UIDartState::platform_configuration ( ) const

inline

Definition at line 120 of file ui_dart_state.h.

                                                        {
    return platform_configuration_.get();
  }

ScheduleMicrotask()

void flutter::UIDartState::ScheduleMicrotask

(

Dart_Handle

handle

)

Definition at line 161 of file ui_dart_state.cc.

                                                       {
  if (tonic::CheckAndHandleError(closure) || !Dart_IsClosure(closure)) {
    return;
  }
 
  microtask_queue_.ScheduleMicrotask(closure);
}

SetDebugName()

void flutter::UIDartState::SetDebugName

(

const std::string &

name

)

Definition at line 111 of file ui_dart_state.cc.

                                                          {
  debug_name_ = debug_name;
  if (platform_configuration_) {
    platform_configuration_->client()->UpdateIsolateDescription(debug_name_,
                                                                main_port_);
  }
}

SetPlatformConfiguration()

void flutter::UIDartState::SetPlatformConfiguration ( std::unique_ptr< PlatformConfiguration >  platform_configuration )

protected

Definition at line 123 of file ui_dart_state.cc.

                                                                 {
  FML_DCHECK(IsRootIsolate());
  platform_configuration_ = std::move(platform_configuration);
  if (platform_configuration_) {
    platform_configuration_->client()->UpdateIsolateDescription(debug_name_,
                                                                main_port_);
  }
}

SetPlatformMessageHandler()

void flutter::UIDartState::SetPlatformMessageHandler

(

std::weak_ptr< PlatformMessageHandler >

handler

)

Definition at line 133 of file ui_dart_state.cc.

                                                 {
  FML_DCHECK(!IsRootIsolate());
  platform_message_handler_ = std::move(handler);
}

ThrowIfUIOperationsProhibited()

void flutter::UIDartState::ThrowIfUIOperationsProhibited ( )

static

Definition at line 103 of file ui_dart_state.cc.

                                                {
  if (!UIDartState::Current()->IsRootIsolate()) {
    Dart_EnterScope();
    Dart_ThrowException(
        tonic::ToDart("UI actions are only available on root isolate."));
  }
}

unhandled_exception_callback()

UnhandledExceptionCallback flutter::UIDartState::unhandled_exception_callback ( ) const

inline

Definition at line 160 of file ui_dart_state.h.

                                                                  {
    return unhandled_exception_callback_;
  }

---

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

• lib/ui/ui_dart_state.h
• lib/ui/ui_dart_state.cc