namespace CCL::TextUtils

Overview

namespace TextUtils {

// global functions

TextEncoding getEncodingByName (StringRef name);
String loadRawString (UrlRef path);
String loadRawString (IStream& stream);

String loadString (
    UrlRef path,
    String endline = String::getLineEnd (),
    TextEncoding encoding = Text::kUnknownEncoding
);

String loadString (
    IStream& stream,
    String endline = String::getLineEnd (),
    TextEncoding encoding = Text::kUnknownEncoding
);

bool loadStringList (
    StringList& stringList,
    UrlRef path,
    bool ignoreEmptyLines = true,
    TextEncoding encoding = Text::kUnknownEncoding
);

bool loadStringList (
    StringList& stringList,
    IStream& stream,
    bool ignoreEmptyLines = true,
    TextEncoding encoding = Text::kUnknownEncoding
);

StringRef getCSS ();

bool saveTextBlock (
    UrlRef path,
    StringRef title,
    VariantRef data,
    const ITextPromise& textPromise
);

} // namespace TextUtils

Detailed Documentation

Global Functions

TextEncoding getEncodingByName (StringRef name)

Determine encoding by name (e.g.

“ascii”).

String loadRawString (UrlRef path)

Load text file to string without line ending modifications.

String loadRawString (IStream& stream)

Load text stream to string without line ending modifications.

String loadString (
    UrlRef path,
    String endline = String::getLineEnd (),
    TextEncoding encoding = Text::kUnknownEncoding
)

Load text file to string with normalized line endings.

String loadString (
    IStream& stream,
    String endline = String::getLineEnd (),
    TextEncoding encoding = Text::kUnknownEncoding
)

Load text stream to string with normalized line endings.

bool loadStringList (
    StringList& stringList,
    UrlRef path,
    bool ignoreEmptyLines = true,
    TextEncoding encoding = Text::kUnknownEncoding
)

Load lines from text file to string list.

bool loadStringList (
    StringList& stringList,
    IStream& stream,
    bool ignoreEmptyLines = true,
    TextEncoding encoding = Text::kUnknownEncoding
)

Load lines from text stream to string list.

StringRef getCSS ()

Get built-in CSS definitions.

bool saveTextBlock (
    UrlRef path,
    StringRef title,
    VariantRef data,
    const ITextPromise& textPromise
)

Save formatted text block to file.