From 7de67f8c1b51296d849f2f95bcc7f33ca3a1b9d5 Mon Sep 17 00:00:00 2001 From: Jon Lipstate Date: Mon, 27 Mar 2023 22:20:24 -0700 Subject: [PATCH] markdown compliant spaces --- core/strings/ascii_set.odin | 8 +- core/strings/builder.odin | 136 +++++++------- core/strings/conversion.odin | 54 +++--- core/strings/intern.odin | 16 +- core/strings/reader.odin | 54 +++--- core/strings/strings.odin | 336 +++++++++++++++++------------------ 6 files changed, 302 insertions(+), 302 deletions(-) diff --git a/core/strings/ascii_set.odin b/core/strings/ascii_set.odin index d597cad6d..7e7cec642 100644 --- a/core/strings/ascii_set.odin +++ b/core/strings/ascii_set.odin @@ -12,10 +12,10 @@ Ascii_Set :: distinct [8]u32 /* Creates an Ascii_Set with unique characters from the input string. -**Inputs** +**Inputs** - chars: A string containing characters to include in the Ascii_Set. -**Returns** +**Returns** - as: An Ascii_Set with unique characters from the input string. - ok: false if any character in the input string is not a valid ASCII character. */ @@ -33,11 +33,11 @@ ascii_set_make :: proc(chars: string) -> (as: Ascii_Set, ok: bool) #no_bounds_ch /* Determines if a given char is contained within an Ascii_Set. -**Inputs** +**Inputs** - as: The Ascii_Set to search. - c: The char to check for in the Ascii_Set. -**Returns** A boolean indicating if the byte is contained in the Ascii_Set (true) or not (false). +**Returns** A boolean indicating if the byte is contained in the Ascii_Set (true) or not (false). */ ascii_set_contains :: proc(as: Ascii_Set, c: byte) -> bool #no_bounds_check { return as[c>>5] & (1<<(c&31)) != 0 diff --git a/core/strings/builder.odin b/core/strings/builder.odin index db5215dee..eb78551bd 100644 --- a/core/strings/builder.odin +++ b/core/strings/builder.odin @@ -7,10 +7,10 @@ import "core:io" /* Type definition for a procedure that flushes a Builder -**Inputs** +**Inputs** - b: A pointer to the Builder -**Returns** A boolean indicating whether the Builder should be reset +**Returns** A boolean indicating whether the Builder should be reset */ Builder_Flush_Proc :: #type proc(b: ^Builder) -> (do_reset: bool) /* @@ -26,10 +26,10 @@ Produces a Builder with a default length of 0 and cap of 16 *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - allocator: (default is context.allocator) -**Returns** A new Builder +**Returns** A new Builder */ builder_make_none :: proc(allocator := context.allocator) -> Builder { return Builder{buf=make([dynamic]byte, allocator)} @@ -39,11 +39,11 @@ Produces a Builder with a specified length and cap of max(16,len) byte buffer *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - len: The desired length of the Builder's buffer - allocator: (default is context.allocator) -**Returns** A new Builder +**Returns** A new Builder */ builder_make_len :: proc(len: int, allocator := context.allocator) -> Builder { return Builder{buf=make([dynamic]byte, len, allocator)} @@ -53,12 +53,12 @@ Produces a Builder with a specified length and cap *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - len: The desired length of the Builder's buffer - cap: The desired capacity of the Builder's buffer, cap is max(cap, len) - allocator: (default is context.allocator) -**Returns** A new Builder +**Returns** A new Builder */ builder_make_len_cap :: proc(len, cap: int, allocator := context.allocator) -> Builder { return Builder{buf=make([dynamic]byte, len, cap, allocator)} @@ -75,11 +75,11 @@ It replaces the existing `buf` *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - b: A pointer to the Builder - allocator: (default is context.allocator) -**Returns** initialized ^Builder +**Returns** initialized ^Builder */ builder_init_none :: proc(b: ^Builder, allocator := context.allocator) -> ^Builder { b.buf = make([dynamic]byte, allocator) @@ -91,12 +91,12 @@ It replaces the existing `buf` *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - b: A pointer to the Builder - len: The desired length of the Builder's buffer - allocator: (default is context.allocator) -**Returns** Initialized ^Builder +**Returns** Initialized ^Builder */ builder_init_len :: proc(b: ^Builder, len: int, allocator := context.allocator) -> ^Builder { b.buf = make([dynamic]byte, len, allocator) @@ -106,13 +106,13 @@ builder_init_len :: proc(b: ^Builder, len: int, allocator := context.allocator) Initializes a Builder with a specified length and cap It replaces the existing `buf` -**Inputs** +**Inputs** - b: A pointer to the Builder - len: The desired length of the Builder's buffer - cap: The desired capacity of the Builder's buffer, actual max(len,cap) - allocator: (default is context.allocator) -**Returns** A pointer to the initialized Builder +**Returns** A pointer to the initialized Builder */ builder_init_len_cap :: proc(b: ^Builder, len, cap: int, allocator := context.allocator) -> ^Builder { b.buf = make([dynamic]byte, len, cap, allocator) @@ -159,10 +159,10 @@ _builder_stream_vtable := &_builder_stream_vtable_obj /* Returns an io.Stream from a Builder -**Inputs** +**Inputs** - b: A pointer to the Builder -**Returns** An io.Stream +**Returns** An io.Stream */ to_stream :: proc(b: ^Builder) -> io.Stream { return io.Stream{stream_vtable=_builder_stream_vtable, stream_data=b} @@ -170,10 +170,10 @@ to_stream :: proc(b: ^Builder) -> io.Stream { /* Returns an io.Writer from a Builder -**Inputs** +**Inputs** - b: A pointer to the Builder -**Returns** An io.Writer +**Returns** An io.Writer */ to_writer :: proc(b: ^Builder) -> io.Writer { return io.to_writer(to_stream(b)) @@ -181,7 +181,7 @@ to_writer :: proc(b: ^Builder) -> io.Writer { /* Deletes and clears the Builder byte buffer content -**Inputs** +**Inputs** - b: A pointer to the Builder */ builder_destroy :: proc(b: ^Builder) { @@ -191,7 +191,7 @@ builder_destroy :: proc(b: ^Builder) { /* Reserves the Builder byte buffer to a specific capacity, when it's higher than before -**Inputs** +**Inputs** - b: A pointer to the Builder - cap: The desired capacity for the Builder's buffer */ @@ -201,7 +201,7 @@ builder_grow :: proc(b: ^Builder, cap: int) { /* Clears the Builder byte buffer content (sets len to zero) -**Inputs** +**Inputs** - b: A pointer to the Builder */ builder_reset :: proc(b: ^Builder) { @@ -212,7 +212,7 @@ Creates a Builder from a slice of bytes with the same slice length as its capaci *Uses Nil Allocator - Does NOT allocate* -**Inputs** +**Inputs** - backing: A slice of bytes to be used as the backing buffer Example: @@ -231,7 +231,7 @@ Output: a ab -**Returns** A new Builder +**Returns** A new Builder */ builder_from_bytes :: proc(backing: []byte) -> Builder { s := transmute(runtime.Raw_Slice)backing @@ -250,10 +250,10 @@ builder_from_slice :: builder_from_bytes /* Casts the Builder byte buffer to a string and returns it -**Inputs** +**Inputs** - b: A Builder -**Returns** The contents of the Builder's buffer, as a string +**Returns** The contents of the Builder's buffer, as a string */ to_string :: proc(b: Builder) -> string { return string(b.buf[:]) @@ -261,10 +261,10 @@ to_string :: proc(b: Builder) -> string { /* Returns the length of the Builder's buffer, in bytes -**Inputs** +**Inputs** - b: A Builder -**Returns** The length of the Builder's buffer +**Returns** The length of the Builder's buffer */ builder_len :: proc(b: Builder) -> int { return len(b.buf) @@ -272,10 +272,10 @@ builder_len :: proc(b: Builder) -> int { /* Returns the capacity of the Builder's buffer, in bytes -**Inputs** +**Inputs** - b: A Builder -**Returns** The capacity of the Builder's buffer +**Returns** The capacity of the Builder's buffer */ builder_cap :: proc(b: Builder) -> int { return cap(b.buf) @@ -283,10 +283,10 @@ builder_cap :: proc(b: Builder) -> int { /* The free space left in the Builder's buffer, in bytes -**Inputs** +**Inputs** - b: A Builder -**Returns** The available space left in the Builder's buffer +**Returns** The available space left in the Builder's buffer */ builder_space :: proc(b: Builder) -> int { return cap(b.buf) - len(b.buf) @@ -294,7 +294,7 @@ builder_space :: proc(b: Builder) -> int { /* Appends a byte to the Builder and returns the number of bytes appended -**Inputs** +**Inputs** - b: A pointer to the Builder - x: The byte to be appended @@ -310,13 +310,13 @@ Example: fmt.println(strings.to_string(builder)) // -> ab } -**Output** +Output: ab NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of bytes appended +**Returns** The number of bytes appended */ write_byte :: proc(b: ^Builder, x: byte) -> (n: int) { n0 := len(b.buf) @@ -327,7 +327,7 @@ write_byte :: proc(b: ^Builder, x: byte) -> (n: int) { /* Appends a slice of bytes to the Builder and returns the number of bytes appended -**Inputs** +**Inputs** - b: A pointer to the Builder - x: The slice of bytes to be appended @@ -345,7 +345,7 @@ Example: NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of bytes appended +**Returns** The number of bytes appended */ write_bytes :: proc(b: ^Builder, x: []byte) -> (n: int) { n0 := len(b.buf) @@ -356,7 +356,7 @@ write_bytes :: proc(b: ^Builder, x: []byte) -> (n: int) { /* Appends a single rune to the Builder and returns the number of bytes written and an `io.Error` -**Inputs** +**Inputs** - b: A pointer to the Builder - r: The rune to be appended @@ -378,7 +378,7 @@ Output: NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of bytes written and an io.Error (if any) +**Returns** The number of bytes written and an io.Error (if any) */ write_rune :: proc(b: ^Builder, r: rune) -> (int, io.Error) { return io.write_rune(to_writer(b), r) @@ -386,7 +386,7 @@ write_rune :: proc(b: ^Builder, r: rune) -> (int, io.Error) { /* Appends a quoted rune to the Builder and returns the number of bytes written -**Inputs** +**Inputs** - b: A pointer to the Builder - r: The rune to be appended @@ -409,7 +409,7 @@ Output: NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of bytes written +**Returns** The number of bytes written */ write_quoted_rune :: proc(b: ^Builder, r: rune) -> (n: int) { return io.write_quoted_rune(to_writer(b), r) @@ -417,7 +417,7 @@ write_quoted_rune :: proc(b: ^Builder, r: rune) -> (n: int) { /* Appends a string to the Builder and returns the number of bytes written -**Inputs** +**Inputs** - b: A pointer to the Builder - s: The string to be appended @@ -439,7 +439,7 @@ Output: NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of bytes written +**Returns** The number of bytes written */ write_string :: proc(b: ^Builder, s: string) -> (n: int) { n0 := len(b.buf) @@ -450,10 +450,10 @@ write_string :: proc(b: ^Builder, s: string) -> (n: int) { /* Pops and returns the last byte in the Builder or 0 when the Builder is empty -**Inputs** +**Inputs** - b: A pointer to the Builder -**Returns** The last byte in the Builder or 0 if empty +**Returns** The last byte in the Builder or 0 if empty */ pop_byte :: proc(b: ^Builder) -> (r: byte) { if len(b.buf) == 0 { @@ -468,10 +468,10 @@ pop_byte :: proc(b: ^Builder) -> (r: byte) { /* Pops the last rune in the Builder and returns the popped rune and its rune width or (0, 0) if empty -**Inputs** +**Inputs** - b: A pointer to the Builder -**Returns** The popped rune and its rune width or (0, 0) if empty +**Returns** The popped rune and its rune width or (0, 0) if empty */ pop_rune :: proc(b: ^Builder) -> (r: rune, width: int) { if len(b.buf) == 0 { @@ -486,7 +486,7 @@ pop_rune :: proc(b: ^Builder) -> (r: rune, width: int) { @(private) DIGITS_LOWER := "0123456789abcdefx" /* -**Inputs** +**Inputs** - b: A pointer to the Builder - str: The string to be quoted and appended - quote: The optional quote character (default is double quotes) @@ -510,7 +510,7 @@ Output: NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of bytes written +**Returns** The number of bytes written */ write_quoted_string :: proc(b: ^Builder, str: string, quote: byte = '"') -> (n: int) { n, _ = io.write_quoted_string(to_writer(b), str, quote) @@ -519,14 +519,14 @@ write_quoted_string :: proc(b: ^Builder, str: string, quote: byte = '"') -> (n: /* Appends an encoded rune to the Builder and returns the number of bytes written -**Inputs** +**Inputs** - b: A pointer to the Builder - r: The rune to be appended - write_quote: Optional boolean flag to write the quote character (default is true) NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of bytes written +**Returns** The number of bytes written */ write_encoded_rune :: proc(b: ^Builder, r: rune, write_quote := true) -> (n: int) { n, _ = io.write_encoded_rune(to_writer(b), r, write_quote) @@ -536,7 +536,7 @@ write_encoded_rune :: proc(b: ^Builder, r: rune, write_quote := true) -> (n: int /* Appends an escaped rune to the Builder and returns the number of bytes written -**Inputs** +**Inputs** - b: A pointer to the Builder - r: The rune to be appended - quote: The quote character @@ -549,7 +549,7 @@ Appends an escaped rune to the Builder and returns the number of bytes written NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of bytes written +**Returns** The number of bytes written */ write_escaped_rune :: proc(b: ^Builder, r: rune, quote: byte, html_safe := false) -> (n: int) { n, _ = io.write_escaped_rune(to_writer(b), r, quote, html_safe) @@ -558,7 +558,7 @@ write_escaped_rune :: proc(b: ^Builder, r: rune, quote: byte, html_safe := false /* Writes a f64 value to the Builder and returns the number of characters written -**Inputs** +**Inputs** - b: A pointer to the Builder - f: The f64 value to be appended - fmt: The format byte @@ -568,7 +568,7 @@ Writes a f64 value to the Builder and returns the number of characters written NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of characters written +**Returns** The number of characters written */ write_float :: proc(b: ^Builder, f: f64, fmt: byte, prec, bit_size: int, always_signed := false) -> (n: int) { buf: [384]byte @@ -583,7 +583,7 @@ write_float :: proc(b: ^Builder, f: f64, fmt: byte, prec, bit_size: int, always_ /* Writes a f16 value to the Builder and returns the number of characters written -**Inputs** +**Inputs** - b: A pointer to the Builder - f: The f16 value to be appended - fmt: The format byte @@ -591,7 +591,7 @@ Writes a f16 value to the Builder and returns the number of characters written NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of characters written +**Returns** The number of characters written */ write_f16 :: proc(b: ^Builder, f: f16, fmt: byte, always_signed := false) -> (n: int) { buf: [384]byte @@ -604,7 +604,7 @@ write_f16 :: proc(b: ^Builder, f: f16, fmt: byte, always_signed := false) -> (n: /* Writes a f32 value to the Builder and returns the number of characters written -**Inputs** +**Inputs** - b: A pointer to the Builder - f: The f32 value to be appended - fmt: The format byte @@ -629,7 +629,7 @@ Output: NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of characters written +**Returns** The number of characters written */ write_f32 :: proc(b: ^Builder, f: f32, fmt: byte, always_signed := false) -> (n: int) { buf: [384]byte @@ -642,7 +642,7 @@ write_f32 :: proc(b: ^Builder, f: f32, fmt: byte, always_signed := false) -> (n: /* Writes a f32 value to the Builder and returns the number of characters written -**Inputs** +**Inputs** - b: A pointer to the Builder - f: The f32 value to be appended - fmt: The format byte @@ -650,7 +650,7 @@ Writes a f32 value to the Builder and returns the number of characters written NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of characters written +**Returns** The number of characters written */ write_f64 :: proc(b: ^Builder, f: f64, fmt: byte, always_signed := false) -> (n: int) { buf: [384]byte @@ -663,14 +663,14 @@ write_f64 :: proc(b: ^Builder, f: f64, fmt: byte, always_signed := false) -> (n: /* Writes a u64 value to the Builder and returns the number of characters written -**Inputs** +**Inputs** - b: A pointer to the Builder - i: The u64 value to be appended - base: The optional base for the numeric representation NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of characters written +**Returns** The number of characters written */ write_u64 :: proc(b: ^Builder, i: u64, base: int = 10) -> (n: int) { buf: [32]byte @@ -680,14 +680,14 @@ write_u64 :: proc(b: ^Builder, i: u64, base: int = 10) -> (n: int) { /* Writes a i64 value to the Builder and returns the number of characters written -**Inputs** +**Inputs** - b: A pointer to the Builder - i: The i64 value to be appended - base: The optional base for the numeric representation NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of characters written +**Returns** The number of characters written */ write_i64 :: proc(b: ^Builder, i: i64, base: int = 10) -> (n: int) { buf: [32]byte @@ -697,14 +697,14 @@ write_i64 :: proc(b: ^Builder, i: i64, base: int = 10) -> (n: int) { /* Writes a uint value to the Builder and returns the number of characters written -**Inputs** +**Inputs** - b: A pointer to the Builder - i: The uint value to be appended - base: The optional base for the numeric representation NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of characters written +**Returns** The number of characters written */ write_uint :: proc(b: ^Builder, i: uint, base: int = 10) -> (n: int) { return write_u64(b, u64(i), base) @@ -712,14 +712,14 @@ write_uint :: proc(b: ^Builder, i: uint, base: int = 10) -> (n: int) { /* Writes a int value to the Builder and returns the number of characters written -**Inputs** +**Inputs** - b: A pointer to the Builder - i: The int value to be appended - base: The optional base for the numeric representation NOTE: The backing dynamic array may be fixed in capacity or fail to resize, `n` states the number actually written. -**Returns** The number of characters written +**Returns** The number of characters written */ write_int :: proc(b: ^Builder, i: int, base: int = 10) -> (n: int) { return write_i64(b, i64(i), base) diff --git a/core/strings/conversion.odin b/core/strings/conversion.odin index ba86058ab..b617db94b 100644 --- a/core/strings/conversion.odin +++ b/core/strings/conversion.odin @@ -9,14 +9,14 @@ Converts invalid UTF-8 sequences in the input string `s` to the `replacement` st *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: Input string that may contain invalid UTF-8 sequences. - replacement: String to replace invalid UTF-8 sequences with. - allocator: (default: context.allocator). WARNING: Allocation does not occur when len(s) == 0 -**Returns** A valid UTF-8 string with invalid sequences replaced by `replacement`. +**Returns** A valid UTF-8 string with invalid sequences replaced by `replacement`. */ to_valid_utf8 :: proc(s, replacement: string, allocator := context.allocator) -> string { if len(s) == 0 { @@ -76,7 +76,7 @@ Converts the input string `s` to all lowercase characters. *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: Input string to be converted. - allocator: (default: context.allocator). @@ -93,7 +93,7 @@ Output: test -**Returns** A new string with all characters converted to lowercase. +**Returns** A new string with all characters converted to lowercase. */ to_lower :: proc(s: string, allocator := context.allocator) -> string { b: Builder @@ -108,7 +108,7 @@ Converts the input string `s` to all uppercase characters. *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: Input string to be converted. - allocator: (default: context.allocator). @@ -125,7 +125,7 @@ Output: TEST -**Returns** A new string with all characters converted to uppercase. +**Returns** A new string with all characters converted to uppercase. */ to_upper :: proc(s: string, allocator := context.allocator) -> string { b: Builder @@ -138,10 +138,10 @@ to_upper :: proc(s: string, allocator := context.allocator) -> string { /* Checks if the rune `c` is a delimiter (' ', '-', or '_'). -**Inputs** +**Inputs** - c: Rune to check for delimiter status. -**Returns** True if `c` is a delimiter, false otherwise. +**Returns** True if `c` is a delimiter, false otherwise. */ is_delimiter :: proc(c: rune) -> bool { return c == '-' || c == '_' || is_space(c) @@ -149,10 +149,10 @@ is_delimiter :: proc(c: rune) -> bool { /* Checks if the rune `r` is a non-alphanumeric or space character. -**Inputs** +**Inputs** - r: Rune to check for separator status. -**Returns** True if `r` is a non-alpha or `unicode.is_space` rune. +**Returns** True if `r` is a non-alpha or `unicode.is_space` rune. */ is_separator :: proc(r: rune) -> bool { if r <= 0x7f { @@ -179,7 +179,7 @@ is_separator :: proc(r: rune) -> bool { /* Iterates over a string, calling a callback for each rune with the previous, current, and next runes as arguments. -**Inputs** +**Inputs** - w: An io.Writer to be used by the callback for writing output. - s: The input string to be iterated over. - callback: A procedure to be called for each rune in the string, with arguments (w: io.Writer, prev, curr, next: rune). @@ -241,11 +241,11 @@ Converts the input string `s` to "lowerCamelCase". *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: Input string to be converted. - allocator: (default: context.allocator). -**Returns** A "lowerCamelCase" formatted string. +**Returns** A "lowerCamelCase" formatted string. */ to_camel_case :: proc(s: string, allocator := context.allocator) -> string { s := s @@ -275,11 +275,11 @@ Converts the input string `s` to "UpperCamelCase" (PascalCase). *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: Input string to be converted. - allocator: (default: context.allocator). -**Returns** A "PascalCase" formatted string. +**Returns** A "PascalCase" formatted string. */ to_pascal_case :: proc(s: string, allocator := context.allocator) -> string { s := s @@ -307,7 +307,7 @@ Returns a string converted to a delimiter-separated case with configurable casin *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to be converted - delimiter: The rune to be used as the delimiter between words - all_upper_case: A boolean indicating if the output should be all uppercased (true) or lowercased (false) @@ -330,7 +330,7 @@ Output: HELLO WORLD a_b_c -**Returns** The converted string +**Returns** The converted string */ to_delimiter_case :: proc( s: string, @@ -380,7 +380,7 @@ Converts a string to "snake_case" with all runes lowercased *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to be converted - allocator: (default: context.allocator). @@ -400,7 +400,7 @@ Output: hello_world ``` -**Returns** The converted string +**Returns** The converted string */ to_snake_case :: proc(s: string, allocator := context.allocator) -> string { return to_delimiter_case(s, '_', false, allocator) @@ -412,7 +412,7 @@ Converts a string to "SNAKE_CASE" with all runes uppercased *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to be converted - allocator: (default: context.allocator). @@ -429,7 +429,7 @@ Output: HELLO_WORLD -**Returns** The converted string +**Returns** The converted string */ to_upper_snake_case :: proc(s: string, allocator := context.allocator) -> string { return to_delimiter_case(s, '_', true, allocator) @@ -439,7 +439,7 @@ Converts a string to "kebab-case" with all runes lowercased *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to be converted - allocator: (default: context.allocator). @@ -456,7 +456,7 @@ Output: hello-world -**Returns** The converted string +**Returns** The converted string */ to_kebab_case :: proc(s: string, allocator := context.allocator) -> string { return to_delimiter_case(s, '-', false, allocator) @@ -466,7 +466,7 @@ Converts a string to "KEBAB-CASE" with all runes uppercased *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to be converted - allocator: (default: context.allocator). @@ -483,7 +483,7 @@ Output: HELLO-WORLD -**Returns** The converted string +**Returns** The converted string */ to_upper_kebab_case :: proc(s: string, allocator := context.allocator) -> string { return to_delimiter_case(s, '-', true, allocator) @@ -493,7 +493,7 @@ Converts a string to "Ada_Case" *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to be converted - allocator: (default: context.allocator). @@ -510,7 +510,7 @@ Output: Hello_World -**Returns** The converted string +**Returns** The converted string */ to_ada_case :: proc(s: string, allocator := context.allocator) -> string { s := s diff --git a/core/strings/intern.odin b/core/strings/intern.odin index e05a58478..e4577d14f 100644 --- a/core/strings/intern.odin +++ b/core/strings/intern.odin @@ -25,7 +25,7 @@ Initializes the entries map and sets the allocator for the string entries *Allocates Using Provided Allocators* -**Inputs** +**Inputs** - m: A pointer to the Intern struct to be initialized - allocator: The allocator for the Intern_Entry strings (Default: context.allocator) - map_allocator: The allocator for the map of entries (Default: context.allocator) @@ -37,7 +37,7 @@ intern_init :: proc(m: ^Intern, allocator := context.allocator, map_allocator := /* Frees the map and all its content allocated using the `.allocator`. -**Inputs** +**Inputs** - m: A pointer to the Intern struct to be destroyed */ intern_destroy :: proc(m: ^Intern) { @@ -51,13 +51,13 @@ Returns the interned string for the given text, is set in the map if it didnt ex *MAY Allocate using the Intern's Allocator* -**Inputs** +**Inputs** - m: A pointer to the Intern struct - text: The string to be interned NOTE: The returned string lives as long as the map entry lives. -**Returns** The interned string and an allocator error if any +**Returns** The interned string and an allocator error if any */ intern_get :: proc(m: ^Intern, text: string) -> (str: string, err: runtime.Allocator_Error) { entry := _intern_get_entry(m, text) or_return @@ -68,13 +68,13 @@ Returns the interned C-String for the given text, is set in the map if it didnt *MAY Allocate using the Intern's Allocator* -**Inputs** +**Inputs** - m: A pointer to the Intern struct - text: The string to be interned NOTE: The returned C-String lives as long as the map entry lives -**Returns** The interned C-String and an allocator error if any +**Returns** The interned C-String and an allocator error if any */ intern_get_cstring :: proc(m: ^Intern, text: string) -> (str: cstring, err: runtime.Allocator_Error) { entry := _intern_get_entry(m, text) or_return @@ -86,11 +86,11 @@ Sets and allocates the entry if it wasn't set yet *MAY Allocate using the Intern's Allocator* -**Inputs** +**Inputs** - m: A pointer to the Intern struct - text: The string to be looked up or interned -**Returns** The new or existing interned entry and an allocator error if any +**Returns** The new or existing interned entry and an allocator error if any */ _intern_get_entry :: proc(m: ^Intern, text: string) -> (new_entry: ^Intern_Entry, err: runtime.Allocator_Error) #no_bounds_check { if prev, ok := m.entries[text]; ok { diff --git a/core/strings/reader.odin b/core/strings/reader.odin index 9489ab2b9..82a31c92c 100644 --- a/core/strings/reader.odin +++ b/core/strings/reader.odin @@ -16,7 +16,7 @@ Reader :: struct { /* Initializes a string Reader with the provided string -**Inputs** +**Inputs** - r: A pointer to a Reader struct - s: The input string to be read */ @@ -28,10 +28,10 @@ reader_init :: proc(r: ^Reader, s: string) { /* Converts a Reader into an io.Stream -**Inputs** +**Inputs** - r: A pointer to a Reader struct -**Returns** An io.Stream for the given Reader +**Returns** An io.Stream for the given Reader */ reader_to_stream :: proc(r: ^Reader) -> (s: io.Stream) { s.stream_data = r @@ -41,11 +41,11 @@ reader_to_stream :: proc(r: ^Reader) -> (s: io.Stream) { /* Initializes a string Reader and returns an io.Reader for the given string -**Inputs** +**Inputs** - r: A pointer to a Reader struct - s: The input string to be read -**Returns** An io.Reader for the given string +**Returns** An io.Reader for the given string */ to_reader :: proc(r: ^Reader, s: string) -> io.Reader { reader_init(r, s) @@ -55,11 +55,11 @@ to_reader :: proc(r: ^Reader, s: string) -> io.Reader { /* Initializes a string Reader and returns an io.Reader_At for the given string -**Inputs** +**Inputs** - r: A pointer to a Reader struct - s: The input string to be read -**Returns** An io.Reader_At for the given string +**Returns** An io.Reader_At for the given string */ to_reader_at :: proc(r: ^Reader, s: string) -> io.Reader_At { reader_init(r, s) @@ -69,10 +69,10 @@ to_reader_at :: proc(r: ^Reader, s: string) -> io.Reader_At { /* Returns the remaining length of the Reader -**Inputs** +**Inputs** - r: A pointer to a Reader struct -**Returns** The remaining length of the Reader +**Returns** The remaining length of the Reader */ reader_length :: proc(r: ^Reader) -> int { if r.i >= i64(len(r.s)) { @@ -83,10 +83,10 @@ reader_length :: proc(r: ^Reader) -> int { /* Returns the length of the string stored in the Reader -**Inputs** +**Inputs** - r: A pointer to a Reader struct -**Returns** The length of the string stored in the Reader +**Returns** The length of the string stored in the Reader */ reader_size :: proc(r: ^Reader) -> i64 { return i64(len(r.s)) @@ -94,11 +94,11 @@ reader_size :: proc(r: ^Reader) -> i64 { /* Reads len(p) bytes from the Reader's string and copies into the provided slice. -**Inputs** +**Inputs** - r: A pointer to a Reader struct - p: A byte slice to copy data into -**Returns** +**Returns** - n: The number of bytes read - err: An io.Error if an error occurs while reading, including .EOF, otherwise nil denotes success. */ @@ -114,12 +114,12 @@ reader_read :: proc(r: ^Reader, p: []byte) -> (n: int, err: io.Error) { /* Reads len(p) bytes from the Reader's string and copies into the provided slice, at the specified offset from the current index. -**Inputs** +**Inputs** - r: A pointer to a Reader struct - p: A byte slice to copy data into - off: The offset from which to read -**Returns** +**Returns** - n: The number of bytes read - err: An io.Error if an error occurs while reading, including .EOF, otherwise nil denotes success. */ @@ -139,10 +139,10 @@ reader_read_at :: proc(r: ^Reader, p: []byte, off: i64) -> (n: int, err: io.Erro /* Reads and returns a single byte from the Reader's string -**Inputs** +**Inputs** - r: A pointer to a Reader struct -**Returns** +**Returns** - The byte read from the Reader - err: An io.Error if an error occurs while reading, including .EOF, otherwise nil denotes success. */ @@ -158,10 +158,10 @@ reader_read_byte :: proc(r: ^Reader) -> (byte, io.Error) { /* Decrements the Reader's index (i) by 1 -**Inputs** +**Inputs** - r: A pointer to a Reader struct -**Returns** An io.Error if `r.i <= 0` (.Invalid_Unread), otherwise nil denotes success. +**Returns** An io.Error if `r.i <= 0` (.Invalid_Unread), otherwise nil denotes success. */ reader_unread_byte :: proc(r: ^Reader) -> io.Error { if r.i <= 0 { @@ -174,10 +174,10 @@ reader_unread_byte :: proc(r: ^Reader) -> io.Error { /* Reads and returns a single rune and its size from the Reader's string -**Inputs** +**Inputs** - r: A pointer to a Reader struct -**Returns** +**Returns** - ch: The rune read from the Reader - size: The size of the rune in bytes - err: An io.Error if an error occurs while reading @@ -199,12 +199,12 @@ reader_read_rune :: proc(r: ^Reader) -> (ch: rune, size: int, err: io.Error) { /* Decrements the Reader's index (i) by the size of the last read rune -**Inputs** +**Inputs** - r: A pointer to a Reader struct WARNING: May only be used once and after a valid `read_rune` call -**Returns** An io.Error if an error occurs while unreading (.Invalid_Unread), else nil denotes success. +**Returns** An io.Error if an error occurs while unreading (.Invalid_Unread), else nil denotes success. */ reader_unread_rune :: proc(r: ^Reader) -> io.Error { if r.i <= 0 { @@ -220,12 +220,12 @@ reader_unread_rune :: proc(r: ^Reader) -> io.Error { /* Seeks the Reader's index to a new position -**Inputs** +**Inputs** - r: A pointer to a Reader struct - offset: The new offset position - whence: The reference point for the new position (.Start, .Current, or .End) -**Returns** +**Returns** - The absolute offset after seeking - err: An io.Error if an error occurs while seeking (.Invalid_Whence, .Invalid_Offset) */ @@ -252,13 +252,13 @@ reader_seek :: proc(r: ^Reader, offset: i64, whence: io.Seek_From) -> (i64, io.E /* Writes the remaining content of the Reader's string into the provided io.Writer -**Inputs** +**Inputs** - r: A pointer to a Reader struct - w: The io.Writer to write the remaining content into WARNING: Panics if writer writes more bytes than remainig length of string. -**Returns** +**Returns** - n: The number of bytes written - err: An io.Error if an error occurs while writing (.Short_Write) */ diff --git a/core/strings/strings.odin b/core/strings/strings.odin index ca2054b33..36b244d27 100644 --- a/core/strings/strings.odin +++ b/core/strings/strings.odin @@ -11,12 +11,12 @@ Clones a string *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The string to be cloned - allocator: (default: context.allocator) - loc: The caller location for debugging purposes (default: #caller_location) -**Returns** A cloned string +**Returns** A cloned string */ clone :: proc(s: string, allocator := context.allocator, loc := #caller_location) -> string { c := make([]byte, len(s), allocator, loc) @@ -28,12 +28,12 @@ Clones a string safely (returns early with an allocation error on failure) *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The string to be cloned - allocator: (default: context.allocator) - loc: The caller location for debugging purposes (default: #caller_location) -**Returns** +**Returns** - str: A cloned string - err: A mem.Allocator_Error if an error occurs during allocation */ @@ -47,12 +47,12 @@ Clones a string and appends a nul byte to make it a cstring *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The string to be cloned - allocator: (default: context.allocator) - loc: The caller location for debugging purposes (default: #caller_location) -**Returns** A cloned cstring with an appended nul byte +**Returns** A cloned cstring with an appended nul byte */ clone_to_cstring :: proc(s: string, allocator := context.allocator, loc := #caller_location) -> cstring { c := make([]byte, len(s)+1, allocator, loc) @@ -63,13 +63,13 @@ clone_to_cstring :: proc(s: string, allocator := context.allocator, loc := #call /* Transmutes a raw pointer into a string. Non-allocating. -**Inputs** +**Inputs** - ptr: A pointer to the start of the byte sequence - len: The length of the byte sequence NOTE: The created string is only valid as long as the pointer and length are valid. -**Returns** A string created from the byte pointer and length +**Returns** A string created from the byte pointer and length */ string_from_ptr :: proc(ptr: ^byte, len: int) -> string { return transmute(string)mem.Raw_String{ptr, len} @@ -80,11 +80,11 @@ Transmutes a raw pointer (nul-terminated) into a string. Non-allocating. Searche NOTE: The created string is only valid as long as the pointer and length are valid. The string is truncated at the first nul byte encountered. -**Inputs** +**Inputs** - ptr: A pointer to the start of the nul-terminated byte sequence - len: The length of the byte sequence -**Returns** A string created from the nul-terminated byte pointer and length +**Returns** A string created from the nul-terminated byte pointer and length */ string_from_nul_terminated_ptr :: proc(ptr: ^byte, len: int) -> string { s := transmute(string)mem.Raw_String{ptr, len} @@ -94,10 +94,10 @@ string_from_nul_terminated_ptr :: proc(ptr: ^byte, len: int) -> string { /* Gets the raw byte pointer for the start of a string `str` -**Inputs** +**Inputs** - str: The input string -**Returns** A pointer to the start of the string's bytes +**Returns** A pointer to the start of the string's bytes */ ptr_from_string :: proc(str: string) -> ^byte { d := transmute(mem.Raw_String)str @@ -106,12 +106,12 @@ ptr_from_string :: proc(str: string) -> ^byte { /* Converts a string `str` to a cstring -**Inputs** +**Inputs** - str: The input string WARNING: This is unsafe because the original string may not contain a nul byte. -**Returns** The converted cstring +**Returns** The converted cstring */ unsafe_string_to_cstring :: proc(str: string) -> cstring { d := transmute(mem.Raw_String)str @@ -120,13 +120,13 @@ unsafe_string_to_cstring :: proc(str: string) -> cstring { /* Truncates a string `str` at the first occurrence of char/byte `b` -**Inputs** +**Inputs** - str: The input string - b: The byte to truncate the string at NOTE: Failure to find the byte results in returning the entire string. -**Returns** The truncated string +**Returns** The truncated string */ truncate_to_byte :: proc(str: string, b: byte) -> string { n := index_byte(str, b) @@ -138,11 +138,11 @@ truncate_to_byte :: proc(str: string, b: byte) -> string { /* Truncates a string str at the first occurrence of rune r as a slice of the original, entire string if not found -**Inputs** +**Inputs** - str: The input string - r: The rune to truncate the string at -**Returns** The truncated string +**Returns** The truncated string */ truncate_to_rune :: proc(str: string, r: rune) -> string { n := index_rune(str, r) @@ -156,12 +156,12 @@ Clones a byte array s and appends a nul byte *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The byte array to be cloned - allocator: (default: context.allocator) - loc: The caller location for debugging purposes (default: #caller_location) -**Returns** A cloned string from the byte array with a nul byte +**Returns** A cloned string from the byte array with a nul byte */ clone_from_bytes :: proc(s: []byte, allocator := context.allocator, loc := #caller_location) -> string { c := make([]byte, len(s)+1, allocator, loc) @@ -174,12 +174,12 @@ Clones a cstring s as a string *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The cstring to be cloned - allocator: (default: context.allocator) - loc: The caller location for debugging purposes (default: #caller_location) -**Returns** A cloned string from the cstring +**Returns** A cloned string from the cstring */ clone_from_cstring :: proc(s: cstring, allocator := context.allocator, loc := #caller_location) -> string { return clone(string(s), allocator, loc) @@ -189,7 +189,7 @@ Clones a string from a byte pointer ptr and a byte length len *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - ptr: A pointer to the start of the byte sequence - len: The length of the byte sequence - allocator: (default: context.allocator) @@ -197,7 +197,7 @@ Clones a string from a byte pointer ptr and a byte length len NOTE: Same as `string_from_ptr`, but perform an additional `clone` operation -**Returns** A cloned string from the byte pointer and length +**Returns** A cloned string from the byte pointer and length */ clone_from_ptr :: proc(ptr: ^byte, len: int, allocator := context.allocator, loc := #caller_location) -> string { s := string_from_ptr(ptr, len) @@ -215,7 +215,7 @@ Clones a string from a nul-terminated cstring ptr and a byte length len *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - ptr: A pointer to the start of the nul-terminated cstring - len: The byte length of the cstring - allocator: (default: context.allocator) @@ -223,7 +223,7 @@ Clones a string from a nul-terminated cstring ptr and a byte length len NOTE: Truncates at the first nul byte encountered or the byte length. -**Returns** A cloned string from the nul-terminated cstring and byte length +**Returns** A cloned string from the nul-terminated cstring and byte length */ clone_from_cstring_bounded :: proc(ptr: cstring, len: int, allocator := context.allocator, loc := #caller_location) -> string { s := string_from_ptr((^u8)(ptr), len) @@ -234,11 +234,11 @@ clone_from_cstring_bounded :: proc(ptr: cstring, len: int, allocator := context. Compares two strings, returning a value representing which one comes first lexicographically. -1 for lhs; 1 for rhs, or 0 if they are equal. -**Inputs** +**Inputs** - lhs: First string for comparison - rhs: Second string for comparison -**Returns** -1 if lhs comes first, 1 if rhs comes first, or 0 if they are equal +**Returns** -1 if lhs comes first, 1 if rhs comes first, or 0 if they are equal */ compare :: proc(lhs, rhs: string) -> int { return mem.compare(transmute([]byte)lhs, transmute([]byte)rhs) @@ -246,11 +246,11 @@ compare :: proc(lhs, rhs: string) -> int { /* Returns the byte offset of the rune r in the string s, -1 when not found -**Inputs** +**Inputs** - s: The input string - r: The rune to search for -**Returns** The byte offset of the rune r in the string s, or -1 if not found +**Returns** The byte offset of the rune r in the string s, or -1 if not found */ contains_rune :: proc(s: string, r: rune) -> int { for c, offset in s { @@ -263,7 +263,7 @@ contains_rune :: proc(s: string, r: rune) -> int { /* Returns true when the string substr is contained inside the string s -**Inputs** +**Inputs** - s: The input string - substr: The substring to search for @@ -296,7 +296,7 @@ Output: true false -**Returns** true if substr is contained inside the string s, false otherwise +**Returns** true if substr is contained inside the string s, false otherwise */ contains :: proc(s, substr: string) -> bool { return index(s, substr) >= 0 @@ -304,7 +304,7 @@ contains :: proc(s, substr: string) -> bool { /* Returns true when the string s contains any of the characters inside the string chars -**Inputs** +**Inputs** - s: The input string - chars: The characters to search for @@ -327,7 +327,7 @@ Output: true false -**Returns** true if the string s contains any of the characters in chars, false otherwise +**Returns** true if the string s contains any of the characters in chars, false otherwise */ contains_any :: proc(s, chars: string) -> bool { return index_any(s, chars) >= 0 @@ -335,7 +335,7 @@ contains_any :: proc(s, chars: string) -> bool { /* Returns the UTF-8 rune count of the string s -**Inputs** +**Inputs** - s: The input string Example: @@ -353,7 +353,7 @@ Output: 4 5 -**Returns** The UTF-8 rune count of the string s +**Returns** The UTF-8 rune count of the string s */ rune_count :: proc(s: string) -> int { return utf8.rune_count_in_string(s) @@ -362,7 +362,7 @@ rune_count :: proc(s: string) -> int { Returns whether the strings u and v are the same alpha characters, ignoring different casings Works with UTF-8 string content -**Inputs** +**Inputs** - u: The first string for comparison - v: The second string for comparison @@ -385,7 +385,7 @@ Output: true false -**Returns** True if the strings u and v are the same alpha characters (ignoring case), false +**Returns** True if the strings u and v are the same alpha characters (ignoring case), false */ equal_fold :: proc(u, v: string) -> bool { s, t := u, v @@ -432,7 +432,7 @@ equal_fold :: proc(u, v: string) -> bool { /* Returns the prefix length common between strings a and b -**Inputs** +**Inputs** - a: The first input string - b: The second input string @@ -455,7 +455,7 @@ Output: 2 0 -**Returns** The prefix length common between strings a and b +**Returns** The prefix length common between strings a and b */ prefix_length :: proc(a, b: string) -> (n: int) { _len := min(len(a), len(b)) @@ -483,7 +483,7 @@ prefix_length :: proc(a, b: string) -> (n: int) { /* Determines if a string s starts with a given prefix -**Inputs** +**Inputs** - s: The string to check for the prefix - prefix: The prefix to look for @@ -506,7 +506,7 @@ Output: true false -**Returns** true if the string s starts with the prefix, otherwise false +**Returns** true if the string s starts with the prefix, otherwise false */ has_prefix :: proc(s, prefix: string) -> bool { return len(s) >= len(prefix) && s[0:len(prefix)] == prefix @@ -531,11 +531,11 @@ Output: false true -**Inputs** +**Inputs** - s: The string to check for the suffix - suffix: The suffix to look for -**Returns** true if the string s ends with the suffix, otherwise false +**Returns** true if the string s ends with the suffix, otherwise false */ has_suffix :: proc(s, suffix: string) -> bool { return len(s) >= len(suffix) && s[len(s)-len(suffix):] == suffix @@ -563,12 +563,12 @@ Output: a-b-c a...b...c -**Inputs** +**Inputs** - a: A slice of strings to join - sep: The separator string - allocator: (default is context.allocator) -**Returns** A combined string from the slice of strings a separated with the sep string +**Returns** A combined string from the slice of strings a separated with the sep string */ join :: proc(a: []string, sep: string, allocator := context.allocator) -> string { if len(a) == 0 { @@ -593,12 +593,12 @@ Joins a slice of strings a with a sep string, returns an error on allocation fai *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - a: A slice of strings to join - sep: The separator string - allocator: (default is context.allocator) -**Returns** +**Returns** - str: A combined string from the slice of strings a separated with the sep string - err: An error if allocation failed, otherwise nil */ @@ -625,7 +625,7 @@ Returns a combined string from the slice of strings `a` without a separator *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - a: A slice of strings to concatenate - allocator: An optional custom allocator (default is context.allocator) @@ -643,7 +643,7 @@ Output: abc -**Returns** The concatenated string +**Returns** The concatenated string */ concatenate :: proc(a: []string, allocator := context.allocator) -> string { if len(a) == 0 { @@ -666,11 +666,11 @@ Returns a combined string from the slice of strings `a` without a separator, or *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - a: A slice of strings to concatenate - allocator: An optional custom allocator (default is context.allocator) -**Returns** The concatenated string, and an error if allocation fails +**Returns** The concatenated string, and an error if allocation fails */ concatenate_safe :: proc(a: []string, allocator := context.allocator) -> (res: string, err: mem.Allocator_Error) { if len(a) == 0 { @@ -693,7 +693,7 @@ Returns a substring of the input string `s` with the specified rune offset and l *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to cut - rune_offset: The starting rune index (default is 0). In runes, not bytes. - rune_length: The number of runes to include in the substring (default is 0, which returns the remainder of the string). In runes, not bytes. @@ -716,7 +716,7 @@ Output: me example -**Returns** The substring +**Returns** The substring */ cut :: proc(s: string, rune_offset := int(0), rune_length := int(0), allocator := context.allocator) -> (res: string) { s := s; rune_length := rune_length @@ -774,14 +774,14 @@ Splits the input string `s` into a slice of substrings separated by the specifie *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to split - sep: The separator string - sep_save: A flag determining if the separator should be saved in the resulting substrings - n: The maximum number of substrings to return, returns nil without alloc when n=0 - allocator: An optional custom allocator (default is context.allocator) -**Returns** A slice of substrings +**Returns** A slice of substrings */ @private _split :: proc(s_, sep: string, sep_save, n_: int, allocator := context.allocator) -> []string { @@ -835,7 +835,7 @@ Splits a string into parts based on a separator. *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The string to split. - sep: The separator string used to split the input string. - allocator: (default is context.allocator). @@ -855,7 +855,7 @@ Output: ["aaa", "bbb", "ccc", "ddd", "eee"] -**Returns** A slice of strings, each representing a part of the split string. +**Returns** A slice of strings, each representing a part of the split string. */ split :: proc(s, sep: string, allocator := context.allocator) -> []string { return _split(s, sep, 0, -1, allocator) @@ -865,7 +865,7 @@ Splits a string into parts based on a separator. if n < count of seperators, the *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The string to split. - sep: The separator string used to split the input string. - allocator: (default is context.allocator) @@ -885,7 +885,7 @@ Output: ["aaa", "bbb", "ccc.ddd.eee"] -**Returns** A slice of strings, each representing a part of the split string. +**Returns** A slice of strings, each representing a part of the split string. */ split_n :: proc(s, sep: string, n: int, allocator := context.allocator) -> []string { return _split(s, sep, 0, n, allocator) @@ -895,7 +895,7 @@ Splits a string into parts after the separator, retaining it in the substrings. *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The string to split. - sep: The separator string used to split the input string. - allocator: (Optional) The allocator used for allocation (default is context.allocator). @@ -915,7 +915,7 @@ Output: ["aaa.", "bbb.", "ccc.", "ddd.", "eee"] -**Returns** A slice of strings, each representing a part of the split string after the separator. +**Returns** A slice of strings, each representing a part of the split string after the separator. */ split_after :: proc(s, sep: string, allocator := context.allocator) -> []string { return _split(s, sep, len(sep), -1, allocator) @@ -925,7 +925,7 @@ Splits a string into a total of 'n' parts after the separator. *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The string to split. - sep: The separator string used to split the input string. - n: The maximum number of parts to split the string into. @@ -946,7 +946,7 @@ Output: ["aaa.", "bbb.", "ccc.ddd.eee"] -**Returns** A slice of strings with 'n' parts or fewer if there weren't +**Returns** A slice of strings with 'n' parts or fewer if there weren't */ split_after_n :: proc(s, sep: string, n: int, allocator := context.allocator) -> []string { return _split(s, sep, len(sep), n, allocator) @@ -957,14 +957,14 @@ up to (but not including) the separator, as well as a boolean indicating success *Used Internally - Private Function* -**Inputs** +**Inputs** - s: Pointer to the input string, which is modified during the search. - sep: The separator string to search for. - sep_save: Number of characters from the separator to include in the result. NOTE: Destructively consumes the string -**Returns** A tuple containing the resulting substring and a boolean indicating success. +**Returns** A tuple containing the resulting substring and a boolean indicating success. */ @private _split_iterator :: proc(s: ^string, sep: string, sep_save: int) -> (res: string, ok: bool) { @@ -997,7 +997,7 @@ _split_iterator :: proc(s: ^string, sep: string, sep_save: int) -> (res: string, Splits the input string by the byte separator in an iterator fashion. Destructively consumes the original string until the end. -**Inputs** +**Inputs** - s: Pointer to the input string, which is modified during the search. - sep: The byte separator to search for. @@ -1021,7 +1021,7 @@ Output: d e -**Returns** A tuple containing the resulting substring and a boolean indicating success. +**Returns** A tuple containing the resulting substring and a boolean indicating success. */ split_by_byte_iterator :: proc(s: ^string, sep: u8) -> (res: string, ok: bool) { m := index_byte(s^, sep) @@ -1041,7 +1041,7 @@ split_by_byte_iterator :: proc(s: ^string, sep: u8) -> (res: string, ok: bool) { Splits the input string by the separator string in an iterator fashion. Destructively consumes the original string until the end. -**Inputs** +**Inputs** - s: Pointer to the input string, which is modified during the search. - sep: The separator string to search for. @@ -1065,7 +1065,7 @@ Output: d e -**Returns** A tuple containing the resulting substring and a boolean indicating success. +**Returns** A tuple containing the resulting substring and a boolean indicating success. */ split_iterator :: proc(s: ^string, sep: string) -> (string, bool) { return _split_iterator(s, sep, 0) @@ -1074,7 +1074,7 @@ split_iterator :: proc(s: ^string, sep: string) -> (string, bool) { Splits the input string after every separator string in an iterator fashion. Destructively consumes the original string until the end. -**Inputs** +**Inputs** - s: Pointer to the input string, which is modified during the search. - sep: The separator string to search for. @@ -1098,7 +1098,7 @@ Output: d. e -**Returns** A tuple containing the resulting substring and a boolean indicating success. +**Returns** A tuple containing the resulting substring and a boolean indicating success. */ split_after_iterator :: proc(s: ^string, sep: string) -> (string, bool) { return _split_iterator(s, sep, len(sep)) @@ -1108,10 +1108,10 @@ Trims the carriage return character from the end of the input string. *Used Internally - Private Function* -**Inputs** +**Inputs** - s: The input string to trim. -**Returns** The trimmed string as a slice. +**Returns** The trimmed string as a slice. */ @(private) _trim_cr :: proc(s: string) -> string { @@ -1128,7 +1128,7 @@ Splits the input string at every line break '\n'. *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to split. - allocator: (default is context.allocator) @@ -1147,7 +1147,7 @@ Output: ["a", "b", "c", "d", "e"] -**Returns** An allocated slice of strings split by line breaks. +**Returns** An allocated slice of strings split by line breaks. */ split_lines :: proc(s: string, allocator := context.allocator) -> []string { sep :: "\n" @@ -1162,7 +1162,7 @@ Splits the input string at every line break '\n' for n parts. *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to split. - n: The number of parts to split into. - allocator: (default is context.allocator) @@ -1182,7 +1182,7 @@ Output: ["a", "b", "c\nd\ne"] -**Returns** An allocated array of strings split by line breaks. +**Returns** An allocated array of strings split by line breaks. */ split_lines_n :: proc(s: string, n: int, allocator := context.allocator) -> []string { sep :: "\n" @@ -1197,7 +1197,7 @@ Splits the input string at every line break '\n' leaving the '\n' in the resulti *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to split. - allocator: (default is context.allocator) @@ -1216,7 +1216,7 @@ Output: ["a\n", "b\n", "c\n", "d\n", "e"] -**Returns** An allocated slice of strings split by line breaks with line breaks included. +**Returns** An allocated slice of strings split by line breaks with line breaks included. */ split_lines_after :: proc(s: string, allocator := context.allocator) -> []string { sep :: "\n" @@ -1232,7 +1232,7 @@ Only runs for n parts. *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string to split. - n: The number of parts to split into. - allocator: (default is context.allocator) @@ -1252,7 +1252,7 @@ Output: ["a\n", "b\n", "c\nd\ne"] -**Returns** An allocated slice of strings split by line breaks with line breaks included. +**Returns** An allocated slice of strings split by line breaks with line breaks included. */ split_lines_after_n :: proc(s: string, n: int, allocator := context.allocator) -> []string { sep :: "\n" @@ -1266,7 +1266,7 @@ split_lines_after_n :: proc(s: string, n: int, allocator := context.allocator) - Splits the input string at every line break '\n'. Returns the current split string every iteration until the string is consumed. -**Inputs** +**Inputs** - s: Pointer to the input string, which is modified during the search. Example: @@ -1285,7 +1285,7 @@ Output: abcde -**Returns** A tuple containing the resulting substring and a boolean indicating success. +**Returns** A tuple containing the resulting substring and a boolean indicating success. */ split_lines_iterator :: proc(s: ^string) -> (line: string, ok: bool) { sep :: "\n" @@ -1296,7 +1296,7 @@ split_lines_iterator :: proc(s: ^string) -> (line: string, ok: bool) { Splits the input string at every line break '\n'. Returns the current split string with line breaks included every iteration until the string is consumed. -**Inputs** +**Inputs** - s: Pointer to the input string, which is modified during the search. Example: @@ -1319,7 +1319,7 @@ Output: d e -**Returns** A tuple containing the resulting substring with line breaks included and a boolean indicating success. +**Returns** A tuple containing the resulting substring with line breaks included and a boolean indicating success. */ split_lines_after_iterator :: proc(s: ^string) -> (line: string, ok: bool) { sep :: "\n" @@ -1330,7 +1330,7 @@ split_lines_after_iterator :: proc(s: ^string) -> (line: string, ok: bool) { Returns the byte offset of the first byte c in the string s it finds, -1 when not found. NOTE: Can't find UTF-8 based runes. -**Inputs** +**Inputs** - s: The input string to search in. - c: The byte to search for. @@ -1353,7 +1353,7 @@ Output: -1 -1 -**Returns** The byte offset of the first occurrence of c in s, or -1 if not found. +**Returns** The byte offset of the first occurrence of c in s, or -1 if not found. */ index_byte :: proc(s: string, c: byte) -> int { for i := 0; i < len(s); i += 1 { @@ -1386,7 +1386,7 @@ Output: -1 -1 -**Returns** The byte offset of the last occurrence of `c` in `s`, or -1 if not found. +**Returns** The byte offset of the last occurrence of `c` in `s`, or -1 if not found. */ last_index_byte :: proc(s: string, c: byte) -> int { for i := len(s)-1; i >= 0; i -= 1 { @@ -1426,7 +1426,7 @@ Output: 6 7 -**Returns** The byte offset of the first occurrence of `r` in `s`, or -1 if not found. +**Returns** The byte offset of the first occurrence of `r` in `s`, or -1 if not found. */ index_rune :: proc(s: string, r: rune) -> int { switch { @@ -1472,7 +1472,7 @@ Output: 2 -1 -**Returns** The byte offset of the first occurrence of `substr` in `s`, or -1 if not found. +**Returns** The byte offset of the first occurrence of `substr` in `s`, or -1 if not found. */ index :: proc(s, substr: string) -> int { hash_str_rabin_karp :: proc(s: string) -> (hash: u32 = 0, pow: u32 = 1) { @@ -1545,7 +1545,7 @@ Output: 2 -1 -**Returns** The byte offset of the last occurrence of `substr` in `s`, or -1 if not found. +**Returns** The byte offset of the last occurrence of `substr` in `s`, or -1 if not found. */ last_index :: proc(s, substr: string) -> int { hash_str_rabin_karp_reverse :: proc(s: string) -> (hash: u32 = 0, pow: u32 = 1) { @@ -1618,7 +1618,7 @@ Output: 0 -1 -**Returns** The index of the first character of `chars` found in `s`, or -1 if not found. +**Returns** The index of the first character of `chars` found in `s`, or -1 if not found. */ index_any :: proc(s, chars: string) -> int { if chars == "" { @@ -1654,7 +1654,7 @@ index_any :: proc(s, chars: string) -> int { /* Finds the last occurrence of any character in 'chars' within 's'. Iterates in reverse. -**Inputs** +**Inputs** - s: The string to search in - chars: The characters to look for @@ -1679,7 +1679,7 @@ Output: 3 -1 -**Returns** The index of the last matching character, or -1 if not found +**Returns** The index of the last matching character, or -1 if not found */ last_index_any :: proc(s, chars: string) -> int { if chars == "" { @@ -1732,11 +1732,11 @@ last_index_any :: proc(s, chars: string) -> int { /* Finds the first occurrence of any substring in 'substrs' within 's' -**Inputs** +**Inputs** - s: The string to search in - substrs: The substrings to look for -**Returns** A tuple containing the index of the first matching substring, and its length (width) +**Returns** A tuple containing the index of the first matching substring, and its length (width) */ index_multi :: proc(s: string, substrs: []string) -> (idx: int, width: int) { idx = -1 @@ -1770,7 +1770,7 @@ index_multi :: proc(s: string, substrs: []string) -> (idx: int, width: int) { /* Counts the number of non-overlapping occurrences of 'substr' in 's' -**Inputs** +**Inputs** - s: The string to search in - substr: The substring to count @@ -1795,7 +1795,7 @@ Output: 1 0 -**Returns** The number of occurrences of 'substr' in 's', returns the rune_count + 1 of the string `s` on empty `substr` +**Returns** The number of occurrences of 'substr' in 's', returns the rune_count + 1 of the string `s` on empty `substr` */ count :: proc(s, substr: string) -> int { if len(substr) == 0 { // special case @@ -1836,7 +1836,7 @@ Repeats the string 's' 'count' times, concatenating the result *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The string to repeat - count: The number of times to repeat 's' - allocator: (default is context.allocator) @@ -1856,7 +1856,7 @@ Output: abcabc -**Returns** The concatenated repeated string +**Returns** The concatenated repeated string */ repeat :: proc(s: string, count: int, allocator := context.allocator) -> string { if count < 0 { @@ -1878,7 +1878,7 @@ Replaces all occurrences of 'old' in 's' with 'new' *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The string to modify - old: The substring to replace - new: The substring to replace 'old' with @@ -1901,7 +1901,7 @@ Output: xyzxyz false zzzz true -**Returns** A tuple containing the modified string and a boolean indicating if an allocation occurred during the replacement +**Returns** A tuple containing the modified string and a boolean indicating if an allocation occurred during the replacement */ replace_all :: proc(s, old, new: string, allocator := context.allocator) -> (output: string, was_allocation: bool) { return replace(s, old, new, -1, allocator) @@ -1911,7 +1911,7 @@ Replaces n instances of old in the string s with the new string *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string - old: The substring to be replaced - new: The replacement string @@ -1937,7 +1937,7 @@ Output: xyzxyz false zzzz true -**Returns** A tuple containing the modified string and a boolean indicating if an allocation occurred during the replacement +**Returns** A tuple containing the modified string and a boolean indicating if an allocation occurred during the replacement */ replace :: proc(s, old, new: string, n: int, allocator := context.allocator) -> (output: string, was_allocation: bool) { if old == new || n == 0 { @@ -1983,7 +1983,7 @@ Removes the key string n times from the s string *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string - key: The substring to be removed - n: The number of instances to remove (if n < 0, no limit on the number of removes) @@ -2008,7 +2008,7 @@ Output: bcbc true abcabc false -**Returns** A tuple containing the modified string and a boolean indicating if an allocation occurred during the removal +**Returns** A tuple containing the modified string and a boolean indicating if an allocation occurred during the removal */ remove :: proc(s, key: string, n: int, allocator := context.allocator) -> (output: string, was_allocation: bool) { return replace(s, key, "", n, allocator) @@ -2018,7 +2018,7 @@ Removes all the key string instances from the s string *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string - key: The substring to be removed - allocator: (default: context.allocator) @@ -2040,7 +2040,7 @@ Output: bcbc true abcabc false -**Returns** A tuple containing the modified string and a boolean indicating if an allocation occurred during the removal +**Returns** A tuple containing the modified string and a boolean indicating if an allocation occurred during the removal */ remove_all :: proc(s, key: string, allocator := context.allocator) -> (output: string, was_allocation: bool) { return remove(s, key, -1, allocator) @@ -2080,7 +2080,7 @@ is_null :: proc(r: rune) -> bool { /* Finds the index of the first rune in the string s for which the procedure p returns the same value as truth -**Inputs** +**Inputs** - s: The input string - p: A procedure that takes a rune and returns a boolean - truth: The boolean value to be matched (default: true) @@ -2109,7 +2109,7 @@ Output: 1 -1 -**Returns** The index of the first matching rune, or -1 if no match was found +**Returns** The index of the first matching rune, or -1 if no match was found */ index_proc :: proc(s: string, p: proc(rune) -> bool, truth := true) -> int { for r, i in s { @@ -2155,7 +2155,7 @@ last_index_proc_with_state :: proc(s: string, p: proc(rawptr, rune) -> bool, sta /* Trims the input string s from the left until the procedure p returns false -**Inputs** +**Inputs** - s: The input string - p: A procedure that takes a rune and returns a boolean @@ -2175,7 +2175,7 @@ Output: ing -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_left_proc :: proc(s: string, p: proc(rune) -> bool) -> string { i := index_proc(s, p, false) @@ -2187,12 +2187,12 @@ trim_left_proc :: proc(s: string, p: proc(rune) -> bool) -> string { /* Trims the input string s from the left until the procedure p with state returns false -**Inputs** +**Inputs** - s: The input string - p: A procedure that takes a raw pointer and a rune and returns a boolean - state: The raw pointer to be passed to the procedure p -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_left_proc_with_state :: proc(s: string, p: proc(rawptr, rune) -> bool, state: rawptr) -> string { i := index_proc_with_state(s, p, state, false) @@ -2204,7 +2204,7 @@ trim_left_proc_with_state :: proc(s: string, p: proc(rawptr, rune) -> bool, stat /* Trims the input string s from the right until the procedure p returns false -**Inputs** +**Inputs** - s: The input string - p: A procedure that takes a rune and returns a boolean @@ -2224,7 +2224,7 @@ Output: test -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_right_proc :: proc(s: string, p: proc(rune) -> bool) -> string { i := last_index_proc(s, p, false) @@ -2239,12 +2239,12 @@ trim_right_proc :: proc(s: string, p: proc(rune) -> bool) -> string { /* Trims the input string s from the right until the procedure p with state returns false -**Inputs** +**Inputs** - s: The input string - p: A procedure that takes a raw pointer and a rune and returns a boolean - state: The raw pointer to be passed to the procedure p -**Returns** The trimmed string as a slice of the original, empty when no match +**Returns** The trimmed string as a slice of the original, empty when no match */ trim_right_proc_with_state :: proc(s: string, p: proc(rawptr, rune) -> bool, state: rawptr) -> string { i := last_index_proc_with_state(s, p, state, false) @@ -2272,11 +2272,11 @@ is_in_cutset :: proc(state: rawptr, r: rune) -> bool { /* Trims the cutset string from the s string -**Inputs** +**Inputs** - s: The input string - cutset: The set of characters to be trimmed from the left of the input string -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_left :: proc(s: string, cutset: string) -> string { if s == "" || cutset == "" { @@ -2288,11 +2288,11 @@ trim_left :: proc(s: string, cutset: string) -> string { /* Trims the cutset string from the s string from the right -**Inputs** +**Inputs** - s: The input string - cutset: The set of characters to be trimmed from the right of the input string -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_right :: proc(s: string, cutset: string) -> string { if s == "" || cutset == "" { @@ -2304,11 +2304,11 @@ trim_right :: proc(s: string, cutset: string) -> string { /* Trims the cutset string from the s string, both from left and right -**Inputs** +**Inputs** - s: The input string - cutset: The set of characters to be trimmed from both sides of the input string -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim :: proc(s: string, cutset: string) -> string { return trim_right(trim_left(s, cutset), cutset) @@ -2316,10 +2316,10 @@ trim :: proc(s: string, cutset: string) -> string { /* Trims until a valid non-space rune from the left, "\t\txyz\t\t" -> "xyz\t\t" -**Inputs** +**Inputs** - s: The input string -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_left_space :: proc(s: string) -> string { return trim_left_proc(s, is_space) @@ -2327,10 +2327,10 @@ trim_left_space :: proc(s: string) -> string { /* Trims from the right until a valid non-space rune, "\t\txyz\t\t" -> "\t\txyz" -**Inputs** +**Inputs** - s: The input string -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_right_space :: proc(s: string) -> string { return trim_right_proc(s, is_space) @@ -2338,10 +2338,10 @@ trim_right_space :: proc(s: string) -> string { /* Trims from both sides until a valid non-space rune, "\t\txyz\t\t" -> "xyz" -**Inputs** +**Inputs** - s: The input string -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_space :: proc(s: string) -> string { return trim_right_space(trim_left_space(s)) @@ -2349,10 +2349,10 @@ trim_space :: proc(s: string) -> string { /* Trims null runes from the left, "\x00\x00testing\x00\x00" -> "testing\x00\x00" -**Inputs** +**Inputs** - s: The input string -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_left_null :: proc(s: string) -> string { return trim_left_proc(s, is_null) @@ -2360,10 +2360,10 @@ trim_left_null :: proc(s: string) -> string { /* Trims null runes from the right, "\x00\x00testing\x00\x00" -> "\x00\x00testing" -**Inputs** +**Inputs** - s: The input string -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_right_null :: proc(s: string) -> string { return trim_right_proc(s, is_null) @@ -2371,9 +2371,9 @@ trim_right_null :: proc(s: string) -> string { /* Trims null runes from both sides, "\x00\x00testing\x00\x00" -> "testing" -**Inputs** +**Inputs** - s: The input string -**Returns** The trimmed string as a slice of the original +**Returns** The trimmed string as a slice of the original */ trim_null :: proc(s: string) -> string { return trim_right_null(trim_left_null(s)) @@ -2381,7 +2381,7 @@ trim_null :: proc(s: string) -> string { /* Trims a prefix string from the start of the s string and returns the trimmed string -**Inputs** +**Inputs** - s: The input string - prefix: The prefix string to be removed @@ -2400,7 +2400,7 @@ Output: ing testing -**Returns** The trimmed string as a slice of original, or the input string if no prefix was found +**Returns** The trimmed string as a slice of original, or the input string if no prefix was found */ trim_prefix :: proc(s, prefix: string) -> string { if has_prefix(s, prefix) { @@ -2411,7 +2411,7 @@ trim_prefix :: proc(s, prefix: string) -> string { /* Trims a suffix string from the end of the s string and returns the trimmed string -**Inputs** +**Inputs** - s: The input string - suffix: The suffix string to be removed @@ -2430,7 +2430,7 @@ Output: todo todo.doc -**Returns** The trimmed string as a slice of original, or the input string if no suffix was found +**Returns** The trimmed string as a slice of original, or the input string if no suffix was found */ trim_suffix :: proc(s, suffix: string) -> string { if has_suffix(s, suffix) { @@ -2443,7 +2443,7 @@ Splits the input string s by all possible substrs and returns an allocated array *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string - substrs: An array of substrings used for splitting - allocator: (default is context.allocator) @@ -2465,7 +2465,7 @@ Output: ["testing", "this", "out", "nice", "done", "last"] -**Returns** An array of strings, or nil on empty substring or no matches +**Returns** An array of strings, or nil on empty substring or no matches */ split_multi :: proc(s: string, substrs: []string, allocator := context.allocator) -> []string #no_bounds_check { if s == "" || len(substrs) <= 0 { @@ -2510,7 +2510,7 @@ split_multi :: proc(s: string, substrs: []string, allocator := context.allocator /* Splits the input string s by all possible substrs in an iterator fashion. The full string is returned if no match. -**Inputs** +**Inputs** - it: A pointer to the input string - substrs: An array of substrings used for splitting @@ -2536,7 +2536,7 @@ Output: done last -**Returns** A tuple containing the split string and a boolean indicating success or failure +**Returns** A tuple containing the split string and a boolean indicating success or failure */ split_multi_iterate :: proc(it: ^string, substrs: []string) -> (res: string, ok: bool) #no_bounds_check { if it == nil || len(it) == 0 || len(substrs) <= 0 { @@ -2568,7 +2568,7 @@ Replaces invalid UTF-8 characters in the input string with a specified replaceme *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string - replacement: The string used to replace invalid UTF-8 characters - allocator: (default is context.allocator) @@ -2587,7 +2587,7 @@ Output: Hello? -**Returns** A new string with invalid UTF-8 characters replaced +**Returns** A new string with invalid UTF-8 characters replaced */ scrub :: proc(s: string, replacement: string, allocator := context.allocator) -> string { str := s @@ -2625,7 +2625,7 @@ Reverses the input string s *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string - allocator: (default is context.allocator) @@ -2644,7 +2644,7 @@ Output: abcxyz zyxcba -**Returns** A reversed version of the input string +**Returns** A reversed version of the input string */ reverse :: proc(s: string, allocator := context.allocator) -> string { str := s @@ -2665,7 +2665,7 @@ Expands the input string by replacing tab characters with spaces to align to a s *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string - tab_size: The number of spaces to use for each tab character - allocator: (default is context.allocator) @@ -2686,7 +2686,7 @@ Output: WARNING: Panics if tab_size <= 0 -**Returns** A new string with tab characters expanded to the specified tab size +**Returns** A new string with tab characters expanded to the specified tab size */ expand_tabs :: proc(s: string, tab_size: int, allocator := context.allocator) -> string { if tab_size <= 0 { @@ -2732,7 +2732,7 @@ expand_tabs :: proc(s: string, tab_size: int, allocator := context.allocator) -> /* Splits the input string str by the separator sep string and returns 3 parts. The values are slices of the original string. -**Inputs** +**Inputs** - str: The input string - sep: The separator string @@ -2754,7 +2754,7 @@ Output: testing t hi s out testing this out -**Returns** A tuple with head (before the split), match (the separator), and tail (the end of the split) strings +**Returns** A tuple with head (before the split), match (the separator), and tail (the end of the split) strings */ partition :: proc(str, sep: string) -> (head, match, tail: string) { i := index(str, sep) @@ -2775,13 +2775,13 @@ Centers the input string within a field of specified length by adding pad string *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - str: The input string - length: The desired length of the centered string - pad: The string used for padding on both sides - allocator: (default is context.allocator) -**Returns** A new string centered within a field of the specified length +**Returns** A new string centered within a field of the specified length */ centre_justify :: proc(str: string, length: int, pad: string, allocator := context.allocator) -> string { n := rune_count(str) @@ -2809,13 +2809,13 @@ Left-justifies the input string within a field of specified length by adding pad *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - str: The input string - length: The desired length of the left-justified string - pad: The string used for padding on the right side - allocator: (default is context.allocator) -**Returns** A new string left-justified within a field of the specified length +**Returns** A new string left-justified within a field of the specified length */ left_justify :: proc(str: string, length: int, pad: string, allocator := context.allocator) -> string { n := rune_count(str) @@ -2842,13 +2842,13 @@ Right-justifies the input string within a field of specified length by adding pa *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - str: The input string - length: The desired length of the right-justified string - pad: The string used for padding on the left side - allocator: (default is context.allocator) -**Returns** A new string right-justified within a field of the specified length +**Returns** A new string right-justified within a field of the specified length */ right_justify :: proc(str: string, length: int, pad: string, allocator := context.allocator) -> string { n := rune_count(str) @@ -2873,7 +2873,7 @@ right_justify :: proc(str: string, length: int, pad: string, allocator := contex /* Writes a given pad string a specified number of times to an io.Writer -**Inputs** +**Inputs** - w: The io.Writer to write the pad string to - pad: The pad string to be written - pad_len: The length of the pad string @@ -2901,11 +2901,11 @@ Splits a string into a slice of substrings at each instance of one or more conse *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string - allocator: (default is context.allocator) -**Returns** A slice of substrings of the input string, or an empty slice if the input string only contains white space +**Returns** A slice of substrings of the input string, or an empty slice if the input string only contains white space */ fields :: proc(s: string, allocator := context.allocator) -> []string #no_bounds_check { n := 0 @@ -2960,14 +2960,14 @@ Splits a string into a slice of substrings at each run of unicode code points `c *Allocates Using Provided Allocator* -**Inputs** +**Inputs** - s: The input string - f: A predicate function to determine the split points - allocator: (default is context.allocator) NOTE: fields_proc makes no guarantee about the order in which it calls f(ch), it assumes that `f` always returns the same value for a given ch -**Returns** A slice of substrings of the input string, or an empty slice if all code points in the input string satisfy the predicate or if the input string is empty +**Returns** A slice of substrings of the input string, or an empty slice if all code points in the input string satisfy the predicate or if the input string is empty */ fields_proc :: proc(s: string, f: proc(rune) -> bool, allocator := context.allocator) -> []string #no_bounds_check { substrings := make([dynamic]string, 0, 32, allocator) @@ -2998,10 +2998,10 @@ fields_proc :: proc(s: string, f: proc(rune) -> bool, allocator := context.alloc /* Retrieves the first non-space substring from a mutable string reference and advances the reference. s is advanced from any space after the substring, or be an empty string if the substring was the remaining characters -**Inputs** +**Inputs** - s: A mutable string reference to be iterated -**Returns** +**Returns** - field: The first non-space substring found - ok: A boolean indicating if a non-space substring was found */ @@ -3040,11 +3040,11 @@ Computes the Levenshtein edit distance between two strings NOTE: Does not perform internal allocation if Length of String b in Runes is Smaller Than 64 -**Inputs** +**Inputs** - a, b: The two strings to compare - allocator: (default is context.allocator) -**Returns** The Levenshtein edit distance between the two strings +**Returns** The Levenshtein edit distance between the two strings NOTE: This implementation is a single-row-version of the Wagner–Fischer algorithm, based on C code by Martin Ettl. */