organic/src/context/global_settings.rs

use std::collections::BTreeMap;
use std::collections::BTreeSet;

use super::constants::DEFAULT_ORG_ENTITIES;
use super::constants::DEFAULT_ORG_LINK_PARAMETERS;
use super::FileAccessInterface;
use super::LocalFileAccessInterface;
use crate::context::constants::DEFAULT_ORG_ELEMENT_AFFILIATED_KEYWORDS;
use crate::context::constants::DEFAULT_ORG_ELEMENT_DUAL_KEYWORDS;
use crate::context::constants::DEFAULT_ORG_ELEMENT_KEYWORD_TRANSLATION_ALIST;
use crate::context::constants::DEFAULT_ORG_ELEMENT_PARSED_KEYWORDS;
use crate::types::IndentationLevel;
use crate::types::Object;

// TODO: Ultimately, I think we'll need most of this: https://orgmode.org/manual/In_002dbuffer-Settings.html

#[derive(Debug, Clone)]
pub struct GlobalSettings<'g, 's> {
    pub radio_targets: Vec<&'g Vec<Object<'s>>>,
    pub file_access: &'g dyn FileAccessInterface,
    pub in_progress_todo_keywords: BTreeSet<String>,
    pub complete_todo_keywords: BTreeSet<String>,
    /// Set to true to allow for plain lists using single letters as the bullet in the same way that numbers are used.
    ///
    /// Corresponds to the org-list-allow-alphabetical elisp variable.
    pub list_allow_alphabetical: bool,

    /// How many spaces a tab should be equal to.
    ///
    /// Corresponds to the tab-width elisp variable.
    pub tab_width: IndentationLevel,

    /// Whether to only allow odd headline levels.
    ///
    /// Corresponds to org-odd-levels-only elisp variable.
    pub odd_levels_only: HeadlineLevelFilter,

    /// If a headline title matches this string exactly, then that section will become a "footnote section".
    ///
    /// Corresponds to org-footnote-section elisp variable.
    pub footnote_section: &'g str,

    /// The allowed protocols for links (for example, the "https" in "https://foo.bar/").
    ///
    /// Corresponds to org-link-parameters elisp variable.
    pub link_parameters: &'g [&'g str],

    /// Link templates where the key is the document text and the value is the replacement.
    ///
    /// For example, `"foo": "bar%s"` will replace `[[foo::baz]]` with `[[barbaz]]`
    ///
    /// This is set by including #+LINK in the org-mode document.
    pub link_templates: BTreeMap<String, String>,

    /// The special characters that can be written in org-mode like \infin for the infinity symbol.
    ///
    /// MUST be sorted with the largest names first. Otherwise the parser may match a shorter substring of a longer entity.
    ///
    /// Corresponds to org-entities elisp variable.
    pub entities: &'g [EntityDefinition<'s>],

    /// Keywords that contain the standard set of objects (excluding footnote references).
    ///
    /// Corresponds to org-element-parsed-keywords elisp variable.
    pub element_parsed_keywords: &'g [&'s str],

    /// Keywords that can have a secondary value in square brackets.
    ///
    /// Corresponds to org-element-dual-keywords elisp variable.
    pub element_dual_keywords: &'g [&'s str],

    /// Keywords that can be affiliated with an element.
    ///
    /// Corresponds to org-element-affiliated-keywords elisp variable.
    pub element_affiliated_keywords: &'g [&'s str],

    /// Mapping of keyword names.
    ///
    /// Corresponds to org-element-keyword-translation-alist elisp variable.
    pub element_keyword_translation_alist: &'g [(&'s str, &'s str)],
}

pub const DEFAULT_TAB_WIDTH: IndentationLevel = 8;

#[derive(Debug, Clone)]
pub struct EntityDefinition<'a> {
    pub name: &'a str,
    pub latex_math_mode: bool,
    pub latex: &'a str,
    pub html: &'a str,
    pub ascii: &'a str,
    // Skipping latin1 because it is detrimental to the future. If anyone out there is using latin1, take a long look in the mirror and change your ways.
    pub utf8: &'a str,
}

impl<'g, 's> GlobalSettings<'g, 's> {
    fn new() -> GlobalSettings<'g, 's> {
        debug_assert!(DEFAULT_ORG_ENTITIES.is_sorted_by(|a, b| b.name.len().partial_cmp(&a.name.len())));
        GlobalSettings {
            radio_targets: Vec::new(),
            file_access: &LocalFileAccessInterface {
                working_directory: None,
            },
            in_progress_todo_keywords: BTreeSet::new(),
            complete_todo_keywords: BTreeSet::new(),
            list_allow_alphabetical: false,
            tab_width: DEFAULT_TAB_WIDTH,
            odd_levels_only: HeadlineLevelFilter::default(),
            footnote_section: "Footnotes",
            link_parameters: &DEFAULT_ORG_LINK_PARAMETERS,
            link_templates: BTreeMap::new(),
            entities: &DEFAULT_ORG_ENTITIES,
            element_parsed_keywords: &DEFAULT_ORG_ELEMENT_PARSED_KEYWORDS,
            element_dual_keywords: &DEFAULT_ORG_ELEMENT_DUAL_KEYWORDS,
            element_affiliated_keywords: &DEFAULT_ORG_ELEMENT_AFFILIATED_KEYWORDS,
            element_keyword_translation_alist: &DEFAULT_ORG_ELEMENT_KEYWORD_TRANSLATION_ALIST,
        }
    }
}

impl<'g, 's> Default for GlobalSettings<'g, 's> {
    fn default() -> GlobalSettings<'g, 's> {
        GlobalSettings::new()
    }
}

#[derive(Debug, Clone, PartialEq)]
pub enum HeadlineLevelFilter {
    Odd,
    OddEven,
}

impl Default for HeadlineLevelFilter {
    fn default() -> Self {
        HeadlineLevelFilter::OddEven
    }
}