atspi_common/

role.rs

use serde::{Deserialize, Serialize};
use zvariant::Type;

use crate::AtspiError;

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, Type, Hash)]
/// An accessible object role.
/// To think of it in terms of HTML, any semantic element likely has a corollary in this enum.
/// For example: `<button>`, `<input>`, `<form>` or `<h4>`.
/// Non-semantic elements like `<span>`, `<div>` and `<b>` will not be represented here, and this information is not passed through via the atspi library.
/// TODO: add examples for GTK/Qt libraries in addition to HTML examples.
#[repr(u32)]
pub enum Role {
	/// A role indicating an error condition, such as uninitialized Role data, or an error deserializing.
	Invalid,
	/// Object is a label indicating the keyboard accelerators for the parent.
	AcceleratorLabel,
	/// Object is used to alert the user about something.
	Alert,
	/// Object contains a dynamic or moving image of some kind.
	Animation,
	/// Object is a 2d directional indicator.
	Arrow,
	/// Object contains one or more dates, usually arranged into a 2d list.
	Calendar,
	/// Object that can be drawn into and is used to trap events.
	Canvas,
	/// A choice that can be checked or unchecked and provides a separate indicator for the current state.
	CheckBox,
	/// A menu item that behaves like a check box. See [`Self::CheckBox`].
	CheckMenuItem,
	/// A specialized dialog that lets the user choose a color.
	ColorChooser,
	/// The header for a column of data.
	ColumnHeader,
	/// A list of choices the user can select from.
	ComboBox,
	/// An object which allows entry of a date.
	DateEditor,
	/// An inconifed internal frame within a [`Role::DesktopFrame`].
	DesktopIcon,
	/// A pane that supports internal frames and iconified versions of those internal frames.
	DesktopFrame,
	/// An object that allows a value to be changed via rotating a visual element, or which displays a value via such a rotating element.
	Dial,
	/// A top level window with title bar and a border.
	Dialog,
	/// A pane that allows the user to navigate through and select the contents of a directory.
	DirectoryPane,
	/// An object used for drawing custom user interface elements.
	DrawingArea,
	/// A specialized dialog that displays the files in the directory and lets the user select a file, browse a different directory, or specify a filename.
	FileChooser,
	/// A object that fills up space in a user interface.
	Filler,
	/// Don't use, reserved for future use.
	FocusTraversable,
	/// Allows selection of a display font.
	FontChooser,
	/// A top level window with a title bar, border, menubar, etc.
	Frame,
	/// A pane that is guaranteed to be painted on top of all panes beneath it.
	GlassPane,
	/// A document container for HTML, whose children represent the document content.
	HTMLContainer,
	/// A small fixed size picture, typically used to decorate components.
	Icon,
	/// An image, typically static.
	Image,
	/// A frame-like object that is clipped by a desktop pane.
	InternalFrame,
	/// An object used to present an icon or short string in an interface.
	Label,
	/// A specialized pane that allows its children to be drawn in layers, providing a form of stacking order.
	LayeredPane,
	/// An object that presents a list of objects to the user and * allows the user to select one or more of them.
	List,
	/// An object that represents an element of a list.
	ListItem,
	/// An object usually found inside a menu bar that contains a list of actions the user can choose from.
	Menu,
	/// An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from.
	MenuBar,
	/// An object usually contained in a menu that presents an action the user can choose.
	MenuItem,
	/// A specialized pane whose primary use is inside a dialog.
	OptionPane,
	/// An object that is a child of a page tab list.
	PageTab,
	/// An object that presents a series of panels (or page tabs), one at a time,through some mechanism provided by the object.
	PageTabList,
	/// A generic container that is often used to group objects.
	Panel,
	/// A text object uses for passwords, or other places where the text content is not shown visibly to the user.
	PasswordText,
	/// A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices.
	PopupMenu,
	/// An object used to indicate how much of a task has been completed.
	ProgressBar,
	/// An object the user can manipulate to tell the application to do something.
	PushButton,
	/// A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked.
	RadioButton,
	/// Object is both a menu item and a "radio button". See [`Self::RadioButton`].
	RadioMenuItem,
	/// A specialized pane that has a glass pane and a layered pane as its children.
	RootPane,
	/// The header for a row of data.
	RowHeader,
	/// An object usually used to allow a user to incrementally view a large amount of data by moving the bounds of a viewport along a one-dimensional axis.
	ScrollBar,
	/// A scroll pane: the pane in which the scrollable content is contained within.
	/// An object that allows a user to incrementally view a large amount of information.
	/// [`Self::ScrollPane`] objects are usually accompanied by [`Self::ScrollBar`] controllers,
	/// on which the [`crate::RelationType::ControllerFor`] and [`crate::RelationType::ControlledBy`] reciprocal relations are set.
	ScrollPane,
	/// An object usually contained in a menu to provide a visible and logical separation of the contents in a menu.
	Separator,
	/// An object that allows the user to select from a bounded range.
	/// Unlike [`Self::ScrollBar`], [`Self::Slider`] objects need not control 'viewport'-like objects.
	Slider,
	/// An object which allows one of a set of choices to be selected, and which displays the current choice.
	SpinButton,
	/// A specialized panel that presents two other panels at the same time.
	SplitPane,
	/// Object displays non-quantitative status information (c.f. [`Self::ProgressBar`])
	StatusBar,
	/// An object used to represent information in terms of rows and columns.
	Table,
	/// A 'cell' or discrete child within a Table.
	/// Note: Table cells need not have [`Self::TableCell`], other [`crate::Role`] values are valid as well.
	TableCell,
	/// An object which labels a particular column in an [`Self::Table`].
	TableColumnHeader,
	/// An object which labels a particular row in a [`Self::Table`].
	/// `TableProxy` rows and columns may also be labelled via the
	/// [`crate::RelationType::LabelFor`]/[`crate::RelationType::LabelledBy`] relationships.
	/// See: `AccessibleProxy::get_relation_type`.
	TableRowHeader,
	/// Object allows menu to be removed from menubar and shown in its own window.
	TearoffMenuItem,
	/// An object that emulates a terminal.
	Terminal,
	/// An interactive widget that supports multiple lines of text and optionally accepts user input,
	/// but whose purpose is not to solicit user input.
	/// Thus [`Self::Text`] is appropriate for the text view in a plain text editor but inappropriate for an input field in a dialog box or web form.
	/// For widgets whose purpose is to solicit input from the user, see [`Self::Entry`] and [`Self::PasswordText`].
	/// For generic objects which display a brief amount of textual information, see [`Self::Static`].
	Text,
	/// A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state.
	ToggleButton,
	/// A bar or palette usually composed of push buttons or toggle buttons.
	ToolBar,
	/// An object that provides information about another object.
	ToolTip,
	/// An object used to repsent hierarchical information to the user.
	Tree,
	/// An object that presents both tabular and hierarchical info to the user.
	TreeTable,
	/// When the role cannot be accurately reported, this role will be set.
	Unknown,
	/// An object usually used in a scroll pane, or to otherwise clip a larger object or content renderer to a specific onscreen viewport.
	Viewport,
	/// A top level window with no title or border.
	Window,
	/// means that the role for this item is known, but not included in the core enumeration.
	Extended,
	/// An object that serves as a document header.
	Header,
	/// An object that serves as a document footer.
	Footer,
	/// An object which is contains a single paragraph of text content. See also [`Self::Text`].
	Paragraph,
	/// An object which describes margins and tab stops, etc. for text objects which it controls (should have [`crate::RelationType::ControllerFor`] relation to such).
	Ruler,
	/// An object corresponding to the toplevel accessible of an application, which may contain [`Self::Frame`] objects or other accessible objects.
	/// Children of objects with the [`Self::DesktopFrame`] role are generally [`Self::Application`] objects.
	Application,
	/// The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry.
	Autocomplete,
	/// The object is an editable text object in a toolbar.
	Editbar,
	/// The object is an embedded component container.
	/// This role is a "grouping" hint that the contained objects share a context which is different from the container in which this accessible is embedded.
	/// In particular, it is used for some kinds of document embedding, and for embedding of out-of-process component, "panel applets", etc.
	Embedded,
	/// The object is a component whose textual content may be entered or modified by the user, provided [`crate::State::Editable`] is present.
	/// A readonly [`Self::Entry`] object (i.e. where [`crate::State::Editable`] is not present) implies a read-only 'text field' in a form, as opposed to a title, label, or caption.
	Entry,
	/// The object is a graphical depiction of quantitative data.
	/// It may contain multiple subelements whose attributes and/or description may be queried to obtain both the  quantitative data and information about how the data is being presented.
	/// The [`crate::RelationType::LabelledBy`] relation is particularly important in interpreting objects of this type, as is the accessible description property.
	/// See [`Self::Caption`].
	CHART,
	/// The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.
	Caption,
	/// The object is a visual frame or container which
	/// contains a view of document content. [`Self::DocumentFrame`]s may occur within
	/// another `DocumentProxy` instance, in which case the second  document may be
	/// said to be embedded in the containing instance.
	/// HTML frames are often [`Self::DocumentFrame`]:  Either this object, or a singleton descendant,
	/// should implement the [`crate::Interface::Document`] interface.
	DocumentFrame,
	/// Heading: this is a heading with a level (usually 1-6). This is represented by `<h1>` through `<h6>` in HTML.
	/// The object serves as a heading for content which follows it in a document.
	/// The 'heading level' of the heading, if available, may be obtained by querying the object's attributes.
	Heading,
	/// The object is a containing instance which encapsulates a page of information.
	/// [`Self::Page`] is used in documents and content which support a paginated navigation model.
	Page,
	/// The object is a containing instance of document content which constitutes a particular 'logical' section of the document.
	/// The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes.
	/// Sections may be nested.
	Section,
	/// The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons.
	/// Objects of this role should be ignored by clients, if they are encountered at all.
	RedundantObject,
	/// The object is a containing instance of document content which has within it components with which the user can interact in order to input information;
	/// i.e. the object is a container for pushbuttons, comboboxes, text input fields, and other 'GUI' components.
	/// [`Self::Form`] should not, in general, be used for toplevel GUI containers or dialogs, but should be reserved for 'GUI' containers which occur within document content, for instance within Web documents, presentations, or text documents.
	/// Unlike other GUI containers and dialogs which occur inside application instances, [`Self::Form`] containers' components are associated with the current document, rather than the current foreground application or viewer instance.
	Form,
	/// The object is a hypertext anchor, i.e. a "link" in a hypertext document.
	/// Such objects are distinct from 'inline' content which may also use the [`crate::Interface::Hypertext`]/[`crate::Interface::Hyperlink`] interfaces to indicate the range/location within a text object where an inline or embedded object lies.
	Link,
	/// The object is a window or similar viewport which is used to allow composition or input of a 'complex character', in other words it is an "input method window".
	InputMethodWindow,
	/// A row in a table.
	TableRow,
	/// An object that represents an element of a tree.
	TreeItem,
	/// A document frame which contains a spreadsheet.
	DocumentSpreadsheet,
	/// A document frame which contains a presentation or slide content.
	DocumentPresentation,
	/// A document frame which contains textual content, such as found in a word processing application.
	DocumentText,
	/// A document frame which contains HTML or other markup suitable for display in a web browser.
	DocumentWeb,
	/// A document frame which contains email content to be displayed or composed either in plain text or HTML.
	DocumentEmail,
	/// An object found within a document and designed to present a comment, note, or other annotation.
	/// In some cases, this object might not be visible until activated.
	Comment,
	/// A non-collapsible list of choices the user can select from.
	ListBox,
	/// A group of related widgets. This group typically has a label.
	Grouping,
	/// An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document.
	ImageMap,
	/// A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application.
	Notification,
	/// An object designed to present a message to the user within an existing window.
	InfoBar,
	/// A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery.
	LevelBar,
	/// A bar that serves as the title of a window or a dialog.
	TitleBar,
	/// An object which contains a text section that is quoted from another source.
	BlockQuote,
	/// An object which represents an audio element.
	Audio,
	/// An object which represents a video element.
	Video,
	/// A definition of a term or concept.
	Definition,
	/// A section of a page that consists of a composition that forms an independent part of a document, page, or site.
	/// Examples: A blog entry, a news story, a forum post.
	Article,
	/// A region of a web page intended as a navigational landmark. This is designed to allow Assistive Technologies to provide quick navigation among key regions within a document.
	Landmark,
	/// A text widget or container holding log content, such as chat history and error logs. In this role there is a relationship between the arrival of new items in the log and the reading order.
	/// The log contains a meaningful sequence and new information is added only to the end of the log, not at arbitrary points.
	Log,
	/// A container where non-essential information changes frequently.
	/// Common usages of marquee include stock tickers and ad banners.
	/// The primary difference between a marquee and a log is that logs usually have a meaningful order or sequence of important content changes.
	Marquee,
	/// A text widget or container that holds a mathematical expression.
	Math,
	/// A rating system, generally out of five stars, but it does not need to be that way. There is no tag nor role for this in HTML, however.
	/// A widget whose purpose is to display a rating, such as the number of stars associated with a song in a media player.
	/// Objects of this role should also implement [`crate::Interface::Value`].
	Rating,
	/// An object containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point.
	Timer,
	/// A generic non-container object whose purpose is to display a brief amount of information to the user and whose role is known by the implementor but lacks semantic value for the user.
	/// Examples in which [`Self::Static`] is appropriate include the message displayed in a message box and an image used as an alternative means to display text.
	/// [`Self::Static`] should not be applied to widgets which are traditionally interactive, objects which display a significant amount of content, or any object which has an accessible relation pointing to another object.
	/// The displayed information, as a general rule, should be exposed through the accessible name of the object.
	/// For labels which describe another widget, see [`Self::Label`].
	/// For text views, see [`Self::Text`].
	/// For generic containers, see [`Self::Panel`]. For objects whose role is not known by the implementor, see [`Self::Unknown`].
	Static,
	/// An object that represents a mathematical fraction.
	MathFraction,
	/// An object that represents a mathematical expression displayed with a radical.
	MathRoot,
	/// An object that contains text that is displayed as a subscript.
	Subscript,
	/// An object that contains text that is displayed as a superscript.
	Superscript,
	/// An object that represents a list of term-value groups.
	/// A term-value group represents an individual description and consist of one or more names ([`Self::DescriptionTerm`]) followed by one or more values ([`Self::DescriptionValue`]).
	/// For each list, there should not be more than one group with the same term name.
	DescriptionList,
	/// An object that represents a term or phrase with a corresponding definition.
	DescriptionTerm,
	/// An object that represents the description, definition, or value of a term.
	DescriptionValue,
	/// An object that contains the text of a footnote.
	Footnote,
	/// Content previously deleted or proposed to be deleted, e.g. in revision history or a content view providing suggestions from reviewers.
	ContentDeletion,
	/// Content previously inserted or proposed to be inserted, e.g. in revision history or a content view providing suggestions from reviewers.
	ContentInsertion,
	/// A run of content that is marked or highlighted, such as for reference purposes, or to call it out as having a special purpose.
	/// If the marked content has an associated section in the document elaborating on the reason for the mark, then [`crate::RelationType::Details`] should be used on the mark to point to that associated section.
	/// In addition, the reciprocal relation [`crate::RelationType::DetailsFor`] should be used on the associated content section to point back to the mark.
	Mark,
	/// A container for content that is called out as a proposed change from the current version of the document, such as by a reviewer of the content.
	/// An object with this role should include children with [`Self::ContentDeletion`] and/or [`Self::ContentInsertion`], in any order, to indicate what the actual change is.
	Suggestion,
	/// A specialized push button to open a menu.
	PushButtonMenu,
}

