alma 0.1.1

A Bevy-native modal text editor with Vim-style navigation.
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
157
158
159
160
161
162
163
164
165
166
167
168

//! Effect payload and proposal vocabulary.

use crate::{
    buffer::BufferEditShape,
    ecs::{
        components::buffer::BufferEntity,
        events::{
            edit::{PluginBufferEditProvenance, RevisionGuardedBufferEditRequested},
            status::{StatusMessage, StatusMessageRequested},
        },
    },
    plugin::PluginIdentity,
    text_stream::TextRevision,
};
use std::fmt::{Debug, Formatter};

/// Host-accepted proposals not yet published to ECS.
#[derive(Eq, PartialEq)]
pub(in crate::plugin::host::effect) enum PluginEffect {
    /// Buffer edit proposal.
    BufferEdit(PluginBufferEditProposal),
    /// Status-line request.
    Status(StatusMessageRequested),
}

impl PluginEffect {
    /// Returns its diagnostic shape.
    pub(in crate::plugin::host::effect) fn shape(&self) -> PluginEffectShape {
        PluginEffectShape::from(self)
    }
}

impl Debug for PluginEffect {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("PluginEffect")
            .field("shape", &self.shape())
            .finish()
    }
}

/// Plugin buffer edit proposal with observed revision provenance.
#[derive(Eq, PartialEq)]
pub struct PluginBufferEditProposal {
    /// Target buffer entity.
    target: BufferEntity,
    /// Owner-boundary edit payload.
    edit: crate::buffer::BufferEdit,
    /// Revision observed by the guest.
    base_revision: TextRevision,
}

impl PluginBufferEditProposal {
    /// Creates a snapshot-derived plugin proposal.
    #[must_use]
    pub const fn from_observed_revision(
        target: BufferEntity,
        edit: crate::buffer::BufferEdit,
        base_revision: TextRevision,
    ) -> Self {
        Self {
            target,
            edit,
            base_revision,
        }
    }

    /// Returns the target buffer.
    #[must_use]
    pub const fn target(&self) -> BufferEntity {
        self.target
    }

    /// Returns the observed revision.
    #[must_use]
    pub const fn base_revision(&self) -> TextRevision {
        self.base_revision
    }

    /// Converts into an owner-boundary request.
    pub(in crate::plugin::host::effect) fn into_request(
        self,
        source_identity: &PluginIdentity,
    ) -> RevisionGuardedBufferEditRequested {
        RevisionGuardedBufferEditRequested {
            target: self.target,
            provenance: PluginBufferEditProvenance::buffer_propose_edit(
                source_identity.clone(),
                self.base_revision,
            ),
            edit: self.edit,
        }
    }
}

impl Debug for PluginBufferEditProposal {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("PluginBufferEditProposal")
            .field("target", &PluginEffectTargetShape::Buffer)
            .field("edit", &BufferEditShape::from_edit(&self.edit))
            .field("base_revision", &self.base_revision)
            .finish()
    }
}

/// Redacted owner target kind.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(in crate::plugin::host::effect) enum PluginEffectTargetShape {
    /// Buffer owner target.
    Buffer,
    /// View owner target.
    View,
}

/// Redacted effect shape.
#[derive(Clone, Debug, Eq, PartialEq)]
pub(in crate::plugin::host::effect) enum PluginEffectShape {
    /// Buffer edit proposal effect.
    BufferEdit {
        /// Redacted edit shape.
        edit: BufferEditShape,
    },
    /// Status effect.
    Status {
        /// Redacted status shape.
        status: PluginStatusMessageShape,
    },
}

impl From<&PluginEffect> for PluginEffectShape {
    fn from(effect: &PluginEffect) -> Self {
        match effect {
            PluginEffect::BufferEdit(effect) => Self::BufferEdit {
                edit: BufferEditShape::from_edit(&effect.edit),
            },
            PluginEffect::Status(request) => Self::Status {
                status: PluginStatusMessageShape::from(&request.message),
            },
        }
    }
}

/// Redacted status shape.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(in crate::plugin::host::effect) enum PluginStatusMessageShape {
    /// Clear status.
    Clear,
    /// Informational status length.
    Info {
        /// Escaped text byte length.
        byte_len: usize,
    },
    /// Error status.
    Error,
}

impl From<&StatusMessage> for PluginStatusMessageShape {
    fn from(message: &StatusMessage) -> Self {
        match message {
            StatusMessage::Clear => Self::Clear,
            StatusMessage::Info(text) => Self::Info {
                byte_len: text.as_str().len(),
            },
            StatusMessage::Error(_error) => Self::Error,
        }
    }
}