arch_pkg_text/parse/

desc.rs

use super::{ParseWithIssues, PartialParse, PartialParseResult};
use crate::desc::{
    FieldName, ParseRawFieldError, ParsedField, Query, QueryMut, RawField,
    misc::{ReuseAdvice, True},
};
use derive_more::{Display, Error};
use lines_inclusive::{LinesInclusive, LinesInclusiveIter};
use pipe_trait::Pipe;

macro_rules! def_struct {
    ($(
        $(#[$attrs:meta])*
        $field:ident $(,)? $(;)?
    )*) => {
        /// Parsed data of a `desc` file text.
        ///
        /// Every function call in [`Query`] and [`QueryMut`] is constant time.
        #[derive(Debug, Default, Clone, Copy)]
        #[allow(non_snake_case, reason = "We don't access the field names directly, keep it simple.")]
        pub struct ParsedDesc<'a> {$(
            $(#[$attrs])*
            $field: Option<&'a str>,
        )*}

        impl<'a> ParsedDesc<'a> {
            /// Get a raw value from the querier.
            fn get_raw_value(&self, field_name: FieldName) -> Option<&'a str> {
                match field_name {$(
                    FieldName::$field => self.$field.filter(|value| !value.is_empty()),
                )*}
            }

            /// Add a raw value into the querier.
            fn set_raw_value(&mut self, field_name: FieldName, raw_value: &'a str) {
                match field_name {$(
                    FieldName::$field => if self.$field.is_none() {
                        self.$field = Some(raw_value);
                    },
                )*}
            }
        }
    };
}

def_struct!(
    FileName Name Base Version Description Groups
    CompressedSize InstalledSize Md5Checksum Sha256Checksum
    PgpSignature Url License Architecture BuildDate Packager
    Dependencies CheckDependencies MakeDependencies OptionalDependencies
    Provides Conflicts Replaces
);

/// Error type of [`ParsedDesc::parse`].
#[derive(Debug, Display, Error, Clone, Copy)]
pub enum DescParseError<'a> {
    #[display("Input has no field")]
    NoField,
    #[display("Receive a value without field: {_0:?}")]
    ValueWithoutField(#[error(not(source))] &'a str),
}

/// Issue that may arise during parsing.
#[derive(Debug, Clone, Copy)]
pub enum DescParseIssue<'a> {
    NoField,
    FirstLineIsNotAField(&'a str, ParseRawFieldError),
    UnknownField(RawField<'a>),
}

impl<'a> DescParseIssue<'a> {
    /// Return `Ok(())` if the issue was [`DescParseIssue::UnknownField`],
    /// or return an `Err` of [`DescParseError`] otherwise.
    ///
    /// This function is the default issue handler for [`ParsedDesc`].
    pub fn ignore_unknown_field(self) -> Result<(), DescParseError<'a>> {
        Err(match self {
            DescParseIssue::NoField => DescParseError::NoField,
            DescParseIssue::FirstLineIsNotAField(line, _) => {
                DescParseError::ValueWithoutField(line)
            }
            DescParseIssue::UnknownField(_) => return Ok(()),
        })
    }
}

