ra8_viewer_output_internal.h File Reference

Private typed diagnostic writers for the host viewer. More...

#include <stddef.h>
#include <stdint.h>
#include "ra8_attributes.h"
#include "ra8_err.h"
#include "ra8_io_stream.h"

Include dependency graph for ra8_viewer_output_internal.h:

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

Go to the source code of this file.

Functions
ra8_err_t	priv_viewer_output_usage (ra8_io_stream_t *output, const char *executable)
	Write the complete command-line usage message.
ra8_err_t	priv_viewer_output_capacity (ra8_io_stream_t *output, const char *subject, size_t required, size_t supplied)
	Write an exact workspace requirement diagnostic.
ra8_err_t	priv_viewer_output_index_error (ra8_io_stream_t *output, const char *operation, uint32_t index, ra8_err_t error)
	Write a numbered operation failure and hexadecimal status.
ra8_err_t	priv_viewer_output_error (ra8_io_stream_t *output, const char *operation, ra8_err_t error)
	Write an unnumbered operation failure and hexadecimal status.
ra8_err_t	priv_viewer_output_open_error (ra8_io_stream_t *output, const char *path, ra8_err_t error)
	Write a document-open failure with its path and status.
ra8_err_t	priv_viewer_output_opened (ra8_io_stream_t *output, const char *path, uint32_t page_count)
	Write a successful document-open diagnostic.
ra8_err_t	priv_viewer_output_wrote (ra8_io_stream_t *output, const char *path)
	Write a successful path-publication diagnostic.
ra8_err_t	priv_viewer_output_tile (ra8_io_stream_t *output, uint32_t tile, uint32_t width, uint32_t height, const char *path)
	Write a successful tile-publication diagnostic.
ra8_err_t	priv_viewer_output_text (ra8_io_stream_t *output, const char *text)
	Write one fixed diagnostic without a terminating byte.

Detailed Description

Private typed diagnostic writers for the host viewer.

Declares the stream-injected, allocation-free message vocabulary used by the viewer composition root and its focused output tests.

Copyright

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

Since

0.1.0

Definition in file ra8_viewer_output_internal.h.

Function Documentation

priv_viewer_output_capacity()

ra8_err_t priv_viewer_output_capacity ( ra8_io_stream_t * output, const char * subject, size_t required, size_t supplied )

nodiscard

Write an exact workspace requirement diagnostic.

Definition at line 125 of file ra8_viewer_output.c.

References internal_put_text(), internal_put_u64(), and ra8_io_stream_puts().

Referenced by internal_report_capacity().

priv_viewer_output_error()

ra8_err_t priv_viewer_output_error ( ra8_io_stream_t * output, const char * operation, ra8_err_t error )

nodiscard

Write an unnumbered operation failure and hexadecimal status.

Definition at line 151 of file ra8_viewer_output.c.

References internal_put_hex(), internal_put_text(), and ra8_io_stream_puts().

Referenced by internal_dump_tile().

priv_viewer_output_index_error()

ra8_err_t priv_viewer_output_index_error ( ra8_io_stream_t * output, const char * operation, uint32_t index, ra8_err_t error )

nodiscard

Write a numbered operation failure and hexadecimal status.

Definition at line 138 of file ra8_viewer_output.c.

References internal_put_hex(), internal_put_text(), internal_put_u32(), and ra8_io_stream_puts().

Referenced by internal_dump_tile(), and internal_render_page().

priv_viewer_output_open_error()

ra8_err_t priv_viewer_output_open_error ( ra8_io_stream_t * output, const char * path, ra8_err_t error )

nodiscard

Write a document-open failure with its path and status.

Definition at line 160 of file ra8_viewer_output.c.

References internal_put_hex(), internal_put_text(), and ra8_io_stream_puts().

Referenced by main().

priv_viewer_output_opened()

ra8_err_t priv_viewer_output_opened ( ra8_io_stream_t * output, const char * path, uint32_t page_count )

nodiscard

Write a successful document-open diagnostic.

Definition at line 169 of file ra8_viewer_output.c.

References internal_put_text(), internal_put_u32(), and ra8_io_stream_puts().

Referenced by main().

priv_viewer_output_text()

ra8_err_t priv_viewer_output_text ( ra8_io_stream_t * output, const char * text )

nodiscard

Write one fixed diagnostic without a terminating byte.

Definition at line 202 of file ra8_viewer_output.c.

References ra8_io_stream_puts().

Referenced by internal_render_page(), and internal_run_window().

priv_viewer_output_tile()

ra8_err_t priv_viewer_output_tile ( ra8_io_stream_t * output, uint32_t tile, uint32_t width, uint32_t height, const char * path )

nodiscard

Write a successful tile-publication diagnostic.

Definition at line 185 of file ra8_viewer_output.c.

References internal_put_text(), internal_put_u32(), and ra8_io_stream_puts().

Referenced by internal_dump_tile().

priv_viewer_output_usage()

ra8_err_t priv_viewer_output_usage ( ra8_io_stream_t * output, const char * executable )

nodiscard

Write the complete command-line usage message.

Definition at line 112 of file ra8_viewer_output.c.

References internal_put_text(), and ra8_io_stream_puts().

Referenced by internal_usage().

priv_viewer_output_wrote()

ra8_err_t priv_viewer_output_wrote ( ra8_io_stream_t * output, const char * path )

nodiscard

Write a successful path-publication diagnostic.

Definition at line 178 of file ra8_viewer_output.c.

References internal_put_text(), and ra8_io_stream_puts().

Referenced by internal_render_page().