deno_npm 0.42.3

// Copyright 2018-2024 the Deno authors. MIT license.

// ini file parsing

use std::borrow::Cow;

use monch::*;

#[derive(Debug, PartialEq, Eq)]
pub enum KeyValueOrSection<'a> {
  KeyValue(KeyValue<'a>),
  Section(Section<'a>),
}

#[derive(Debug, PartialEq, Eq)]
pub struct Section<'a> {
  pub header: &'a str,
  pub items: Vec<KeyValue<'a>>,
}

#[derive(Debug, PartialEq, Eq)]
pub struct KeyValue<'a> {
  pub key: Key<'a>,
  pub value: Value<'a>,
}

#[derive(Debug, PartialEq, Eq)]
pub enum Key<'a> {
  Plain(Cow<'a, str>),
  Array(Cow<'a, str>),
}

#[derive(Debug, PartialEq, Eq)]
pub enum Value<'a> {
  String(Cow<'a, str>),
  Boolean(bool),
  Number(i64),
  Null,
  Undefined,
}

pub fn parse_ini(
  input: &str,
) -> Result<Vec<KeyValueOrSection<'_>>, ParseErrorFailureError> {
  with_failure_handling(|input| {
    let (input, _) = skip_trivia(input)?;
    let (input, items) = many0(|input| {
      let (input, kv_or_section) = parse_kv_or_section(input)?;
      let (input, _) = skip_trivia(input)?;
      Ok((input, kv_or_section))
    })(input)?;
    Ok((input, items))
  })(input)
}

fn parse_kv_or_section(input: &str) -> ParseResult<'_, KeyValueOrSection<'_>> {
  or(
    map(parse_section, KeyValueOrSection::Section),
    map(parse_key_value, KeyValueOrSection::KeyValue),
  )(input)
}

fn parse_section(input: &str) -> ParseResult<'_, Section<'_>> {
  let (input, _) = skip_non_newline_whitespace(input)?;
  let (input, header) = parse_section_header(input)?;
  let (input, _) = skip_non_newline_whitespace(input)?;
  let (input, _) = skip_trivia(input)?;
  let (input, items) = many0(|input| {
    let (input, kv) = parse_key_value(input)?;
    let (input, _) = skip_trivia(input)?;
    Ok((input, kv))
  })(input)?;
  Ok((input, Section { header, items }))
}

fn parse_section_header(input: &str) -> ParseResult<'_, &str> {
  let (input, _) = ch('[')(input)?;
  let (input, header_text) = take_while(|c| c != ']' && c != '\n')(input)?;
  let (input, _) = ch(']')(input)?;

  Ok((input, header_text))
}

fn parse_key_value(input: &str) -> ParseResult<'_, KeyValue<'_>> {
  fn parse_empty_value(input: &str) -> ParseResult<'_, ()> {
    let (input, _) = skip_non_newline_whitespace(input)?;
    let (input, _) = skip_comment(input)?;
    if input.is_empty() || input.starts_with('\n') || input.starts_with("\r\n")
    {
      Ok((input, ()))
    } else {
      Err(ParseError::Backtrace)
    }
  }

  let (input, key) = parse_key(input)?;
  let (input, _) = skip_non_newline_whitespace(input)?;
  let (input, value) = or(
    |input| {
      let (input, _) = ch('=')(input)?;
      parse_value(input)
    },
    map(parse_empty_value, |_| Value::Boolean(true)),
  )(input)?;
  Ok((input, KeyValue { key, value }))
}

fn parse_key(input: &str) -> ParseResult<'_, Key<'_>> {
  fn parse_unquoted(input: &str) -> ParseResult<'_, Key<'_>> {
    let (input, key) =
      take_while_not_comment_and(|c| c != '=' && c != '\n')(input)?;
    let key = trim_cow_str(key);
    match strip_cow_str_suffix(&key, "[]") {
      Some(key) => Ok((input, Key::Array(key))),
      None => Ok((input, Key::Plain(key))),
    }
  }

  or(
    map(parse_quoted_skipping_spaces, Key::Plain),
    parse_unquoted,
  )(input)
}

fn parse_value(input: &str) -> ParseResult<'_, Value<'_>> {
  fn parse_unquoted(input: &str) -> ParseResult<'_, Value<'_>> {
    let (input, value) = take_until_comment_or_newline(input)?;
    let value = trim_cow_str(value);
    Ok((
      input,
      match value.as_ref() {
        "true" => Value::Boolean(true),
        "false" => Value::Boolean(false),
        "null" => Value::Null,
        "undefined" => Value::Undefined,
        _ => {
          if let Ok(value) = value.parse::<i64>() {
            Value::Number(value)
          } else {
            Value::String(value)
          }
        }
      },
    ))
  }

  or(
    map(parse_quoted_skipping_spaces, Value::String),
    parse_unquoted,
  )(input)
}

fn strip_cow_str_suffix<'a>(
  cow: &Cow<'a, str>,
  suffix: &str,
) -> Option<Cow<'a, str>> {
  match cow {
    Cow::Borrowed(s) => s.strip_suffix(suffix).map(Cow::Borrowed),
    Cow::Owned(s) => s
      .strip_suffix(suffix)
      .map(ToOwned::to_owned)
      .map(Cow::Owned),
  }
}

