proto.rs

  1use crate::{
  2    diagnostic_set::DiagnosticEntry, CodeAction, CodeLabel, Completion, CursorShape, Diagnostic,
  3    Language,
  4};
  5use anyhow::{anyhow, Result};
  6use clock::ReplicaId;
  7use lsp::{DiagnosticSeverity, LanguageServerId};
  8use rpc::proto;
  9use std::{ops::Range, sync::Arc};
 10use text::*;
 11
 12pub use proto::{BufferState, Operation};
 13
 14pub fn serialize_fingerprint(fingerprint: RopeFingerprint) -> String {
 15    fingerprint.to_hex()
 16}
 17
 18pub fn deserialize_fingerprint(fingerprint: &str) -> Result<RopeFingerprint> {
 19    RopeFingerprint::from_hex(fingerprint)
 20        .map_err(|error| anyhow!("invalid fingerprint: {}", error))
 21}
 22
 23pub fn deserialize_line_ending(message: proto::LineEnding) -> fs::LineEnding {
 24    match message {
 25        proto::LineEnding::Unix => fs::LineEnding::Unix,
 26        proto::LineEnding::Windows => fs::LineEnding::Windows,
 27    }
 28}
 29
 30pub fn serialize_line_ending(message: fs::LineEnding) -> proto::LineEnding {
 31    match message {
 32        fs::LineEnding::Unix => proto::LineEnding::Unix,
 33        fs::LineEnding::Windows => proto::LineEnding::Windows,
 34    }
 35}
 36
 37pub fn serialize_operation(operation: &crate::Operation) -> proto::Operation {
 38    proto::Operation {
 39        variant: Some(match operation {
 40            crate::Operation::Buffer(text::Operation::Edit(edit)) => {
 41                proto::operation::Variant::Edit(serialize_edit_operation(edit))
 42            }
 43
 44            crate::Operation::Buffer(text::Operation::Undo {
 45                undo,
 46                lamport_timestamp,
 47            }) => proto::operation::Variant::Undo(proto::operation::Undo {
 48                replica_id: undo.id.replica_id as u32,
 49                local_timestamp: undo.id.value,
 50                lamport_timestamp: lamport_timestamp.value,
 51                version: serialize_version(&undo.version),
 52                counts: undo
 53                    .counts
 54                    .iter()
 55                    .map(|(edit_id, count)| proto::UndoCount {
 56                        replica_id: edit_id.replica_id as u32,
 57                        local_timestamp: edit_id.value,
 58                        count: *count,
 59                    })
 60                    .collect(),
 61            }),
 62
 63            crate::Operation::UpdateSelections {
 64                selections,
 65                line_mode,
 66                lamport_timestamp,
 67                cursor_shape,
 68            } => proto::operation::Variant::UpdateSelections(proto::operation::UpdateSelections {
 69                replica_id: lamport_timestamp.replica_id as u32,
 70                lamport_timestamp: lamport_timestamp.value,
 71                selections: serialize_selections(selections),
 72                line_mode: *line_mode,
 73                cursor_shape: serialize_cursor_shape(cursor_shape) as i32,
 74            }),
 75
 76            crate::Operation::UpdateDiagnostics {
 77                lamport_timestamp,
 78                server_id,
 79                diagnostics,
 80            } => proto::operation::Variant::UpdateDiagnostics(proto::UpdateDiagnostics {
 81                replica_id: lamport_timestamp.replica_id as u32,
 82                lamport_timestamp: lamport_timestamp.value,
 83                server_id: server_id.0 as u64,
 84                diagnostics: serialize_diagnostics(diagnostics.iter()),
 85            }),
 86
 87            crate::Operation::UpdateCompletionTriggers {
 88                triggers,
 89                lamport_timestamp,
 90            } => proto::operation::Variant::UpdateCompletionTriggers(
 91                proto::operation::UpdateCompletionTriggers {
 92                    replica_id: lamport_timestamp.replica_id as u32,
 93                    lamport_timestamp: lamport_timestamp.value,
 94                    triggers: triggers.clone(),
 95                },
 96            ),
 97        }),
 98    }
 99}
