const ini = @This();
const Document = @import("../../document.zig");
const lang = @import("../manifest.zig");
pub const Parser = @import("parser.zig");
pub const Tokenizer = @import("tokenizer.zig");
pub const Printer = @import("printer.zig");
pub const Type = enum {
/// The one dialect this parser accepts: `=`-separated `key = value`
/// lines, `[section]` headers, `;`/`#` full-line comments. See
/// `tokenizer.zig`'s module doc for exactly what's deliberately excluded
/// from the many incompatible things "INI" means in the wild.
INI,
};
pub const Language = struct {
pub const Type = ini.Type;
pub const Parser = ini.Parser;
pub const Printer = ini.Printer;
pub const default_type: ini.Type = .INI;
pub fn parse(parser: *ini.Parser, input: []const u8, format: ini.Type) !Document {
return ini.Parser.parse(parser.allocator, input, format);
}
pub const print = ini.Printer.print;
pub const printNode = ini.Printer.printNode;
pub const name = "ini";
pub const extensions: []const []const u8 = &.{"ini"};
/// A root mapping and one level of `[section]` mappings; a sequence at
/// any depth, or a mapping nested two or more levels deep, has no INI
/// spelling (`printer.zig` hard-errors on both rather than degrading).
pub const caps: lang.Caps = .{ .read = true, .edit = true, .serialize = true, .max_mapping_depth = 1 };
/// What `languages/harness.zig` round-trips and edits: a root key and a
/// `[section]` (the shape the parser records regions for).
pub const samples: []const []const u8 = &.{
"a = 1\n\n[s]\nk = v\n",
};
/// Untyped scalars: the grammar carries no type information, so
/// `port = 8080` reads back as the STRING "8080".
pub const dialects: []const lang.Dialect(@This()) = &.{.{
.name = "ini",
.abi_value = 9,
// After TOML and fig: INI's grammar is also permissive (a bare
// `key = value` line, or an empty file, both parse), so it is tried
// only after everything stricter has had first claim — it wins only on
// content those reject, e.g. a `[section]` header or an unquoted value
// with characters no TOML/fig scalar allows (`path = C:\a\b`).
.sniff_rank = 7,
.splice = .raw,
.empty_doc_seed = "",
}};
pub fn syntax(t: ini.Type) lang.Syntax {
_ = t;
return .{
// The printer accepts a leading `#` on read but always WRITES
// `;`, so `;` is what the editor's inserts and scans use. No
// same-line trailing comment syntax at all: a `;`/`#` after a
// value on the SAME line is literal value text (see `parser.zig`,
// "a value runs to end of line"). Splicing one in would corrupt
// the value on reread, so trailing ops are refused.
.comments = .{ .style = .semicolon, .line = ";", .trailing = null },
.kv_sep = " = ",
// No literal spelling for an empty nested mapping — `{}` in INI
// is the two-character STRING `{}`, not a container — so `set`
// cannot auto-vivify a missing ancestor here at all.
.empty_map_literal = null,
// A section format: a `[section]` may be reopened and so
// scattered, and `parser.zig` records every section's header
// lines in `Document.node_regions`. Its refusals say "section".
.section_noun = .section,
};
}
// ── Editing hooks ────────────────────────────────────────────────────────
//
// Operations this format takes over from the generic splice engine.
// `Editor` dispatches on PRESENCE — `@hasDecl(Language, "insertKey")` — so
// declaring one here is the whole of opting in, and every operation not
// named below runs the generic implementation. Each signature is fixed by
// the `editor.Editor` method of the same name; see its doc comment for what
// the hook is handed and what it is expected to have done on return.
//
// The logic lives in `editor_helper.zig` (which holds this format's editor
// tests too), not here: this block is the DECLARATION of which operations
// are overridden, so a reader can see a format's whole answer in one struct
// without opening the helper.
const edit = @import("editor_helper.zig");
/// INI has no flow syntax at all, so this bypasses the generic `isFlow`
/// sniff rather than risk a `[section]`-opening file misreading its root as
/// a bracket-delimited flow container.
pub const insertKey = edit.iniInsertKey;
// No delete/replace/move/reorder guards: the engine's section rule covers
// them. A `[section]` is a section node (`Document.node_regions`) — its
// span is anchored at its first header's name token alone — and a section
// node cannot be line-spliced: `deleteKey`, `replaceValAtPath`, `moveKey`
// and `reorderKeys` refuse it (`CannotDeleteSection`, …) and point at the
// whole-container ops.
// ── Whole-container ops ──────────────────────────────────────────────────
//
// All generic (see `editor.Editor`'s block of the same name). A reopened
// `[section]` is scattered through the file exactly as a TOML table or fig
// container is, and `deleteContainer`/`moveContainer`/`reorderContainers`
// derive its regions — every header occurrence plus its entries — from
// `Document.node_regions`, with no INI code at all. No `insertContainer`
// (INI cannot auto-vivify at all — `syntax().empty_map_literal` is null)
// and no `renameContainer` (a header's key is one tight span the generic
// `replaceKeyAtPath` rewrites, with no dotted descendants to follow).
};
// Test discovery: importing `ini.zig` (from root.zig) pulls in every INI
// submodule's tests, so the module owns its own test surface. `editor_helper.zig`
// holds the INI editor (section-nesting) tests, mirroring TOML's split.
test {
_ = @import("tokenizer.zig");
_ = @import("parser.zig");
_ = @import("printer.zig");
_ = @import("editor_helper.zig");
}