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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
use crate::event::Event;
use crate::event::Event::Token;
use crate::token_source::TokenSource;
use crate::Parser;
use biome_rowan::{SyntaxKind, TextRange, TextSize};
use drop_bomb::DebugDropBomb;
use std::num::NonZeroU32;
/// A structure signifying the start of parsing of a syntax tree node
#[derive(Debug)]
#[must_use = "Marker must either be `completed` or `abandoned`"]
pub struct Marker {
/// The index in the events list
pos: u32,
/// The byte index where the node starts
start: TextSize,
pub(crate) old_start: u32,
child_idx: Option<usize>,
bomb: DebugDropBomb,
}
impl Marker {
pub fn new(pos: u32, start: TextSize) -> Marker {
Marker {
pos,
start,
old_start: pos,
child_idx: None,
bomb: DebugDropBomb::new("Marker must either be `completed` or `abandoned` to avoid that children are implicitly attached to a marker's parent."),
}
}
fn old_start(mut self, old: u32) -> Self {
if self.old_start >= old {
self.old_start = old;
};
self
}
/// Finishes the syntax tree node and assigns `kind` to it,
/// and mark the create a `CompletedMarker` for possible future
/// operation like `.precede()` to deal with forward_parent.
pub fn complete<P>(mut self, p: &mut P, kind: P::Kind) -> CompletedMarker
where
P: Parser,
{
self.bomb.defuse();
let context = p.context_mut();
let idx = self.pos as usize;
match context.events[idx] {
Event::Start {
kind: ref mut slot, ..
} => {
*slot = kind;
}
_ => unreachable!(),
}
let finish_pos = context.events.len() as u32;
context.push_event(Event::Finish);
let new = CompletedMarker::new(self.pos, finish_pos, self.start);
new.old_start(self.old_start)
}
/// Abandons the syntax tree node. All its children
/// are attached to its parent instead.
pub fn abandon<P>(mut self, p: &mut P)
where
P: Parser,
{
self.bomb.defuse();
let idx = self.pos as usize;
if idx == p.context().events.len() - 1 {
if let Some(Event::Start {
forward_parent: None,
kind,
}) = p.context_mut().events.pop()
{
assert_eq!(kind, P::Kind::TOMBSTONE);
}
}
if let Some(idx) = self.child_idx {
match p.context_mut().events[idx] {
Event::Start {
ref mut forward_parent,
..
} => {
*forward_parent = None;
}
_ => unreachable!(),
}
}
}
pub fn start(&self) -> TextSize {
self.start
}
}
/// A structure signifying a completed node
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CompletedMarker {
start_pos: u32,
offset: TextSize,
// Hack for parsing completed markers which have been preceded
// This should be redone completely in the future
old_start: u32,
finish_pos: u32,
}
impl CompletedMarker {
pub fn new(start_pos: u32, finish_pos: u32, offset: TextSize) -> Self {
CompletedMarker {
start_pos,
offset,
old_start: start_pos,
finish_pos,
}
}
pub(crate) fn old_start(mut self, old: u32) -> Self {
// For multiple precedes we should not update the old start
if self.old_start >= old {
self.old_start = old;
};
self
}
/// Change the kind of node this marker represents
pub fn change_kind<P>(&mut self, p: &mut P, new_kind: P::Kind)
where
P: Parser,
{
match p
.context_mut()
.events
.get_mut(self.start_pos as usize)
.expect("Finish position of marker is OOB")
{
Event::Start { kind, .. } => {
*kind = new_kind;
}
_ => unreachable!(),
}
}
pub fn change_to_bogus<P>(&mut self, p: &mut P)
where
P: Parser,
{
self.change_kind(p, self.kind(p).to_bogus());
}
/// Get the range of the marker
pub fn range<P>(&self, p: &P) -> TextRange
where
P: Parser,
{
let end = p.context().events[self.old_start as usize..self.finish_pos as usize]
.iter()
.rev()
.find_map(|event| match event {
Token { end, .. } => Some(*end),
_ => None,
})
.unwrap_or(self.offset);
TextRange::new(self.offset, end)
}
/// Get the underlying text of a marker
pub fn text<'a, P>(&self, p: &'a P) -> &'a str
where
P: Parser,
{
&p.source().text()[self.range(p)]
}
/// This method allows to create a new node which starts
/// *before* the current one. That is, parser could start
/// node `A`, then complete it, and then after parsing the
/// whole `A`, decide that it should have started some node
/// `B` before starting `A`. `precede` allows to do exactly
/// that. See also docs about `forward_parent` in `Event::Start`.
///
/// Given completed events `[START, FINISH]` and its corresponding
/// `CompletedMarker(pos: 0, _)`.
/// Append a new `START` events as `[START, FINISH, NEWSTART]`,
/// then mark `NEWSTART` as `START`'s parent with saving its relative
/// distance to `NEWSTART` into forward_parent(=2 in this case);
pub fn precede<P>(self, p: &mut P) -> Marker
where
P: Parser,
{
let mut new_pos = p.start();
let idx = self.start_pos as usize;
match p.context_mut().events[idx] {
Event::Start {
ref mut forward_parent,
..
} => {
// Safety: The new marker is always inserted after the start marker of this node, thus
// subtracting the two positions can never be 0.
*forward_parent = Some(NonZeroU32::try_from(new_pos.pos - self.start_pos).unwrap());
}
_ => unreachable!(),
}
new_pos.child_idx = Some(self.start_pos as usize);
new_pos.start = self.offset;
new_pos.old_start(self.old_start)
}
/// Undo this completion and turns into a `Marker`
pub fn undo_completion<P>(self, p: &mut P) -> Marker
where
P: Parser,
{
let start_idx = self.start_pos as usize;
let finish_idx = self.finish_pos as usize;
let events = &mut p.context_mut().events;
match events[start_idx] {
Event::Start {
ref mut kind,
forward_parent: None,
} => *kind = P::Kind::TOMBSTONE,
_ => unreachable!(),
}
match events[finish_idx] {
ref mut slot @ Event::Finish { .. } => *slot = Event::tombstone(),
_ => unreachable!(),
}
Marker::new(self.start_pos, self.offset)
}
pub fn kind<P>(&self, p: &P) -> P::Kind
where
P: Parser,
{
match p.context().events[self.start_pos as usize] {
Event::Start { kind, .. } => kind,
_ => unreachable!(),
}
}
}