sweetline_bindings_generated library

Enums

sl_error
Error codes

Functions

sl_create_document(Pointer<Char> uri, Pointer<Char> text) → sl_document_handle_t
Create a managed document (Document) @param uri Document URI @param text Document content @return Managed document handle
sl_create_engine(bool show_index, bool inline_style) → sl_engine_handle_t
Create a SweetLine highlight engine @param show_index Whether the analysis result includes character index, if not only line and column are returned @param inline_style Whether the analysis result uses inline styles instead of only returning style IDs @return Highlight engine handle
sl_document_analyze(sl_analyzer_handle_t analyzer_handle) → Pointer<Int32>
Perform full highlight analysis on a managed document (typically called once after initial document load) @param analyzer_handle Document highlight analyzer handle @return Analysis result, tightly packed in byte order. Structure: @code Same format as sl_text_analyze: flags, spanStride, lineCount, lineEntry... @endcode Note: the return value must be freed by calling sl_free_buffer after use
sl_document_analyze_incremental(sl_analyzer_handle_t analyzer_handle, Pointer<Int32> changes_range, Pointer<Char> new_text) → Pointer<Int32>
Perform incremental highlight analysis on a managed document (called when document changes) @param analyzer_handle Document highlight analyzer handle @param changes_range Change range, array structure: startLine,startColumn,endLine,endColumn @param new_text Changed text @return Full analysis result for the entire document, tightly packed in byte order. Structure: @code Same format as sl_text_analyze: flags, spanStride, lineCount, lineEntry... @endcode Note: the return value must be freed by calling sl_free_buffer after use
sl_document_analyze_incremental_in_line_range(sl_analyzer_handle_t analyzer_handle, Pointer<Int32> changes_range, Pointer<Char> new_text, Pointer<Int32> visible_range) → Pointer<Int32>
Perform incremental highlight analysis on a managed document, returning only a highlight slice for the specified line range @param analyzer_handle Document highlight analyzer handle @param changes_range Change range, array structure: startLine,startColumn,endLine,endColumn @param new_text Changed text @param visible_range Visible line range, array structure: startLine,lineCount @return Highlight slice for the specified line range, tightly packed in byte order. Structure: @code result0 = span payload flags bit0: hasStartIndex bit1: inlineStyle result1 = span field count (stride) result2 = slice start line (start_line) result3 = total line count after patch (total_line_count) result4 = slice line count (line_count) Followed by line_count line entries: line_entry0 = span count of current line followed by span payloads (same span payload structure as sl_text_analyze) @endcode Note: the return value must be freed by calling sl_free_buffer after use
sl_document_analyze_indent_guides(sl_analyzer_handle_t analyzer_handle) → Pointer<Int32>
Perform indent guide analysis on a managed document (requires prior call to sl_document_analyze or sl_document_analyze_incremental) @param analyzer_handle Document highlight analyzer handle @return Analysis result, tightly packed in byte order. Structure: @code result0 = number of indent guide lines (guide_count) result1 = fixed field count per guide line (stride=6) result2 = number of line states (line_count) result3 = field count per line state (4) Followed by guide_count guide line entries, each with structure: column, start_line, end_line, nesting_level, scope_rule_id, branch_count, branch_line_0, branch_column_0, ... Note: actual length per guide line = stride + branch_count * 2 Followed by line_count line state entries, each with structure: nesting_level, scope_state, scope_column, indent_level where scope_state: 0=START, 1=END, 2=CONTENT @endcode Note: the return value must be freed by calling sl_free_buffer after use
sl_document_get_highlight_slice(sl_analyzer_handle_t analyzer_handle, Pointer<Int32> visible_range) → Pointer<Int32>
Get highlight slice from the current cached document highlight result Requires prior call to sl_document_analyze or sl_document_analyze_incremental @param analyzer_handle Document highlight analyzer handle @param visible_range Visible line range, array structure: startLine,lineCount @return Highlight slice for the specified line range, tightly packed in byte order. Structure: @code Same format as sl_document_analyze_incremental_in_line_range: flags, spanStride, startLine, totalLineCount, lineCount, lineEntry... @endcode Note: the return value must be freed by calling sl_free_buffer after use
sl_engine_compile_file(sl_engine_handle_t engine_handle, Pointer<Char> syntax_file) → sl_syntax_error_t
Compile syntax rules (from a JSON configuration file) @param engine_handle Highlight engine handle @param syntax_file Path to the syntax rule JSON file @return Syntax rule error information (if any)
sl_engine_compile_json(sl_engine_handle_t engine_handle, Pointer<Char> syntax_json) → sl_syntax_error_t
Compile syntax rules (directly from JSON content) @param engine_handle Highlight engine handle @param syntax_json Syntax rule JSON configuration @return Syntax rule error information (if any)
sl_engine_create_text_analyzer(sl_engine_handle_t engine_handle, Pointer<Char> syntax_name) → sl_analyzer_handle_t
Create a plain text highlight analyzer by syntax rule name (no incremental analysis support) @param engine_handle Highlight engine handle @param syntax_name Syntax rule name @return Plain text highlight analyzer handle
sl_engine_create_text_analyzer_by_file_name(sl_engine_handle_t engine_handle, Pointer<Char> file_name) → sl_analyzer_handle_t
Create a plain text highlight analyzer by file name (no incremental analysis support) @param engine_handle Highlight engine handle @param file_name File name or basename used for syntax routing @return Plain text highlight analyzer handle
sl_engine_define_macro(sl_engine_handle_t engine_handle, Pointer<Char> macro_name) → sl_error
sl_engine_get_style_name(sl_engine_handle_t engine_handle, int style_id) → Pointer<Char>
Get style name by style ID @param engine_handle Highlight engine handle @param style_id Highlight style ID @return The registered style name for the given ID in the engine
sl_engine_load_document(sl_engine_handle_t engine_handle, sl_document_handle_t document_handle) → sl_analyzer_handle_t
Load a managed document and get a document highlight analyzer handle (supports incremental analysis) @param engine_handle Highlight engine handle @param document_handle Managed document handle @return Document highlight analyzer handle
sl_engine_register_style_name(sl_engine_handle_t engine_handle, Pointer<Char> style_name, int style_id) → sl_error
sl_engine_undefine_macro(sl_engine_handle_t engine_handle, Pointer<Char> macro_name) → sl_error
sl_free_buffer(Pointer<Int32> result) → void
Free the memory of analysis results. All analysis functions returning int32_t* (such as sl_text_analyze, sl_document_analyze, sl_document_analyze_incremental, sl_document_analyze_incremental_in_line_range, sl_document_get_highlight_slice) must be freed via this function @param result Highlight analysis result
sl_free_document(sl_document_handle_t document_handle) → sl_error
sl_free_engine(sl_engine_handle_t engine_handle) → sl_error
sl_text_analyze(sl_analyzer_handle_t analyzer_handle, Pointer<Char> text) → Pointer<Int32>
Perform full highlight analysis on a text @param analyzer_handle Plain text highlight analyzer handle @param text Full text content @return Analysis result, tightly packed in byte order. Structure: @code result0 = span payload flags bit0: hasStartIndex bit1: inlineStyle result1 = span field count (stride) result2 = line count Followed by line_count line entries: line_entry0 = span count of current line Followed by span_count * stride fields Span payload: common: column, length if show_index=true: append startIndex if inline_style=true: append foregroundColor, backgroundColor, fontAttributes else: append styleId fontAttributes bitmask: (bits & 1) != 0 => bold (bits & (1 << 1)) != 0 => italic (bits & (1 << 2)) != 0 => strikethrough @endcode Note: the return value must be freed by calling sl_free_buffer after use
sl_text_analyze_indent_guides(sl_analyzer_handle_t analyzer_handle, Pointer<Char> text) → Pointer<Int32>
Perform indent guide analysis on plain text (requires prior call to sl_text_analyze for highlight results) @param analyzer_handle Plain text highlight analyzer handle @param text Text content @return Analysis result, format same as sl_document_analyze_indent_guides Note: the return value must be freed by calling sl_free_buffer after use
sl_text_analyze_line(sl_analyzer_handle_t analyzer_handle, Pointer<Char> text, Pointer<Int32> line_info) → Pointer<Int32>
Perform single line highlight analysis and return the result @param analyzer_handle Plain text highlight analyzer handle @param text Single line text content @param line_info Metadata for the current line, must be an int32_t array of length 3: @code line_info0 = current line number line_info1 = start highlight state, typically from the end_state of the previous line's result; line 0 starts at 0 line_info2 = cumulative character count up to the current line, excluding line endings @endcode @return Analysis result, tightly packed in byte order. Structure: @code result0 = span payload flags bit0: hasStartIndex bit1: inlineStyle result1 = number of integer fields per token span result2 = number of token spans result3 = state ID at the end of current line analysis result4 = total characters analyzed in current line (excluding line endings) Followed by result2 * result1 integer fields (single-line span payload): common: column, length if show_index=true: append startIndex if inline_style=true: append foregroundColor, backgroundColor, fontAttributes else: append styleId @endcode Note: the return value must be freed by calling sl_free_buffer after use