rayforce-sys 1.2.0

Raw FFI bindings to the RayforceDB v2 core (librayforce)
Documentation
/*
 *   Copyright (c) 2025-2026 Anton Kundenko <singaraiona@gmail.com>
 *   All rights reserved.

 *   Permission is hereby granted, free of charge, to any person obtaining a copy
 *   of this software and associated documentation files (the "Software"), to deal
 *   in the Software without restriction, including without limitation the rights
 *   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *   copies of the Software, and to permit persons to whom the Software is
 *   furnished to do so, subject to the following conditions:

 *   The above copyright notice and this permission notice shall be included in all
 *   copies or substantial portions of the Software.

 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *   SOFTWARE.
 */

#ifndef RAY_LANG_FORMAT_H
#define RAY_LANG_FORMAT_H

#include <rayforce.h>
#include <stdio.h>

#define FMT_TABLE_MAX_WIDTH   10
#define FMT_TABLE_MAX_HEIGHT  20
#define FMT_LIST_MAX_HEIGHT   50
#define FMT_DEFAULT_ROW_WIDTH 80
#define FMT_DEFAULT_PRECISION  2
#define FMT_PP_MAX_ROWS       20   /* max pairs/elems shown in broken pp form */

/* Format a ray_t value into a new ray_t string (RAY_STR atom).
 * mode: 0 = compact, 1 = full (REPL), 2 = show (no limits) */
ray_t* ray_fmt(ray_t* obj, int mode);

/* REPL pretty-printer: like ray_fmt(obj, 1) but dicts/lists that would
 * exceed the row width break across multiple indented lines (JSON-style).
 * Used only for top-level REPL display — ray_fmt stays single-line. */
ray_t* ray_fmt_pp(ray_t* obj);

/* Pretty-print and write to FILE* (REPL display path). */
void ray_fmt_pp_print(FILE* fp, ray_t* obj);

/* Format and write to FILE* */
void ray_fmt_print(FILE* fp, ray_t* obj, int mode);

/* Write obj to fp in full, without display limits, streaming so memory
 * stays bounded (show).  RAY_ERR_IO if fp fails or if memory ran out after
 * part of the output was written (the part ends with an error marker);
 * RAY_ERR_OOM if memory ran out before anything was written. */
ray_err_t ray_fmt_write(FILE* fp, ray_t* obj);

/* Display settings */
void ray_fmt_set_precision(int digits);
void ray_fmt_set_width(int cols);

/* Type name string (e.g. RAY_I64 -> "i64") */
const char* ray_type_name(int8_t type);

#endif /* RAY_LANG_FORMAT_H */