mirror of
https://github.com/zed-industries/zed.git
synced 2024-09-20 02:47:34 +03:00
712 lines
15 KiB
Protocol Buffer
712 lines
15 KiB
Protocol Buffer
syntax = "proto3";
|
|
package zed.messages;
|
|
|
|
message Envelope {
|
|
uint32 id = 1;
|
|
optional uint32 responding_to = 2;
|
|
optional uint32 original_sender_id = 3;
|
|
oneof payload {
|
|
Ack ack = 4;
|
|
Error error = 5;
|
|
Ping ping = 6;
|
|
Test test = 7;
|
|
|
|
RegisterProject register_project = 8;
|
|
RegisterProjectResponse register_project_response = 9;
|
|
UnregisterProject unregister_project = 10;
|
|
ShareProject share_project = 11;
|
|
UnshareProject unshare_project = 12;
|
|
JoinProject join_project = 13;
|
|
JoinProjectResponse join_project_response = 14;
|
|
LeaveProject leave_project = 15;
|
|
AddProjectCollaborator add_project_collaborator = 16;
|
|
RemoveProjectCollaborator remove_project_collaborator = 17;
|
|
|
|
GetDefinition get_definition = 18;
|
|
GetDefinitionResponse get_definition_response = 19;
|
|
GetReferences get_references = 20;
|
|
GetReferencesResponse get_references_response = 21;
|
|
GetDocumentHighlights get_document_highlights = 22;
|
|
GetDocumentHighlightsResponse get_document_highlights_response = 23;
|
|
GetProjectSymbols get_project_symbols = 24;
|
|
GetProjectSymbolsResponse get_project_symbols_response = 25;
|
|
OpenBufferForSymbol open_buffer_for_symbol = 26;
|
|
OpenBufferForSymbolResponse open_buffer_for_symbol_response = 27;
|
|
|
|
RegisterWorktree register_worktree = 28;
|
|
UnregisterWorktree unregister_worktree = 29;
|
|
UpdateWorktree update_worktree = 31;
|
|
UpdateDiagnosticSummary update_diagnostic_summary = 32;
|
|
DiskBasedDiagnosticsUpdating disk_based_diagnostics_updating = 33;
|
|
DiskBasedDiagnosticsUpdated disk_based_diagnostics_updated = 34;
|
|
|
|
OpenBuffer open_buffer = 35;
|
|
OpenBufferResponse open_buffer_response = 36;
|
|
CloseBuffer close_buffer = 37;
|
|
UpdateBuffer update_buffer = 38;
|
|
UpdateBufferFile update_buffer_file = 39;
|
|
SaveBuffer save_buffer = 40;
|
|
BufferSaved buffer_saved = 41;
|
|
BufferReloaded buffer_reloaded = 42;
|
|
FormatBuffers format_buffers = 43;
|
|
FormatBuffersResponse format_buffers_response = 44;
|
|
GetCompletions get_completions = 45;
|
|
GetCompletionsResponse get_completions_response = 46;
|
|
ApplyCompletionAdditionalEdits apply_completion_additional_edits = 47;
|
|
ApplyCompletionAdditionalEditsResponse apply_completion_additional_edits_response = 48;
|
|
GetCodeActions get_code_actions = 49;
|
|
GetCodeActionsResponse get_code_actions_response = 50;
|
|
ApplyCodeAction apply_code_action = 51;
|
|
ApplyCodeActionResponse apply_code_action_response = 52;
|
|
PrepareRename prepare_rename = 53;
|
|
PrepareRenameResponse prepare_rename_response = 54;
|
|
PerformRename perform_rename = 55;
|
|
PerformRenameResponse perform_rename_response = 56;
|
|
SearchProject search_project = 57;
|
|
SearchProjectResponse search_project_response = 58;
|
|
|
|
GetChannels get_channels = 59;
|
|
GetChannelsResponse get_channels_response = 60;
|
|
JoinChannel join_channel = 61;
|
|
JoinChannelResponse join_channel_response = 62;
|
|
LeaveChannel leave_channel = 63;
|
|
SendChannelMessage send_channel_message = 64;
|
|
SendChannelMessageResponse send_channel_message_response = 65;
|
|
ChannelMessageSent channel_message_sent = 66;
|
|
GetChannelMessages get_channel_messages = 67;
|
|
GetChannelMessagesResponse get_channel_messages_response = 68;
|
|
|
|
UpdateContacts update_contacts = 69;
|
|
|
|
GetUsers get_users = 70;
|
|
GetUsersResponse get_users_response = 71;
|
|
}
|
|
}
|
|
|
|
// Messages
|
|
|
|
message Ping {}
|
|
|
|
message Ack {}
|
|
|
|
message Error {
|
|
string message = 1;
|
|
}
|
|
|
|
message Test {
|
|
uint64 id = 1;
|
|
}
|
|
|
|
message RegisterProject {}
|
|
|
|
message RegisterProjectResponse {
|
|
uint64 project_id = 1;
|
|
}
|
|
|
|
message UnregisterProject {
|
|
uint64 project_id = 1;
|
|
}
|
|
|
|
message ShareProject {
|
|
uint64 project_id = 1;
|
|
}
|
|
|
|
message UnshareProject {
|
|
uint64 project_id = 1;
|
|
}
|
|
|
|
message JoinProject {
|
|
uint64 project_id = 1;
|
|
}
|
|
|
|
message JoinProjectResponse {
|
|
uint32 replica_id = 1;
|
|
repeated Worktree worktrees = 2;
|
|
repeated Collaborator collaborators = 3;
|
|
}
|
|
|
|
message LeaveProject {
|
|
uint64 project_id = 1;
|
|
}
|
|
|
|
message RegisterWorktree {
|
|
uint64 project_id = 1;
|
|
uint64 worktree_id = 2;
|
|
string root_name = 3;
|
|
repeated string authorized_logins = 4;
|
|
bool visible = 5;
|
|
}
|
|
|
|
message UnregisterWorktree {
|
|
uint64 project_id = 1;
|
|
uint64 worktree_id = 2;
|
|
}
|
|
|
|
message UpdateWorktree {
|
|
uint64 project_id = 1;
|
|
uint64 worktree_id = 2;
|
|
string root_name = 3;
|
|
repeated Entry updated_entries = 4;
|
|
repeated uint64 removed_entries = 5;
|
|
}
|
|
|
|
message AddProjectCollaborator {
|
|
uint64 project_id = 1;
|
|
Collaborator collaborator = 2;
|
|
}
|
|
|
|
message RemoveProjectCollaborator {
|
|
uint64 project_id = 1;
|
|
uint32 peer_id = 2;
|
|
}
|
|
|
|
message GetDefinition {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
Anchor position = 3;
|
|
repeated VectorClockEntry version = 4;
|
|
}
|
|
|
|
message GetDefinitionResponse {
|
|
repeated Location locations = 1;
|
|
}
|
|
|
|
message GetReferences {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
Anchor position = 3;
|
|
repeated VectorClockEntry version = 4;
|
|
}
|
|
|
|
message GetReferencesResponse {
|
|
repeated Location locations = 1;
|
|
}
|
|
|
|
message GetDocumentHighlights {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
Anchor position = 3;
|
|
repeated VectorClockEntry version = 4;
|
|
}
|
|
|
|
message GetDocumentHighlightsResponse {
|
|
repeated DocumentHighlight highlights = 1;
|
|
}
|
|
|
|
message Location {
|
|
Buffer buffer = 1;
|
|
Anchor start = 2;
|
|
Anchor end = 3;
|
|
}
|
|
|
|
message DocumentHighlight {
|
|
Kind kind = 1;
|
|
Anchor start = 2;
|
|
Anchor end = 3;
|
|
|
|
enum Kind {
|
|
Text = 0;
|
|
Read = 1;
|
|
Write = 2;
|
|
}
|
|
}
|
|
|
|
message GetProjectSymbols {
|
|
uint64 project_id = 1;
|
|
string query = 2;
|
|
}
|
|
|
|
message GetProjectSymbolsResponse {
|
|
repeated Symbol symbols = 4;
|
|
}
|
|
|
|
message Symbol {
|
|
uint64 source_worktree_id = 1;
|
|
uint64 worktree_id = 2;
|
|
string language_name = 3;
|
|
string name = 4;
|
|
int32 kind = 5;
|
|
string path = 6;
|
|
Point start = 7;
|
|
Point end = 8;
|
|
bytes signature = 9;
|
|
}
|
|
|
|
message OpenBufferForSymbol {
|
|
uint64 project_id = 1;
|
|
Symbol symbol = 2;
|
|
}
|
|
|
|
message OpenBufferForSymbolResponse {
|
|
Buffer buffer = 1;
|
|
}
|
|
|
|
message OpenBuffer {
|
|
uint64 project_id = 1;
|
|
uint64 worktree_id = 2;
|
|
string path = 3;
|
|
}
|
|
|
|
message OpenBufferResponse {
|
|
Buffer buffer = 1;
|
|
}
|
|
|
|
message CloseBuffer {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
}
|
|
|
|
message UpdateBuffer {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
repeated Operation operations = 3;
|
|
}
|
|
|
|
message UpdateBufferFile {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
File file = 3;
|
|
}
|
|
|
|
message SaveBuffer {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
repeated VectorClockEntry version = 3;
|
|
}
|
|
|
|
message BufferSaved {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
repeated VectorClockEntry version = 3;
|
|
Timestamp mtime = 4;
|
|
}
|
|
|
|
message BufferReloaded {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
repeated VectorClockEntry version = 3;
|
|
Timestamp mtime = 4;
|
|
}
|
|
|
|
message FormatBuffers {
|
|
uint64 project_id = 1;
|
|
repeated uint64 buffer_ids = 2;
|
|
}
|
|
|
|
message FormatBuffersResponse {
|
|
ProjectTransaction transaction = 1;
|
|
}
|
|
|
|
message GetCompletions {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
Anchor position = 3;
|
|
repeated VectorClockEntry version = 4;
|
|
}
|
|
|
|
message GetCompletionsResponse {
|
|
repeated Completion completions = 1;
|
|
repeated VectorClockEntry version = 2;
|
|
}
|
|
|
|
message ApplyCompletionAdditionalEdits {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
Completion completion = 3;
|
|
}
|
|
|
|
message ApplyCompletionAdditionalEditsResponse {
|
|
Transaction transaction = 1;
|
|
}
|
|
|
|
message Completion {
|
|
Anchor old_start = 1;
|
|
Anchor old_end = 2;
|
|
string new_text = 3;
|
|
bytes lsp_completion = 4;
|
|
}
|
|
|
|
message GetCodeActions {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
Anchor start = 3;
|
|
Anchor end = 4;
|
|
repeated VectorClockEntry version = 5;
|
|
}
|
|
|
|
message GetCodeActionsResponse {
|
|
repeated CodeAction actions = 1;
|
|
repeated VectorClockEntry version = 2;
|
|
}
|
|
|
|
message ApplyCodeAction {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
CodeAction action = 3;
|
|
}
|
|
|
|
message ApplyCodeActionResponse {
|
|
ProjectTransaction transaction = 1;
|
|
}
|
|
|
|
message PrepareRename {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
Anchor position = 3;
|
|
repeated VectorClockEntry version = 4;
|
|
}
|
|
|
|
message PrepareRenameResponse {
|
|
bool can_rename = 1;
|
|
Anchor start = 2;
|
|
Anchor end = 3;
|
|
repeated VectorClockEntry version = 4;
|
|
}
|
|
|
|
message PerformRename {
|
|
uint64 project_id = 1;
|
|
uint64 buffer_id = 2;
|
|
Anchor position = 3;
|
|
string new_name = 4;
|
|
repeated VectorClockEntry version = 5;
|
|
}
|
|
|
|
message PerformRenameResponse {
|
|
ProjectTransaction transaction = 2;
|
|
}
|
|
|
|
message SearchProject {
|
|
uint64 project_id = 1;
|
|
string query = 2;
|
|
bool regex = 3;
|
|
bool whole_word = 4;
|
|
bool case_sensitive = 5;
|
|
}
|
|
|
|
message SearchProjectResponse {
|
|
repeated Location locations = 1;
|
|
}
|
|
|
|
message CodeAction {
|
|
Anchor start = 1;
|
|
Anchor end = 2;
|
|
bytes lsp_action = 3;
|
|
}
|
|
|
|
message ProjectTransaction {
|
|
repeated Buffer buffers = 1;
|
|
repeated Transaction transactions = 2;
|
|
}
|
|
|
|
message Transaction {
|
|
LocalTimestamp id = 1;
|
|
repeated LocalTimestamp edit_ids = 2;
|
|
repeated VectorClockEntry start = 3;
|
|
repeated VectorClockEntry end = 4;
|
|
repeated Range ranges = 5;
|
|
}
|
|
|
|
message LocalTimestamp {
|
|
uint32 replica_id = 1;
|
|
uint32 value = 2;
|
|
}
|
|
|
|
message UpdateDiagnosticSummary {
|
|
uint64 project_id = 1;
|
|
uint64 worktree_id = 2;
|
|
DiagnosticSummary summary = 3;
|
|
}
|
|
|
|
message DiagnosticSummary {
|
|
string path = 1;
|
|
uint32 error_count = 2;
|
|
uint32 warning_count = 3;
|
|
uint32 info_count = 4;
|
|
uint32 hint_count = 5;
|
|
}
|
|
|
|
message DiskBasedDiagnosticsUpdating {
|
|
uint64 project_id = 1;
|
|
}
|
|
|
|
message DiskBasedDiagnosticsUpdated {
|
|
uint64 project_id = 1;
|
|
}
|
|
|
|
message GetChannels {}
|
|
|
|
message GetChannelsResponse {
|
|
repeated Channel channels = 1;
|
|
}
|
|
|
|
message JoinChannel {
|
|
uint64 channel_id = 1;
|
|
}
|
|
|
|
message JoinChannelResponse {
|
|
repeated ChannelMessage messages = 1;
|
|
bool done = 2;
|
|
}
|
|
|
|
message LeaveChannel {
|
|
uint64 channel_id = 1;
|
|
}
|
|
|
|
message GetUsers {
|
|
repeated uint64 user_ids = 1;
|
|
}
|
|
|
|
message GetUsersResponse {
|
|
repeated User users = 1;
|
|
}
|
|
|
|
message SendChannelMessage {
|
|
uint64 channel_id = 1;
|
|
string body = 2;
|
|
Nonce nonce = 3;
|
|
}
|
|
|
|
message SendChannelMessageResponse {
|
|
ChannelMessage message = 1;
|
|
}
|
|
|
|
message ChannelMessageSent {
|
|
uint64 channel_id = 1;
|
|
ChannelMessage message = 2;
|
|
}
|
|
|
|
message GetChannelMessages {
|
|
uint64 channel_id = 1;
|
|
uint64 before_message_id = 2;
|
|
}
|
|
|
|
message GetChannelMessagesResponse {
|
|
repeated ChannelMessage messages = 1;
|
|
bool done = 2;
|
|
}
|
|
|
|
message UpdateContacts {
|
|
repeated Contact contacts = 1;
|
|
}
|
|
|
|
// Entities
|
|
|
|
message Collaborator {
|
|
uint32 peer_id = 1;
|
|
uint32 replica_id = 2;
|
|
uint64 user_id = 3;
|
|
}
|
|
|
|
message User {
|
|
uint64 id = 1;
|
|
string github_login = 2;
|
|
string avatar_url = 3;
|
|
}
|
|
|
|
message Worktree {
|
|
uint64 id = 1;
|
|
string root_name = 2;
|
|
repeated Entry entries = 3;
|
|
repeated DiagnosticSummary diagnostic_summaries = 4;
|
|
bool visible = 5;
|
|
}
|
|
|
|
message File {
|
|
uint64 worktree_id = 1;
|
|
optional uint64 entry_id = 2;
|
|
string path = 3;
|
|
Timestamp mtime = 4;
|
|
}
|
|
|
|
message Entry {
|
|
uint64 id = 1;
|
|
bool is_dir = 2;
|
|
string path = 3;
|
|
uint64 inode = 4;
|
|
Timestamp mtime = 5;
|
|
bool is_symlink = 6;
|
|
bool is_ignored = 7;
|
|
}
|
|
|
|
message Buffer {
|
|
oneof variant {
|
|
uint64 id = 1;
|
|
BufferState state = 2;
|
|
}
|
|
}
|
|
|
|
message BufferState {
|
|
uint64 id = 1;
|
|
optional File file = 2;
|
|
string base_text = 3;
|
|
repeated Operation operations = 4;
|
|
repeated SelectionSet selections = 5;
|
|
repeated Diagnostic diagnostics = 6;
|
|
repeated string completion_triggers = 7;
|
|
}
|
|
|
|
message BufferFragment {
|
|
uint32 replica_id = 1;
|
|
uint32 local_timestamp = 2;
|
|
uint32 lamport_timestamp = 3;
|
|
uint32 insertion_offset = 4;
|
|
uint32 len = 5;
|
|
bool visible = 6;
|
|
repeated VectorClockEntry deletions = 7;
|
|
repeated VectorClockEntry max_undos = 8;
|
|
}
|
|
|
|
message SelectionSet {
|
|
uint32 replica_id = 1;
|
|
repeated Selection selections = 2;
|
|
uint32 lamport_timestamp = 3;
|
|
}
|
|
|
|
message Selection {
|
|
uint64 id = 1;
|
|
Anchor start = 2;
|
|
Anchor end = 3;
|
|
bool reversed = 4;
|
|
}
|
|
|
|
message Anchor {
|
|
uint32 replica_id = 1;
|
|
uint32 local_timestamp = 2;
|
|
uint64 offset = 3;
|
|
Bias bias = 4;
|
|
}
|
|
|
|
enum Bias {
|
|
Left = 0;
|
|
Right = 1;
|
|
}
|
|
|
|
message UpdateDiagnostics {
|
|
uint32 replica_id = 1;
|
|
uint32 lamport_timestamp = 2;
|
|
repeated Diagnostic diagnostics = 3;
|
|
}
|
|
|
|
message Diagnostic {
|
|
Anchor start = 1;
|
|
Anchor end = 2;
|
|
Severity severity = 3;
|
|
string message = 4;
|
|
optional string code = 5;
|
|
uint64 group_id = 6;
|
|
bool is_primary = 7;
|
|
bool is_valid = 8;
|
|
bool is_disk_based = 9;
|
|
|
|
enum Severity {
|
|
None = 0;
|
|
Error = 1;
|
|
Warning = 2;
|
|
Information = 3;
|
|
Hint = 4;
|
|
}
|
|
}
|
|
|
|
message Operation {
|
|
oneof variant {
|
|
Edit edit = 1;
|
|
Undo undo = 2;
|
|
UpdateSelections update_selections = 3;
|
|
UpdateDiagnostics update_diagnostics = 4;
|
|
UpdateCompletionTriggers update_completion_triggers = 5;
|
|
}
|
|
|
|
message Edit {
|
|
uint32 replica_id = 1;
|
|
uint32 local_timestamp = 2;
|
|
uint32 lamport_timestamp = 3;
|
|
repeated VectorClockEntry version = 4;
|
|
repeated Range ranges = 5;
|
|
optional string new_text = 6;
|
|
}
|
|
|
|
message Undo {
|
|
uint32 replica_id = 1;
|
|
uint32 local_timestamp = 2;
|
|
uint32 lamport_timestamp = 3;
|
|
repeated VectorClockEntry version = 4;
|
|
repeated Range transaction_ranges = 5;
|
|
repeated VectorClockEntry transaction_version = 6;
|
|
repeated UndoCount counts = 7;
|
|
}
|
|
|
|
message UpdateSelections {
|
|
uint32 replica_id = 1;
|
|
uint32 lamport_timestamp = 2;
|
|
repeated Selection selections = 3;
|
|
}
|
|
|
|
message UpdateCompletionTriggers {
|
|
uint32 replica_id = 1;
|
|
uint32 lamport_timestamp = 2;
|
|
repeated string triggers = 3;
|
|
}
|
|
}
|
|
|
|
message UndoMapEntry {
|
|
uint32 replica_id = 1;
|
|
uint32 local_timestamp = 2;
|
|
repeated UndoCount counts = 3;
|
|
}
|
|
|
|
message UndoCount {
|
|
uint32 replica_id = 1;
|
|
uint32 local_timestamp = 2;
|
|
uint32 count = 3;
|
|
}
|
|
|
|
message VectorClockEntry {
|
|
uint32 replica_id = 1;
|
|
uint32 timestamp = 2;
|
|
}
|
|
|
|
message Timestamp {
|
|
uint64 seconds = 1;
|
|
uint32 nanos = 2;
|
|
}
|
|
|
|
message Range {
|
|
uint64 start = 1;
|
|
uint64 end = 2;
|
|
}
|
|
|
|
message Point {
|
|
uint32 row = 1;
|
|
uint32 column = 2;
|
|
}
|
|
|
|
message Nonce {
|
|
uint64 upper_half = 1;
|
|
uint64 lower_half = 2;
|
|
}
|
|
|
|
message Channel {
|
|
uint64 id = 1;
|
|
string name = 2;
|
|
}
|
|
|
|
message ChannelMessage {
|
|
uint64 id = 1;
|
|
string body = 2;
|
|
uint64 timestamp = 3;
|
|
uint64 sender_id = 4;
|
|
Nonce nonce = 5;
|
|
}
|
|
|
|
message Contact {
|
|
uint64 user_id = 1;
|
|
repeated ProjectMetadata projects = 2;
|
|
}
|
|
|
|
message ProjectMetadata {
|
|
uint64 id = 1;
|
|
bool is_shared = 2;
|
|
repeated string worktree_root_names = 3;
|
|
repeated uint64 guests = 4;
|
|
}
|