zls/src/main.zig

1733 lines
69 KiB
Zig
Raw Normal View History

2020-04-24 23:19:03 +01:00
const std = @import("std");
2020-05-07 16:29:40 +01:00
const build_options = @import("build_options");
const Config = @import("config.zig");
const DocumentStore = @import("document_store.zig");
2020-05-17 15:50:13 +01:00
const readRequestHeader = @import("header.zig").readRequestHeader;
2020-05-07 16:29:40 +01:00
const data = @import("data/" ++ build_options.data_version ++ ".zig");
const requests = @import("requests.zig");
const types = @import("types.zig");
const analysis = @import("analysis.zig");
const URI = @import("uri.zig");
2020-07-05 23:32:14 +01:00
const references = @import("references.zig");
2020-06-27 01:16:14 +01:00
const rename = @import("rename.zig");
2020-07-03 00:31:28 +01:00
const offsets = @import("offsets.zig");
const semantic_tokens = @import("semantic_tokens.zig");
const known_folders = @import("known-folders");
2020-04-24 23:19:03 +01:00
2020-08-14 11:41:34 +01:00
const logger = std.log.scoped(.main);
// Always set this to debug to make std.log call into our handler, then control the runtime
// value in the definition below.
pub const log_level = .debug;
var actual_log_level: std.log.Level = switch (std.builtin.mode) {
2020-06-26 12:29:59 +01:00
.Debug => .debug,
else => .notice,
};
pub fn log(
comptime message_level: std.log.Level,
comptime scope: @Type(.EnumLiteral),
comptime format: []const u8,
2020-07-12 20:12:09 +01:00
args: anytype,
2020-06-26 12:29:59 +01:00
) void {
if (@enumToInt(message_level) > @enumToInt(actual_log_level)) {
return;
}
// After shutdown, pipe output to stderr
if (!keep_running) {
std.debug.print("[{s}-{s}] " ++ format, .{ @tagName(message_level), @tagName(scope) } ++ args);
return;
}
var arena = std.heap.ArenaAllocator.init(allocator);
defer arena.deinit();
var message = std.fmt.allocPrint(&arena.allocator, "[{s}-{s}] " ++ format, .{ @tagName(message_level), @tagName(scope) } ++ args) catch |err| {
2020-06-26 12:29:59 +01:00
std.debug.print("Failed to allocPrint message.", .{});
return;
};
2020-06-26 12:29:59 +01:00
if (@enumToInt(message_level) <= @enumToInt(std.log.Level.notice)) {
const message_type: types.MessageType = switch (message_level) {
.info => .Log,
.notice => .Info,
.warn => .Warning,
.err => .Error,
else => .Error,
};
send(&arena, types.Notification{
2020-06-26 12:29:59 +01:00
.method = "window/showMessage",
.params = types.Notification.Params{
.ShowMessage = .{
2020-06-27 01:16:14 +01:00
.type = message_type,
.message = message,
},
2020-06-26 12:29:59 +01:00
},
}) catch |err| {
std.debug.print("Failed to send show message notification (error: {}).", .{err});
};
} else {
const message_type: types.MessageType = if (message_level == .debug)
.Log
else
.Info;
send(&arena, types.Notification{
2020-06-26 12:29:59 +01:00
.method = "window/logMessage",
.params = types.Notification.Params{
.LogMessage = .{
2020-06-27 01:16:14 +01:00
.type = message_type,
.message = message,
},
2020-06-26 12:29:59 +01:00
},
}) catch |err| {
std.debug.print("Failed to send show message notification (error: {}).", .{err});
};
}
}
2020-04-24 23:19:03 +01:00
// Code is largely based off of https://github.com/andersfr/zig-lsp/blob/master/server.zig
2021-01-10 07:12:11 +00:00
var stdout: std.io.BufferedWriter(4096, std.fs.File.Writer) = undefined;
2020-04-24 23:19:03 +01:00
var allocator: *std.mem.Allocator = undefined;
var document_store: DocumentStore = undefined;
const ClientCapabilities = struct {
supports_snippets: bool = false,
supports_semantic_tokens: bool = false,
hover_supports_md: bool = false,
completion_doc_supports_md: bool = false,
};
var client_capabilities = ClientCapabilities{};
var offset_encoding = offsets.Encoding.utf16;
const not_implemented_response =
\\,"error":{"code":-32601,"message":"NotImplemented"}}
2020-04-24 23:19:03 +01:00
;
const null_result_response =
\\,"result":null}
2020-04-24 23:19:03 +01:00
;
const empty_result_response =
\\,"result":{}}
2020-04-24 23:19:03 +01:00
;
const empty_array_response =
\\,"result":[]}
2020-04-24 23:19:03 +01:00
;
const edit_not_applied_response =
\\,"result":{"applied":false,"failureReason":"feature not implemented"}}
2020-04-24 23:19:03 +01:00
;
const no_completions_response =
\\,"result":{"isIncomplete":false,"items":[]}}
2020-04-24 23:19:03 +01:00
;
const no_semantic_tokens_response =
\\,"result":{"data":[]}}
;
2020-04-24 23:19:03 +01:00
/// Sends a request or response
2020-07-12 20:12:09 +01:00
fn send(arena: *std.heap.ArenaAllocator, reqOrRes: anytype) !void {
var arr = std.ArrayList(u8).init(&arena.allocator);
2020-06-27 01:16:14 +01:00
try std.json.stringify(reqOrRes, .{}, arr.writer());
const stdout_stream = stdout.writer();
try stdout_stream.print("Content-Length: {}\r\n\r\n", .{arr.items.len});
try stdout_stream.writeAll(arr.items);
try stdout.flush();
2020-04-24 23:19:03 +01:00
}
2020-06-06 13:40:33 +01:00
fn respondGeneric(id: types.RequestId, response: []const u8) !void {
const id_len = switch (id) {
.Integer => |id_val| blk: {
if (id_val == 0) break :blk 1;
var digits: usize = 1;
var value = @divTrunc(id_val, 10);
while (value != 0) : (value = @divTrunc(value, 10)) {
digits += 1;
}
break :blk digits;
},
.String => |str_val| str_val.len + 2,
else => unreachable,
2020-04-24 23:19:03 +01:00
};
2020-06-06 13:40:33 +01:00
// Numbers of character that will be printed from this string: len - 1 brackets
const json_fmt = "{{\"jsonrpc\":\"2.0\",\"id\":";
2021-01-10 07:12:11 +00:00
const stdout_stream = stdout.writer();
2020-06-10 18:48:40 +01:00
try stdout_stream.print("Content-Length: {}\r\n\r\n" ++ json_fmt, .{response.len + id_len + json_fmt.len - 1});
2020-06-06 13:40:33 +01:00
switch (id) {
.Integer => |int| try stdout_stream.print("{}", .{int}),
.String => |str| try stdout_stream.print("\"{s}\"", .{str}),
2020-06-06 13:40:33 +01:00
else => unreachable,
}
try stdout_stream.writeAll(response);
try stdout.flush();
}
2020-06-09 04:21:55 +01:00
fn showMessage(@"type": types.MessageType, message: []const u8) !void {
try send(types.Notification{
.method = "window/showMessage",
.params = .{
.ShowMessageParams = .{
.@"type" = @"type",
2020-06-10 18:48:40 +01:00
.message = message,
2020-06-09 04:21:55 +01:00
},
},
});
}
// TODO: Is this correct or can we get a better end?
fn astLocationToRange(loc: std.zig.ast.Tree.Location) types.Range {
return .{
.start = .{
.line = @intCast(i64, loc.line),
.character = @intCast(i64, loc.column),
},
.end = .{
.line = @intCast(i64, loc.line),
.character = @intCast(i64, loc.column),
},
};
}
fn publishDiagnostics(arena: *std.heap.ArenaAllocator, handle: DocumentStore.Handle, config: Config) !void {
2020-05-24 17:00:21 +01:00
const tree = handle.tree;
2020-04-24 23:19:03 +01:00
var diagnostics = std.ArrayList(types.Diagnostic).init(&arena.allocator);
2020-04-24 23:19:03 +01:00
for (tree.errors) |err| {
const loc = tree.tokenLocation(0, err.token);
var mem_buffer: [256]u8 = undefined;
var fbs = std.io.fixedBufferStream(&mem_buffer);
2021-01-10 07:12:11 +00:00
try tree.renderError(err, fbs.writer());
try diagnostics.append(.{
.range = astLocationToRange(loc),
.severity = .Error,
.code = @tagName(err.tag),
.source = "zls",
.message = try std.mem.dupe(&arena.allocator, u8, fbs.getWritten()),
// .relatedInformation = undefined
});
}
if (tree.errors.len == 0) {
for (tree.rootDecls()) |decl_idx| {
const decl = tree.nodes.items(.tag)[decl_idx];
switch (decl) {
.fn_proto => blk: {
const func = tree.fnProto(decl_idx);
const is_extern = func.extern_export_token != null;
if (is_extern)
2020-05-08 18:02:46 +01:00
break :blk;
2020-05-15 20:10:53 +01:00
if (config.warn_style) {
if (func.name_token) |name_token| {
2020-05-15 20:10:53 +01:00
const loc = tree.tokenLocation(0, name_token);
2020-05-17 15:23:04 +01:00
const is_type_function = analysis.isTypeFunction(tree, func);
2020-05-15 20:10:53 +01:00
const func_name = tree.tokenSlice(name_token);
if (!is_type_function and !analysis.isCamelCase(func_name)) {
try diagnostics.append(.{
.range = astLocationToRange(loc),
.severity = .Information,
.code = "BadStyle",
.source = "zls",
.message = "Functions should be camelCase",
});
} else if (is_type_function and !analysis.isPascalCase(func_name)) {
try diagnostics.append(.{
.range = astLocationToRange(loc),
.severity = .Information,
.code = "BadStyle",
.source = "zls",
.message = "Type functions should be PascalCase",
});
}
2020-05-04 03:17:19 +01:00
}
}
},
else => {},
2020-05-04 03:17:19 +01:00
}
}
2020-04-24 23:19:03 +01:00
}
try send(arena, types.Notification{
.method = "textDocument/publishDiagnostics",
.params = .{
.PublishDiagnostics = .{
.uri = handle.uri(),
2020-05-07 11:56:08 +01:00
.diagnostics = diagnostics.items,
},
2020-05-07 14:23:13 +01:00
},
});
}
2020-04-24 23:19:03 +01:00
fn typeToCompletion(
arena: *std.heap.ArenaAllocator,
list: *std.ArrayList(types.CompletionItem),
field_access: analysis.FieldAccessReturn,
orig_handle: *DocumentStore.Handle,
config: Config,
) error{OutOfMemory}!void {
const type_handle = field_access.original;
switch (type_handle.type.data) {
.slice => {
if (!type_handle.type.is_type_val) {
try list.append(.{
.label = "len",
.kind = .Field,
});
try list.append(.{
.label = "ptr",
.kind = .Field,
});
}
},
.error_union => {},
.pointer => |n| {
if (config.operator_completions) {
try list.append(.{
.label = "*",
.kind = .Operator,
});
}
try nodeToCompletion(
arena,
list,
.{ .node = n, .handle = type_handle.handle },
null,
orig_handle,
type_handle.type.is_type_val,
config,
);
},
.other => |n| try nodeToCompletion(
arena,
list,
.{ .node = n, .handle = type_handle.handle },
field_access.unwrapped,
orig_handle,
type_handle.type.is_type_val,
config,
),
.primitive => {},
}
}
fn nodeToCompletion(
2020-06-10 19:24:17 +01:00
arena: *std.heap.ArenaAllocator,
list: *std.ArrayList(types.CompletionItem),
2020-06-10 17:54:01 +01:00
node_handle: analysis.NodeWithHandle,
unwrapped: ?analysis.TypeWithHandle,
2020-06-10 18:48:40 +01:00
orig_handle: *DocumentStore.Handle,
is_type_val: bool,
config: Config,
) error{OutOfMemory}!void {
2020-06-10 18:48:40 +01:00
const node = node_handle.node;
const handle = node_handle.handle;
2021-03-01 15:02:24 +00:00
const tree = handle.tree;
const node_tags = tree.nodes.items(.tag);
const datas = tree.nodes.items(.data);
const token_tags = tree.tokens.items(.tag);
2020-06-10 18:48:40 +01:00
const doc_kind: types.MarkupContent.Kind = if (client_capabilities.completion_doc_supports_md)
.Markdown
else
.PlainText;
const doc = if (try analysis.getDocComments(
list.allocator,
handle.tree,
node,
doc_kind,
)) |doc_comments|
types.MarkupContent{
.kind = doc_kind,
.value = doc_comments,
}
else
null;
2021-03-01 15:02:24 +00:00
if (analysis.isContainer(node_tags[node])) {
const context = DeclToCompletionContext{
.completions = list,
.config = &config,
.arena = arena,
.orig_handle = orig_handle,
};
try analysis.iterateSymbolsContainer(&document_store, arena, node_handle, orig_handle, declToCompletion, context, !is_type_val);
}
if (is_type_val) return;
2021-03-01 15:02:24 +00:00
switch (node_tags[node]) {
2021-03-01 15:30:43 +00:00
.fn_proto, .fn_proto_multi, .fn_proto_one, .fn_decl => {
2021-03-01 15:02:24 +00:00
var buf: [1]std.zig.ast.Node.Index = undefined;
const func = analysis.fnProto(tree, node, &buf).?;
if (func.name_token) |name_token| {
const use_snippets = config.enable_snippets and client_capabilities.supports_snippets;
const insert_text = if (use_snippets) blk: {
// TODO Also check if we are dot accessing from a type val and dont skip in that case.
2021-03-01 15:02:24 +00:00
const skip_self_param = if (func.ast.params.len > 0) param_check: {
const in_container = analysis.innermostContainer(handle, tree.tokenLocation(0, func.ast.fn_token).line_start);
var it = func.iterate(tree);
const param = it.next().?;
if (try analysis.resolveTypeOfNode(&document_store, arena, .{
.node = param.type_expr,
.handle = handle,
})) |resolved_type| {
if (std.meta.eql(in_container, resolved_type))
break :param_check true;
}
if (analysis.isPtrType(tree, param.type_expr)) {
if (try analysis.resolveTypeOfNode(&document_store, arena, .{
.node = datas[param.type_expr].rhs,
.handle = handle,
})) |resolved_prefix_op| {
if (std.meta.eql(in_container, resolved_prefix_op))
break :param_check true;
}
}
2021-03-01 15:02:24 +00:00
break :param_check false;
} else false;
2020-06-10 19:24:17 +01:00
2021-03-01 15:02:24 +00:00
break :blk try analysis.getFunctionSnippet(&arena.allocator, tree, func, skip_self_param);
} else null;
2020-06-10 19:24:17 +01:00
const is_type_function = analysis.isTypeFunction(handle.tree, func);
2020-05-17 15:23:04 +01:00
try list.append(.{
2020-06-10 19:24:17 +01:00
.label = handle.tree.tokenSlice(name_token),
2020-05-17 15:23:04 +01:00
.kind = if (is_type_function) .Struct else .Function,
.documentation = doc,
2020-06-10 19:24:17 +01:00
.detail = analysis.getFunctionSignature(handle.tree, func),
.insertText = insert_text,
.insertTextFormat = if (use_snippets) .Snippet else .PlainText,
2020-05-17 15:23:04 +01:00
});
}
},
2021-03-01 15:02:24 +00:00
.global_var_decl, .local_var_decl, .aligned_var_decl, .simple_var_decl => {
const var_decl = analysis.varDecl(tree, node).?;
const is_const = token_tags[var_decl.ast.mut_token] == .keyword_const;
2020-06-14 23:19:21 +01:00
if (try analysis.resolveVarDeclAlias(&document_store, arena, node_handle)) |result| {
const context = DeclToCompletionContext{
.completions = list,
.config = &config,
.arena = arena,
.orig_handle = orig_handle,
};
return try declToCompletion(context, result);
}
2020-05-17 15:23:04 +01:00
try list.append(.{
2021-03-01 15:02:24 +00:00
.label = handle.tree.tokenSlice(var_decl.ast.mut_token + 1),
2020-05-17 15:23:04 +01:00
.kind = if (is_const) .Constant else .Variable,
.documentation = doc,
2021-03-01 15:02:24 +00:00
.detail = analysis.getVariableSignature(tree, var_decl),
2020-05-17 15:23:04 +01:00
});
},
2021-03-01 15:02:24 +00:00
.container_field, .container_field_align, .container_field_init => {
const field = analysis.containerField(tree, node).?;
2020-06-10 23:00:13 +01:00
try list.append(.{
2021-03-01 15:02:24 +00:00
.label = handle.tree.tokenSlice(field.ast.name_token),
2020-06-10 23:00:13 +01:00
.kind = .Field,
.documentation = doc,
.detail = analysis.getContainerFieldSignature(handle.tree, field),
});
},
2021-03-01 15:02:24 +00:00
.array_type, .array_type_sentinel => {
try list.append(.{
.label = "len",
.kind = .Field,
});
},
2021-03-01 15:02:24 +00:00
.ptr_type, .ptr_type_aligned, .ptr_type_bit_range, .ptr_type_sentinel => {
const ptr_type = analysis.ptrType(tree, node).?;
switch (ptr_type.size) {
.One, .C => if (config.operator_completions) {
try list.append(.{
.label = "*",
.kind = .Operator,
});
},
.Many, .Slice => return list.append(.{ .label = "len", .kind = .Field }),
2020-07-16 17:04:23 +01:00
}
2021-03-01 15:02:24 +00:00
if (unwrapped) |actual_type| {
2020-07-16 17:04:23 +01:00
try typeToCompletion(arena, list, .{ .original = actual_type }, orig_handle, config);
2020-05-27 16:49:11 +01:00
}
2020-07-16 17:04:23 +01:00
return;
},
2021-03-01 15:02:24 +00:00
.optional_type => {
2020-07-16 17:04:23 +01:00
if (config.operator_completions) {
try list.append(.{
.label = "?",
.kind = .Operator,
});
}
return;
},
2021-03-01 15:02:24 +00:00
.string_literal => {
2020-05-17 15:23:04 +01:00
try list.append(.{
.label = "len",
.kind = .Field,
});
},
2020-06-10 18:48:40 +01:00
else => if (analysis.nodeToString(handle.tree, node)) |string| {
2020-05-17 15:23:04 +01:00
try list.append(.{
.label = string,
.kind = .Field,
.documentation = doc,
2021-03-01 15:02:24 +00:00
.detail = tree.getNodeSource(node),
2020-05-17 15:23:04 +01:00
});
},
}
}
2020-05-18 21:19:23 +01:00
fn identifierFromPosition(pos_index: usize, handle: DocumentStore.Handle) []const u8 {
2020-05-22 23:03:41 +01:00
const text = handle.document.text;
if (pos_index + 1 >= text.len) return &[0]u8{};
2020-05-18 21:19:23 +01:00
var start_idx = pos_index;
2020-05-18 21:19:23 +01:00
while (start_idx > 0 and
2020-05-22 23:03:41 +01:00
(std.ascii.isAlNum(text[start_idx]) or text[start_idx] == '_')) : (start_idx -= 1)
2020-05-18 21:19:23 +01:00
{}
var end_idx = pos_index;
while (end_idx < handle.document.text.len and
2020-05-22 23:03:41 +01:00
(std.ascii.isAlNum(text[end_idx]) or text[end_idx] == '_')) : (end_idx += 1)
2020-05-18 21:19:23 +01:00
{}
if (end_idx <= start_idx) return &[0]u8{};
2020-05-22 23:58:47 +01:00
return text[start_idx + 1 .. end_idx];
2020-05-18 21:19:23 +01:00
}
fn gotoDefinitionSymbol(id: types.RequestId, arena: *std.heap.ArenaAllocator, decl_handle: analysis.DeclWithHandle, resolve_alias: bool) !void {
2020-06-10 18:48:40 +01:00
var handle = decl_handle.handle;
const location = switch (decl_handle.decl.*) {
.ast_node => |node| block: {
if (resolve_alias) {
if (try analysis.resolveVarDeclAlias(&document_store, arena, .{ .node = node, .handle = handle })) |result| {
handle = result.handle;
2020-07-07 09:57:02 +01:00
break :block result.location(offset_encoding) catch return;
}
2020-06-14 23:19:21 +01:00
}
2020-06-10 18:48:40 +01:00
2020-06-14 23:19:21 +01:00
const name_token = analysis.getDeclNameToken(handle.tree, node) orelse
return try respondGeneric(id, null_result_response);
2020-07-07 09:57:02 +01:00
break :block offsets.tokenRelativeLocation(handle.tree, 0, name_token, offset_encoding) catch return;
},
2020-07-07 09:57:02 +01:00
else => decl_handle.location(offset_encoding) catch return,
};
try send(arena, types.Response{
2020-06-06 13:40:33 +01:00
.id = id,
.result = .{
.Location = .{
.uri = handle.document.uri,
2020-07-07 09:57:02 +01:00
.range = .{
.start = .{
.line = @intCast(i64, location.line),
.character = @intCast(i64, location.column),
},
.end = .{
.line = @intCast(i64, location.line),
.character = @intCast(i64, location.column),
},
},
},
},
});
}
2021-03-01 15:02:24 +00:00
fn hoverSymbol(
id: types.RequestId,
arena: *std.heap.ArenaAllocator,
decl_handle: analysis.DeclWithHandle,
) (std.os.WriteError || error{OutOfMemory})!void {
const handle = decl_handle.handle;
2021-03-01 15:02:24 +00:00
const tree = handle.tree;
const hover_kind: types.MarkupContent.Kind = if (client_capabilities.hover_supports_md) .Markdown else .PlainText;
const md_string = switch (decl_handle.decl.*) {
.ast_node => |node| ast_node: {
2020-06-14 23:19:21 +01:00
if (try analysis.resolveVarDeclAlias(&document_store, arena, .{ .node = node, .handle = handle })) |result| {
return try hoverSymbol(id, arena, result);
}
2020-06-03 09:23:14 +01:00
2021-03-01 15:02:24 +00:00
const doc_str = if (try analysis.getDocComments(&arena.allocator, tree, node, hover_kind)) |str|
2020-06-10 18:48:40 +01:00
str
else
"";
2021-03-01 15:02:24 +00:00
var buf: [1]std.zig.ast.Node.Index = undefined;
const signature_str = if (analysis.varDecl(tree, node)) |var_decl| blk: {
break :blk analysis.getVariableSignature(tree, var_decl);
} else if (analysis.fnProto(tree, node, &buf)) |fn_proto| blk: {
break :blk analysis.getFunctionSignature(tree, fn_proto);
} else if (analysis.containerField(tree, node)) |field| blk: {
break :blk analysis.getContainerFieldSignature(tree, field);
} else analysis.nodeToString(tree, node) orelse
return try respondGeneric(id, null_result_response);
2020-06-10 18:48:40 +01:00
break :ast_node if (hover_kind == .Markdown)
try std.fmt.allocPrint(&arena.allocator, "```zig\n{s}\n```\n{s}", .{ signature_str, doc_str })
else
try std.fmt.allocPrint(&arena.allocator, "{s}\n{s}", .{ signature_str, doc_str });
},
.param_decl => |param| param_decl: {
2021-03-01 15:02:24 +00:00
const doc_str = if (param.first_doc_comment) |doc_comments|
try analysis.collectDocComments(&arena.allocator, handle.tree, doc_comments, hover_kind)
else
"";
2021-03-01 15:02:24 +00:00
const first_token = param.first_doc_comment orelse
param.comptime_noalias orelse
param.name_token orelse
param.anytype_ellipsis3 orelse
tree.firstToken(param.type_expr);
const last_token = tree.lastToken(param.type_expr);
const signature_str = tree.source[tree.tokenLocation(0, first_token).line_start..tree.tokenLocation(0, last_token).line_end];
break :param_decl if (hover_kind == .Markdown)
try std.fmt.allocPrint(&arena.allocator, "```zig\n{s}\n```\n{s}", .{ signature_str, doc_str })
else
try std.fmt.allocPrint(&arena.allocator, "{s}\n{s}", .{ signature_str, doc_str });
},
.pointer_payload => |payload| if (hover_kind == .Markdown)
2021-03-01 15:02:24 +00:00
try std.fmt.allocPrint(&arena.allocator, "```zig\n{s}\n```", .{tree.tokenSlice(payload.name)})
else
2021-03-01 15:02:24 +00:00
try std.fmt.allocPrint(&arena.allocator, "{s}", .{tree.tokenSlice(payload.name)}),
2021-03-01 13:32:19 +00:00
// .array_payload => |payload| if (hover_kind == .Markdown)
// try std.fmt.allocPrint(&arena.allocator, "```zig\n{s}\n```", .{handle.tree.tokenSlice(payload.identifier.firstToken())})
// else
// try std.fmt.allocPrint(&arena.allocator, "{s}", .{handle.tree.tokenSlice(payload.identifier.firstToken())}),
.switch_payload => |payload| if (hover_kind == .Markdown)
2021-03-01 15:02:24 +00:00
try std.fmt.allocPrint(&arena.allocator, "```zig\n{s}\n```", .{tree.tokenSlice(payload.node)})
else
2021-03-01 15:02:24 +00:00
try std.fmt.allocPrint(&arena.allocator, "{s}", .{tree.tokenSlice(payload.node)}),
2020-06-14 20:24:18 +01:00
.label_decl => |label_decl| block: {
2021-03-01 15:02:24 +00:00
const source = tree.tokenSlice(label_decl);
2020-06-14 20:24:18 +01:00
break :block if (hover_kind == .Markdown)
try std.fmt.allocPrint(&arena.allocator, "```zig\n{s}\n```", .{source})
2020-06-14 20:24:18 +01:00
else
try std.fmt.allocPrint(&arena.allocator, "```{s}```", .{source});
2020-06-14 20:24:18 +01:00
},
};
try send(arena, types.Response{
.id = id,
.result = .{
.Hover = .{
.contents = .{ .value = md_string },
},
},
});
}
2020-06-14 20:24:18 +01:00
fn getLabelGlobal(pos_index: usize, handle: *DocumentStore.Handle) !?analysis.DeclWithHandle {
const name = identifierFromPosition(pos_index, handle.*);
if (name.len == 0) return null;
return try analysis.lookupLabel(handle, name, pos_index);
}
fn getSymbolGlobal(arena: *std.heap.ArenaAllocator, pos_index: usize, handle: *DocumentStore.Handle) !?analysis.DeclWithHandle {
const name = identifierFromPosition(pos_index, handle.*);
if (name.len == 0) return null;
2020-06-11 00:40:11 +01:00
return try analysis.lookupSymbolGlobal(&document_store, arena, handle, name, pos_index);
}
fn gotoDefinitionLabel(arena: *std.heap.ArenaAllocator, id: types.RequestId, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
2020-06-14 20:24:18 +01:00
const decl = (try getLabelGlobal(pos_index, handle)) orelse return try respondGeneric(id, null_result_response);
return try gotoDefinitionSymbol(id, arena, decl, false);
2020-06-14 20:24:18 +01:00
}
fn gotoDefinitionGlobal(arena: *std.heap.ArenaAllocator, id: types.RequestId, pos_index: usize, handle: *DocumentStore.Handle, config: Config, resolve_alias: bool) !void {
const decl = (try getSymbolGlobal(arena, pos_index, handle)) orelse return try respondGeneric(id, null_result_response);
return try gotoDefinitionSymbol(id, arena, decl, resolve_alias);
}
2020-05-18 21:19:23 +01:00
fn hoverDefinitionLabel(arena: *std.heap.ArenaAllocator, id: types.RequestId, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
2020-06-14 20:24:18 +01:00
const decl = (try getLabelGlobal(pos_index, handle)) orelse return try respondGeneric(id, null_result_response);
return try hoverSymbol(id, arena, decl);
2020-06-14 20:24:18 +01:00
}
2020-11-04 22:54:47 +00:00
fn hoverDefinitionBuiltin(arena: *std.heap.ArenaAllocator, id: types.RequestId, pos_index: usize, handle: *DocumentStore.Handle) !void {
const name = identifierFromPosition(pos_index, handle.*);
if (name.len == 0) return try respondGeneric(id, null_result_response);
inline for (data.builtins) |builtin| {
if (std.mem.eql(u8, builtin.name[1..], name)) {
try send(arena, types.Response{
.id = id,
.result = .{
.Hover = .{
.contents = .{ .value = try std.fmt.allocPrint(&arena.allocator, "```zig\n{s}\n```\n{s}", .{ builtin.signature, builtin.documentation }) },
2020-11-04 22:54:47 +00:00
},
},
});
}
}
}
fn hoverDefinitionGlobal(arena: *std.heap.ArenaAllocator, id: types.RequestId, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
const decl = (try getSymbolGlobal(arena, pos_index, handle)) orelse return try respondGeneric(id, null_result_response);
return try hoverSymbol(id, arena, decl);
2020-05-18 21:19:23 +01:00
}
fn getSymbolFieldAccess(
2020-06-10 18:48:40 +01:00
handle: *DocumentStore.Handle,
arena: *std.heap.ArenaAllocator,
2020-07-03 00:31:28 +01:00
position: offsets.DocumentPosition,
range: analysis.SourceRange,
config: Config,
2020-06-10 18:48:40 +01:00
) !?analysis.DeclWithHandle {
2020-07-03 00:31:28 +01:00
const name = identifierFromPosition(position.absolute_index, handle.*);
if (name.len == 0) return null;
2020-07-03 00:31:28 +01:00
var tokenizer = std.zig.Tokenizer.init(position.line[range.start..range.end]);
if (try analysis.getFieldAccessType(&document_store, arena, handle, position.absolute_index, &tokenizer)) |result| {
2020-07-07 21:50:32 +01:00
const container_handle = result.unwrapped orelse result.original;
const container_handle_node = switch (container_handle.type.data) {
.other => |n| n,
else => return null,
};
return try analysis.lookupSymbolContainer(
&document_store,
arena,
.{ .node = container_handle_node, .handle = container_handle.handle },
name,
true,
);
}
return null;
}
fn gotoDefinitionFieldAccess(
arena: *std.heap.ArenaAllocator,
2020-06-06 13:40:33 +01:00
id: types.RequestId,
handle: *DocumentStore.Handle,
2020-07-03 00:31:28 +01:00
position: offsets.DocumentPosition,
range: analysis.SourceRange,
config: Config,
resolve_alias: bool,
) !void {
const decl = (try getSymbolFieldAccess(handle, arena, position, range, config)) orelse return try respondGeneric(id, null_result_response);
return try gotoDefinitionSymbol(id, arena, decl, resolve_alias);
}
2020-05-18 21:19:23 +01:00
fn hoverDefinitionFieldAccess(
arena: *std.heap.ArenaAllocator,
2020-06-06 13:40:33 +01:00
id: types.RequestId,
handle: *DocumentStore.Handle,
2020-07-03 00:31:28 +01:00
position: offsets.DocumentPosition,
range: analysis.SourceRange,
config: Config,
) !void {
const decl = (try getSymbolFieldAccess(handle, arena, position, range, config)) orelse return try respondGeneric(id, null_result_response);
return try hoverSymbol(id, arena, decl);
2020-05-18 21:19:23 +01:00
}
fn gotoDefinitionString(arena: *std.heap.ArenaAllocator, id: types.RequestId, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
2020-05-24 17:00:21 +01:00
const tree = handle.tree;
2021-03-01 13:32:19 +00:00
const import_str = analysis.getImportStr(tree, 0, pos_index) orelse return try respondGeneric(id, null_result_response);
const uri = (try document_store.uriFromImportStr(
&arena.allocator,
handle.*,
import_str,
)) orelse return try respondGeneric(id, null_result_response);
try send(arena, types.Response{
2020-06-06 13:40:33 +01:00
.id = id,
.result = .{
.Location = .{
.uri = uri,
.range = .{
.start = .{ .line = 0, .character = 0 },
.end = .{ .line = 0, .character = 0 },
},
},
},
});
}
fn renameDefinitionGlobal(arena: *std.heap.ArenaAllocator, id: types.RequestId, handle: *DocumentStore.Handle, pos_index: usize, new_name: []const u8) !void {
const decl = (try getSymbolGlobal(arena, pos_index, handle)) orelse return try respondGeneric(id, null_result_response);
2020-06-27 13:29:45 +01:00
var workspace_edit = types.WorkspaceEdit{
.changes = std.StringHashMap([]types.TextEdit).init(&arena.allocator),
};
2020-07-04 23:40:18 +01:00
try rename.renameSymbol(arena, &document_store, decl, new_name, &workspace_edit.changes.?, offset_encoding);
try send(arena, types.Response{
2020-06-27 13:29:45 +01:00
.id = id,
.result = .{ .WorkspaceEdit = workspace_edit },
});
2020-06-27 01:16:14 +01:00
}
2020-06-27 13:29:45 +01:00
fn renameDefinitionFieldAccess(
arena: *std.heap.ArenaAllocator,
2020-06-27 13:29:45 +01:00
id: types.RequestId,
handle: *DocumentStore.Handle,
2020-07-03 00:31:28 +01:00
position: offsets.DocumentPosition,
2020-06-27 13:29:45 +01:00
range: analysis.SourceRange,
new_name: []const u8,
config: Config,
) !void {
const decl = (try getSymbolFieldAccess(handle, arena, position, range, config)) orelse return try respondGeneric(id, null_result_response);
2020-06-27 13:29:45 +01:00
var workspace_edit = types.WorkspaceEdit{
.changes = std.StringHashMap([]types.TextEdit).init(&arena.allocator),
};
2020-07-04 23:40:18 +01:00
try rename.renameSymbol(arena, &document_store, decl, new_name, &workspace_edit.changes.?, offset_encoding);
try send(arena, types.Response{
2020-06-27 13:29:45 +01:00
.id = id,
.result = .{ .WorkspaceEdit = workspace_edit },
});
2020-06-27 01:16:14 +01:00
}
fn renameDefinitionLabel(arena: *std.heap.ArenaAllocator, id: types.RequestId, handle: *DocumentStore.Handle, pos_index: usize, new_name: []const u8) !void {
2020-06-27 01:16:14 +01:00
const decl = (try getLabelGlobal(pos_index, handle)) orelse return try respondGeneric(id, null_result_response);
var workspace_edit = types.WorkspaceEdit{
.changes = std.StringHashMap([]types.TextEdit).init(&arena.allocator),
};
2020-07-04 23:40:18 +01:00
try rename.renameLabel(arena, decl, new_name, &workspace_edit.changes.?, offset_encoding);
try send(arena, types.Response{
2020-06-27 01:16:14 +01:00
.id = id,
.result = .{ .WorkspaceEdit = workspace_edit },
});
}
2020-07-05 23:32:14 +01:00
fn referencesDefinitionGlobal(arena: *std.heap.ArenaAllocator, id: types.RequestId, handle: *DocumentStore.Handle, pos_index: usize, include_decl: bool) !void {
const decl = (try getSymbolGlobal(arena, pos_index, handle)) orelse return try respondGeneric(id, null_result_response);
var locs = std.ArrayList(types.Location).init(&arena.allocator);
try references.symbolReferences(arena, &document_store, decl, offset_encoding, include_decl, &locs, std.ArrayList(types.Location).append);
try send(arena, types.Response{
.id = id,
.result = .{ .Locations = locs.items },
});
}
fn referencesDefinitionFieldAccess(
arena: *std.heap.ArenaAllocator,
id: types.RequestId,
handle: *DocumentStore.Handle,
position: offsets.DocumentPosition,
range: analysis.SourceRange,
include_decl: bool,
config: Config,
) !void {
const decl = (try getSymbolFieldAccess(handle, arena, position, range, config)) orelse return try respondGeneric(id, null_result_response);
var locs = std.ArrayList(types.Location).init(&arena.allocator);
try references.symbolReferences(arena, &document_store, decl, offset_encoding, include_decl, &locs, std.ArrayList(types.Location).append);
try send(arena, types.Response{
.id = id,
.result = .{ .Locations = locs.items },
});
}
fn referencesDefinitionLabel(arena: *std.heap.ArenaAllocator, id: types.RequestId, handle: *DocumentStore.Handle, pos_index: usize, include_decl: bool) !void {
const decl = (try getLabelGlobal(pos_index, handle)) orelse return try respondGeneric(id, null_result_response);
var locs = std.ArrayList(types.Location).init(&arena.allocator);
try references.labelReferences(arena, decl, offset_encoding, include_decl, &locs, std.ArrayList(types.Location).append);
try send(arena, types.Response{
.id = id,
.result = .{ .Locations = locs.items },
});
}
const DeclToCompletionContext = struct {
completions: *std.ArrayList(types.CompletionItem),
config: *const Config,
arena: *std.heap.ArenaAllocator,
2020-06-10 18:48:40 +01:00
orig_handle: *DocumentStore.Handle,
};
2021-03-01 13:32:19 +00:00
fn hasComment(tree: ast.Tree, start_token: ast.TokenIndex, end_token: ast.TokenIndex) bool {
const token_starts = tree.tokens.items(.start);
const start = token_starts[start_token];
const end = token_starts[end_token];
return std.mem.indexOf(u8, tree.source[start..end], "//") != null;
}
2020-06-11 00:40:11 +01:00
fn declToCompletion(context: DeclToCompletionContext, decl_handle: analysis.DeclWithHandle) !void {
const tree = decl_handle.handle.tree;
switch (decl_handle.decl.*) {
.ast_node => |node| try nodeToCompletion(context.arena, context.completions, .{ .node = node, .handle = decl_handle.handle }, null, context.orig_handle, false, context.config.*),
.param_decl => |param| {
const doc_kind: types.MarkupContent.Kind = if (client_capabilities.completion_doc_supports_md) .Markdown else .PlainText;
2021-03-01 13:32:19 +00:00
const doc = if (param.first_doc_comment) |doc_comments|
types.MarkupContent{
.kind = doc_kind,
.value = try analysis.collectDocComments(&context.arena.allocator, tree, doc_comments, doc_kind),
}
else
null;
2021-03-01 13:32:19 +00:00
const first_token = param.first_doc_comment orelse
param.comptime_noalias orelse
param.name_token orelse
param.anytype_ellipsis3 orelse
tree.firstToken(param.type_expr);
const last_token = tree.lastToken(param.type_expr);
try context.completions.append(.{
.label = tree.tokenSlice(param.name_token.?),
.kind = .Constant,
.documentation = doc,
2021-03-01 13:32:19 +00:00
.detail = tree.source[tree.tokenLocation(0, first_token).line_start..tree.tokenLocation(0, last_token).line_end],
});
},
.pointer_payload => |payload| {
try context.completions.append(.{
2021-03-01 13:32:19 +00:00
.label = tree.tokenSlice(payload.name),
.kind = .Variable,
});
},
2021-03-01 13:32:19 +00:00
// .array_payload => |payload| {
// try context.completions.append(.{
// .label = tree.tokenSlice(payload.identifier.firstToken()),
// .kind = .Variable,
// });
// },
.switch_payload => |payload| {
try context.completions.append(.{
2021-03-01 13:32:19 +00:00
.label = tree.tokenSlice(tree.firstToken(payload.node)),
.kind = .Variable,
});
},
2020-06-14 20:24:18 +01:00
.label_decl => |label_decl| {
try context.completions.append(.{
2021-03-01 13:32:19 +00:00
.label = tree.tokenSlice(label_decl),
2020-06-14 20:24:18 +01:00
.kind = .Variable,
});
},
}
}
fn completeLabel(arena: *std.heap.ArenaAllocator, id: types.RequestId, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
2020-06-14 20:24:18 +01:00
var completions = std.ArrayList(types.CompletionItem).init(&arena.allocator);
const context = DeclToCompletionContext{
.completions = &completions,
.config = &config,
.arena = arena,
2020-06-14 20:24:18 +01:00
.orig_handle = handle,
};
try analysis.iterateLabels(handle, pos_index, declToCompletion, context);
try send(arena, types.Response{
2020-06-14 20:24:18 +01:00
.id = id,
.result = .{
.CompletionList = .{
.isIncomplete = false,
.items = completions.items,
},
},
});
}
2020-11-04 22:39:24 +00:00
var builtin_completions: ?[]types.CompletionItem = null;
fn completeBuiltin(arena: *std.heap.ArenaAllocator, id: types.RequestId, config: Config) !void {
if (builtin_completions == null) {
builtin_completions = try allocator.alloc(types.CompletionItem, data.builtins.len);
for (data.builtins) |builtin, idx| {
builtin_completions.?[idx] = types.CompletionItem{
.label = builtin.name,
.kind = .Function,
.filterText = builtin.name[1..],
.detail = builtin.signature,
.documentation = .{
.kind = .Markdown,
.value = builtin.documentation,
},
};
if (config.enable_snippets) {
builtin_completions.?[idx].insertText = builtin.snippet[1..];
builtin_completions.?[idx].insertTextFormat = .Snippet;
} else {
builtin_completions.?[idx].insertText = builtin.name[1..];
}
}
}
try send(arena, types.Response{
.id = id,
.result = .{
.CompletionList = .{
.isIncomplete = false,
.items = builtin_completions.?,
},
},
});
}
fn completeGlobal(arena: *std.heap.ArenaAllocator, id: types.RequestId, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
var completions = std.ArrayList(types.CompletionItem).init(&arena.allocator);
2020-05-07 11:56:08 +01:00
const context = DeclToCompletionContext{
.completions = &completions,
.config = &config,
.arena = arena,
2020-06-10 18:48:40 +01:00
.orig_handle = handle,
};
try analysis.iterateSymbolsGlobal(&document_store, arena, handle, pos_index, declToCompletion, context);
2020-06-09 04:21:55 +01:00
try send(arena, types.Response{
2020-06-06 13:40:33 +01:00
.id = id,
.result = .{
.CompletionList = .{
.isIncomplete = false,
2020-05-07 11:56:08 +01:00
.items = completions.items,
},
},
});
2020-04-24 23:19:03 +01:00
}
2020-07-03 00:31:28 +01:00
fn completeFieldAccess(
arena: *std.heap.ArenaAllocator,
id: types.RequestId,
handle: *DocumentStore.Handle,
position: offsets.DocumentPosition,
range: analysis.SourceRange,
config: Config,
) !void {
var completions = std.ArrayList(types.CompletionItem).init(&arena.allocator);
2020-07-03 00:31:28 +01:00
var tokenizer = std.zig.Tokenizer.init(position.line[range.start..range.end]);
if (try analysis.getFieldAccessType(&document_store, arena, handle, position.absolute_index, &tokenizer)) |result| {
try typeToCompletion(arena, &completions, result, handle, config);
}
2020-06-10 18:48:40 +01:00
try send(arena, types.Response{
2020-06-06 13:40:33 +01:00
.id = id,
.result = .{
.CompletionList = .{
.isIncomplete = false,
.items = completions.items,
},
},
});
2020-05-11 13:28:08 +01:00
}
fn documentSymbol(arena: *std.heap.ArenaAllocator, id: types.RequestId, handle: *DocumentStore.Handle) !void {
try send(arena, types.Response{
2020-06-06 13:40:33 +01:00
.id = id,
2020-07-07 09:57:02 +01:00
.result = .{ .DocumentSymbols = try analysis.getDocumentSymbols(&arena.allocator, handle.tree, offset_encoding) },
});
}
fn loadConfig(folder_path: []const u8) ?Config {
var folder = std.fs.cwd().openDir(folder_path, .{}) catch return null;
defer folder.close();
const file_buf = folder.readFileAlloc(allocator, "zls.json", 0x1000000) catch |err| {
if (err != error.FileNotFound)
logger.warn("Error while reading configuration file: {}", .{err});
return null;
};
defer allocator.free(file_buf);
// TODO: Better errors? Doesn't seem like std.json can provide us positions or context.
var config = std.json.parse(Config, &std.json.TokenStream.init(file_buf), std.json.ParseOptions{ .allocator = allocator }) catch |err| {
logger.warn("Error while parsing configuration file: {}", .{err});
return null;
};
if (config.zig_lib_path) |zig_lib_path| {
if (!std.fs.path.isAbsolute(zig_lib_path)) {
logger.warn("zig library path is not absolute, defaulting to null.", .{});
allocator.free(zig_lib_path);
config.zig_lib_path = null;
}
}
return config;
}
fn initializeHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.Initialize, config: Config) !void {
for (req.params.capabilities.offsetEncoding.value) |encoding| {
if (std.mem.eql(u8, encoding, "utf-8")) {
offset_encoding = .utf8;
}
}
if (req.params.capabilities.textDocument) |textDocument| {
client_capabilities.supports_semantic_tokens = textDocument.semanticTokens.exists;
if (textDocument.hover) |hover| {
for (hover.contentFormat.value) |format| {
if (std.mem.eql(u8, "markdown", format)) {
client_capabilities.hover_supports_md = true;
}
2020-06-16 16:49:31 +01:00
}
}
if (textDocument.completion) |completion| {
if (completion.completionItem) |completionItem| {
client_capabilities.supports_snippets = completionItem.snippetSupport.value;
for (completionItem.documentationFormat.value) |documentationFormat| {
if (std.mem.eql(u8, "markdown", documentationFormat)) {
client_capabilities.completion_doc_supports_md = true;
}
}
}
}
}
try send(arena, types.Response{
.id = id,
.result = .{
.InitializeResult = .{
.offsetEncoding = if (offset_encoding == .utf8)
@as([]const u8, "utf-8")
else
"utf-16",
.serverInfo = .{
.name = "zls",
.version = "0.1.0",
},
.capabilities = .{
.signatureHelpProvider = .{
.triggerCharacters = &[_][]const u8{ "(", "," },
},
.textDocumentSync = .Full,
.renameProvider = true,
.completionProvider = .{
.resolveProvider = false,
.triggerCharacters = &[_][]const u8{ ".", ":", "@" },
},
.documentHighlightProvider = false,
.hoverProvider = true,
.codeActionProvider = false,
.declarationProvider = true,
.definitionProvider = true,
.typeDefinitionProvider = true,
.implementationProvider = false,
.referencesProvider = true,
.documentSymbolProvider = true,
.colorProvider = false,
.documentFormattingProvider = true,
.documentRangeFormattingProvider = false,
.foldingRangeProvider = false,
.selectionRangeProvider = false,
.workspaceSymbolProvider = false,
.rangeProvider = false,
.documentProvider = true,
.workspace = .{
.workspaceFolders = .{
.supported = false,
.changeNotifications = false,
},
},
.semanticTokensProvider = .{
.full = true,
.range = false,
.legend = .{
.tokenTypes = comptime block: {
const tokTypeFields = std.meta.fields(semantic_tokens.TokenType);
var names: [tokTypeFields.len][]const u8 = undefined;
for (tokTypeFields) |field, i| {
names[i] = field.name;
}
break :block &names;
},
.tokenModifiers = comptime block: {
const tokModFields = std.meta.fields(semantic_tokens.TokenModifiers);
var names: [tokModFields.len][]const u8 = undefined;
for (tokModFields) |field, i| {
names[i] = field.name;
}
break :block &names;
},
},
},
},
},
},
});
2020-08-14 11:41:34 +01:00
logger.notice("zls initialized", .{});
logger.info("{}", .{client_capabilities});
logger.notice("Using offset encoding: {s}", .{std.meta.tagName(offset_encoding)});
}
2020-06-16 16:49:31 +01:00
var keep_running = true;
fn shutdownHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, config: Config) !void {
logger.notice("Server closing...", .{});
keep_running = false;
// Technically we should deinitialize first and send possible errors to the client
try respondGeneric(id, null_result_response);
}
2020-06-16 16:49:31 +01:00
fn openDocumentHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.OpenDocument, config: Config) !void {
const handle = try document_store.openDocument(req.params.textDocument.uri, req.params.textDocument.text);
try publishDiagnostics(arena, handle.*, config);
2020-06-30 16:00:33 +01:00
try semanticTokensFullHandler(arena, id, .{ .params = .{ .textDocument = .{ .uri = req.params.textDocument.uri } } }, config);
}
fn changeDocumentHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.ChangeDocument, config: Config) !void {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.debug("Trying to change non existent document {s}", .{req.params.textDocument.uri});
return;
};
try document_store.applyChanges(handle, req.params.contentChanges.Array, offset_encoding, config.zig_lib_path);
try publishDiagnostics(arena, handle.*, config);
}
2020-06-30 16:00:33 +01:00
fn saveDocumentHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.SaveDocument, config: Config) error{OutOfMemory}!void {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.warn("Trying to save non existent document {s}", .{req.params.textDocument.uri});
return;
};
try document_store.applySave(handle);
}
2020-06-30 16:00:33 +01:00
fn closeDocumentHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.CloseDocument, config: Config) error{}!void {
document_store.closeDocument(req.params.textDocument.uri);
}
fn semanticTokensFullHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.SemanticTokensFull, config: Config) (error{OutOfMemory} || std.fs.File.WriteError)!void {
if (config.enable_semantic_tokens) {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.warn("Trying to get semantic tokens of non existent document {s}", .{req.params.textDocument.uri});
return try respondGeneric(id, no_semantic_tokens_response);
};
const token_array = try semantic_tokens.writeAllSemanticTokens(arena, &document_store, handle, offset_encoding);
defer allocator.free(token_array);
2020-05-18 21:19:23 +01:00
return try send(arena, types.Response{
.id = id,
.result = .{ .SemanticTokensFull = .{ .data = token_array } },
});
}
}
fn completionHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.Completion, config: Config) !void {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.warn("Trying to complete in non existent document {s}", .{req.params.textDocument.uri});
return try respondGeneric(id, no_completions_response);
};
if (req.params.position.character >= 0) {
const doc_position = try offsets.documentPosition(handle.document, req.params.position, offset_encoding);
2020-07-03 00:31:28 +01:00
const pos_context = try analysis.documentPositionContext(arena, handle.document, doc_position);
const use_snippets = config.enable_snippets and client_capabilities.supports_snippets;
switch (pos_context) {
.builtin => try completeBuiltin(arena, id, config),
.var_access, .empty => try completeGlobal(arena, id, doc_position.absolute_index, handle, config),
.field_access => |range| try completeFieldAccess(arena, id, handle, doc_position, range, config),
.global_error_set => try send(arena, types.Response{
.id = id,
.result = .{
.CompletionList = .{
.isIncomplete = false,
2020-07-08 02:05:44 +01:00
.items = try document_store.errorCompletionItems(arena, handle),
},
},
}),
.enum_literal => try send(arena, types.Response{
.id = id,
.result = .{
.CompletionList = .{
.isIncomplete = false,
2020-07-08 02:05:44 +01:00
.items = try document_store.enumCompletionItems(arena, handle),
},
},
}),
.label => try completeLabel(arena, id, doc_position.absolute_index, handle, config),
else => try respondGeneric(id, no_completions_response),
}
} else {
try respondGeneric(id, no_completions_response);
}
}
fn signatureHelperHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, config: Config) !void {
// TODO Implement this
try respondGeneric(id,
\\,"result":{"signatures":[]}}
);
}
fn gotoHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.GotoDefinition, config: Config, resolve_alias: bool) !void {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.warn("Trying to go to definition in non existent document {s}", .{req.params.textDocument.uri});
return try respondGeneric(id, null_result_response);
};
if (req.params.position.character >= 0) {
const doc_position = try offsets.documentPosition(handle.document, req.params.position, offset_encoding);
2020-07-03 00:31:28 +01:00
const pos_context = try analysis.documentPositionContext(arena, handle.document, doc_position);
switch (pos_context) {
.var_access => try gotoDefinitionGlobal(arena, id, doc_position.absolute_index, handle, config, resolve_alias),
.field_access => |range| try gotoDefinitionFieldAccess(arena, id, handle, doc_position, range, config, resolve_alias),
2020-07-03 00:31:28 +01:00
.string_literal => try gotoDefinitionString(arena, id, doc_position.absolute_index, handle, config),
.label => try gotoDefinitionLabel(arena, id, doc_position.absolute_index, handle, config),
else => try respondGeneric(id, null_result_response),
}
} else {
try respondGeneric(id, null_result_response);
}
}
fn gotoDefinitionHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.GotoDefinition, config: Config) !void {
try gotoHandler(arena, id, req, config, true);
}
fn gotoDeclarationHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.GotoDeclaration, config: Config) !void {
try gotoHandler(arena, id, req, config, false);
}
fn hoverHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.Hover, config: Config) !void {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.warn("Trying to get hover in non existent document {s}", .{req.params.textDocument.uri});
return try respondGeneric(id, null_result_response);
};
if (req.params.position.character >= 0) {
const doc_position = try offsets.documentPosition(handle.document, req.params.position, offset_encoding);
2020-07-03 00:31:28 +01:00
const pos_context = try analysis.documentPositionContext(arena, handle.document, doc_position);
switch (pos_context) {
2020-11-04 22:54:47 +00:00
.builtin => try hoverDefinitionBuiltin(arena, id, doc_position.absolute_index, handle),
.var_access => try hoverDefinitionGlobal(arena, id, doc_position.absolute_index, handle, config),
.field_access => |range| try hoverDefinitionFieldAccess(arena, id, handle, doc_position, range, config),
.label => try hoverDefinitionLabel(arena, id, doc_position.absolute_index, handle, config),
else => try respondGeneric(id, null_result_response),
}
} else {
try respondGeneric(id, null_result_response);
}
}
fn documentSymbolsHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.DocumentSymbols, config: Config) !void {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.warn("Trying to get document symbols in non existent document {s}", .{req.params.textDocument.uri});
return try respondGeneric(id, null_result_response);
};
try documentSymbol(arena, id, handle);
}
fn formattingHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.Formatting, config: Config) !void {
if (config.zig_exe_path) |zig_exe_path| {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.warn("Trying to got to definition in non existent document {s}", .{req.params.textDocument.uri});
return try respondGeneric(id, null_result_response);
};
var process = try std.ChildProcess.init(&[_][]const u8{ zig_exe_path, "fmt", "--stdin" }, allocator);
defer process.deinit();
process.stdin_behavior = .Pipe;
process.stdout_behavior = .Pipe;
process.spawn() catch |err| {
logger.warn("Failed to spawn zig fmt process, error: {}", .{err});
return try respondGeneric(id, null_result_response);
};
try process.stdin.?.writeAll(handle.document.text);
process.stdin.?.close();
process.stdin = null;
const stdout_bytes = try process.stdout.?.reader().readAllAlloc(allocator, std.math.maxInt(usize));
defer allocator.free(stdout_bytes);
switch (try process.wait()) {
.Exited => |code| if (code == 0) {
return try send(arena, types.Response{
.id = id,
.result = .{
.TextEdits = &[1]types.TextEdit{
.{
.range = try offsets.documentRange(handle.document, offset_encoding),
.newText = stdout_bytes,
},
},
},
});
},
else => {},
}
}
return try respondGeneric(id, null_result_response);
}
fn renameHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.Rename, config: Config) !void {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.warn("Trying to rename in non existent document {s}", .{req.params.textDocument.uri});
return try respondGeneric(id, null_result_response);
};
if (req.params.position.character >= 0) {
const doc_position = try offsets.documentPosition(handle.document, req.params.position, offset_encoding);
2020-07-03 00:31:28 +01:00
const pos_context = try analysis.documentPositionContext(arena, handle.document, doc_position);
switch (pos_context) {
2020-07-03 00:31:28 +01:00
.var_access => try renameDefinitionGlobal(arena, id, handle, doc_position.absolute_index, req.params.newName),
.field_access => |range| try renameDefinitionFieldAccess(arena, id, handle, doc_position, range, req.params.newName, config),
2020-07-03 00:31:28 +01:00
.label => try renameDefinitionLabel(arena, id, handle, doc_position.absolute_index, req.params.newName),
else => try respondGeneric(id, null_result_response),
}
} else {
try respondGeneric(id, null_result_response);
}
}
2020-07-05 23:32:14 +01:00
fn referencesHandler(arena: *std.heap.ArenaAllocator, id: types.RequestId, req: requests.References, config: Config) !void {
const handle = document_store.getHandle(req.params.textDocument.uri) orelse {
logger.warn("Trying to get references in non existent document {s}", .{req.params.textDocument.uri});
2020-07-05 23:32:14 +01:00
return try respondGeneric(id, null_result_response);
};
if (req.params.position.character >= 0) {
const doc_position = try offsets.documentPosition(handle.document, req.params.position, offset_encoding);
const pos_context = try analysis.documentPositionContext(arena, handle.document, doc_position);
const include_decl = req.params.context.includeDeclaration;
switch (pos_context) {
.var_access => try referencesDefinitionGlobal(arena, id, handle, doc_position.absolute_index, include_decl),
.field_access => |range| try referencesDefinitionFieldAccess(arena, id, handle, doc_position, range, include_decl, config),
2020-07-05 23:32:14 +01:00
.label => try referencesDefinitionLabel(arena, id, handle, doc_position.absolute_index, include_decl),
else => try respondGeneric(id, null_result_response),
}
} else {
try respondGeneric(id, null_result_response);
}
}
2020-06-30 16:00:33 +01:00
// Needed for the hack seen below.
2020-07-12 20:12:09 +01:00
fn extractErr(val: anytype) anyerror {
2020-06-30 16:00:33 +01:00
val catch |e| return e;
return error.HackDone;
}
fn processJsonRpc(arena: *std.heap.ArenaAllocator, parser: *std.json.Parser, json: []const u8, config: Config) !void {
var tree = try parser.parse(json);
defer tree.deinit();
2020-07-05 22:56:41 +01:00
const id = if (tree.root.Object.get("id")) |id| switch (id) {
.Integer => |int| types.RequestId{ .Integer = int },
.String => |str| types.RequestId{ .String = str },
else => types.RequestId{ .Integer = 0 },
} else types.RequestId{ .Integer = 0 };
2020-06-16 20:02:31 +01:00
2020-07-05 22:56:41 +01:00
std.debug.assert(tree.root.Object.get("method") != null);
const method = tree.root.Object.get("method").?.String;
2020-06-16 20:02:31 +01:00
const start_time = std.time.milliTimestamp();
defer {
const end_time = std.time.milliTimestamp();
logger.debug("Took {}ms to process method {s}", .{ end_time - start_time, method });
}
2020-06-27 01:16:14 +01:00
const method_map = .{
.{"initialized"},
.{"$/cancelRequest"},
.{"textDocument/willSave"},
.{ "initialize", requests.Initialize, initializeHandler },
.{ "shutdown", void, shutdownHandler },
.{ "textDocument/didOpen", requests.OpenDocument, openDocumentHandler },
.{ "textDocument/didChange", requests.ChangeDocument, changeDocumentHandler },
.{ "textDocument/didSave", requests.SaveDocument, saveDocumentHandler },
.{ "textDocument/didClose", requests.CloseDocument, closeDocumentHandler },
.{ "textDocument/semanticTokens/full", requests.SemanticTokensFull, semanticTokensFullHandler },
.{ "textDocument/completion", requests.Completion, completionHandler },
.{ "textDocument/signatureHelp", void, signatureHelperHandler },
.{ "textDocument/definition", requests.GotoDefinition, gotoDefinitionHandler },
.{ "textDocument/typeDefinition", requests.GotoDefinition, gotoDefinitionHandler },
.{ "textDocument/implementation", requests.GotoDefinition, gotoDefinitionHandler },
.{ "textDocument/declaration", requests.GotoDeclaration, gotoDeclarationHandler },
.{ "textDocument/hover", requests.Hover, hoverHandler },
.{ "textDocument/documentSymbol", requests.DocumentSymbols, documentSymbolsHandler },
.{ "textDocument/formatting", requests.Formatting, formattingHandler },
.{ "textDocument/rename", requests.Rename, renameHandler },
2020-07-05 23:32:14 +01:00
.{ "textDocument/references", requests.References, referencesHandler },
};
2020-06-30 16:00:33 +01:00
// Hack to avoid `return`ing in the inline for, which causes bugs.
var done: ?anyerror = null;
inline for (method_map) |method_info| {
2020-06-30 16:00:33 +01:00
if (done == null and std.mem.eql(u8, method, method_info[0])) {
if (method_info.len == 1) {
2020-06-30 16:00:33 +01:00
done = error.HackDone;
} else if (method_info[1] != void) {
2020-06-30 16:00:33 +01:00
const ReqT = method_info[1];
if (requests.fromDynamicTree(arena, ReqT, tree.root)) |request_obj| {
done = error.HackDone;
done = extractErr(method_info[2](arena, id, request_obj, config));
} else |err| {
if (err == error.MalformedJson) {
logger.warn("Could not create request type {s} from JSON {s}", .{ @typeName(ReqT), json });
}
2020-06-30 16:00:33 +01:00
done = err;
}
} else {
2020-06-30 16:00:33 +01:00
done = error.HackDone;
2020-07-03 00:31:28 +01:00
(method_info[2])(arena, id, config) catch |err| {
done = err;
};
2020-06-27 01:16:14 +01:00
}
}
2020-04-24 23:19:03 +01:00
}
2020-06-30 16:00:33 +01:00
if (done) |err| switch (err) {
error.MalformedJson => return try respondGeneric(id, null_result_response),
error.HackDone => return,
else => return err,
};
const unimplemented_map = std.ComptimeStringMap(void, .{
2020-06-30 16:00:33 +01:00
.{"textDocument/documentHighlight"},
.{"textDocument/codeAction"},
.{"textDocument/codeLens"},
.{"textDocument/documentLink"},
.{"textDocument/rangeFormatting"},
.{"textDocument/onTypeFormatting"},
.{"textDocument/prepareRename"},
.{"textDocument/foldingRange"},
.{"textDocument/selectionRange"},
.{"textDocument/semanticTokens/range"},
.{"workspace/didChangeWorkspaceFolders"},
});
if (unimplemented_map.has(method)) {
// TODO: Unimplemented methods, implement them and add them to server capabilities.
return try respondGeneric(id, null_result_response);
}
2020-07-05 22:56:41 +01:00
if (tree.root.Object.get("id")) |_| {
return try respondGeneric(id, not_implemented_response);
}
logger.debug("Method without return value not implemented: {s}", .{method});
2020-04-24 23:19:03 +01:00
}
var gpa_state = std.heap.GeneralPurposeAllocator(.{}){};
2020-04-24 23:19:03 +01:00
pub fn main() anyerror!void {
defer _ = gpa_state.deinit();
allocator = &gpa_state.allocator;
2020-06-16 22:26:45 +01:00
// Check arguments.
var args_it = std.process.args();
const prog_name = try args_it.next(allocator) orelse unreachable;
allocator.free(prog_name);
while (args_it.next(allocator)) |maybe_arg| {
const arg = try maybe_arg;
defer allocator.free(arg);
if (std.mem.eql(u8, arg, "--debug-log")) {
actual_log_level = .debug;
std.debug.print("Enabled debug logging", .{});
} else {
std.debug.print("Unrecognized argument {s}", .{arg});
std.os.exit(1);
}
}
args_it.deinit();
// Init global vars
2020-06-26 01:26:09 +01:00
const reader = std.io.getStdIn().reader();
2021-01-10 07:12:11 +00:00
stdout = std.io.bufferedWriter(std.io.getStdOut().writer());
2020-04-24 23:19:03 +01:00
2020-05-17 15:39:04 +01:00
// Read the configuration, if any.
const config_parse_options = std.json.ParseOptions{ .allocator = allocator };
2020-05-17 15:39:04 +01:00
var config = Config{};
2020-06-30 16:00:33 +01:00
var config_had_null_zig_path = config.zig_exe_path == null;
defer {
if (config_had_null_zig_path) {
if (config.zig_exe_path) |exe_path| {
allocator.free(exe_path);
config.zig_exe_path = null;
}
}
std.json.parseFree(Config, config, config_parse_options);
}
config_read: {
const res = try known_folders.getPath(allocator, .local_configuration);
if (res) |local_config_path| {
defer allocator.free(local_config_path);
if (loadConfig(local_config_path)) |conf| {
config = conf;
break :config_read;
}
}
2020-05-25 17:33:08 +01:00
var exe_dir_bytes: [std.fs.MAX_PATH_BYTES]u8 = undefined;
const exe_dir_path = std.fs.selfExeDirPath(&exe_dir_bytes) catch break :config_read;
2020-05-25 17:33:08 +01:00
if (loadConfig(exe_dir_path)) |conf| {
config = conf;
2020-05-17 15:39:04 +01:00
}
}
// Find the zig executable in PATH
var zig_exe_path: ?[]const u8 = null;
find_zig: {
if (config.zig_exe_path) |exe_path| {
if (std.fs.path.isAbsolute(exe_path)) {
zig_exe_path = try std.mem.dupe(allocator, u8, exe_path);
2020-12-20 02:01:16 +00:00
// make sure the path still exists
if (blk: {
std.fs.cwd().access(zig_exe_path.?, .{}) catch break :blk false;
break :blk true;
})
break :find_zig;
}
logger.debug("zig path `{s}` is not absolute, will look in path", .{exe_path});
}
const env_path = std.process.getEnvVarOwned(allocator, "PATH") catch |err| switch (err) {
error.EnvironmentVariableNotFound => {
logger.warn("Could not get PATH environmental variable", .{});
break :find_zig;
},
else => return err,
};
defer allocator.free(env_path);
const exe_extension = @as(std.zig.CrossTarget, .{}).exeFileExt();
const zig_exe = try std.fmt.allocPrint(allocator, "zig{s}", .{exe_extension});
defer allocator.free(zig_exe);
2020-05-25 17:33:08 +01:00
var it = std.mem.tokenize(env_path, &[_]u8{std.fs.path.delimiter});
while (it.next()) |path| {
const full_path = try std.fs.path.join(allocator, &[_][]const u8{
path,
zig_exe,
});
2020-05-25 15:24:44 +01:00
defer allocator.free(full_path);
var buf: [std.fs.MAX_PATH_BYTES]u8 = undefined;
2020-06-30 16:00:33 +01:00
zig_exe_path = try std.mem.dupe(allocator, u8, std.os.realpath(full_path, &buf) catch continue);
logger.info("Found zig in PATH: {s}", .{zig_exe_path});
break :find_zig;
}
}
if (zig_exe_path) |exe_path| {
2020-06-16 20:02:31 +01:00
config.zig_exe_path = exe_path;
logger.info("Using zig executable {s}", .{exe_path});
if (config.zig_lib_path == null) find_lib_path: {
// Use `zig env` to find the lib path
const zig_env_result = try std.ChildProcess.exec(.{
.allocator = allocator,
.argv = &[_][]const u8{ exe_path, "env" },
});
defer {
allocator.free(zig_env_result.stdout);
allocator.free(zig_env_result.stderr);
}
switch (zig_env_result.term) {
.Exited => |exit_code| {
if (exit_code == 0) {
const Env = struct {
zig_exe: []const u8,
lib_dir: ?[]const u8,
std_dir: []const u8,
global_cache_dir: []const u8,
version: []const u8,
};
var json_env = std.json.parse(
Env,
&std.json.TokenStream.init(zig_env_result.stdout),
.{ .allocator = allocator },
) catch {
logger.alert("Failed to parse zig env JSON result", .{});
break :find_lib_path;
};
defer std.json.parseFree(Env, json_env, .{ .allocator = allocator });
// We know this is allocated with `allocator`, we just steal it!
config.zig_lib_path = json_env.lib_dir.?;
json_env.lib_dir = null;
logger.notice("Using zig lib path '{s}'", .{config.zig_lib_path});
}
},
else => logger.alert("zig env invocation failed", .{}),
}
}
} else {
logger.warn("Zig executable path not specified in zls.json and could not be found in PATH", .{});
}
if (config.zig_lib_path == null) {
logger.warn("Zig standard library path not specified in zls.json and could not be resolved from the zig executable", .{});
}
const build_runner_path = if (config.build_runner_path) |p|
try allocator.dupe(u8, p)
else blk: {
2020-05-25 17:33:08 +01:00
var exe_dir_bytes: [std.fs.MAX_PATH_BYTES]u8 = undefined;
const exe_dir_path = try std.fs.selfExeDirPath(&exe_dir_bytes);
break :blk try std.fs.path.resolve(allocator, &[_][]const u8{ exe_dir_path, "build_runner.zig" });
};
2020-05-25 17:33:08 +01:00
const build_runner_cache_path = if (config.build_runner_path) |p|
try allocator.dupe(u8, p)
else blk: {
const cache_dir_path = (try known_folders.getPath(allocator, .cache)) orelse {
logger.warn("Known-folders could not fetch the cache path", .{});
return;
};
defer allocator.free(cache_dir_path);
break :blk try std.fs.path.resolve(allocator, &[_][]const u8{ cache_dir_path, "zls" });
};
try document_store.init(allocator, zig_exe_path, build_runner_path, build_runner_cache_path, config.zig_lib_path);
defer document_store.deinit();
// This JSON parser is passed to processJsonRpc and reset.
var json_parser = std.json.Parser.init(allocator, false);
defer json_parser.deinit();
// Arena used for temporary allocations while handlign a request
var arena = std.heap.ArenaAllocator.init(allocator);
defer arena.deinit();
2020-06-16 22:26:45 +01:00
while (keep_running) {
const headers = readRequestHeader(&arena.allocator, reader) catch |err| {
logger.crit("{s}; exiting!", .{@errorName(err)});
2020-04-24 23:19:03 +01:00
return;
2020-05-17 15:50:13 +01:00
};
const buf = try arena.allocator.alloc(u8, headers.content_length);
2020-06-26 01:26:09 +01:00
try reader.readNoEof(buf);
try processJsonRpc(&arena, &json_parser, buf, config);
2020-05-17 15:50:13 +01:00
json_parser.reset();
arena.deinit();
2020-07-08 02:05:44 +01:00
arena.state = .{};
2020-04-24 23:19:03 +01:00
}
2020-11-04 22:39:24 +00:00
if (builtin_completions) |compls| {
allocator.free(compls);
}
2020-04-24 23:19:03 +01:00
}