#include <atk/atk.h>
#include "flutter/shell/platform/linux/fl_accessible_node.h"
#include "flutter/shell/platform/linux/fl_accessible_text_field.h"
#include "flutter/shell/platform/linux/fl_view_accessible.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_value.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_view.h"

Classes
struct	_FlViewAccessible

Enumerations
enum	FlAtkLive { FL_ATK_LIVE_NONE , FL_ATK_LIVE_POLITE , FL_ATK_LIVE_ASSERTIVE , FL_ATK_LIVE_NONE , FL_ATK_LIVE_POLITE , FL_ATK_LIVE_ASSERTIVE }

Functions
static FlAccessibleNode *	create_node (FlViewAccessible self, FlutterSemanticsNode2 semantics)

static FlAccessibleNode *	lookup_node (FlViewAccessible *self, int32_t id)

static FlAccessibleNode *	get_node (FlViewAccessible self, FlutterSemanticsNode2 semantics)

static gint	fl_view_accessible_get_n_children (AtkObject *accessible)

static AtkObject *	fl_view_accessible_ref_child (AtkObject *accessible, gint i)

static AtkRole	fl_view_accessible_get_role (AtkObject *accessible)

static AtkStateSet *	fl_view_accessible_ref_state_set (AtkObject *accessible)

static void	fl_view_accessible_dispose (GObject *object)

static void	fl_view_accessible_class_init (FlViewAccessibleClass *klass)

static void	fl_view_accessible_init (FlViewAccessible *self)

FlViewAccessible *	fl_view_accessible_new (FlEngine *engine, FlutterViewId view_id)

void	fl_view_accessible_handle_update_semantics (FlViewAccessible self, const FlutterSemanticsUpdate2 update)

void	fl_view_accessible_send_announcement (FlViewAccessible self, const char message, gboolean assertive)

Variables
static constexpr int32_t	kRootSemanticsNodeId = 0

Enumeration Type Documentation

◆ FlAtkLive

enum FlAtkLive

Enumerator
FL_ATK_LIVE_NONE
FL_ATK_LIVE_POLITE
FL_ATK_LIVE_ASSERTIVE
FL_ATK_LIVE_NONE
FL_ATK_LIVE_POLITE
FL_ATK_LIVE_ASSERTIVE

Definition at line 37 of file fl_view_accessible.cc.

              {
   FL_ATK_LIVE_NONE,
   FL_ATK_LIVE_POLITE,
   FL_ATK_LIVE_ASSERTIVE
 } FlAtkLive;

Function Documentation

◆ create_node()

static FlAccessibleNode* create_node	(	FlViewAccessible *	self,
		FlutterSemanticsNode2 *	semantics
	)

static

Definition at line 43 of file fl_view_accessible.cc.

                                                                        {
   g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&self->engine));
   if (engine == nullptr) {
     return nullptr;
   }
  
   if (semantics->flags2->is_text_field) {
     return fl_accessible_text_field_new(engine, self->view_id, semantics->id);
   }
  
   return fl_accessible_node_new(engine, self->view_id, semantics->id);
 }

References fl_accessible_node_new(), fl_accessible_text_field_new(), and g_autoptr().

Referenced by get_node().

◆ fl_view_accessible_class_init()

static void fl_view_accessible_class_init ( FlViewAccessibleClass * klass )

static

Definition at line 134 of file fl_view_accessible.cc.

                                                                         {
   ATK_OBJECT_CLASS(klass)->get_n_children = fl_view_accessible_get_n_children;
   ATK_OBJECT_CLASS(klass)->ref_child = fl_view_accessible_ref_child;
   ATK_OBJECT_CLASS(klass)->get_role = fl_view_accessible_get_role;
   ATK_OBJECT_CLASS(klass)->ref_state_set = fl_view_accessible_ref_state_set;
  
   G_OBJECT_CLASS(klass)->dispose = fl_view_accessible_dispose;
 }

References fl_view_accessible_dispose(), fl_view_accessible_get_n_children(), fl_view_accessible_get_role(), fl_view_accessible_ref_child(), and fl_view_accessible_ref_state_set().

◆ fl_view_accessible_dispose()

static void fl_view_accessible_dispose ( GObject * object )

static

Definition at line 124 of file fl_view_accessible.cc.

                                                         {
   FlViewAccessible* self = FL_VIEW_ACCESSIBLE(object);
  
   g_clear_pointer(&self->semantics_nodes_by_id, g_hash_table_unref);
  
   g_weak_ref_clear(&self->engine);
  
   G_OBJECT_CLASS(fl_view_accessible_parent_class)->dispose(object);
 }

Referenced by fl_view_accessible_class_init().

◆ fl_view_accessible_get_n_children()

static gint fl_view_accessible_get_n_children ( AtkObject * accessible )

static

