Fixed function hovering showing up as result type

Closes Type prefixed functions display wrong signature upon hover #22

Author: gnikit

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELONG
 
+## 2.2.2
+
+### Fixed
+
+- Fixed hovering over functions displaying as theire result types
+  ([gnikit/fortls#22](https://github.com/gnikit/fortls/issues/22))
+
 ## 2.2.1
 
 ### Changed

fortls/langserver.py

@@ -740,7 +740,9 @@ def get_definition(
                 )
             ):
                 curr_scope = curr_scope.parent
-            var_obj = find_in_scope(curr_scope, def_name, self.obj_tree)
+            var_obj = find_in_scope(
+                curr_scope, def_name, self.obj_tree, var_line_number=def_line + 1
+            )
         # Search in global scope
         if var_obj is None:
             if is_member:

fortls/objects.py

@@ -165,9 +165,13 @@ def find_in_scope(
     obj_tree: dict,
     interface: bool = False,
     local_only: bool = False,
+    var_line_number: int = None,
 ):
     def check_scope(
-        local_scope: fortran_scope, var_name_lower: str, filter_public: bool = False
+        local_scope: fortran_scope,
+        var_name_lower: str,
+        filter_public: bool = False,
+        var_line_number: int = None,
     ):
         for child in local_scope.get_children():
             if child.name.startswith("#GEN_INT"):
@@ -178,6 +182,19 @@ def check_scope(
                 if (child.vis < 0) or ((local_scope.def_vis < 0) and (child.vis <= 0)):
                     continue
             if child.name.lower() == var_name_lower:
+                # For functions with an implicit result() variable the name
+                # of the function is used. If we are hovering over the function
+                # definition, we do not want the implicit result() to be returned.
+                # If scope is from a function and child's name is same as functions name
+                # and start of scope i.e. function definition is equal to the request ln
+                # then we are need to skip this child
+                if (
+                    isinstance(local_scope, fortran_function)
+                    and local_scope.name.lower() == child.name.lower()
+                    and local_scope.sline == var_line_number
+                ):
+                    return None
+
                 return child
         return None
 
@@ -186,7 +203,7 @@ def check_scope(
     # Check local scope
     if scope is None:
         return None
-    tmp_var = check_scope(scope, var_name_lower)
+    tmp_var = check_scope(scope, var_name_lower, var_line_number=var_line_number)
     if local_only or (tmp_var is not None):
         return tmp_var
     # Check INCLUDE statements

test/test_server.py

@@ -573,6 +573,10 @@ def check_return(result_array, checks):
     string += hover_req(file_path, 7, 55)
     file_path = test_dir / "hover" / "pointers.f90"
     string += hover_req(file_path, 1, 26)
+    file_path = test_dir / "hover" / "functions.f90"
+    string += hover_req(file_path, 1, 11)
+    string += hover_req(file_path, 7, 19)
+
     errcode, results = run_request(
         string, fortls_args=["--variable_hover", "--sort_keywords"]
     )
@@ -590,6 +594,10 @@ def check_return(result_array, checks):
         "DOUBLE PRECISION, PARAMETER :: somevar = 23.12",
         "DOUBLE PRECISION, PARAMETER :: some = 1e-19",
         "INTEGER, POINTER",
+        """FUNCTION fun1(arg)
+ INTEGER, INTENT(IN) :: arg""",
+        """INTEGER FUNCTION fun2(arg)
+ INTEGER, INTENT(IN) :: arg""",
     )
     assert len(ref_results) == len(results) - 1
     check_return(results[1:], ref_results)

test/test_source/hover/functions.f90

@@ -0,0 +1,10 @@
+! simple function
+function fun1(arg)
+    integer, intent(in) :: arg
+    integer :: fun1
+end function fun1
+
+! function with type on definition, implied result
+integer function fun2(arg)
+    integer, intent(in) :: arg
+end function fun2