100
101pub fn serialize_edit_operation(operation: &EditOperation) -> proto::operation::Edit {
102    proto::operation::Edit {
103        replica_id: operation.timestamp.replica_id as u32,
104        local_timestamp: operation.timestamp.local,
105        lamport_timestamp: operation.timestamp.lamport,
106        version: serialize_version(&operation.version),
107        ranges: operation.ranges.iter().map(serialize_range).collect(),
108        new_text: operation
109            .new_text
110            .iter()
111            .map(|text| text.to_string())
112            .collect(),
113    }
114}
115
116pub fn serialize_undo_map_entry(
117    (edit_id, counts): (&clock::Local, &[(clock::Local, u32)]),
118) -> proto::UndoMapEntry {
119    proto::UndoMapEntry {
120        replica_id: edit_id.replica_id as u32,
121        local_timestamp: edit_id.value,
122        counts: counts
123            .iter()
124            .map(|(undo_id, count)| proto::UndoCount {
125                replica_id: undo_id.replica_id as u32,
126                local_timestamp: undo_id.value,
127                count: *count,
128            })
129            .collect(),
130    }
131}
132
133pub fn serialize_selections(selections: &Arc<[Selection<Anchor>]>) -> Vec<proto::Selection> {
134    selections.iter().map(serialize_selection).collect()
135}
136
137pub fn serialize_selection(selection: &Selection<Anchor>) -> proto::Selection {
138    proto::Selection {
139        id: selection.id as u64,
140        start: Some(proto::EditorAnchor {
141            anchor: Some(serialize_anchor(&selection.start)),
142            excerpt_id: 0,
143        }),
144        end: Some(proto::EditorAnchor {
145            anchor: Some(serialize_anchor(&selection.end)),
146            excerpt_id: 0,
147        }),
148        reversed: selection.reversed,
149    }
150}
151
152pub fn serialize_cursor_shape(cursor_shape: &CursorShape) -> proto::CursorShape {
153    match cursor_shape {
154        CursorShape::Bar => proto::CursorShape::CursorBar,
155        CursorShape::Block => proto::CursorShape::CursorBlock,
156        CursorShape::Underscore => proto::CursorShape::CursorUnderscore,
157        CursorShape::Hollow => proto::CursorShape::CursorHollow,
158    }
159}
160
161pub fn deserialize_cursor_shape(cursor_shape: proto::CursorShape) -> CursorShape {
162    match cursor_shape {
163        proto::CursorShape::CursorBar => CursorShape::Bar,
164        proto::CursorShape::CursorBlock => CursorShape::Block,
165        proto::CursorShape::CursorUnderscore => CursorShape::Underscore,
166        proto::CursorShape::CursorHollow => CursorShape::Hollow,
167    }
168}
169
170pub fn serialize_diagnostics<'a>(
171    diagnostics: impl IntoIterator<Item = &'a DiagnosticEntry<Anchor>>,
172) -> Vec<proto::Diagnostic> {
173    diagnostics
174        .into_iter()
175        .map(|entry| proto::Diagnostic {
176            start: Some(serialize_anchor(&entry.range.start)),
177            end: Some(serialize_anchor(&entry.range.end)),
178            message: entry.diagnostic.message.clone(),
179            severity: match entry.diagnostic.severity {
180                DiagnosticSeverity::ERROR => proto::diagnostic::Severity::Error,
181                DiagnosticSeverity::WARNING => proto::diagnostic::Severity::Warning,
182                DiagnosticSeverity::INFORMATION => proto::diagnostic::Severity::Information,
183                DiagnosticSeverity::HINT => proto::diagnostic::Severity::Hint,
184                _ => proto::diagnostic::Severity::None,
185            } as i32,
186            group_id: entry.diagnostic.group_id as u64,
187            is_primary: entry.diagnostic.is_primary,
188            is_valid: entry.diagnostic.is_valid,
189            code: entry.diagnostic.code.clone(),
190            is_disk_based: entry.diagnostic.is_disk_based,
191            is_unnecessary: entry.diagnostic.is_unnecessary,
192        })
193        .collect()
194}
195
196pub fn serialize_anchor(anchor: &Anchor) -> proto::Anchor {
197    proto::Anchor {
198        replica_id: anchor.timestamp.replica_id as u32,
199        local_timestamp: anchor.timestamp.value,
200        offset: anchor.offset as u64,
201        bias: match anchor.bias {
202            Bias::Left => proto::Bias::Left as i32,
203            Bias::Right => proto::Bias::Right as i32,
204        },
205        buffer_id: anchor.buffer_id,
206    }
207}
208
209pub fn deserialize_operation(message: proto::Operation) -> Result<crate::Operation> {
210    Ok(
211        match message
212            .variant
213            .ok_or_else(|| anyhow!("missing operation variant"))?
214        {
215            proto::operation::Variant::Edit(edit) => {
216                crate::Operation::Buffer(text::Operation::Edit(deserialize_edit_operation(edit)))
217            }
218            proto::operation::Variant::Undo(undo) => {
219                crate::Operation::Buffer(text::Operation::Undo {
220                    lamport_timestamp: clock::Lamport {
221                        replica_id: undo.replica_id as ReplicaId,
222                        value: undo.lamport_timestamp,
223                    },
224                    undo: UndoOperation {
225                        id: clock::Local {
226                            replica_id: undo.replica_id as ReplicaId,
227                            value: undo.local_timestamp,
228                        },
229                        version: deserialize_version(&undo.version),
230                        counts: undo
231                            .counts
232                            .into_iter()
233                            .map(|c| {
234                                (
235                                    clock::Local {
236                                        replica_id: c.replica_id as ReplicaId,
237                                        value: c.local_timestamp,
238                                    },
239                                    c.count,
240                                )
241                            })
242                            .collect(),
243                    },
244                })
245            }
246            proto::operation::Variant::UpdateSelections(message) => {
247                let selections = message
248                    .selections
249                    .into_iter()
250                    .filter_map(|selection| {
251                        Some(Selection {
252                            id: selection.id as usize,
253                            start: deserialize_anchor(selection.start?.anchor?)?,
254                            end: deserialize_anchor(selection.end?.anchor?)?,
255                            reversed: selection.reversed,
256                            goal: SelectionGoal::None,
257                        })
258                    })
259                    .collect::<Vec<_>>();
260
261                crate::Operation::UpdateSelections {
262                    lamport_timestamp: clock::Lamport {
263                        replica_id: message.replica_id as ReplicaId,
264                        value: message.lamport_timestamp,
265                    },
266                    selections: Arc::from(selections),
267                    line_mode: message.line_mode,
268                    cursor_shape: deserialize_cursor_shape(
269                        proto::CursorShape::from_i32(message.cursor_shape)
270                            .ok_or_else(|| anyhow!("Missing cursor shape"))?,
271                    ),
272                }
273            }
274            proto::operation::Variant::UpdateDiagnostics(message) => {
275                crate::Operation::UpdateDiagnostics {
276                    lamport_timestamp: clock::Lamport {
277                        replica_id: message.replica_id as ReplicaId,
278                        value: message.lamport_timestamp,
279                    },
280                    server_id: LanguageServerId(message.server_id as usize),
281                    diagnostics: deserialize_diagnostics(message.diagnostics),
282                }
283            }
284            proto::operation::Variant::UpdateCompletionTriggers(message) => {
285                crate::Operation::UpdateCompletionTriggers {
286                    triggers: message.triggers,
287                    lamport_timestamp: clock::Lamport {
288                        replica_id: message.replica_id as ReplicaId,
289                        value: message.lamport_timestamp,
290                    },
291                }
292            }
293        },
294    )
295}
296
297pub fn deserialize_edit_operation(edit: proto::operation::Edit) -> EditOperation {
298    EditOperation {
299        timestamp: InsertionTimestamp {
300            replica_id: edit.replica_id as ReplicaId,
301            local: edit.local_timestamp,
302            lamport: edit.lamport_timestamp,
303        },
304        version: deserialize_version(&edit.version),
305        ranges: edit.ranges.into_iter().map(deserialize_range).collect(),
306        new_text: edit.new_text.into_iter().map(Arc::from).collect(),
307    }
308}
309
310pub fn deserialize_undo_map_entry(
311    entry: proto::UndoMapEntry,
312) -> (clock::Local, Vec<(clock::Local, u32)>) {
313    (
314        clock::Local {
315            replica_id: entry.replica_id as u16,
316            value: entry.local_timestamp,
317        },
318        entry
319            .counts
320            .into_iter()
321            .map(|undo_count| {
322                (
323                    clock::Local {
324                        replica_id: undo_count.replica_id as u16,
325                        value: undo_count.local_timestamp,
326                    },
327                    undo_count.count,
328                )
329            })
330            .collect(),
331    )
332}
333
334pub fn deserialize_selections(selections: Vec<proto::Selection>) -> Arc<[Selection<Anchor>]> {
335    Arc::from(
336        selections
337            .into_iter()
338            .filter_map(deserialize_selection)
339            .collect::<Vec<_>>(),
340    )
341}
342
343pub fn deserialize_selection(selection: proto::Selection) -> Option<Selection<Anchor>> {
344    Some(Selection {
345        id: selection.id as usize,
346        start: deserialize_anchor(selection.start?.anchor?)?,
347        end: deserialize_anchor(selection.end?.anchor?)?,
348        reversed: selection.reversed,
349        goal: SelectionGoal::None,
350    })
351}
352
353pub fn deserialize_diagnostics(
354    diagnostics: Vec<proto::Diagnostic>,
355) -> Arc<[DiagnosticEntry<Anchor>]> {
356    diagnostics
357        .into_iter()
358        .filter_map(|diagnostic| {
359            Some(DiagnosticEntry {
360                range: deserialize_anchor(diagnostic.start?)?..deserialize_anchor(diagnostic.end?)?,
361                diagnostic: Diagnostic {
362                    severity: match proto::diagnostic::Severity::from_i32(diagnostic.severity)? {
363                        proto::diagnostic::Severity::Error => DiagnosticSeverity::ERROR,
364                        proto::diagnostic::Severity::Warning => DiagnosticSeverity::WARNING,
365                        proto::diagnostic::Severity::Information => DiagnosticSeverity::INFORMATION,
366                        proto::diagnostic::Severity::Hint => DiagnosticSeverity::HINT,
367                        proto::diagnostic::Severity::None => return None,
368                    },
369                    message: diagnostic.message,
370                    group_id: diagnostic.group_id as usize,
371                    code: diagnostic.code,
372                    is_valid: diagnostic.is_valid,
373                    is_primary: diagnostic.is_primary,
374                    is_disk_based: diagnostic.is_disk_based,
375                    is_unnecessary: diagnostic.is_unnecessary,
376                },
377            })
378        })
379        .collect()
380}
381
382pub fn deserialize_anchor(anchor: proto::Anchor) -> Option<Anchor> {
383    Some(Anchor {
384        timestamp: clock::Local {
385            replica_id: anchor.replica_id as ReplicaId,
386            value: anchor.local_timestamp,
387        },
388        offset: anchor.offset as usize,
389        bias: match proto::Bias::from_i32(anchor.bias)? {
390            proto::Bias::Left => Bias::Left,
391            proto::Bias::Right => Bias::Right,
392        },
393        buffer_id: anchor.buffer_id,
394    })
395}
396
397pub fn lamport_timestamp_for_operation(operation: &proto::Operation) -> Option<clock::Lamport> {
398    let replica_id;
399    let value;
400    match operation.variant.as_ref()? {
401        proto::operation::Variant::Edit(op) => {
402            replica_id = op.replica_id;
403            value = op.lamport_timestamp;
404        }
405        proto::operation::Variant::Undo(op) => {
406            replica_id = op.replica_id;
407            value = op.lamport_timestamp;
408        }
409        proto::operation::Variant::UpdateDiagnostics(op) => {
410            replica_id = op.replica_id;
411            value = op.lamport_timestamp;
412        }
413        proto::operation::Variant::UpdateSelections(op) => {
414            replica_id = op.replica_id;
415            value = op.lamport_timestamp;
416        }
417        proto::operation::Variant::UpdateCompletionTriggers(op) => {
418            replica_id = op.replica_id;
419            value = op.lamport_timestamp;
420        }
421    }
422
423    Some(clock::Lamport {
424        replica_id: replica_id as ReplicaId,
425        value,
426    })
427}
428
429pub fn serialize_completion(completion: &Completion) -> proto::Completion {
430    proto::Completion {
431        old_start: Some(serialize_anchor(&completion.old_range.start)),
432        old_end: Some(serialize_anchor(&completion.old_range.end)),
433        new_text: completion.new_text.clone(),
434        lsp_completion: serde_json::to_vec(&completion.lsp_completion).unwrap(),
435    }
436}
437
438pub async fn deserialize_completion(
439    completion: proto::Completion,
440    language: Option<Arc<Language>>,
441) -> Result<Completion> {
442    let old_start = completion
443        .old_start
444        .and_then(deserialize_anchor)
445        .ok_or_else(|| anyhow!("invalid old start"))?;
446    let old_end = completion
447        .old_end
448        .and_then(deserialize_anchor)
449        .ok_or_else(|| anyhow!("invalid old end"))?;
450    let lsp_completion = serde_json::from_slice(&completion.lsp_completion)?;
451
452    let mut label = None;
453    if let Some(language) = language {
454        label = language.label_for_completion(&lsp_completion).await;
455    }
456
457    Ok(Completion {
458        old_range: old_start..old_end,
459        new_text: completion.new_text,
460        label: label.unwrap_or_else(|| {
461            CodeLabel::plain(
462                lsp_completion.label.clone(),
463                lsp_completion.filter_text.as_deref(),
464            )
465        }),
466        lsp_completion,
467    })
468}
469
470pub fn serialize_code_action(action: &CodeAction) -> proto::CodeAction {
471    proto::CodeAction {
472        server_id: action.server_id.0 as u64,
473        start: Some(serialize_anchor(&action.range.start)),
474        end: Some(serialize_anchor(&action.range.end)),
475        lsp_action: serde_json::to_vec(&action.lsp_action).unwrap(),
476    }
477}
478
479pub fn deserialize_code_action(action: proto::CodeAction) -> Result<CodeAction> {
480    let start = action
481        .start
482        .and_then(deserialize_anchor)
483        .ok_or_else(|| anyhow!("invalid start"))?;
484    let end = action
485        .end
486        .and_then(deserialize_anchor)
487        .ok_or_else(|| anyhow!("invalid end"))?;
488    let lsp_action = serde_json::from_slice(&action.lsp_action)?;
489    Ok(CodeAction {
490        server_id: LanguageServerId(action.server_id as usize),
491        range: start..end,
492        lsp_action,
493    })
494}
495
496pub fn serialize_transaction(transaction: &Transaction) -> proto::Transaction {
497    proto::Transaction {
498        id: Some(serialize_local_timestamp(transaction.id)),
499        edit_ids: transaction
500            .edit_ids
501            .iter()
502            .copied()
503            .map(serialize_local_timestamp)
504            .collect(),
505        start: serialize_version(&transaction.start),
506    }
507}
508
509pub fn deserialize_transaction(transaction: proto::Transaction) -> Result<Transaction> {
510    Ok(Transaction {
511        id: deserialize_local_timestamp(
512            transaction
513                .id
514                .ok_or_else(|| anyhow!("missing transaction id"))?,
515        ),
516        edit_ids: transaction
517            .edit_ids
518            .into_iter()
519            .map(deserialize_local_timestamp)
520            .collect(),
521        start: deserialize_version(&transaction.start),
522    })
523}
524
525pub fn serialize_local_timestamp(timestamp: clock::Local) -> proto::LocalTimestamp {
526    proto::LocalTimestamp {
527        replica_id: timestamp.replica_id as u32,
528        value: timestamp.value,
529    }
530}
531
532pub fn deserialize_local_timestamp(timestamp: proto::LocalTimestamp) -> clock::Local {
533    clock::Local {
534        replica_id: timestamp.replica_id as ReplicaId,
535        value: timestamp.value,
536    }
537}
538
539pub fn serialize_range(range: &Range<FullOffset>) -> proto::Range {
540    proto::Range {
541        start: range.start.0 as u64,
542        end: range.end.0 as u64,
543    }
544}
545
546pub fn deserialize_range(range: proto::Range) -> Range<FullOffset> {
547    FullOffset(range.start as usize)..FullOffset(range.end as usize)
548}
549
550pub fn deserialize_version(message: &[proto::VectorClockEntry]) -> clock::Global {
551    let mut version = clock::Global::new();
552    for entry in message {
553        version.observe(clock::Local {
554            replica_id: entry.replica_id as ReplicaId,
555            value: entry.timestamp,
556        });
557    }
558    version
559}
560
561pub fn serialize_version(version: &clock::Global) -> Vec<proto::VectorClockEntry> {
562    version
563        .iter()
564        .map(|entry| proto::VectorClockEntry {
565            replica_id: entry.replica_id as u32,
566            timestamp: entry.value,
567        })
568        .collect()
569}