starsector 1.0.1

Org mode structural parser/emitter with an emphasis on modularity and avoiding edits unrelated to changes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use std::borrow::Cow;

use rand::RngCore;
// Wrappers for things we delegate to Orgize. We prioritize convenience over
// performance for these.
//
// `orgize::Org` represents the entire document, but for our purposes here, it
// is a document consisting of at most one headline.

use crate::*;

pub(crate) fn has_property_internal(
    property: &str,
    org: &orgize::Org<'_>,
) -> Result<bool, HeadlineError> {
    let title = get_title_internal(org)?;
    Ok(title
        .properties
        .pairs
        .binary_search_by(|(k, _)| k.as_ref().cmp(property))
        .is_ok())
}

// ELDRITCH: binary search, but is it sorted?
pub(crate) fn get_property_internal(
    property: &'_ str,
    org: &orgize::Org,
) -> Result<Option<Cow<'static, str>>, HeadlineError> {
    let title = get_title_internal(org)?;
    let pairs = &title.properties.pairs;
    let p = match pairs.binary_search_by(|(k, _)| k.as_ref().cmp(property)) {
        Ok(p_index) => Some(pairs[p_index].1.to_string().into()),
        _ => None,
    };
    Ok(p)
}

pub(crate) fn get_id_internal(
    org: &orgize::Org,
) -> Result<Option<Cow<'static, str>>, HeadlineError> {
    get_property_internal("ID".into(), org).map(|p| p.map(Into::into))
}

pub(crate) fn properties_internal(
    org: &orgize::Org,
) -> Result<indexmap::IndexMap<Cow<'static, str>, Cow<'static, str>>, HeadlineError> {
    let p = get_title_internal(org)?
        .properties
        .iter()
        .map(|(k, v)| (Cow::Owned(k.to_string()), Cow::Owned(v.to_string())))
        .collect();
    Ok(p)
}

pub fn clear_property_internal(
    org: &mut orgize::Org,
    key: &str,
) -> Result<(), crate::errors::HeadlineError> {
    let t = &mut get_title_mut_internal(org)?;
    let pairs = &mut t.properties.pairs;
    match pairs.binary_search_by(|(k, _)| k.as_ref().cmp(key)) {
        Ok(id_index) => {
            pairs.remove(id_index);
        }
        _ => {}
    }
    Ok(())
}

pub fn set_property_internal(
    org: &mut orgize::Org,
    key: &str,
    value: &str,
) -> Result<(), crate::errors::HeadlineError> {
    let t = &mut get_title_mut_internal(org)?;
    let pairs = &mut t.properties.pairs;
    match pairs.binary_search_by(|(k, _)| k.as_ref().cmp(key)) {
        Ok(id_index) => {
            match pairs[id_index].1 {
                Cow::Borrowed(..) => {
                    pairs[id_index].1 = value.to_string().into();
                }
                Cow::Owned(..) => {
                    pairs[id_index].1.to_mut().replace_range(.., value);
                }
            };
        }
        _ => {
            pairs.push((key.to_string().into(), value.to_string().into()));
        }
    }
    Ok(())
}

pub fn set_properties_internal(
    org: &mut orgize::Org,
    properties: indexmap::IndexMap<Cow<'static, str>, Cow<'static, str>>,
) -> Result<(), crate::errors::HeadlineError> {
    let t = &mut get_title_mut_internal(org)?;
    t.properties = properties
        .into_iter()
        .map(|(k, v)| (k.into(), v.into()))
        .collect();

    Ok(())
}

pub fn generate_id_internal(
    org: &mut orgize::Org,
) -> Result<Cow<'static, str>, crate::errors::HeadlineError> {
    if let Some(id) = get_property_internal("ID", org)? {
        return Ok(id.to_owned());
    }

    let mut bytes = [0; 16];
    rand::thread_rng().fill_bytes(&mut bytes);
    let bytes = hex::encode(&bytes);
    let bytes = format!(
        "{}-{}-{}-{}-{}",
        &bytes[..8],
        &bytes[8..12],
        &bytes[12..16],
        &bytes[16..20],
        &bytes[20..]
    );
    set_property_internal(org, "ID", &bytes)?;
    Ok(bytes.into())
}

fn get_title_mut_internal<'a, 'b>(
    org: &'a mut orgize::Org<'b>,
) -> Result<&'a mut orgize::elements::Title<'b>, crate::errors::HeadlineError> {
    let id = match org.headlines().next().map(|s| s.title_node()) {
        None => return Err(HeadlineError::InvalidHeadlineError),
        Some(headline) => headline,
    };

    match &mut org[id] {
        orgize::elements::Element::Title(t) => Ok(t),
        _ => Err(HeadlineError::InvalidHeadlineError),
    }
}

fn get_title_internal<'a, 'b>(
    org: &'a orgize::Org<'b>,
) -> Result<&'a orgize::elements::Title<'b>, crate::errors::HeadlineError> {
    let id = match org.headlines().next().map(|s| s.title_node()) {
        None => return Err(HeadlineError::InvalidHeadlineError),
        Some(headline) => headline,
    };

    match &org[id] {
        orgize::elements::Element::Title(t) => Ok(t),
        _ => Err(HeadlineError::InvalidHeadlineError),
    }
}