[#22] Code Navigation and tests

.travis.yml

@@ -3,7 +3,7 @@ otp_release:
   - 22.0
   - 21.3
 script:
-  - rebar3 as test do compile, proper --cover, xref, cover, coveralls send
+  - rebar3 as test do compile, ct, proper --cover, dialyzer, xref, cover, coveralls send
 cache:
   directories:
      - "$HOME/.cache/rebar3"

priv/code_navigation/include/code_navigation.hrl

@@ -0,0 +1,3 @@
+-record(included_record_a, {field_a, field_b}).
+
+-define(INCLUDED_MACRO_A, included_macro_a).

priv/code_navigation/src/behaviour_a.erl

@@ -0,0 +1,3 @@
+-module(behaviour_a).
+
+-callback callback_a() -> ok.

priv/code_navigation/src/code_navigation.erl

@@ -0,0 +1,29 @@
+-module(code_navigation).
+
+-behaviour(behaviour_a).
+
+-export([ function_a/0 ]).
+
+%% behaviour_a callbacks
+-export([ callback_a/0 ]).
+
+-include("code_navigation.hrl").
+-include_lib("code_navigation/include/code_navigation.hrl").
+
+-record(record_a, {field_a, field_b}).
+
+-define(MACRO_A, macro_a).
+
+function_a() ->
+  function_b(),
+  #record_a{}.
+
+function_b() ->
+  ?MACRO_A.
+
+callback_a() ->
+  ok.
+
+function_c() ->
+  code_navigation_extra:do(test),
+  length([1, 2, 3]).

priv/code_navigation/src/code_navigation_extra.erl

@@ -0,0 +1,6 @@
+-module(code_navigation_extra).
+
+-export([ do/1 ]).
+
+do(_Config) ->
+  ok.

src/erlang_ls_buffer.erl

@@ -140,12 +140,12 @@ do_get_mfa(Text, Line, _Character) ->
   {M, F, A}.
 
 -spec do_get_element_at_pos(binary(), non_neg_integer(), non_neg_integer()) ->
-   [erlang_ls_parser:poi()].
+   [erlang_ls_poi:poi()].
 do_get_element_at_pos(Text, Line, Column) ->
   %% TODO: Cache tree
   {ok, Tree} = erlang_ls_parser:parse(Text),
-  AnnotatedTree = erlang_ls_parser:annotate(Tree),
-  erlang_ls_parser:find_poi_by_pos(AnnotatedTree, {Line, Column}).
+  AnnotatedTree = erlang_ls_tree:annotate(Tree),
+  erlang_ls_poi:match_pos(AnnotatedTree, {Line, Column}).
 
 -spec get_line_text(binary(), integer()) -> binary().
 get_line_text(Text, Line) ->

src/erlang_ls_code_navigation.erl

@@ -0,0 +1,173 @@
+%%==============================================================================
+%% Code Navigation
+%%==============================================================================
+-module(erlang_ls_code_navigation).
+
+%%==============================================================================
+%% Exports
+%%==============================================================================
+
+%% API
+-export([ goto_definition/2
+        , goto_definition/3
+        ]).
+
+%%==============================================================================
+%% Includes
+%%==============================================================================
+-include("erlang_ls.hrl").
+
+%%==============================================================================
+%% Macros
+%%==============================================================================
+-define(OTP_INCLUDE_PATH, "/usr/local/Cellar/erlang/21.2.4/lib/erlang/lib").
+%% TODO: Implement support for workspaces
+-define(ERLANG_LS_PATH, "/Users/robert.aloi/git/github/erlang-ls/erlang_ls").
+-define(TEST_APP_PATH, "/Users/robert.aloi/git/github/erlang-ls/test").
+-define(DEPS_PATH, "/Users/robert.aloi/git/github/erlang-ls/erlang_ls/_build/debug/lib").
+
+%%==============================================================================
+%% API
+%%==============================================================================
+
+-spec goto_definition(binary(), erlang_ls_poi:poi()) ->
+   {ok, binary(), erlang_ls_poi:range()} | {error, any()}.
+goto_definition(Filename, POI) ->
+  goto_definition(Filename, POI, full_path()).
+
+-spec goto_definition(binary(), erlang_ls_poi:poi(), [string()]) ->
+   {ok, binary(), erlang_ls_poi:range()} | {error, any()}.
+goto_definition( _Filename
+               , #{ info := {application, {M, _F, _A}} = Info }
+               , Path) ->
+  case erlang_ls_tree:annotate_file(filename(M), Path) of
+    {ok, FullName, AnnotatedTree} ->
+      case erlang_ls_poi:match(AnnotatedTree, definition(Info)) of
+        [#{ range := Range }] ->
+          {ok, FullName, Range};
+        [] ->
+          {error, not_found}
+      end;
+    {error, Error} ->
+      {error, Error}
+  end;
+goto_definition( Filename
+               , #{ info := {application, {_F, _A}} = Info }
+               , Path) ->
+  case erlang_ls_tree:annotate_file(filename:basename(Filename), Path) of
+    {ok, FullName, AnnotatedTree} ->
+      case erlang_ls_poi:match(AnnotatedTree, definition(Info)) of
+        [#{ range := Range }] ->
+          {ok, FullName, Range};
+        [] ->
+          {error, not_found}
+      end;
+    {error, Error} ->
+      {error, Error}
+  end;
+goto_definition(_Filename, #{ info := {behaviour, Behaviour} = Info }, Path) ->
+  search(filename(Behaviour), Path, definition(Info));
+%% TODO: Eventually search everywhere and suggest a code lens to include a file
+goto_definition(Filename, #{ info := {macro, _Define} = Info }, Path) ->
+  search(filename:basename(Filename), Path, definition(Info));
+goto_definition(Filename, #{ info := {record_expr, _Record} = Info }, Path) ->
+  search(filename:basename(Filename), Path, definition(Info));
+goto_definition(_Filename, #{ info := {include, Include0} }, Path) ->
+  Include = list_to_binary(string:trim(Include0, both, [$"])),
+  case erlang_ls_tree:annotate_file(Include, Path) of
+    {ok, FullName, _AnnotatedTree} ->
+      {ok, FullName, #{ from => {0, 0}, to => {0, 0} }};
+    {error, Error} ->
+      {error, Error}
+  end;
+goto_definition(_Filename, #{ info := {include_lib, Include0} }, Path) ->
+  Include = list_to_binary(lists:last(filename:split(string:trim(Include0, both, [$"])))),
+  case erlang_ls_tree:annotate_file(Include, Path) of
+    {ok, FullName, _AnnotatedTree} ->
+      {ok, FullName, #{ from => {0, 0}, to => {0, 0} }};
+    {error, Error} ->
+      {error, Error}
+  end;
+goto_definition(_Filename, _, _Path) ->
+  {error, not_found}.
+
+-spec definition({atom(), any()}) -> {atom(), any()}.
+definition({application, {_M, F, A}}) ->
+  {function, {F, A}};
+definition({application, {F, A}}) ->
+  {function, {F, A}};
+definition({behaviour, Behaviour}) ->
+  {module, Behaviour};
+definition({macro, Define}) ->
+  {define, Define};
+definition({record_expr, Record}) ->
+  {record, Record}.
+
+-spec otp_path() -> [string()].
+otp_path() ->
+  filelib:wildcard(filename:join([?OTP_INCLUDE_PATH, "*/src"])).
+
+-spec app_path() -> [string()].
+app_path() ->
+  [ filename:join([?TEST_APP_PATH, "src"])
+  , filename:join([?TEST_APP_PATH, "include"])
+  , filename:join([?ERLANG_LS_PATH, "src"])
+  , filename:join([?TEST_APP_PATH, "include"])
+  ].
+
+-spec deps_path() -> [string()].
+deps_path() ->
+  filelib:wildcard(filename:join([?DEPS_PATH, "*/src"])).
+
+full_path() ->
+  lists:append( [ app_path() , deps_path() , otp_path() ]).
+
+%% Look for a definition recursively in a file and its includes.
+-spec search(binary(), [string()], any()) ->
+   {ok, binary(), erlang_ls_poi:range()} | {error, any()}.
+search(Filename, Path, Thing) ->
+  case erlang_ls_tree:annotate_file(Filename, Path) of
+    {ok, FullName, AnnotatedTree} ->
+      case find(AnnotatedTree, Thing) of
+        {error, not_found} ->
+          Includes = erlang_ls_poi:match_key(AnnotatedTree, include),
+          IncludeLibs = erlang_ls_poi:match_key(AnnotatedTree, include_lib),
+          search_in_includes(Includes ++ IncludeLibs, Path, Thing);
+        {ok, Range} ->
+          {ok, FullName, Range}
+      end;
+    {error, Error} ->
+      {error, Error}
+  end.
+
+%% Look for a definition in a given tree
+-spec find(erlang_ls_tree:tree(), any()) ->
+   {ok, erlang_ls_poi:range()} | {error, any()}.
+find(AnnotatedTree, Thing) ->
+  case erlang_ls_poi:match(AnnotatedTree, Thing) of
+    [#{ range := Range }|_] ->
+      {ok, Range};
+    [] ->
+      {error, not_found}
+  end.
+
+-spec search_in_includes([erlang_ls_poi:poi()], [string()], any()) ->
+   {ok, binary(), erlang_ls_poi:range()} | {error, any()}.
+search_in_includes([], _Path, _Thing) ->
+  {error, not_found};
+search_in_includes([#{info := Info}|T], Path, Thing) ->
+  Include = normalize_include(Info),
+  case search(list_to_binary(Include), Path, Thing) of
+    {error, _Error} -> search_in_includes(T, Path, Thing);
+    {ok, FullName, Range} -> {ok, FullName, Range}
+  end.
+
+-spec normalize_include({atom(), string()}) -> string().
+normalize_include({include, Include}) ->
+  string:trim(Include, both, [$"]);
+normalize_include({include_lib, Include}) ->
+  lists:last(filename:split(string:trim(Include, both, [$"]))).
+
+-spec filename(atom()) -> binary().
+filename(Module) ->
+  list_to_binary(atom_to_list(Module) ++ ".erl").

src/erlang_ls_completion.erl

@@ -3,7 +3,6 @@
 -export([ record_definitions/0
         ]).
 
-%% TODO: Store these in an ETS table
 -spec record_definitions() -> [atom()].
 record_definitions() ->
   lists:usort(lists:flatten([record_definitions(B) || B <- all_beams()])).