Definition at line 89 of file fl_view_accessible.cc.

                                                                      {
   FlViewAccessible* self = FL_VIEW_ACCESSIBLE(accessible);
   FlAccessibleNode* node = lookup_node(self, 0);
  
   if (node == nullptr) {
     return 0;
   }
  
   return 1;
 }

References accessible, and lookup_node().

Referenced by fl_view_accessible_class_init().

◆ fl_view_accessible_get_role()

static AtkRole fl_view_accessible_get_role ( AtkObject * accessible )

static

Definition at line 113 of file fl_view_accessible.cc.

                                                                   {
   return ATK_ROLE_PANEL;
 }

Referenced by fl_view_accessible_class_init().

◆ fl_view_accessible_handle_update_semantics()

void fl_view_accessible_handle_update_semantics	(	FlViewAccessible *	accessible,
		const FlutterSemanticsUpdate2 *	update
	)

fl_view_accessible_handle_update_semantics: @accessible: an #FlViewAccessible. @update: semantic update information.

Handle a semantics update from Flutter.

Definition at line 157 of file fl_view_accessible.cc.

                                            {
   g_return_if_fail(FL_IS_VIEW_ACCESSIBLE(self));
  
   g_autoptr(GHashTable) pending_children =
       g_hash_table_new_full(g_direct_hash, g_direct_equal, nullptr,
                             reinterpret_cast<GDestroyNotify>(fl_value_unref));
   for (size_t i = 0; i < update->node_count; i++) {
     FlutterSemanticsNode2* node = update->nodes[i];
     FlAccessibleNode* atk_node = get_node(self, node);
  
     fl_accessible_node_set_flags(atk_node, node->flags2);
     fl_accessible_node_set_actions(atk_node, node->actions);
     fl_accessible_node_set_name(atk_node, node->label);
     fl_accessible_node_set_extents(
         atk_node, node->rect.left + node->transform.transX,
         node->rect.top + node->transform.transY,
         node->rect.right - node->rect.left, node->rect.bottom - node->rect.top);
     fl_accessible_node_set_value(atk_node, node->value);
     fl_accessible_node_set_text_selection(atk_node, node->text_selection_base,
                                           node->text_selection_extent);
     fl_accessible_node_set_text_direction(atk_node, node->text_direction);
  
     FlValue* children = fl_value_new_int32_list(
         node->children_in_traversal_order, node->child_count);
     g_hash_table_insert(pending_children, atk_node, children);
   }
  
   g_hash_table_foreach_remove(
       pending_children,
       [](gpointer key, gpointer value, gpointer user_data) -> gboolean {
         FlViewAccessible* self = FL_VIEW_ACCESSIBLE(user_data);
  
         FlAccessibleNode* parent = FL_ACCESSIBLE_NODE(key);
  
         size_t child_count = fl_value_get_length(static_cast<FlValue*>(value));
         const int32_t* children_in_traversal_order =
             fl_value_get_int32_list(static_cast<FlValue*>(value));
  
         g_autoptr(GPtrArray) children = g_ptr_array_new();
         for (size_t i = 0; i < child_count; i++) {
           FlAccessibleNode* child =
               lookup_node(self, children_in_traversal_order[i]);
           if (child == nullptr) {
             continue;
           }
           fl_accessible_node_set_parent(child, ATK_OBJECT(parent), i);
           g_ptr_array_add(children, child);
         }
         fl_accessible_node_set_children(parent, children);
  
         return TRUE;
       },
       self);
 }

References fl_accessible_node_set_actions(), fl_accessible_node_set_children(), fl_accessible_node_set_extents(), fl_accessible_node_set_flags(), fl_accessible_node_set_name(), fl_accessible_node_set_parent(), fl_accessible_node_set_text_direction(), fl_accessible_node_set_text_selection(), fl_accessible_node_set_value(), fl_value_get_int32_list(), fl_value_get_length(), fl_value_new_int32_list(), fl_value_unref(), g_autoptr(), get_node(), i, lookup_node(), TRUE, user_data, and value.

Referenced by TEST(), and update_semantics_cb().

◆ fl_view_accessible_init()

static void fl_view_accessible_init ( FlViewAccessible * self )

static

Definition at line 143 of file fl_view_accessible.cc.

                                                             {
   self->semantics_nodes_by_id = g_hash_table_new_full(
       g_direct_hash, g_direct_equal, nullptr, g_object_unref);
 }

◆ fl_view_accessible_new()

FlViewAccessible* fl_view_accessible_new	(	FlEngine *	engine,
		FlutterViewId	view_id
	)

Definition at line 148 of file fl_view_accessible.cc.

                                                                 {
   FlViewAccessible* self =
       FL_VIEW_ACCESSIBLE(g_object_new(fl_view_accessible_get_type(), nullptr));
   g_weak_ref_init(&self->engine, engine);
   self->view_id = view_id;
   return self;
 }

References view_id.

