organic/src/parser/object_parser.rs

use nom::branch::alt;
use nom::combinator::map;
use nom::combinator::not;

use super::parser_with_context::parser_with_context;
use super::plain_text::plain_text;
use super::regular_link::regular_link;
use super::Context;
use crate::error::Res;
use crate::parser::angle_link::angle_link;
use crate::parser::citation::citation;
use crate::parser::entity::entity;
use crate::parser::export_snippet::export_snippet;
use crate::parser::footnote_reference::footnote_reference;
use crate::parser::latex_fragment::latex_fragment;
use crate::parser::object::Object;
use crate::parser::org_macro::org_macro;
use crate::parser::plain_link::plain_link;
use crate::parser::radio_link::radio_link;
use crate::parser::radio_link::radio_target;
use crate::parser::text_markup::text_markup;

#[tracing::instrument(ret, level = "debug")]
pub fn standard_set_object<'r, 's>(
    context: Context<'r, 's>,
    input: &'s str,
) -> Res<&'s str, Object<'s>> {
    // TODO: citations (NOT citation references), inline babel calls, inline source blocks, line breaks, links, macros, targets and radio targets, statistics cookies, subscript and superscript, timestamps, and text markup.
    not(|i| context.check_exit_matcher(i))(input)?;

    alt((
        map(parser_with_context!(citation)(context), Object::Citation),
        map(
            parser_with_context!(footnote_reference)(context),
            Object::FootnoteReference,
        ),
        map(
            parser_with_context!(export_snippet)(context),
            Object::ExportSnippet,
        ),
        map(parser_with_context!(entity)(context), Object::Entity),
        map(
            parser_with_context!(latex_fragment)(context),
            Object::LatexFragment,
        ),
        map(parser_with_context!(radio_link)(context), Object::RadioLink),
        map(
            parser_with_context!(radio_target)(context),
            Object::RadioTarget,
        ),
        parser_with_context!(text_markup)(context),
        map(
            parser_with_context!(regular_link)(context),
            Object::RegularLink,
        ),
        map(parser_with_context!(plain_link)(context), Object::PlainLink),
        map(parser_with_context!(angle_link)(context), Object::AngleLink),
        map(parser_with_context!(org_macro)(context), Object::OrgMacro),
        map(parser_with_context!(plain_text)(context), Object::PlainText),
    ))(input)
}

#[tracing::instrument(ret, level = "debug")]
pub fn minimal_set_object<'r, 's>(
    context: Context<'r, 's>,
    input: &'s str,
) -> Res<&'s str, Object<'s>> {
    // TODO: superscripts and subscripts
    not(|i| context.check_exit_matcher(i))(input)?;

    alt((
        map(parser_with_context!(entity)(context), Object::Entity),
        map(
            parser_with_context!(latex_fragment)(context),
            Object::LatexFragment,
        ),
        parser_with_context!(text_markup)(context),
        map(parser_with_context!(plain_text)(context), Object::PlainText),
    ))(input)
}

#[tracing::instrument(ret, level = "debug")]
pub fn any_object_except_plain_text<'r, 's>(
    context: Context<'r, 's>,
    input: &'s str,
) -> Res<&'s str, Object<'s>> {
    // Used for exit matchers so this does not check exit matcher condition.
    alt((
        map(parser_with_context!(citation)(context), Object::Citation),
        map(
            parser_with_context!(footnote_reference)(context),
            Object::FootnoteReference,
        ),
        map(
            parser_with_context!(export_snippet)(context),
            Object::ExportSnippet,
        ),
        map(parser_with_context!(entity)(context), Object::Entity),
        map(
            parser_with_context!(latex_fragment)(context),
            Object::LatexFragment,
        ),
        map(parser_with_context!(radio_link)(context), Object::RadioLink),
        map(
            parser_with_context!(radio_target)(context),
            Object::RadioTarget,
        ),
        parser_with_context!(text_markup)(context),
        map(
            parser_with_context!(regular_link)(context),
            Object::RegularLink,
        ),
        map(parser_with_context!(plain_link)(context), Object::PlainLink),
        map(parser_with_context!(angle_link)(context), Object::AngleLink),
        map(parser_with_context!(org_macro)(context), Object::OrgMacro),
    ))(input)
}

#[tracing::instrument(ret, level = "debug")]
pub fn regular_link_description_object_set<'r, 's>(
    context: Context<'r, 's>,
    input: &'s str,
) -> Res<&'s str, Object<'s>> {
    // TODO: minimal set of objects as well as export snippets, inline babel calls, inline source blocks, macros, and statistics cookies. It can also contain another link, but only when it is a plain or angle link. It can contain square brackets, but not ]]
    alt((parser_with_context!(minimal_set_object)(context),))(input)
}