StringBuilder Chilkat2 Perl Reference Documentation
Chilkat2::StringBuilder
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.StringBuilder
Append strings, characters, integers, random values, UUIDs, encoded data,
and other Chilkat objects without repeatedly recreating strings.
Find substrings, compare content, extract ranges, split or inspect text,
and work with selected portions of the buffer.
Replace text, mask sensitive values, normalize line endings, trim or edit
content, and apply regex-based processing when needed.
Encode or decode text and binary data using formats such as Base64, hex,
URL encoding, quoted-printable, and other supported encodings.
Compute hashes of the current text, convert Markdown to HTML, and move
content between
Load text from files, save text with explicit character encodings, and
securely clear the buffer when it contains sensitive data.
For an extended overview, see
StringBuilder Class Overview.
Build, transform, search, encode, decode, hash, and save mutable text.
Chilkat.StringBuilder is a flexible mutable text container for
constructing and transforming strings. It supports appending text, integers,
random values, UUIDs, encoded bytes, and BinData; searching,
comparing, extracting, replacing, masking, regex processing, line-ending
normalization, encoding, decoding, hashing, Markdown conversion, file I/O,
and secure clearing of sensitive text.
Build text incrementally
Search and extract
Replace and transform
Encoding and decoding
Hashing and conversion
StringBuilder, BinData, files,
and plain strings.
File I/O and secure clearing
StringBuilder when text will be assembled or modified in
multiple steps. Append or load the starting content, perform searches,
replacements, encoding, decoding, hashing, or line-ending normalization, then
retrieve the result as a string, save it to a file, or pass the object
directly to another Chilkat method.
Object Creation
use Chilkat2;
my $sb = Chilkat2::StringBuilder->new;
# or set properties (and RaiseError) at creation:
# my $sb = Chilkat2::StringBuilder->new(VerboseLogging => 1, RaiseError => 1);Creates the object. The optional pairs set writable properties (and RaiseError) in order, as if set one by one; an unknown or read-only name croaks. use Chilkat2; loads every class; the Chilkat2/StringBuilder.pm file holds only this class's documentation (perldoc Chilkat2::StringBuilder).
Perl frees the object when its last reference goes (undef $sb, or the variable going out of scope); there is nothing to close. Objects returned by methods are independent and freed the same way. The class may be subclassed (use parent -norequire, 'Chilkat2::StringBuilder';): an object is a blessed hash reference whose hash is free for the subclass's own fields.
When false (the default), a method that fails returns false (or undef), and the reason is in LastErrorText. When true, it dies with a Chilkat2::Error instead, as DBI does with its RaiseError. Objects returned by a method inherit the value of the object that returned them.
Errors
A Chilkat2::Error stringifies to the failed call's full LastErrorText, and has the methods text, class ('Chilkat2::StringBuilder'), method (the method name) and object. Methods that look something up and find nothing return undef without dying (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain boolean, and property reads and writes never fail for Chilkat reasons.
Misuse always croaks, with your file and line, whatever RaiseError is: a wrong number of arguments, a reference or undef where a string or number is expected, an object of the wrong class, an out-of-range integer, a string containing a NUL character, a wide character in a byte string, or a write to a read-only property.
Strings are Perl character strings in both directions (length, regexes and :encoding layers see characters); binary data (BinData) is a byte string. Unlocking: call Chilkat2::Global->new->UnlockBundle('...') once at startup.
Properties
DebugLogFilePath
my $strVal = $sb->DebugLogFilePath;
$sb->DebugLogFilePath($strVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
HasEmojis
my $boolVal = $sb->HasEmojis;
Returns 1 if the content contains one or more emoji characters.
IntValue
my $intVal = $sb->IntValue;
$sb->IntValue($intVal);
Returns the content of the string converted to an integer.
topIsBase64
my $boolVal = $sb->IsBase64;
Returns 1 if the content contains only those characters allowed in the base64 encoding. A base64 string is composed of characters 'A'..'Z', 'a'..'z', '0'..'9', '+', '/' and it is often padded at the end with up to two '=', to make the length a multiple of 4. Whitespace is ignored.
LastErrorHtml
my $strVal = $sb->LastErrorHtml;
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
my $strVal = $sb->LastErrorText;
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
my $strVal = $sb->LastErrorXml;
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
my $boolVal = $sb->LastMethodSuccess;
$sb->LastMethodSuccess($boolVal);
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Length
my $intVal = $sb->Length;
The number of characters of the string contained within this instance.
topVerboseLogging
my $boolVal = $sb->VerboseLogging;
$sb->VerboseLogging($boolVal);
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
my $strVal = $sb->Version;
Methods
Append
# $success is true or false
my $success = $sb->Append($value);
Appends a copy of the specified string to this instance.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendBd
# $charset is a string
# $offset is an integer
# $numBytes is an integer
# $success is true or false
my $success = $sb->AppendBd($binData, $charset, $offset, $numBytes);
Appends the contents of $binData. The $charset specifies the character encoding of the bytes contained in $binData. The $charset can be any of the supported encodings listed at Chilkat Supported Character Encodings. To append the entire contents of $binData, set $offset and $numBytes equal to zero. To append a range of $binData, set the $offset and $numBytes to specify the range.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendInt
# $success is true or false
my $success = $sb->AppendInt($value);
Appends the string representation of a specified 32-bit signed integer to this instance.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendInt64
# $success is true or false
my $success = $sb->AppendInt64($value);
Appends the string representation of a specified 64-bit signed integer to this instance.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendLine
# $crlf is a boolean
# $success is true or false
my $success = $sb->AppendLine($str, $crlf);
Appends the $str followed by a CRLF or LF to the end of the curent StringBuilder object. If $crlf is 1, then a CRLF line ending is used. Otherwise a LF line ending is used.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendLn
# $success is true or false
my $success = $sb->AppendLn($str);
Appends the $str followed by a CRLF to the end of this object. This method is the same as AppendLine , except the line-ending is always CRLF.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendRandom
# $encoding is a string
# $success is true or false
my $success = $sb->AppendRandom($numBytes, $encoding);
Append $numBytes random bytes encoded according to $encoding. $encoding can be hex, hex_lower, base64, base64url, or any other encoding supported by Chilkat.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendSb
# $success is true or false
my $success = $sb->AppendSb($sb);
Appends the contents of another StringBuilder to this instance.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendUuid
# $success is true or false
my $success = $sb->AppendUuid($lowerCase);
Generates and appends a random GUID/UUID such as 63c35f38-2b5f-4600-b3da-3ddee86d62b3. If $lowerCase is 1, then the hex values use lowercase (a - f). If $lowerCase is 0 then uppercase is used (A - F).
Note: This generates a version 4 UUID.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendUuid7
# $success is true or false
my $success = $sb->AppendUuid7($lowerCase);
Generates and appends a random version 7 UUID. If $lowerCase is 1, then the hex values use lowercase (a - f). If $lowerCase is 0 then uppercase is used (A - F).
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Clear
Removes all characters from the current StringBuilder instance.
Returns the object, so calls can be chained.
topContains
# $caseSensitive is a boolean
# $flag is true or false
my $flag = $sb->Contains($str, $caseSensitive);
Returns 1 if the $str is contained within this object. For case sensitive matching, set $caseSensitive equal to 1. For case-insensitive, set $caseSensitive equal to 0.
Never dies: false is an answer, not a failure.
topContainsWord
# $caseSensitive is a boolean
# $flag is true or false
my $flag = $sb->ContainsWord($word, $caseSensitive);
Returns 1 if the $word is contained within this object, but only if it is a whole word. This method is limited to finding whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)
For case sensitive matching, set $caseSensitive equal to 1. For case-insensitive, set $caseSensitive equal to 0.
Never dies: false is an answer, not a failure.
topContentsEqual
# $caseSensitive is a boolean
# $flag is true or false
my $flag = $sb->ContentsEqual($str, $caseSensitive);
Returns 1 if the contents of this object equals the $str. Returns 0 if unequal. For case insensitive equality, set $caseSensitive equal to 0.
Never dies: false is an answer, not a failure.
topContentsEqualSb
# $caseSensitive is a boolean
# $flag is true or false
my $flag = $sb->ContentsEqualSb($sb, $caseSensitive);
Returns 1 if the contents of this object equals the $sb. Returns 0 if unequal. For case insensitive equality, set $caseSensitive equal to 0.
Never dies: false is an answer, not a failure.
topDecode
# $charset is a string
# $success is true or false
my $success = $sb->Decode($encoding, $charset);
Decodes and replaces the contents with the decoded string. The $encoding can be set to any of the following strings: base64, hex, quoted-printable (or qp), url, base32, Q, B, url_rc1738, url_rfc2396, url_rfc3986, url_oauth, uu, modBase64, or html (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled Supported Binary Encodings below.
Note: This method can only be called if the encoded content decodes to a string. The $charset indicates the charset to be used in intepreting the decoded bytes. For example, the $charset can be utf-8, utf-16, iso-8859-1, shift_JIS, etc.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
DecodeAndAppend
# $encoding is a string
# $charset is a string
# $success is true or false
my $success = $sb->DecodeAndAppend($value, $encoding, $charset);
Decodes a binary encoded string, where the binary encoding (such as url, hex, base64, etc.) is specified by $encoding, and the underlying charset encoding (such as utf-8, windows-1252, etc.) is specified by $charset. The decoded string is appended to this object.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Encode
# $charset is a string
# $success is true or false
my $success = $sb->Encode($encoding, $charset);
Encodes to base64, hex, quoted-printable, URL encoding, etc. The $encoding can be set to any of the following strings: base64, hex, quoted-printable (or qp), url, base32, Q, B, url_rc1738, url_rfc2396, url_rfc3986, url_oauth, uu, modBase64, or html (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled Supported Binary Encodings below.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
EndsWith
# $caseSensitive is a boolean
# $flag is true or false
my $flag = $sb->EndsWith($substr, $caseSensitive);
Returns 1 if the string ends with $substr. Otherwise returns 0. The comparison is case sensitive if $caseSensitive is 1, and case insensitive if $caseSensitive is 0.
Never dies: false is an answer, not a failure.
topEntityDecode
my $success = $sb->EntityDecode();
Decodes HTML entities. See HTML entities for more information about HTML entities.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetAfterBetween
# $beginMark is a string
# $endMark is a string
# $str is a string or undef
my $str = $sb->GetAfterBetween($searchAfter, $beginMark, $endMark);
Begin searching after the 1st occurrence of $searchAfter is found, and then return the substring found between the next occurrence of $beginMark and the next occurrence of $endMark.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetAfterFinal
# $removeFlag is a boolean
# $str is a string or undef
my $str = $sb->GetAfterFinal($marker, $removeFlag);
Returns the substring found after the final occurrence of $marker. If $removeFlag is 1, the $marker and the content that follows is removed from this content.
If the $marker is not present, then the entire string is returned. In this case, if $removeFlag is 1, this object is also cleared.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetAsString
my $str = $sb->GetAsString();
Returns the contents as a string.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetBefore
# $removeFlag is a boolean
# $str is a string or undef
my $str = $sb->GetBefore($marker, $removeFlag);
Returns the substring found before the 1st occurrence of $marker. If $removeFlag is 1, the content up to and including the $marker is removed from this object's contents.
If the $marker is not present, then the entire string is returned. In this case, if $removeFlag is 1, this object is also cleared.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetBetween
# $endMark is a string
# $str is a string or undef
my $str = $sb->GetBetween($beginMark, $endMark);
Returns the substring found between the 1st occurrence of $beginMark and the next occurrence of $endMark.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetEncoded
# $charset is a string
# $str is a string or undef
my $str = $sb->GetEncoded($encoding, $charset);
Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or URL-encoding. The $encoding can be set to any of the following strings: base64, hex, quoted-printable (or qp), url, base32, Q, B, url_rc1738, url_rfc2396, url_rfc3986, url_oauth, uu, modBase64, or html (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled Supported Binary Encodings below.
Note: The Encode method modifies the content of this object. The GetEncoded method leaves this object's content unmodified.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetHash
# $encoding is a string
# $charset is a string
# $str is a string or undef
my $str = $sb->GetHash($algorithm, $encoding, $charset);
Returns the hash of the contents of this object. The $algorithm is the hash algorithm, and can be sha1, sha256, sha384, sha512, sha3-224, sha3-256, sha3-384, sha3-512, md2, md5, ripemd128, ripemd160,ripemd256, or ripemd320.
The $encoding can be base64, modBase64, base64Url, base32, base58, qp (for quoted-printable), url (for url-encoding), hex, hexLower, or any of the encodings found at Chilkat Binary Encodings List.
The $charset is the character encoding byte representation to hash. It is typically utf-8. It can be any of the chacter encodings listed at Chilkat Character Encodings List.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetNth
# $delimiterChar is a string
# $exceptDoubleQuoted is a boolean
# $exceptEscaped is a boolean
# $str is a string or undef
my $str = $sb->GetNth($index, $delimiterChar, $exceptDoubleQuoted, $exceptEscaped);
Returns the Nth substring in string that is a list delimted by $delimiterChar. The first substring is at index 0. If $exceptDoubleQuoted is 1, then the delimiter char found between double quotes is not treated as a delimiter. If $exceptEscaped is 1, then an escaped (with a backslash) delimiter char is not treated as a delimiter.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetRange
# $numChars is an integer
# $removeFlag is a boolean
# $str is a string or undef
my $str = $sb->GetRange($startIndex, $numChars, $removeFlag);
Returns a string containing the specified range of characters from this instance. If $removeFlag is 1, then the range of chars is removed from this instance.
Note: It was discovered that the range of chars was always removed regardless of the value of $removeFlag. This is fixed in v9.5.0.89.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
GetRangeSb
# $numChars is an integer
# $removeFlag is a boolean
# $sb is a Chilkat2::StringBuilder
# $success is true or false
my $success = $sb->GetRangeSb($startIndex, $numChars, $removeFlag, $sb);
Appends to $startIndex the specified range of characters from this instance. If $removeFlag is 1, then the range of chars is removed from this instance.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
HtmlToMarkdown
my $success = $sb->HtmlToMarkdown();
Converts the HTML contained in this object to Markdown, replacing the contents with the Markdown. Returns 1 on success. If the conversion fails, the contents are left unchanged and the reason is in the LastErrorText.
This is the reverse of MarkdownToHtml. The HTML is parsed with the same parser used by Html.ToXml and Html.ToText, and the resulting document tree produces CommonMark / GitHub-flavored Markdown:
h1throughh6become#..######headings.p,div,sectionand other block-level elements become paragraphs separated by a blank line.brbecomes a hard line break andhrbecomes---.b/strongbecome**bold**,i/em/citebecome*italic*,del/s/strikebecome~~struck~~, andcode/kbd/sampbecome a backtick code span.prebecomes a fenced code block. The language is taken from alanguage-xxxorlang-xxxclass on thepreor itscodechild.a hrefbecomes[text](url "title"), andimgbecomes.ul/ol/libecome-and1.lists, with nested lists indented. A checkboxinputinside a list item becomes[ ]or[x].blockquotebecomes lines prefixed with>.tablebecomes a GitHub pipe table. The first row is the header when it containsthcells or is inside athead;colspanis honored, andalignortext-alignsets the column alignment. A single-column table becomes plain paragraphs, because such tables are usually for layout.dl/dt/ddbecome a term line followed by: definitionlines.
head, script, style, title, meta, link, noscript, iframe, object, embed, svg, canvas, form controls and comments produce no output. Any other tag is transparent: only its content is emitted.
Markdown-significant punctuation in ordinary text is backslash-escaped so that the text renders literally. Text inside code and pre is never escaped. HTML entities are decoded.
The Markdown uses LF line endings, always ends with a single line ending, and never contains more than one consecutive blank line outside of a code block. Call ToCRLF afterwards for CRLF line endings.
StringBuilder first if it is still needed.Empty contents, or HTML with no visible content, produce empty contents and 1 is returned.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
IsWellFormed
# $flag is true or false
my $flag = $sb->IsWellFormed($format);
Returns 1 if the contents of this object are well-formed JSON or XML. $format selects which check to apply and must be json or xml (case insensitive). Returns 0 if the contents do not conform, or if $format is anything else.
Chilkat's JSON and XML parsers are deliberately tolerant. Given text that is not well-formed they can still report success, leaving an empty or partially populated document. This method answers the question those parsers do not, and it does so without loading the text into a JsonObject or Xml object first. The checks applied here are the same ones those classes apply when their Strict property is set.
For xml this is a well-formedness check: element nesting and tag matching, attribute syntax and duplicate attributes, entity and character references, comments, processing instructions, CDATA sections, the XML declaration, the DOCTYPE declaration, and that the bytes are valid UTF-8 containing only characters XML permits. It is not a validating parse: no DTD or schema is read.
For json the full RFC 8259 grammar is checked.
Empty contents are not well-formed in either format, so 0 is returned.
Never dies: false is an answer, not a failure.
topLastNLines
# $bCrlf is a boolean
# $str is a string or undef
my $str = $sb->LastNLines($numLines, $bCrlf);
Returns the last N lines of the text. If fewer than $numLines lines exists, then all of the text is returned. If $bCrlf is 1, then the line endings of the returned string are converted to CRLF, otherwise the line endings are converted to LF-only.
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
LoadFile
# $charset is a string
# $success is true or false
my $success = $sb->LoadFile($path, $charset);
Loads the contents of a file.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
MarkdownToHtml
# $sbHtml is a Chilkat2::StringBuilder
# $success is true or false
my $success = $sb->MarkdownToHtml($options, $sbHtml);
This method converts the Markdown content of this object to HTML, storing the result in $sbHtml. It supports both streaming and full document conversion. $options specifies conversion options, including a key streaming option. In streaming mode, generated HTML is appended to $sbHtml. In non-streaming mode, $sbHtml is fully replaced by the generated HTML. For further details, see the examples linked below.
In streaming mode, only complete markdown lines are converted to HTML and removed from this object, leaving just the final partial line, if present. If this object contains only a partial markdown line, no HTML is emitted.
Starting in v11.3.0 ...
"emitJavascript": truecan be included in$optionsto emit Javascript function calls instead of HTML. This is used to update the response in an embedded browser in real-time. See Real-Time Streaming AI Responses to Embedded Browsers in Desktop Apps"streamingShell": trueis used to convert an empty string to an HTML shell to be used as the starting point before applying Javascript function calls. See Preparing the HTML Shell"theme": "html_theme_name"can be included when creating the HTML shell to select a predefined theme or when converting Markdown to HTML in non-streaming mode. The available themes are:- ChatGPT - A style that is similar to the ChatGPT application.
- cleanWin - A clean style for Windows applications.
- cleanMac - A clean style for MacOS applications.
- raw - No HTML styles, header, or body begin/end elements are emitted. Only the Markdown to HTML generated elements are emitted.
If no
themeis is included, then default HTML docType/root/body/header elements are emitted unless various parts are overridden bydocType,rootElement,head,bodyStart,bodyEnd, andbodyExtra."usesPrism": truecan be included when creating the HTML shell (or when converting Markdown to HTML in non-streaming mode) to include PRISM code highlighting."prism": { "theme": "prism_theme_name" }Is optional and can be used to specify the prism theme whenusesPrismistrue. Possible values are:- tomorrow
- default
- coy
- dark
- funky
- okaidia
- solarizedlight
- twilight
"prism": { "version": "version_number" }Is optional can can be used to specify the prism version, such as"1.29.0"whenusesPrismistrue. If not specified, then "1.29.0" is used.- If no
themeis specified, then any or all of the following HTML document parts can be explicitly specified:"docType": "doctype_element"TheDOCTYPEelement. The default is"<!DOCTYPE html>""rootElement": "root_element"Thehtmlelement. The default is"<html>""head": "head_section"The HTML fragment for the HTML head section. The default is"<head><meta charset="utf-8" /></head>".
Note: IfusesPrismistrue, then prism related links will be inserted just before the</head>."bodyStart": "html_fragment"The HTML fragment to begin the body section. The default is"<body><div id="content">""bodyEnd": "html_fragment"The HTML fragment to end the body section. The default is"</div><!-- end-of-content-div --></body>""noContentDiv": trueIf set, the default bodyStart and bodyEnd do not include the"<div id="content">"and"</div><!-- end-of-content-div -->"
"copyButton": trueIn non-streaming mode, can optionally be set to include HTML for adding a copy button. THe copy button is added by default in streaming mode."ChatGPT": { "max-width": "css_length"; }Is optional can can be used to specify the max width of the body text if thethemeisChatGPT. The css_length is a length using CSS length units, such as"72ch","40em","800px", etc.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
MaskQuotedStrings
# $quoteType is an integer
# $maskedStrings is a Chilkat2::StringTable
# $success is true or false
my $success = $sb->MaskQuotedStrings($maskChar, $quoteType, $maskedStrings);
This function masks the content inside single and/or double-quoted strings by replacing it with a specified mask character ($maskChar). The content of each masked quoted string is saved to $maskedStrings. The contents can be restored by calling RestoreMaskedStrings.
$quoteType determines which types of quoted strings are masked:
- Both single and double quoted.
- Only single quoted strings.
- Only double quoted strings.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Obfuscate
Obfuscates the string. (The Unobfuscate method can be called to reverse the obfuscation to restore the original string.)
The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is NOT a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.
Returns the object, so calls can be chained.
Prepend
# $success is true or false
my $success = $sb->Prepend($value);
Prepends a copy of the specified string to this instance.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
PunyDecode
my $success = $sb->PunyDecode();
In-place decodes the string from punycode.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
PunyEncode
my $success = $sb->PunyEncode();
In-place encodes the string to punycode.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
RegexMatch
# $json is a Chilkat2::JsonObject
# $timeoutMs is an integer
# $n is an integer
my $n = $sb->RegexMatch($pattern, $json, $timeoutMs);
Searches the content of this object for substrings that match a regular expression pattern and returns the matches in $json. Returns the number of matches or -1 for failure. $timeoutMs is the maximum number of milliseconds of processing allowed before giving up. Pass 0 for an infinite amount of time. Failure information is also returned in $json.
RegexReplace
# $success is true or false
my $success = $sb->RegexReplace($json);
Replaces the substrings of capture groups found in a previous call to RegexMatch.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
RemoveAccents
my $success = $sb->RemoveAccents();
Removes the accents (diacritics) from European accented characters. This applies only to the accented characters found in the Windows-1252 (Latin alphabet) and Windows-1250 (Central European) charsets. Accent marks for characters in other languages will not be removed.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
RemoveAfterFinal
# $success is true or false
my $success = $sb->RemoveAfterFinal($marker);
Removes the substring found after the final occurrence of the $marker. Also removes the $marker. Returns 1 if the $marker was found and content was removed. Otherwise returns 0.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
RemoveBefore
# $success is true or false
my $success = $sb->RemoveBefore($marker);
Removes the substring found before the 1st occurrence of the $marker. Also removes the $marker. Returns 1 if the $marker was found and content was removed. Otherwise returns 0.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
RemoveCharsAt
# $numChars is an integer
# $success is true or false
my $success = $sb->RemoveCharsAt($startIndex, $numChars);
Removes the specified range of characters from this instance.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
RemoveEmojis
Replace
# $replacement is a string
# $n is an integer
my $n = $sb->Replace($value, $replacement);
Replaces all occurrences of a specified string in this instance with another specified string. Returns the number of replacements.
topReplaceAfterFinal
# $replacement is a string
# $success is true or false
my $success = $sb->ReplaceAfterFinal($marker, $replacement);
Replaces the content found after the final occurrence of $marker with $replacement.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ReplaceAllBetween
# $endMark is a string
# $replacement is a string
# $replaceMarks is a boolean
# $success is true or false
my $success = $sb->ReplaceAllBetween($beginMark, $endMark, $replacement, $replaceMarks);
Replaces the first occurrence of ALL the content found between $beginMark and $endMark with $replacement. The $beginMark and $endMark are included in what is replaced if $replaceMarks is 1.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ReplaceBetween
# $endMark is a string
# $value is a string
# $replacement is a string
# $n is an integer
my $n = $sb->ReplaceBetween($beginMark, $endMark, $value, $replacement);
Replaces all occurrences of $value with $replacement, but only where $value is found between $beginMark and $endMark. Returns the number of replacements made.
ReplaceFirst
# $replacement is a string
# $success is true or false
my $success = $sb->ReplaceFirst($value, $replacement);
Replaces the first occurrence of a specified string in this instance with another string. Returns 1 if the $value was found and replaced. Otherwise returns 0.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ReplaceI
# $replacement is an integer
# $n is an integer
my $n = $sb->ReplaceI($value, $replacement);
Replaces all occurrences of $value with the decimal integer $replacement. Returns the number of replacements.
ReplaceNoCase
# $replacement is a string
# $n is an integer
my $n = $sb->ReplaceNoCase($value, $replacement);
Replaces all occurrences of $value with $replacement (case insensitive). Returns the number of replacements.
ReplaceWord
# $replacement is a string
# $n is an integer
my $n = $sb->ReplaceWord($value, $replacement);
Replaces all word occurrences of a specified string in this instance with another specified string. Returns the number of replacements made.
Important: This method is limited to replacing whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)
RestoreMaskedStrings
# $maskedStrings is a Chilkat2::StringTable
# $success is true or false
my $success = $sb->RestoreMaskedStrings($quoteType, $maskedStrings);
Restores single and/or double-quoted strings previously masked by MaskQuotedStrings.
$quoteType determines which types of quoted strings are masked:
- Both single and double quoted.
- Only single quoted strings.
- Only double quoted strings.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SecureClear
Removes all characters from the current StringBuilder instance, and write zero bytes to the allocated memory before deallocating.
Returns the object, so calls can be chained.
topSetNth
# $value is a string
# $delimiterChar is a string
# $exceptDoubleQuoted is a boolean
# $exceptEscaped is a boolean
# $success is true or false
my $success = $sb->SetNth($index, $value, $delimiterChar, $exceptDoubleQuoted, $exceptEscaped);
Sets the Nth substring in string in a list delimted by $delimiterChar. The first substring is at index 0. If $exceptDoubleQuoted is 1, then the delimiter char found between double quotes is not treated as a delimiter. If $exceptEscaped is 1, then an escaped (with a backslash) delimiter char is not treated as a delimiter.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SetString
# $success is true or false
my $success = $sb->SetString($value);
Sets this instance to a copy of the specified string.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Shorten
# $success is true or false
my $success = $sb->Shorten($numChars);
Shortens the string by removing the last $numChars chars.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
StartsWith
# $caseSensitive is a boolean
# $flag is true or false
my $flag = $sb->StartsWith($substr, $caseSensitive);
Returns 1 if the string starts with $substr. Otherwise returns 0. The comparison is case sensitive if $caseSensitive is 1, and case insensitive if $caseSensitive is 0.
Never dies: false is an answer, not a failure.
topToCRLF
my $success = $sb->ToCRLF();
Converts line endings to CRLF (Windows) format.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ToLF
my $success = $sb->ToLF();
Converts line endings to LF-only (UNIX) format.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ToLowercase
my $success = $sb->ToLowercase();
Converts the contents to lowercase.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ToUppercase
my $success = $sb->ToUppercase();
Converts the contents to uppercase.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Trim
my $success = $sb->Trim();
Trims whitespace from both ends of the string.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
TrimInsideSpaces
my $success = $sb->TrimInsideSpaces();
Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurances of more than one SPACE char in a row.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Unobfuscate
Unobfuscates the string.
The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is not a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.
Returns the object, so calls can be chained.
WriteFile
# $charset is a string
# $emitBom is a boolean
# $success is true or false
my $success = $sb->WriteFile($path, $charset, $emitBom);
Writes the contents to a file. If $emitBom is 1, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
WriteFileIfModified
# $charset is a string
# $emitBom is a boolean
# $success is true or false
my $success = $sb->WriteFileIfModified($path, $charset, $emitBom);
Writes the contents to a file, but only if it is a new file or if the contents are different than the existing file. If $emitBom is 1, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.