BBClash is the open-source version of the BBCode compiler being built for Penclash. Unlike most implementations, BBClash is not RegEx-based. It functions like a compiler, tokenizing, lexing, and then constructing compliant HTML from an AST-like object. This makes it robust and good at handling even improperly-formatted input.
Our BBCode specification can be found here.
Note: currently requires Rust Nightly to build. Relevant issue: 54727
use bbclash::bbcode_to_html; assert_eq!(bbcode_to_html("I'm [i]italic[/i] and [b]bold![/b]"), "<p>I'm <i>italic</i> and <b>bold!</b></p>");
BBBClash has two main modes of operation: pretty and ugly. Pretty output uses the
bbcode_to_html function, and excludes improperly formatted bbcode and empty elements from the final output:
use bbclash::bbcode_to_html; assert_eq!(bbcode_to_html("I'm [colour]missing an argument![/colour]"), "<p>I'm missing an argument!</p>"); assert_eq!(bbcode_to_html("[quote][/quote]"), "");
Ugly uses the
bbcode_to_html_ugly function, and leaves improperly formatted BBCode tags and empty elements in the final output as written:
use bbclash::bbcode_to_html_ugly; assert_eq!(bbcode_to_html_ugly("I'm [colour]missing an argument![/colour]"), "<p>I'm [colour]missing an argument![/colour]</p>"); assert_eq!(bbcode_to_html_ugly("[quote][/quote]"), "<blockquote></blockquote>");
Note that neither mode arbitrarily strips any text in square brackets. This only affects improperly-written BBCode tags;
[non tags] will not be affected.
Because this package was built for an existing application, and because it is performance-focused, BBClash's BBCode implementation is entirely hard-coded. Because of this, it is reccommended that you download a local copy and modify it to suit your needs.
Building is as simple as running
$ cargo build. Tests and benchmarks can be run with
$ cargo test and
$ cargo bench, respectively.
A single element of a BBCode AST.
Struct for lexing BBCode Instructions into an ASTElement tree.
Struct for BBCode tokenization.
Struct for generation of HTML strings.
Types of argument for Instructions.
Types of ASTElement.
A single Instruction output by the tokenizer.
Generates a string of HTML from an &str of BBCode. This function produces pretty output, meaning that any eroneously written BBCode encountered or empty tags will be removed from the final output.
Generates a string of HTML from an &str of BBCode. This function produces ugly output, meaning that any eroneously written BBCode or empty tags encountered will be included in the final output.