impl<'a> ParsedDesc<'a> {
    /// Parse a `desc` file text, [unknown fields are ignored](DescParseIssue::ignore_unknown_field).
    pub fn parse(text: &'a str) -> Result<Self, DescParseError<'a>> {
        ParsedDesc::partial_parse(text).try_into_complete()
    }

    /// Parse a `desc` file text with a callback that handle [parsing issues](DescParseIssue).
    pub fn parse_with_issues<HandleIssue, Error>(
        text: &'a str,
        mut handle_issue: HandleIssue,
    ) -> PartialParseResult<ParsedDesc<'a>, Error>
    where
        HandleIssue: FnMut(DescParseIssue<'a>) -> Result<(), Error>,
    {
        let mut parsed = ParsedDesc::default();
        let mut lines = text.lines_inclusive();

        macro_rules! return_or {
            ($issue:expr, $alternative:expr) => {
                match handle_issue($issue) {
                    Err(error) => return PartialParseResult::new_partial(parsed, error),
                    Ok(()) => $alternative,
                }
            };
        }

        // parse the first field
        let (first_line, first_field) = loop {
            let Some(first_line) = lines.next() else {
                return_or!(
                    DescParseIssue::NoField,
                    return PartialParseResult::new_complete(parsed)
                );
            };
            let first_field = match first_line.trim().pipe(RawField::parse_raw) {
                Ok(first_field) => first_field,
                Err(error) => {
                    return_or!(
                        DescParseIssue::FirstLineIsNotAField(first_line, error),
                        continue
                    )
                }
            };
            break (first_line, first_field);
        };

        // parse the remaining values and fields.
        let mut current_field = Some((first_field, first_line));
        while let Some((field, field_line)) = current_field {
            let (value_length, next_field) = ParsedDesc::parse_next(&mut lines);
            let value_start_offset =
                field_line.as_ptr() as usize + field_line.len() - text.as_ptr() as usize;
            let value_end_offset = value_start_offset + value_length;
            if let Ok(field) = field.to_parsed::<FieldName>() {
                let value = text[value_start_offset..value_end_offset].trim();
                parsed.set_raw_value(*field.name(), value);
            } else {
                return_or!(DescParseIssue::UnknownField(field), ())
            }
            current_field = next_field;
        }

        PartialParseResult::new_complete(parsed)
    }

    /// Parse a value until the end of input or when a [`RawField`] is found.
    ///
    /// This function returns a tuple of the length of the value and the next field.
    fn parse_next(
        remaining_lines: &mut LinesInclusiveIter<'a>,
    ) -> (usize, Option<(RawField<'a>, &'a str)>) {
        let mut value_length = 0;

        for line in remaining_lines {
            if let Ok(field) = line.trim().pipe(RawField::parse_raw) {
                return (value_length, Some((field, line)));
            }
            value_length += line.len();
        }

        (value_length, None)
    }
}

/// Try parsing a `desc` text, [unknown fields are ignored](DescParseIssue::ignore_unknown_field), partial success means error.
impl<'a> TryFrom<&'a str> for ParsedDesc<'a> {
    /// Error that occurs when parsing fails or incomplete.
    type Error = DescParseError<'a>;
    /// Try parsing a `desc` text, [unknown fields are ignored](DescParseIssue::ignore_unknown_field), partial success means error.
    fn try_from(text: &'a str) -> Result<Self, Self::Error> {
        ParsedDesc::parse(text)
    }
}

impl<'a> PartialParse<&'a str> for ParsedDesc<'a> {
    type Error = DescParseError<'a>;
    fn partial_parse(input: &'a str) -> PartialParseResult<Self, Self::Error> {
        ParsedDesc::parse_with_issues(input, DescParseIssue::ignore_unknown_field)
    }
}

impl<'a, HandleIssue, Error> ParseWithIssues<&'a str, HandleIssue, Error> for ParsedDesc<'a>
where
    HandleIssue: FnMut(DescParseIssue<'a>) -> Result<(), Error>,
{
    fn parse_with_issues(
        input: &'a str,
        handle_issue: HandleIssue,
    ) -> PartialParseResult<Self, Error> {
        ParsedDesc::parse_with_issues(input, handle_issue)
    }
}

impl<'a> Query<'a> for ParsedDesc<'a> {
    fn query_raw_text(&self, field: ParsedField) -> Option<&'a str> {
        self.get_raw_value(*field.name())
    }
}

impl<'a> QueryMut<'a> for ParsedDesc<'a> {
    fn query_raw_text_mut(&mut self, field: ParsedField) -> Option<&'a str> {
        self.query_raw_text(field)
    }
}

impl ReuseAdvice for ParsedDesc<'_> {
    /// [`ParsedDesc`] costs O(n) time to construct (n being text length).
    /// Performing a lookup on it costs O(1) time.
    ///
    /// This struct is designed to be reused.
    type ShouldReuse = True;
}