impl TryFrom<u32> for Role {
	type Error = AtspiError;

	#[allow(clippy::too_many_lines)]
	fn try_from(value: u32) -> Result<Self, Self::Error> {
		#[allow(clippy::enum_glob_use)]
		use Role::*;
		let res = match value {
			0 => Invalid,
			1 => AcceleratorLabel,
			2 => Alert,
			3 => Animation,
			4 => Arrow,
			5 => Calendar,
			6 => Canvas,
			7 => CheckBox,
			8 => CheckMenuItem,
			9 => ColorChooser,
			10 => ColumnHeader,
			11 => ComboBox,
			12 => DateEditor,
			13 => DesktopIcon,
			14 => DesktopFrame,
			15 => Dial,
			16 => Dialog,
			17 => DirectoryPane,
			18 => DrawingArea,
			19 => FileChooser,
			20 => Filler,
			21 => FocusTraversable,
			22 => FontChooser,
			23 => Frame,
			24 => GlassPane,
			25 => HTMLContainer,
			26 => Icon,
			27 => Image,
			28 => InternalFrame,
			29 => Label,
			30 => LayeredPane,
			31 => List,
			32 => ListItem,
			33 => Menu,
			34 => MenuBar,
			35 => MenuItem,
			36 => OptionPane,
			37 => PageTab,
			38 => PageTabList,
			39 => Panel,
			40 => PasswordText,
			41 => PopupMenu,
			42 => ProgressBar,
			43 => PushButton,
			44 => RadioButton,
			45 => RadioMenuItem,
			46 => RootPane,
			47 => RowHeader,
			48 => ScrollBar,
			49 => ScrollPane,
			50 => Separator,
			51 => Slider,
			52 => SpinButton,
			53 => SplitPane,
			54 => StatusBar,
			55 => Table,
			56 => TableCell,
			57 => TableColumnHeader,
			58 => TableRowHeader,
			59 => TearoffMenuItem,
			60 => Terminal,
			61 => Text,
			62 => ToggleButton,
			63 => ToolBar,
			64 => ToolTip,
			65 => Tree,
			66 => TreeTable,
			67 => Unknown,
			68 => Viewport,
			69 => Window,
			70 => Extended,
			71 => Header,
			72 => Footer,
			73 => Paragraph,
			74 => Ruler,
			75 => Application,
			76 => Autocomplete,
			77 => Editbar,
			78 => Embedded,
			79 => Entry,
			80 => CHART,
			81 => Caption,
			82 => DocumentFrame,
			83 => Heading,
			84 => Page,
			85 => Section,
			86 => RedundantObject,
			87 => Form,
			88 => Link,
			89 => InputMethodWindow,
			90 => TableRow,
			91 => TreeItem,
			92 => DocumentSpreadsheet,
			93 => DocumentPresentation,
			94 => DocumentText,
			95 => DocumentWeb,
			96 => DocumentEmail,
			97 => Comment,
			98 => ListBox,
			99 => Grouping,
			100 => ImageMap,
			101 => Notification,
			102 => InfoBar,
			103 => LevelBar,
			104 => TitleBar,
			105 => BlockQuote,
			106 => Audio,
			107 => Video,
			108 => Definition,
			109 => Article,
			110 => Landmark,
			111 => Log,
			112 => Marquee,
			113 => Math,
			114 => Rating,
			115 => Timer,
			116 => Static,
			117 => MathFraction,
			118 => MathRoot,
			119 => Subscript,
			120 => Superscript,
			121 => DescriptionList,
			122 => DescriptionTerm,
			123 => DescriptionValue,
			124 => Footnote,
			125 => ContentDeletion,
			126 => ContentInsertion,
			127 => Mark,
			128 => Suggestion,
			129 => PushButtonMenu,
			_ => return Err(AtspiError::UnknownRole(value)),
		};
		Ok(res)
	}
}

