zls/src/main.zig

1071 lines
40 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 12:40:32 +01:00
const DebugAllocator = @import("debug_allocator.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 types = @import("types.zig");
const analysis = @import("analysis.zig");
const URI = @import("uri.zig");
2020-04-24 23:19:03 +01:00
// Code is largely based off of https://github.com/andersfr/zig-lsp/blob/master/server.zig
var stdout: std.io.BufferedOutStream(4096, std.fs.File.OutStream) = undefined;
2020-04-24 23:19:03 +01:00
var allocator: *std.mem.Allocator = undefined;
var document_store: DocumentStore = undefined;
var workspace_folder_configs: std.StringHashMap(?Config) = undefined;
const initialize_response =
\\,"result":{"capabilities":{"signatureHelpProvider":{"triggerCharacters":["(",","]},"textDocumentSync":1,"completionProvider":{"resolveProvider":false,"triggerCharacters":[".",":","@"]},"documentHighlightProvider":false,"hoverProvider":true,"codeActionProvider":false,"declarationProvider":true,"definitionProvider":true,"typeDefinitionProvider":true,"implementationProvider":false,"referencesProvider":false,"documentSymbolProvider":false,"colorProvider":false,"documentFormattingProvider":false,"documentRangeFormattingProvider":false,"foldingRangeProvider":false,"selectionRangeProvider":false,"workspaceSymbolProvider":false,"workspace":{"workspaceFolders":{"supported":true,"changeNotifications":true}}}}}
2020-04-24 23:19:03 +01:00
;
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
;
/// Sends a request or response
2020-05-08 03:27:42 +01:00
fn send(reqOrRes: var) !void {
// The most memory we'll probably need
var mem_buffer: [1024 * 128]u8 = undefined;
var fbs = std.io.fixedBufferStream(&mem_buffer);
try std.json.stringify(reqOrRes, std.json.StringifyOptions{}, fbs.outStream());
const stdout_stream = stdout.outStream();
try stdout_stream.print("Content-Length: {}\r\n\r\n", .{fbs.pos});
try stdout_stream.writeAll(fbs.getWritten());
try stdout.flush();
2020-04-24 23:19:03 +01:00
}
2020-05-08 03:27:42 +01:00
fn respondGeneric(id: i64, response: []const u8) !void {
2020-04-24 23:19:03 +01:00
const id_digits = blk: {
if (id == 0) break :blk 1;
var digits: usize = 1;
var value = @divTrunc(id, 10);
while (value != 0) : (value = @divTrunc(value, 10)) {
digits += 1;
}
break :blk digits;
};
// Numbers of character that will be printed from this string: len - 3 brackets
// 1 from the beginning (escaped) and the 2 from the arg {}
const json_fmt = "{{\"jsonrpc\":\"2.0\",\"id\":{}";
const stdout_stream = stdout.outStream();
try stdout_stream.print("Content-Length: {}\r\n\r\n" ++ json_fmt, .{ response.len + id_digits + json_fmt.len - 3, id });
try stdout_stream.writeAll(response);
try stdout.flush();
}
// 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(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
// Use an arena for our local memory allocations.
var arena = std.heap.ArenaAllocator.init(allocator);
defer arena.deinit();
var diagnostics = std.ArrayList(types.Diagnostic).init(&arena.allocator);
2020-04-24 23:19:03 +01:00
2020-05-23 23:21:02 +01:00
for (tree.errors) |*err| {
const loc = tree.tokenLocation(0, err.loc());
var mem_buffer: [256]u8 = undefined;
var fbs = std.io.fixedBufferStream(&mem_buffer);
try tree.renderError(err, fbs.outStream());
try diagnostics.append(.{
.range = astLocationToRange(loc),
.severity = .Error,
.code = @tagName(err.*),
.source = "zls",
.message = try std.mem.dupe(&arena.allocator, u8, fbs.getWritten()),
// .relatedInformation = undefined
});
}
if (tree.errors.len == 0) {
2020-05-23 23:21:02 +01:00
for (tree.root_node.decls()) |decl| {
2020-05-04 03:17:19 +01:00
switch (decl.id) {
2020-05-08 18:02:46 +01:00
.FnProto => blk: {
2020-05-04 03:17:19 +01:00
const func = decl.cast(std.zig.ast.Node.FnProto).?;
const is_extern = func.extern_export_inline_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| {
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(types.Notification{
.method = "textDocument/publishDiagnostics",
.params = .{
.PublishDiagnosticsParams = .{
.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 containerToCompletion(
list: *std.ArrayList(types.CompletionItem),
analysis_ctx: *DocumentStore.AnalysisContext,
orig_handle: *DocumentStore.Handle,
container: *std.zig.ast.Node,
config: Config,
) !void {
2020-05-24 15:07:48 +01:00
var child_idx: usize = 0;
while (container.iterate(child_idx)) |child_node| : (child_idx += 1) {
// Declarations in the same file do not need to be public.
2020-05-24 17:00:21 +01:00
if (orig_handle == analysis_ctx.handle or analysis.isNodePublic(analysis_ctx.tree(), child_node)) {
2020-05-24 13:24:18 +01:00
try nodeToCompletion(list, analysis_ctx, orig_handle, child_node, config);
2020-05-17 15:23:04 +01:00
}
}
}
const ResolveVarDeclFnAliasRewsult = struct {
decl: *std.zig.ast.Node,
analysis_ctx: DocumentStore.AnalysisContext,
};
fn resolveVarDeclFnAlias(analysis_ctx: *DocumentStore.AnalysisContext, decl: *std.zig.ast.Node) ResolveVarDeclFnAliasRewsult {
var child_analysis_context = analysis_ctx.clone();
if (decl.cast(std.zig.ast.Node.VarDecl)) |var_decl| {
const child_node = block: {
if (var_decl.type_node) |type_node| {
if (std.mem.eql(u8, "type", analysis_ctx.tree().tokenSlice(type_node.firstToken()))) {
break :block var_decl.init_node orelse type_node;
}
break :block type_node;
}
break :block var_decl.init_node.?;
};
if (analysis.resolveTypeOfNode(&child_analysis_context, child_node)) |resolved_node| {
if (resolved_node.id == .FnProto) {
return .{ .decl = resolved_node, .analysis_ctx = child_analysis_context };
}
}
}
return .{ .decl = decl, .analysis_ctx = analysis_ctx.* };
}
fn nodeToCompletion(
list: *std.ArrayList(types.CompletionItem),
analysis_ctx: *DocumentStore.AnalysisContext,
orig_handle: *DocumentStore.Handle,
node: *std.zig.ast.Node,
config: Config,
) error{OutOfMemory}!void {
2020-05-24 17:00:21 +01:00
var doc = if (try analysis.getDocComments(list.allocator, analysis_ctx.tree(), node)) |doc_comments|
types.MarkupContent{
.kind = .Markdown,
.value = doc_comments,
}
else
null;
2020-05-17 15:23:04 +01:00
switch (node.id) {
.ErrorSetDecl, .Root, .ContainerDecl => {
try containerToCompletion(list, analysis_ctx, orig_handle, node, config);
2020-05-17 15:23:04 +01:00
},
.FnProto => {
2020-05-17 15:23:04 +01:00
const func = node.cast(std.zig.ast.Node.FnProto).?;
if (func.name_token) |name_token| {
const insert_text = if (config.enable_snippets)
2020-05-24 17:00:21 +01:00
try analysis.getFunctionSnippet(list.allocator, analysis_ctx.tree(), func)
else
null;
2020-05-24 17:00:21 +01:00
const is_type_function = analysis.isTypeFunction(analysis_ctx.tree(), func);
2020-05-17 15:23:04 +01:00
try list.append(.{
2020-05-24 17:00:21 +01:00
.label = analysis_ctx.tree().tokenSlice(name_token),
2020-05-17 15:23:04 +01:00
.kind = if (is_type_function) .Struct else .Function,
.documentation = doc,
2020-05-24 17:00:21 +01:00
.detail = analysis.getFunctionSignature(analysis_ctx.tree(), func),
.insertText = insert_text,
.insertTextFormat = if (config.enable_snippets) .Snippet else .PlainText,
2020-05-17 15:23:04 +01:00
});
}
},
.VarDecl => {
2020-05-17 15:23:04 +01:00
const var_decl = node.cast(std.zig.ast.Node.VarDecl).?;
2020-05-24 17:00:21 +01:00
const is_const = analysis_ctx.tree().token_ids[var_decl.mut_token] == .Keyword_const;
var result = resolveVarDeclFnAlias(analysis_ctx, node);
if (result.decl != node) {
return try nodeToCompletion(list, &result.analysis_ctx, orig_handle, result.decl, config);
}
2020-05-17 15:23:04 +01:00
try list.append(.{
2020-05-24 17:00:21 +01:00
.label = analysis_ctx.tree().tokenSlice(var_decl.name_token),
2020-05-17 15:23:04 +01:00
.kind = if (is_const) .Constant else .Variable,
.documentation = doc,
2020-05-24 17:00:21 +01:00
.detail = analysis.getVariableSignature(analysis_ctx.tree(), var_decl),
2020-05-17 15:23:04 +01:00
});
},
2020-05-17 15:23:04 +01:00
.PrefixOp => {
try list.append(.{
.label = "len",
.kind = .Field,
});
try list.append(.{
.label = "ptr",
.kind = .Field,
});
},
2020-05-17 15:23:04 +01:00
.StringLiteral => {
try list.append(.{
.label = "len",
.kind = .Field,
});
},
2020-05-24 17:00:21 +01:00
else => if (analysis.nodeToString(analysis_ctx.tree(), node)) |string| {
2020-05-17 15:23:04 +01:00
try list.append(.{
.label = string,
.kind = .Field,
.documentation = doc,
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: i64, analysis_ctx: *DocumentStore.AnalysisContext, decl: *std.zig.ast.Node) !void {
const result = resolveVarDeclFnAlias(analysis_ctx, decl);
const name_token = analysis.getDeclNameToken(result.analysis_ctx.tree(), result.decl) orelse unreachable;
try send(types.Response{
.id = .{ .Integer = id },
.result = .{
.Location = .{
.uri = result.analysis_ctx.handle.document.uri,
.range = astLocationToRange(result.analysis_ctx.tree().tokenLocation(0, name_token)),
},
},
});
}
fn hoverSymbol(id: i64, analysis_ctx: *DocumentStore.AnalysisContext, decl: *std.zig.ast.Node) !void {
const result = resolveVarDeclFnAlias(analysis_ctx, decl);
const str_value = switch (result.decl.id) {
.VarDecl => blk: {
const var_decl = result.decl.cast(std.zig.ast.Node.VarDecl).?;
break :blk analysis.getVariableSignature(result.analysis_ctx.tree(), var_decl);
},
.FnProto => blk: {
const fn_decl = result.decl.cast(std.zig.ast.Node.FnProto).?;
break :blk analysis.getFunctionSignature(result.analysis_ctx.tree(), fn_decl);
},
else => analysis.nodeToString(result.analysis_ctx.tree(), result.decl) orelse return try respondGeneric(id, null_result_response),
};
try send(types.Response{
.id = .{ .Integer = id },
.result = .{
.Hover = .{
.contents = .{ .value = str_value },
},
},
});
}
fn getSymbolGlobal(arena: *std.heap.ArenaAllocator, pos_index: usize, handle: DocumentStore.Handle) !?*std.zig.ast.Node {
2020-05-18 21:19:23 +01:00
const name = identifierFromPosition(pos_index, handle);
if (name.len == 0) return null;
var decl_nodes = std.ArrayList(*std.zig.ast.Node).init(&arena.allocator);
_ = try analysis.declsFromIndex(arena, &decl_nodes, handle.tree, pos_index);
return analysis.getChildOfSlice(handle.tree, decl_nodes.items, name);
}
fn gotoDefinitionGlobal(id: i64, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
2020-05-18 21:19:23 +01:00
var arena = std.heap.ArenaAllocator.init(allocator);
defer arena.deinit();
const decl = (try getSymbolGlobal(&arena, pos_index, handle.*)) orelse return try respondGeneric(id, null_result_response);
var analysis_ctx = try document_store.analysisContext(handle, &arena, pos_index, config.zig_lib_path);
return try gotoDefinitionSymbol(id, &analysis_ctx, decl);
}
2020-05-18 21:19:23 +01:00
fn hoverDefinitionGlobal(id: i64, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
var arena = std.heap.ArenaAllocator.init(allocator);
defer arena.deinit();
const decl = (try getSymbolGlobal(&arena, pos_index, handle.*)) orelse return try respondGeneric(id, null_result_response);
var analysis_ctx = try document_store.analysisContext(handle, &arena, pos_index, config.zig_lib_path);
return try hoverSymbol(id, &analysis_ctx, decl);
2020-05-18 21:19:23 +01:00
}
fn getSymbolFieldAccess(
analysis_ctx: *DocumentStore.AnalysisContext,
position: types.Position,
line_start_idx: usize,
config: Config,
) !?*std.zig.ast.Node {
const pos_index = try analysis_ctx.handle.document.positionToIndex(position);
var name = identifierFromPosition(pos_index, analysis_ctx.handle.*);
if (name.len == 0) return null;
const line = try analysis_ctx.handle.document.getLine(@intCast(usize, position.line));
var tokenizer = std.zig.Tokenizer.init(line[line_start_idx..]);
const line_length = @ptrToInt(name.ptr) - @ptrToInt(line.ptr) + name.len - line_start_idx;
name = try std.mem.dupe(&analysis_ctx.arena.allocator, u8, name);
if (analysis.getFieldAccessTypeNode(analysis_ctx, &tokenizer, line_length)) |container| {
return analysis.getChild(analysis_ctx.tree(), container, name);
}
return null;
}
fn gotoDefinitionFieldAccess(
id: i64,
handle: *DocumentStore.Handle,
position: types.Position,
line_start_idx: usize,
config: Config,
) !void {
2020-05-18 21:19:23 +01:00
var arena = std.heap.ArenaAllocator.init(allocator);
defer arena.deinit();
var analysis_ctx = try document_store.analysisContext(handle, &arena, try handle.document.positionToIndex(position), config.zig_lib_path);
const decl = (try getSymbolFieldAccess(&analysis_ctx, position, line_start_idx, config)) orelse return try respondGeneric(id, null_result_response);
return try gotoDefinitionSymbol(id, &analysis_ctx, decl);
}
2020-05-18 21:19:23 +01:00
fn hoverDefinitionFieldAccess(
id: i64,
handle: *DocumentStore.Handle,
position: types.Position,
line_start_idx: usize,
config: Config,
) !void {
var arena = std.heap.ArenaAllocator.init(allocator);
defer arena.deinit();
var analysis_ctx = try document_store.analysisContext(handle, &arena, try handle.document.positionToIndex(position), config.zig_lib_path);
const decl = (try getSymbolFieldAccess(&analysis_ctx, position, line_start_idx, config)) orelse return try respondGeneric(id, null_result_response);
return try hoverSymbol(id, &analysis_ctx, decl);
2020-05-18 21:19:23 +01:00
}
fn gotoDefinitionString(id: i64, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
2020-05-24 17:00:21 +01:00
const tree = handle.tree;
var arena = std.heap.ArenaAllocator.init(allocator);
defer arena.deinit();
const import_str = analysis.getImportStr(tree, pos_index) orelse return try respondGeneric(id, null_result_response);
const uri = (try document_store.uriFromImportStr(
&arena.allocator,
handle.*,
import_str,
try DocumentStore.stdUriFromLibPath(&arena.allocator, config.zig_lib_path),
)) orelse return try respondGeneric(id, null_result_response);
try send(types.Response{
.id = .{ .Integer = id },
.result = .{
.Location = .{
.uri = uri,
.range = .{
.start = .{ .line = 0, .character = 0 },
.end = .{ .line = 0, .character = 0 },
},
},
},
});
}
fn completeGlobal(id: i64, pos_index: usize, handle: *DocumentStore.Handle, config: Config) !void {
// We use a local arena allocator to deallocate all temporary data without iterating
var arena = std.heap.ArenaAllocator.init(allocator);
var completions = std.ArrayList(types.CompletionItem).init(&arena.allocator);
// Deallocate all temporary data.
defer arena.deinit();
2020-05-07 11:56:08 +01:00
var analysis_ctx = try document_store.analysisContext(handle, &arena, pos_index, config.zig_lib_path);
for (analysis_ctx.scope_nodes) |decl_ptr| {
var decl = decl_ptr.*;
2020-05-24 13:24:18 +01:00
try nodeToCompletion(&completions, &analysis_ctx, handle, decl_ptr, config);
}
2020-04-24 23:19:03 +01:00
try send(types.Response{
.id = .{ .Integer = id },
.result = .{
.CompletionList = .{
.isIncomplete = false,
2020-05-07 11:56:08 +01:00
.items = completions.items,
},
},
});
2020-04-24 23:19:03 +01:00
}
fn completeFieldAccess(id: i64, handle: *DocumentStore.Handle, position: types.Position, line_start_idx: usize, config: Config) !void {
var arena = std.heap.ArenaAllocator.init(allocator);
defer arena.deinit();
2020-05-11 13:28:08 +01:00
var analysis_ctx = try document_store.analysisContext(handle, &arena, try handle.document.positionToIndex(position), config.zig_lib_path);
var completions = std.ArrayList(types.CompletionItem).init(&arena.allocator);
2020-05-17 15:39:04 +01:00
const line = try handle.document.getLine(@intCast(usize, position.line));
var tokenizer = std.zig.Tokenizer.init(line[line_start_idx..]);
const line_length = line.len - line_start_idx;
if (analysis.getFieldAccessTypeNode(&analysis_ctx, &tokenizer, line_length)) |node| {
2020-05-24 13:24:18 +01:00
try nodeToCompletion(&completions, &analysis_ctx, handle, node, config);
}
try send(types.Response{
.id = .{ .Integer = id },
.result = .{
.CompletionList = .{
.isIncomplete = false,
.items = completions.items,
},
},
});
2020-05-11 13:28:08 +01:00
}
// Compute builtin completions at comptime.
const builtin_completions = block: {
@setEvalBranchQuota(3_500);
const CompletionList = [data.builtins.len]types.CompletionItem;
var with_snippets: CompletionList = undefined;
var without_snippets: CompletionList = undefined;
for (data.builtins) |builtin, i| {
const cutoff = std.mem.indexOf(u8, builtin, "(") orelse builtin.len;
const base_completion = types.CompletionItem{
.label = builtin[0..cutoff],
.kind = .Function,
.filterText = builtin[1..cutoff],
.detail = data.builtin_details[i],
.documentation = .{
.kind = .Markdown,
.value = data.builtin_docs[i],
},
};
with_snippets[i] = base_completion;
with_snippets[i].insertText = builtin[1..];
with_snippets[i].insertTextFormat = .Snippet;
without_snippets[i] = base_completion;
without_snippets[i].insertText = builtin[1..cutoff];
}
break :block [2]CompletionList{
without_snippets, with_snippets,
};
};
const PositionContext = union(enum) {
builtin,
comment,
string_literal,
field_access: usize,
var_access,
other,
empty,
};
const token_separators = [_]u8{
' ', '\t', '(', ')', '[', ']',
'{', '}', '|', '=', '!', ';',
',', '?', ':', '%', '+', '*',
'>', '<', '~', '-', '/', '&',
};
fn documentPositionContext(doc: types.TextDocument, pos_index: usize) PositionContext {
// First extract the whole current line up to the cursor.
var curr_position = pos_index;
while (curr_position > 0) : (curr_position -= 1) {
if (doc.text[curr_position - 1] == '\n') break;
}
var line = doc.text[curr_position .. pos_index + 1];
// Strip any leading whitespace.
var skipped_ws: usize = 0;
while (skipped_ws < line.len and (line[skipped_ws] == ' ' or line[skipped_ws] == '\t')) : (skipped_ws += 1) {}
if (skipped_ws >= line.len) return .empty;
line = line[skipped_ws..];
// Quick exit for comment lines and multi line string literals.
if (line.len >= 2 and line[0] == '/' and line[1] == '/')
return .comment;
2020-05-08 15:25:22 +01:00
if (line.len >= 2 and line[0] == '\\' and line[1] == '\\')
return .string_literal;
// TODO: This does not detect if we are in a string literal over multiple lines.
// Find out what context we are in.
// Go over the current line character by character
// and determine the context.
curr_position = 0;
var expr_start: usize = skipped_ws;
2020-05-24 03:07:09 +01:00
// std.debug.warn("{}", .{curr_position});
if (pos_index != 0 and doc.text[pos_index - 1] == ')')
return .{ .field_access = expr_start };
var new_token = true;
2020-05-08 12:36:54 +01:00
var context: PositionContext = .other;
var string_pop_ctx: PositionContext = .other;
while (curr_position < line.len) : (curr_position += 1) {
const c = line[curr_position];
const next_char = if (curr_position < line.len - 1) line[curr_position + 1] else null;
if (context != .string_literal and c == '"') {
expr_start = curr_position + skipped_ws;
context = .string_literal;
continue;
}
if (context == .string_literal) {
// Skip over escaped quotes
if (c == '\\' and next_char != null and next_char.? == '"') {
curr_position += 1;
} else if (c == '"') {
context = string_pop_ctx;
string_pop_ctx = .other;
new_token = true;
}
continue;
}
if (c == '/' and next_char != null and next_char.? == '/') {
context = .comment;
break;
}
if (std.mem.indexOfScalar(u8, &token_separators, c) != null) {
expr_start = curr_position + skipped_ws + 1;
new_token = true;
context = .other;
continue;
}
2020-05-08 13:07:14 +01:00
if (c == '.' and (!new_token or context == .string_literal)) {
new_token = true;
if (next_char != null and next_char.? == '.') continue;
context = .{ .field_access = expr_start };
continue;
}
if (new_token) {
const access_ctx: PositionContext = if (context == .field_access)
.{ .field_access = expr_start }
else
.var_access;
new_token = false;
if (c == '_' or std.ascii.isAlpha(c)) {
context = access_ctx;
} else if (c == '@') {
// This checks for @"..." identifiers by controlling
// the context the string will set after it is over.
if (next_char != null and next_char.? == '"') {
string_pop_ctx = access_ctx;
}
context = .builtin;
} else {
context = .other;
}
continue;
}
if (context == .field_access or context == .var_access or context == .builtin) {
if (c != '_' and !std.ascii.isAlNum(c)) {
context = .other;
}
continue;
}
context = .other;
}
return context;
}
fn loadConfig(folder_path: []const u8) ?Config {
var folder = std.fs.cwd().openDir(folder_path, .{}) catch return null;
defer folder.close();
const conf_file = folder.openFile("zls.json", .{}) catch return null;
defer conf_file.close();
// Max 1MB
const file_buf = conf_file.inStream().readAllAlloc(allocator, 0x1000000) catch 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| {
std.debug.warn("Error while parsing configuration file: {}\nUsing default config.\n", .{err});
return null;
};
if (config.zig_lib_path) |zig_lib_path| {
if (!std.fs.path.isAbsolute(zig_lib_path)) {
std.debug.warn("zig library path is not absolute, defaulting to null.\n", .{});
allocator.free(zig_lib_path);
config.zig_lib_path = null;
}
}
return config;
}
fn loadWorkspaceConfigs() !void {
var folder_config_it = workspace_folder_configs.iterator();
while (folder_config_it.next()) |entry| {
if (entry.value) |_| continue;
const folder_path = try URI.parse(allocator, entry.key);
defer allocator.free(folder_path);
entry.value = loadConfig(folder_path);
}
}
fn configFromUriOr(uri: []const u8, default: Config) Config {
var folder_config_it = workspace_folder_configs.iterator();
while (folder_config_it.next()) |entry| {
if (std.mem.startsWith(u8, uri, entry.key)) {
return entry.value orelse default;
}
}
return default;
}
fn processJsonRpc(parser: *std.json.Parser, json: []const u8, config: Config) !void {
2020-04-24 23:19:03 +01:00
var tree = try parser.parse(json);
defer tree.deinit();
const root = tree.root;
const id = if (root.Object.getValue("id")) |id| id.Integer else 0;
if (id == 1337 and (root.Object.getValue("method") == null or std.mem.eql(u8, root.Object.getValue("method").?.String, ""))) {
2020-05-19 21:24:24 +01:00
if (root.Object.getValue("result")) |result_obj| {
if (result_obj == .Array) {
const result = result_obj.Array;
2020-05-19 21:24:24 +01:00
for (result.items) |workspace_folder| {
const duped_uri = try std.mem.dupe(allocator, u8, workspace_folder.Object.getValue("uri").?.String);
try workspace_folder_configs.putNoClobber(duped_uri, null);
}
}
}
try loadWorkspaceConfigs();
return;
}
std.debug.assert(root.Object.getValue("method") != null);
const method = root.Object.getValue("method").?.String;
2020-04-24 23:19:03 +01:00
const params = root.Object.getValue("params").?.Object;
2020-05-24 13:39:40 +01:00
const start_time = std.time.milliTimestamp();
defer {
const end_time = std.time.milliTimestamp();
2020-05-25 17:33:08 +01:00
std.debug.warn("Took {}ms to process method {}\n", .{ end_time - start_time, method });
2020-05-24 13:39:40 +01:00
}
2020-04-24 23:19:03 +01:00
// Core
if (std.mem.eql(u8, method, "initialize")) {
try respondGeneric(id, initialize_response);
} else if (std.mem.eql(u8, method, "initialized")) {
// Send the workspaceFolders request
try send(types.Request{
.id = .{ .Integer = 1337 },
.method = "workspace/workspaceFolders",
.params = {},
});
2020-04-24 23:19:03 +01:00
} else if (std.mem.eql(u8, method, "$/cancelRequest")) {
// noop
}
// Workspace folder changes
else if (std.mem.eql(u8, method, "workspace/didChangeWorkspaceFolders")) {
const event = params.getValue("event").?.Object;
const added = event.getValue("added").?.Array;
const removed = event.getValue("removed").?.Array;
for (removed.items) |rem| {
const uri = rem.Object.getValue("uri").?.String;
if (workspace_folder_configs.remove(uri)) |entry| {
allocator.free(entry.key);
if (entry.value) |c| {
std.json.parseFree(Config, c, std.json.ParseOptions{ .allocator = allocator });
}
}
}
for (added.items) |add| {
const duped_uri = try std.mem.dupe(allocator, u8, add.Object.getValue("uri").?.String);
if (try workspace_folder_configs.put(duped_uri, null)) |old| {
allocator.free(old.key);
if (old.value) |c| {
std.json.parseFree(Config, c, std.json.ParseOptions{ .allocator = allocator });
}
}
}
try loadWorkspaceConfigs();
}
2020-04-24 23:19:03 +01:00
// File changes
else if (std.mem.eql(u8, method, "textDocument/didOpen")) {
const document = params.getValue("textDocument").?.Object;
const uri = document.getValue("uri").?.String;
const text = document.getValue("text").?.String;
const handle = try document_store.openDocument(uri, text);
try publishDiagnostics(handle.*, configFromUriOr(uri, config));
2020-04-24 23:19:03 +01:00
} else if (std.mem.eql(u8, method, "textDocument/didChange")) {
const text_document = params.getValue("textDocument").?.Object;
const uri = text_document.getValue("uri").?.String;
const content_changes = params.getValue("contentChanges").?.Array;
const handle = document_store.getHandle(uri) orelse {
2020-05-18 16:36:47 +01:00
std.debug.warn("Trying to change non existent document {}", .{uri});
return;
};
2020-04-24 23:19:03 +01:00
const local_config = configFromUriOr(uri, config);
try document_store.applyChanges(handle, content_changes, local_config.zig_lib_path);
try publishDiagnostics(handle.*, local_config);
2020-04-24 23:19:03 +01:00
} else if (std.mem.eql(u8, method, "textDocument/didSave")) {
// noop
} else if (std.mem.eql(u8, method, "textDocument/didClose")) {
const document = params.getValue("textDocument").?.Object;
const uri = document.getValue("uri").?.String;
document_store.closeDocument(uri);
2020-04-24 23:19:03 +01:00
}
// Autocomplete / Signatures
else if (std.mem.eql(u8, method, "textDocument/completion")) {
const text_document = params.getValue("textDocument").?.Object;
const uri = text_document.getValue("uri").?.String;
const position = params.getValue("position").?.Object;
const handle = document_store.getHandle(uri) orelse {
2020-05-18 16:36:47 +01:00
std.debug.warn("Trying to complete in non existent document {}", .{uri});
2020-05-18 21:19:23 +01:00
return try respondGeneric(id, no_completions_response);
};
const pos = types.Position{
.line = position.getValue("line").?.Integer,
.character = position.getValue("character").?.Integer - 1,
};
if (pos.character >= 0) {
const pos_index = try handle.document.positionToIndex(pos);
const pos_context = documentPositionContext(handle.document, pos_index);
2020-05-08 04:05:17 +01:00
const this_config = configFromUriOr(uri, config);
switch (pos_context) {
.builtin => try send(types.Response{
.id = .{ .Integer = id },
.result = .{
.CompletionList = .{
.isIncomplete = false,
.items = builtin_completions[@boolToInt(this_config.enable_snippets)][0..],
},
},
}),
.var_access, .empty => try completeGlobal(id, pos_index, handle, this_config),
.field_access => |start_idx| try completeFieldAccess(id, handle, pos, start_idx, this_config),
else => try respondGeneric(id, no_completions_response),
}
} else {
try respondGeneric(id, no_completions_response);
}
2020-04-24 23:19:03 +01:00
} else if (std.mem.eql(u8, method, "textDocument/signatureHelp")) {
try respondGeneric(id,
\\,"result":{"signatures":[]}}
2020-05-14 00:36:51 +01:00
);
2020-05-18 21:19:23 +01:00
} else if (std.mem.eql(u8, method, "textDocument/definition") or
std.mem.eql(u8, method, "textDocument/declaration") or
std.mem.eql(u8, method, "textDocument/typeDefinition"))
{
const document = params.getValue("textDocument").?.Object;
const uri = document.getValue("uri").?.String;
const position = params.getValue("position").?.Object;
const handle = document_store.getHandle(uri) orelse {
std.debug.warn("Trying to got to definition in non existent document {}", .{uri});
return try respondGeneric(id, null_result_response);
};
const pos = types.Position{
.line = position.getValue("line").?.Integer,
.character = position.getValue("character").?.Integer - 1,
};
if (pos.character >= 0) {
const pos_index = try handle.document.positionToIndex(pos);
const pos_context = documentPositionContext(handle.document, pos_index);
switch (pos_context) {
.var_access => try gotoDefinitionGlobal(
id,
pos_index,
handle,
configFromUriOr(uri, config),
),
.field_access => |start_idx| try gotoDefinitionFieldAccess(
id,
handle,
pos,
start_idx,
configFromUriOr(uri, config),
),
.string_literal => try gotoDefinitionString(id, pos_index, handle, config),
2020-05-18 21:19:23 +01:00
else => try respondGeneric(id, null_result_response),
}
}
} else if (std.mem.eql(u8, method, "textDocument/hover")) {
const document = params.getValue("textDocument").?.Object;
const uri = document.getValue("uri").?.String;
const position = params.getValue("position").?.Object;
const handle = document_store.getHandle(uri) orelse {
std.debug.warn("Trying to got to definition in non existent document {}", .{uri});
return try respondGeneric(id, null_result_response);
};
const pos = types.Position{
.line = position.getValue("line").?.Integer,
.character = position.getValue("character").?.Integer - 1,
};
if (pos.character >= 0) {
const pos_index = try handle.document.positionToIndex(pos);
const pos_context = documentPositionContext(handle.document, pos_index);
switch (pos_context) {
.var_access => try hoverDefinitionGlobal(
id,
pos_index,
handle,
configFromUriOr(uri, config),
),
.field_access => |start_idx| try hoverDefinitionFieldAccess(
id,
handle,
pos,
start_idx,
configFromUriOr(uri, config),
),
else => try respondGeneric(id, null_result_response),
}
}
2020-04-24 23:19:03 +01:00
} else if (root.Object.getValue("id")) |_| {
2020-05-18 16:36:47 +01:00
std.debug.warn("Method with return value not implemented: {}", .{method});
2020-04-24 23:19:03 +01:00
try respondGeneric(id, not_implemented_response);
} else {
2020-05-18 16:36:47 +01:00
std.debug.warn("Method without return value not implemented: {}", .{method});
2020-04-24 23:19:03 +01:00
}
}
2020-05-17 12:40:32 +01:00
var debug_alloc_state: DebugAllocator = undefined;
2020-05-07 10:58:35 +01:00
// We can now use if(leak_count_alloc) |alloc| { ... } as a comptime check.
2020-05-17 12:40:32 +01:00
const debug_alloc: ?*DebugAllocator = if (build_options.allocation_info) &debug_alloc_state else null;
2020-04-24 23:19:03 +01:00
pub fn main() anyerror!void {
// TODO: Use a better purpose general allocator once std has one.
// Probably after the generic composable allocators PR?
2020-05-14 15:22:15 +01:00
// This is not too bad for now since most allocations happen in local arenas.
allocator = std.heap.page_allocator;
2020-04-24 23:19:03 +01:00
if (build_options.allocation_info) {
// TODO: Use a better debugging allocator, track size in bytes, memory reserved etc..
// Initialize the leak counting allocator.
2020-05-17 12:40:32 +01:00
debug_alloc_state = DebugAllocator.init(allocator);
allocator = &debug_alloc_state.allocator;
}
// Init global vars
const in_stream = std.io.getStdIn().inStream();
stdout = std.io.bufferedOutStream(std.io.getStdOut().outStream());
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{};
defer std.json.parseFree(Config, config, config_parse_options);
config_read: {
const known_folders = @import("known-folders");
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 has_zig = false;
2020-05-25 15:24:44 +01:00
// TODO: Should we just spawn a child process that calls "zig version" or something
// and check that way?
find_zig: {
const env_path = std.process.getEnvVarOwned(allocator, "PATH") catch |err| switch (err) {
error.EnvironmentVariableNotFound => {
std.debug.warn("Could not get PATH.\n", .{});
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{}", .{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;
const zig_path = std.os.realpath(full_path, &buf) catch continue;
std.debug.warn("Found zig in PATH: {}\n", .{zig_path});
has_zig = true;
break :find_zig;
}
}
if (config.build_runner_path) |build_runner_path| {
try document_store.init(allocator, has_zig, try std.mem.dupe(allocator, u8, build_runner_path));
} else {
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);
const build_runner_path = try std.fs.path.resolve(allocator, &[_][]const u8{ exe_dir_path, "build_runner.zig" });
try document_store.init(allocator, has_zig, build_runner_path);
2020-05-25 17:33:08 +01:00
}
defer document_store.deinit();
workspace_folder_configs = std.StringHashMap(?Config).init(allocator);
defer workspace_folder_configs.deinit();
// This JSON parser is passed to processJsonRpc and reset.
var json_parser = std.json.Parser.init(allocator, false);
defer json_parser.deinit();
2020-05-17 15:50:13 +01:00
while (true) {
2020-05-17 16:26:00 +01:00
const headers = readRequestHeader(allocator, in_stream) catch |err| {
2020-05-18 16:36:47 +01:00
std.debug.warn("{}; exiting!", .{@errorName(err)});
2020-04-24 23:19:03 +01:00
return;
2020-05-17 15:50:13 +01:00
};
defer headers.deinit(allocator);
const buf = try allocator.alloc(u8, headers.content_length);
defer allocator.free(buf);
2020-05-17 16:26:00 +01:00
try in_stream.readNoEof(buf);
2020-05-17 15:50:13 +01:00
try processJsonRpc(&json_parser, buf, config);
json_parser.reset();
2020-04-24 23:19:03 +01:00
if (debug_alloc) |dbg| {
2020-05-18 17:37:56 +01:00
std.debug.warn("{}\n", .{dbg.info});
}
2020-04-24 23:19:03 +01:00
}
}