Caller-owned C ABI for the Cocoa scrolling JOF view. More...

#include <stddef.h>
#include <stdint.h>
#include "ra8_err.h"
#include "ra8_viewer_reader.h"

Include dependency graph for ra8_viewer_view.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	ra8_viewer_view_requirements_t
	Exact first-party workspace required by one platform view. More...

Typedefs
typedef struct ra8_viewer_view	ra8_viewer_view_t
	Opaque view state bound inside caller workspace.

Functions
ra8_err_t	ra8_viewer_view_requirements (const ra8_viewer_reader_t reader, ra8_viewer_view_requirements_t out)
	Calculate the exact view workspace for `reader`.
ra8_err_t	ra8_viewer_view_open (ra8_viewer_view_t *out, ra8_viewer_reader_t reader, const char title, void workspace, size_t workspace_bytes, const ra8_viewer_view_requirements_t requirements, ra8_viewer_workspace_report_t report)
	Open a scrolling window into caller-owned first-party workspace.
bool	ra8_viewer_view_pump (ra8_viewer_view_t *view)
	Drain pending events; true after the window closes.
void	ra8_viewer_view_close (ra8_viewer_view_t *view)
	Close the window and reset borrowed view state without freeing it.

Detailed Description

Caller-owned C ABI for the Cocoa scrolling JOF view.

First-party C state, layout arrays, and pixel conversion scratch are bound from caller storage. AppKit and CoreGraphics object ownership remains an explicit platform/SOUP dependency and is not represented as first-party heap.

Copyright: Copyright (c) 2026 Brighton Sikarskie SPDX-License-Identifier: MIT

Since: 0.1.0

Definition in file ra8_viewer_view.h.

Typedef Documentation

◆ ra8_viewer_view_t

typedef struct ra8_viewer_view ra8_viewer_view_t

Opaque view state bound inside caller workspace.

Definition at line 24 of file ra8_viewer_view.h.

Function Documentation

◆ ra8_viewer_view_close()

void ra8_viewer_view_close ( ra8_viewer_view_t * view )

Close the window and reset borrowed view state without freeing it.

Removes notifications, closes AppKit objects, and clears C references.

Parameters

[in,out] view Bound view, or NULL.

Precondition: view is NULL or came from a successful open.; No pump call is in progress.

Postcondition: The platform window is closed when non-NULL.; Caller workspace and reader ownership remain unchanged.

Note: Must execute on the creating thread; NULL is safe.

Since: 0.1.0

Definition at line 48 of file ra8_viewer_view_stub.c.

Referenced by internal_run_window().

◆ ra8_viewer_view_open()

ra8_err_t ra8_viewer_view_open	(	ra8_viewer_view_t **	out,
		ra8_viewer_reader_t *	reader,
		const char *	title,
		void *	workspace,
		size_t	workspace_bytes,
		const ra8_viewer_view_requirements_t *	requirements,
		ra8_viewer_workspace_report_t *	report )

nodiscard

Open a scrolling window into caller-owned first-party workspace.

Parameters

[out]	out	Receives the bound view on success.
[in]	reader	Open reader that outlives the view.
[in]	title	Optional NUL-terminated title.
[in,out]	workspace	Caller-owned backing.
[in]	workspace_bytes	Accessible backing extent.
[in]	requirements	Unmodified requirements result.
[out]	report	Exact required/supplied evidence.