organic/src/parser/object_parser.rs

use super::org_source::OrgSource;
use super::plain_text::plain_text;
use super::regular_link::regular_link;
use super::subscript_and_superscript::detect_subscript_or_superscript;
use crate::context::RefContext;
use crate::error::CustomError;
use crate::error::MyError;
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::inline_babel_call::inline_babel_call;
use crate::parser::inline_source_block::inline_source_block;
use crate::parser::latex_fragment::latex_fragment;
use crate::parser::line_break::line_break;
use crate::parser::macros::element;
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::statistics_cookie::statistics_cookie;
use crate::parser::subscript_and_superscript::subscript;
use crate::parser::subscript_and_superscript::superscript;
use crate::parser::target::target;
use crate::parser::text_markup::text_markup;
use crate::parser::timestamp::timestamp;
use crate::types::Object;

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
pub(crate) fn standard_set_object<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, Object<'s>> {
    element!(standard_set_object_sans_plain_text, context, input);
    element!(
        plain_text(detect_standard_set_object_sans_plain_text),
        context,
        input,
        Object::PlainText
    );
    Err(nom::Err::Error(CustomError::MyError(MyError("No object."))))
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
pub(crate) fn minimal_set_object<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, Object<'s>> {
    element!(minimal_set_object_sans_plain_text, context, input);
    element!(
        plain_text(detect_minimal_set_object_sans_plain_text),
        context,
        input,
        Object::PlainText
    );
    Err(nom::Err::Error(CustomError::MyError(MyError("No object."))))
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
fn standard_set_object_sans_plain_text<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, Object<'s>> {
    element!(timestamp, context, input, Object::Timestamp);
    element!(subscript, context, input, Object::Subscript);
    element!(superscript, context, input, Object::Superscript);
    element!(statistics_cookie, context, input, Object::StatisticsCookie);
    element!(target, context, input, Object::Target);
    element!(line_break, context, input, Object::LineBreak);
    element!(
        inline_source_block,
        context,
        input,
        Object::InlineSourceBlock
    );
    element!(inline_babel_call, context, input, Object::InlineBabelCall);
    element!(citation, context, input, Object::Citation);
    element!(
        footnote_reference,
        context,
        input,
        Object::FootnoteReference
    );
    element!(export_snippet, context, input, Object::ExportSnippet);
    element!(entity, context, input, Object::Entity);
    element!(latex_fragment, context, input, Object::LatexFragment);
    element!(radio_link, context, input, Object::RadioLink);
    element!(radio_target, context, input, Object::RadioTarget);
    element!(text_markup, context, input);
    element!(regular_link, context, input, Object::RegularLink);
    element!(plain_link, context, input, Object::PlainLink);
    element!(angle_link, context, input, Object::AngleLink);
    element!(org_macro, context, input, Object::OrgMacro);

    Err(nom::Err::Error(CustomError::MyError(MyError("No object."))))
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
fn minimal_set_object_sans_plain_text<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, Object<'s>> {
    element!(subscript, context, input, Object::Subscript);
    element!(superscript, context, input, Object::Superscript);
    element!(entity, context, input, Object::Entity);
    element!(latex_fragment, context, input, Object::LatexFragment);
    element!(text_markup, context, input);
    Err(nom::Err::Error(CustomError::MyError(MyError("No object."))))
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
pub(crate) fn detect_standard_set_object_sans_plain_text<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, ()> {
    if detect_subscript_or_superscript(input).is_ok() {
        return Ok((input, ()));
    }
    if standard_set_object_sans_plain_text(context, input).is_ok() {
        return Ok((input, ()));
    }

    return Err(nom::Err::Error(CustomError::MyError(MyError(
        "No object detected.",
    ))));
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
fn detect_minimal_set_object_sans_plain_text<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, ()> {
    if detect_subscript_or_superscript(input).is_ok() {
        return Ok((input, ()));
    }
    if minimal_set_object_sans_plain_text(context, input).is_ok() {
        return Ok((input, ()));
    }

    return Err(nom::Err::Error(CustomError::MyError(MyError(
        "No object detected.",
    ))));
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
pub(crate) fn regular_link_description_set_object<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, Object<'s>> {
    // TODO: It can also contain another link, but only when it is a plain or angle link. It can contain square brackets, but not ]]
    element!(
        regular_link_description_set_object_sans_plain_text,
        context,
        input
    );
    element!(
        plain_text(detect_regular_link_description_set_object_sans_plain_text),
        context,
        input,
        Object::PlainText
    );
    Err(nom::Err::Error(CustomError::MyError(MyError("No object."))))
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
fn regular_link_description_set_object_sans_plain_text<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, Object<'s>> {
    // TODO: It can also contain another link, but only when it is a plain or angle link. It can contain square brackets, but not ]]
    element!(export_snippet, context, input, Object::ExportSnippet);
    element!(statistics_cookie, context, input, Object::StatisticsCookie);
    element!(
        inline_source_block,
        context,
        input,
        Object::InlineSourceBlock
    );
    element!(inline_babel_call, context, input, Object::InlineBabelCall);
    element!(org_macro, context, input, Object::OrgMacro);
    element!(minimal_set_object_sans_plain_text, context, input);
    Err(nom::Err::Error(CustomError::MyError(MyError("No object."))))
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
fn detect_regular_link_description_set_object_sans_plain_text<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, ()> {
    if detect_subscript_or_superscript(input).is_ok() {
        return Ok((input, ()));
    }
    if regular_link_description_set_object_sans_plain_text(context, input).is_ok() {
        return Ok((input, ()));
    }

    Err(nom::Err::Error(CustomError::MyError(MyError(
        "No object detected.",
    ))))
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
pub(crate) fn table_cell_set_object<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, Object<'s>> {
    element!(table_cell_set_object_sans_plain_text, context, input);
    element!(
        plain_text(detect_table_cell_set_object_sans_plain_text),
        context,
        input,
        Object::PlainText
    );
    Err(nom::Err::Error(CustomError::MyError(MyError("No object."))))
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
fn table_cell_set_object_sans_plain_text<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, Object<'s>> {
    element!(citation, context, input, Object::Citation);
    element!(export_snippet, context, input, Object::ExportSnippet);
    element!(
        footnote_reference,
        context,
        input,
        Object::FootnoteReference
    );
    element!(radio_link, context, input, Object::RadioLink);
    element!(regular_link, context, input, Object::RegularLink);
    element!(plain_link, context, input, Object::PlainLink);
    element!(angle_link, context, input, Object::AngleLink);
    element!(org_macro, context, input, Object::OrgMacro);
    element!(radio_target, context, input, Object::RadioTarget);
    element!(target, context, input, Object::Target);
    element!(timestamp, context, input, Object::Timestamp);
    element!(minimal_set_object_sans_plain_text, context, input);
    Err(nom::Err::Error(CustomError::MyError(MyError("No object."))))
}

#[cfg_attr(
    feature = "tracing",
    tracing::instrument(ret, level = "debug", skip(context))
)]
fn detect_table_cell_set_object_sans_plain_text<'b, 'g, 'r, 's>(
    context: RefContext<'b, 'g, 'r, 's>,
    input: OrgSource<'s>,
) -> Res<OrgSource<'s>, ()> {
    if detect_subscript_or_superscript(input).is_ok() {
        return Ok((input, ()));
    }
    if table_cell_set_object_sans_plain_text(context, input).is_ok() {
        return Ok((input, ()));
    }

    return Err(nom::Err::Error(CustomError::MyError(MyError(
        "No object detected.",
    ))));
}