Referenced by setup_engine(), and TEST().

◆ fl_view_accessible_ref_child()

static AtkObject* fl_view_accessible_ref_child	(	AtkObject *	accessible,
		gint	i
	)

static

Definition at line 101 of file fl_view_accessible.cc.

                                                                               {
   FlViewAccessible* self = FL_VIEW_ACCESSIBLE(accessible);
   FlAccessibleNode* node = lookup_node(self, 0);
  
   if (i != 0 || node == nullptr) {
     return nullptr;
   }
  
   return ATK_OBJECT(g_object_ref(node));
 }

References accessible, i, and lookup_node().

Referenced by fl_view_accessible_class_init().

◆ fl_view_accessible_ref_state_set()

static AtkStateSet* fl_view_accessible_ref_state_set ( AtkObject * accessible )

static

Definition at line 118 of file fl_view_accessible.cc.

                                                                             {
   FlViewAccessible* self = FL_VIEW_ACCESSIBLE(accessible);
   FlAccessibleNode* node = lookup_node(self, 0);
   return node != nullptr ? atk_object_ref_state_set(ATK_OBJECT(node)) : nullptr;
 }

References accessible, and lookup_node().

Referenced by fl_view_accessible_class_init().

◆ fl_view_accessible_send_announcement()

void fl_view_accessible_send_announcement	(	FlViewAccessible *	accessible,
		const char *	message,
		gboolean	assertive
	)

fl_view_accessible_send_announcement: @accessible: an #FlViewAccessible. @message: text to be announced. @assertive: TRUE if the message should be in an assertive voice.

Sends an annoucement to a screen reader.

Definition at line 214 of file fl_view_accessible.cc.

                                                               {
   g_return_if_fail(FL_IS_VIEW_ACCESSIBLE(self));
   if (atk_get_major_version() == 2 && atk_get_minor_version() >= 50) {
     g_signal_emit_by_name(
         self, "notification", message,
         assertive ? FL_ATK_LIVE_ASSERTIVE : FL_ATK_LIVE_POLITE);
   } else if (atk_get_major_version() == 2 && atk_get_minor_version() >= 46) {
     g_signal_emit_by_name(self, "announcement", message);
   }
 }

References FL_ATK_LIVE_ASSERTIVE, FL_ATK_LIVE_POLITE, and message.

◆ get_node()

static FlAccessibleNode* get_node	(	FlViewAccessible *	self,
		FlutterSemanticsNode2 *	semantics
	)

static

Definition at line 64 of file fl_view_accessible.cc.

                                                                     {
   FlAccessibleNode* node = lookup_node(self, semantics->id);
   if (node != nullptr) {
     return node;
   }
  
   node = create_node(self, semantics);
   if (semantics->id == kRootSemanticsNodeId) {
     fl_accessible_node_set_parent(node, ATK_OBJECT(self), 0);
   }
   g_hash_table_insert(self->semantics_nodes_by_id,
                       GINT_TO_POINTER(semantics->id),
                       reinterpret_cast<gpointer>(node));
  
   // Update when root node is created.
   if (!self->root_node_created && semantics->id == kRootSemanticsNodeId) {
     g_signal_emit_by_name(self, "children-changed::add", 0, node, nullptr);
     self->root_node_created = true;
   }
  
   return node;
 }

References create_node(), fl_accessible_node_set_parent(), kRootSemanticsNodeId, and lookup_node().

Referenced by fl_view_accessible_handle_update_semantics().

◆ lookup_node()

static FlAccessibleNode* lookup_node	(	FlViewAccessible *	self,
		int32_t	id
	)

static

Definition at line 57 of file fl_view_accessible.cc.

                                                                          {
   return FL_ACCESSIBLE_NODE(
       g_hash_table_lookup(self->semantics_nodes_by_id, GINT_TO_POINTER(id)));
 }

Referenced by fl_view_accessible_get_n_children(), fl_view_accessible_handle_update_semantics(), fl_view_accessible_ref_child(), fl_view_accessible_ref_state_set(), and get_node().

Variable Documentation

◆ kRootSemanticsNodeId

constexpr int32_t kRootSemanticsNodeId = 0

staticconstexpr

Definition at line 17 of file fl_view_accessible.cc.

Referenced by get_node().

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ FlAtkLive

Function Documentation

◆ create_node()

◆ fl_view_accessible_class_init()

◆ fl_view_accessible_dispose()

◆ fl_view_accessible_get_n_children()

◆ fl_view_accessible_get_role()

◆ fl_view_accessible_handle_update_semantics()

◆ fl_view_accessible_init()

◆ fl_view_accessible_new()

◆ fl_view_accessible_ref_child()

◆ fl_view_accessible_ref_state_set()

◆ fl_view_accessible_send_announcement()

◆ get_node()

◆ lookup_node()

Variable Documentation

◆ kRootSemanticsNodeId