//! Block quote is a construct that occurs in the [document][] content type. //! //! It forms with the following BNF: //! //! ```bnf //! block_quote_start ::= '>' [ space_or_tab ] //! block_quote_cont ::= '>' [ space_or_tab ] //! ``` //! //! Further lines that are not prefixed with `block_quote_cont` cause the block //! quote to be exited, except when those lines are lazy continuation. //! Like so many things in markdown, block quotes too, are very complex. //! See [*§ Phase 1: block structure*][commonmark-block] for more on parsing //! details. //! //! Block quote relates to the `
` element in HTML. //! See [*§ 4.4.4 The `blockquote` element*][html-blockquote] in the HTML spec //! for more info. //! //! ## Tokens //! //! * [`BlockQuote`][Name::BlockQuote] //! * [`BlockQuoteMarker`][Name::BlockQuoteMarker] //! * [`BlockQuotePrefix`][Name::BlockQuotePrefix] //! * [`SpaceOrTab`][Name::SpaceOrTab] //! //! ## References //! //! * [`block-quote.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/block-quote.js) //! * [*§ 5.1 Block quotes* in `CommonMark`](https://spec.commonmark.org/0.30/#block-quotes) //! //! [document]: crate::content::document //! [html-blockquote]: https://html.spec.whatwg.org/multipage/grouping-content.html#the-blockquote-element //! [commonmark-block]: https://spec.commonmark.org/0.30/#phase-1-block-structure use crate::constant::TAB_SIZE; use crate::construct::partial_space_or_tab::space_or_tab_min_max; use crate::event::Name; use crate::state::{Name as StateName, State}; use crate::tokenizer::Tokenizer; /// Start of block quote. /// /// ```markdown /// > | > a /// ^ /// ``` pub fn start(tokenizer: &mut Tokenizer) -> State { if tokenizer.parse_state.constructs.block_quote { let name = space_or_tab_min_max( tokenizer, 0, if tokenizer.parse_state.constructs.code_indented { TAB_SIZE - 1 } else { usize::MAX }, ); tokenizer.attempt(name, State::Next(StateName::BlockQuoteBefore), State::Nok) } else { State::Nok } } /// Start of block quote, after whitespace, before `>`. /// /// ```markdown /// > | > a /// ^ /// ``` pub fn before(tokenizer: &mut Tokenizer) -> State { match tokenizer.current { Some(b'>') => { tokenizer.enter(Name::BlockQuote); State::Retry(StateName::BlockQuoteContBefore) } _ => State::Retry(StateName::BlockQuoteContBefore), } } /// Start of block quote continuation. /// /// ```markdown /// | > a /// > | > b /// ^ /// ``` pub fn cont_start(tokenizer: &mut Tokenizer) -> State { let name = space_or_tab_min_max( tokenizer, 0, if tokenizer.parse_state.constructs.code_indented { TAB_SIZE - 1 } else { usize::MAX }, ); tokenizer.attempt( name, State::Next(StateName::BlockQuoteContBefore), State::Nok, ) } /// After whitespace, before `>`. /// /// ```markdown /// | > a /// > | > b /// ^ /// ``` pub fn cont_before(tokenizer: &mut Tokenizer) -> State { match tokenizer.current { Some(b'>') => { tokenizer.enter(Name::BlockQuotePrefix); tokenizer.enter(Name::BlockQuoteMarker); tokenizer.consume(); tokenizer.exit(Name::BlockQuoteMarker); State::Next(StateName::BlockQuoteContAfter) } _ => State::Nok, } } /// After `>`, before optional whitespace. /// /// ```markdown /// > | > a /// ^ /// > | >b /// ^ /// ``` pub fn cont_after(tokenizer: &mut Tokenizer) -> State { if let Some(b'\t' | b' ') = tokenizer.current { tokenizer.enter(Name::SpaceOrTab); tokenizer.consume(); tokenizer.exit(Name::SpaceOrTab); } tokenizer.exit(Name::BlockQuotePrefix); State::Ok }