text_accessibility.hpp

Go to the documentation of this file.

#pragma once
 
// Cross-platform text accessibility surface.
//
// Most of Pulp's painted text bypasses the platform a11y APIs
// (NSAccessibility on macOS, UIA on Windows, AccessKit on Linux) because
// glyphs land directly on the GPU canvas without ever entering the
// platform's accessibility tree. This header defines the cross-platform
// SURFACE — a value type that captures the minimum a screen reader needs
// and a registration entry point — plus a no-op default backend that
// stores nodes in a process-local table.
//
// Platform backends overlay the default registry when available
// (NSAccessibility on macOS, UIA on Windows, AccessKit on Linux). The
// default backend remains useful for tests and unsupported platforms.
 
#include <cstddef>
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
 
namespace pulp::view {

enum class TextAccessibilityRole : std::uint8_t {
    Label,
    Button,
    TextEditor,
    Heading,
    Other,
};

struct TextAccessibilityNode {
    std::string id;

    std::string text;

    TextAccessibilityRole role = TextAccessibilityRole::Label;

    std::vector<std::size_t> cluster_boundaries_utf8;

    std::vector<std::size_t> cluster_boundaries_utf16;

    std::size_t selection_start_utf8 = 0;
    std::size_t selection_end_utf8 = 0;
};

std::string_view accessibility_backend_name() noexcept;

void register_text_accessibility_node(const TextAccessibilityNode& node);

void unregister_text_accessibility_node(std::string_view id);

std::vector<TextAccessibilityNode> snapshot_accessibility_nodes();
 
}  // namespace pulp::view