#[cfg(test)]
pub mod tests {
	use super::Role;
	use zvariant::{from_slice, to_bytes, EncodingContext};

	const HIGHEST_ROLE_VALUE: u32 = 129;

	#[test]
	fn test_serialization_matches_from_impl() {
		let ctxt = EncodingContext::<byteorder::LE>::new_dbus(0);
		for role_num in 1..=HIGHEST_ROLE_VALUE {
			let from_role = Role::try_from(role_num)
				.unwrap_or_else(|_| panic!("Unable to convert {role_num} into Role"));
			let encoded = to_bytes(ctxt, &from_role).expect("Unable to encode {from_role}");
			println!("ENCODED: {encoded:?}");
			let zbus_role: Role =
				from_slice(&encoded, ctxt).expect("Unable to convert {encoded} into Role");
			assert_eq!(from_role, zbus_role, "The serde zvariant::from_slice(...) and From<u32> implementations have produced different results. The number used was {role_num}, it produced a Role of {from_role}, but the from_slice(...) implementation produced {zbus_role}");
			assert_eq!(
				from_role as u32, role_num,
				"The role number {role_num} does not match the representation of the role {}",
				from_role as u32
			);
		}
	}
}

const ROLE_NAMES: &[&str] = &[
	"invalid",
	"accelerator label",
	"alert",
	"animation",
	"arrow",
	"calendar",
	"canvas",
	"check box",
	"check menu item",
	"color chooser",
	"column header",
	"combo box",
	"date editor",
	"desktop icon",
	"desktop frame",
	"dial",
	"dialog",
	"directory pane",
	"drawing area",
	"file chooser",
	"filler",
	"focus traversable",
	"font chooser",
	"frame",
	"glass pane",
	"html container",
	"icon",
	"image",
	"internal frame",
	"label",
	"layered pane",
	"list",
	"list item",
	"menu",
	"menu bar",
	"menu item",
	"option pane",
	"page tab",
	"page tab list",
	"panel",
	"password text",
	"popup menu",
	"progress bar",
	"push button",
	"radio button",
	"radio menu item",
	"root pane",
	"row header",
	"scroll bar",
	"scroll pane",
	"separator",
	"slider",
	"spin button",
	"split pane",
	"status bar",
	"table",
	"table cell",
	"table column header",
	"table row header",
	"tearoff menu item",
	"terminal",
	"text",
	"toggle button",
	"tool bar",
	"tool tip",
	"tree",
	"tree table",
	"unknown",
	"viewport",
	"window",
	"extended",
	"header",
	"footer",
	"paragraph",
	"ruler",
	"application",
	"autocomplete",
	"editbar",
	"embedded",
	"entry",
	"chart",
	"caption",
	"document frame",
	"heading",
	"page",
	"section",
	"redundant object",
	"form",
	"link",
	"input method window",
	"table row",
	"tree item",
	"document spreadsheet",
	"document presentation",
	"document text",
	"document web",
	"document email",
	"comment",
	"list box",
	"grouping",
	"image map",
	"notification",
	"info bar",
	"level bar",
	"title bar",
	"block quote",
	"audio",
	"video",
	"definition",
	"article",
	"landmark",
	"log",
	"marquee",
	"math",
	"rating",
	"timer",
	"static",
	"math fraction",
	"math root",
	"subscript",
	"superscript",
	"description list",
	"description term",
	"description value",
	"footnote",
	"content deletion",
	"content insertion",
	"mark",
	"suggestion",
	"push button menu",
];

impl Role {
	/// Get a readable, English name from the role.
	#[must_use]
	pub fn name(&self) -> &'static str {
		ROLE_NAMES[*self as usize]
	}
}

impl std::fmt::Display for Role {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		write!(f, "{}", self.name())
	}
}