ra8-firmware 0.1.0
Bare-metal firmware for the Renesas RA8 family (RA8D2 / RA8P1)
Loading...
Searching...
No Matches
ra8_viewer_output_internal.h
Go to the documentation of this file.
1
10
11#pragma once
12
13#include <stddef.h>
14#include <stdint.h>
15
16#include "ra8_attributes.h"
17#include "ra8_err.h"
18#include "ra8_io_stream.h"
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
26 const char* executable);
27
30 const char* subject,
31 size_t required,
32 size_t supplied);
33
36 const char* operation,
37 uint32_t index,
38 ra8_err_t error);
39
41RA8_PRIV [[nodiscard]] ra8_err_t
42priv_viewer_output_error(ra8_io_stream_t* output, const char* operation, ra8_err_t error);
43
45RA8_PRIV [[nodiscard]] ra8_err_t
46priv_viewer_output_open_error(ra8_io_stream_t* output, const char* path, ra8_err_t error);
47
49RA8_PRIV [[nodiscard]] ra8_err_t
50priv_viewer_output_opened(ra8_io_stream_t* output, const char* path, uint32_t page_count);
51
54 const char* path);
55
58 uint32_t tile,
59 uint32_t width,
60 uint32_t height,
61 const char* path);
62
64RA8_PRIV [[nodiscard]] ra8_err_t priv_viewer_output_text(ra8_io_stream_t* output, const char* text);
65
66#ifdef __cplusplus
67}
68#endif
Annotation-attribute framework macros for ra8-firmware.
#define RA8_PRIV
Module-private helper: shared across TUs but only inside one library.
Error Code Definitions for ra8-firmware.
ra8_err_codes_t ra8_err_t
Canonical error-return type used by every ra8-firmware API.
Definition ra8_err.h:546
ra8_io targetable byte-stream facade – one writer, many destinations.
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_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_text(ra8_io_stream_t *output, const char *text)
Write one fixed diagnostic without a terminating byte.
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_usage(ra8_io_stream_t *output, const char *executable)
Write the complete command-line usage message.
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_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_capacity(ra8_io_stream_t *output, const char *subject, size_t required, size_t supplied)
Write an exact workspace requirement diagnostic.
Caller-allocated byte-stream handle binding a sink to its context.