fn trim_cow_str(cow: Cow<'_, str>) -> Cow<'_, str> {
  match cow {
    Cow::Borrowed(s) => Cow::Borrowed(s.trim()),
    Cow::Owned(s) => Cow::Owned({
      let trimmed = s.trim();
      if trimmed.len() == s.len() {
        s // don't allocate
      } else {
        trimmed.to_string()
      }
    }),
  }
}

fn skip_trivia(input: &str) -> ParseResult<'_, ()> {
  let mut input = input;
  let mut length = 0;

  while input.len() != length {
    length = input.len();
    input = skip_whitespace(input)?.0;
    input = skip_comment(input)?.0;
  }
  Ok((input, ()))
}

fn parse_quoted_skipping_spaces(input: &str) -> ParseResult<'_, Cow<'_, str>> {
  let (input, _) = skip_non_newline_whitespace(input)?;
  let (input, value) = parse_quoted_string(input)?;
  let (input, _) = skip_non_newline_whitespace(input)?;
  Ok((input, value))
}

fn parse_quoted_string(input: &str) -> ParseResult<'_, Cow<'_, str>> {
  fn take_inner_text(
    quote_start_char: char,
  ) -> impl Fn(&str) -> ParseResult<'_, Cow<str>> {
    move |input| {
      let mut last_char = None;
      let mut texts = Vec::new();
      let mut start_index = 0;
      for (index, c) in input.char_indices() {
        if c == '\\' && last_char == Some('\\') {
          last_char = None;
          texts.push(&input[start_index..index - 1]);
          start_index = index;
          continue;
        }
        if c == quote_start_char {
          if last_char == Some('\\') {
            texts.push(&input[start_index..index - 1]);
            start_index = index;
          } else {
            texts.push(&input[start_index..index]);
            return Ok((&input[index..], {
              if texts.len() == 1 {
                Cow::Borrowed(texts[0])
              } else {
                Cow::Owned(texts.concat())
              }
            }));
          }
        }
        if c == '\n' {
          return Err(ParseError::Backtrace);
        }
        last_char = Some(c);
      }
      Err(ParseError::Backtrace)
    }
  }

  let (input, quote_start_char) = or(ch('"'), ch('\''))(input)?;
  let (input, quoted_text) = take_inner_text(quote_start_char)(input)?;
  let (input, _) = ch(quote_start_char)(input)?;
  Ok((input, quoted_text))
}

fn skip_non_newline_whitespace(input: &str) -> ParseResult<'_, ()> {
  skip_while(|c| c == ' ' || c == '\t')(input)
}

fn skip_comment(input: &str) -> ParseResult<'_, ()> {
  let (input, maybe_found) =
    maybe(or(map(ch('#'), |_| ()), map(ch(';'), |_| ())))(input)?;
  if maybe_found.is_none() {
    return Ok((input, ()));
  }
  let (input, _) = skip_while(|c| c != '\n')(input)?;

  Ok((input, ()))
}

fn take_until_comment_or_newline(input: &str) -> ParseResult<'_, Cow<'_, str>> {
  take_while_not_comment_and(|c| c != '\n')(input)
}

fn take_while_not_comment_and<'a>(
  test: impl Fn(char) -> bool,
) -> impl Fn(&'a str) -> ParseResult<'a, Cow<'a, str>> {
  move |input| {
    let mut texts = Vec::new();
    let mut last_char = None;
    let mut start_index = 0;
    let mut end_index = None;
    for (index, c) in input.char_indices() {
      if !test(c) {
        end_index = Some(index);
        break;
      }
      if c == '\\' && last_char == Some('\\') {
        texts.push(&input[start_index..index - 1]);
        start_index = index;
        last_char = None;
        continue;
      }
      if matches!(c, '#' | ';') {
        if last_char == Some('\\') {
          texts.push(&input[start_index..index - 1]);
          start_index = index;
        } else {
          end_index = Some(index);
          break;
        }
      }
      last_char = Some(c);
    }
    texts.push(&input[start_index..end_index.unwrap_or(input.len())]);
    Ok((&input[end_index.unwrap_or(input.len())..], {
      if texts.len() == 1 {
        Cow::Borrowed(texts[0])
      } else {
        Cow::Owned(texts.concat())
      }
    }))
  }
}

#[cfg(test)]
mod test {
  use super::*;
  use pretty_assertions::assert_eq;

  #[test]
  fn parses_ini() {
    let ini = parse_ini(
      r#"
a=1
b="2"
c    =    '3'
d
e = true;comment
f = false # comment;test#;comment
g = null
h = undefined
i[] = 1
i[] = 2
j = \;escaped\#not a comment\\#comment
"k;#" = "a;#\"\\"

[section]

a = 1
"#,
    )
    .unwrap();
    assert_eq!(
      ini,
      vec![
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("a".into()),
          value: Value::Number(1),
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("b".into()),
          value: Value::String("2".into()),
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("c".into()),
          value: Value::String("3".into()),
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("d".into()),
          value: Value::Boolean(true)
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("e".into()),
          value: Value::Boolean(true),
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("f".into()),
          value: Value::Boolean(false),
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("g".into()),
          value: Value::Null,
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("h".into()),
          value: Value::Undefined,
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Array("i".into()),
          value: Value::Number(1),
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Array("i".into()),
          value: Value::Number(2),
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("j".into()),
          value: Value::String(";escaped#not a comment\\".into()),
        }),
        KeyValueOrSection::KeyValue(KeyValue {
          key: Key::Plain("k;#".into()),
          value: Value::String("a;#\"\\".into()),
        }),
        KeyValueOrSection::Section(Section {
          header: "section",
          items: vec![KeyValue {
            key: Key::Plain("a".into()),
            value: Value::Number(1),
          }]
        }),
      ]
    )
  }
}