Add new GPS.Project.get_executable_file function

To handle the case where the root project extends another
project, defining a new exec directory without defining a new
main file.

We always want to compute the executable's path from a
project's exec directory.

Deprecate the GPS.File.executable_path property, since it can't
handle complex cases involving extended projects: its usage
has been replaced by the API instead.

Fixes eng/shared/integration-testsuite#15

Author: AnthonyLeonardoGracio

docs/users_guide/GPS.rst

@@ -1814,6 +1814,8 @@ Classes
 
    .. automethod:: GPS.Project.get_config
 
+   .. automethod:: GPS.Project.get_executable_file
+
    .. automethod:: GPS.Project.get_executable_name
 
    .. automethod:: GPS.Project.get_extended_project

docs/users_guide/GPS/__init__.py

@@ -5982,6 +5982,12 @@ class File(object):
 
     executable_path = None
     """
+    OBSOLESCENT.
+
+    This property is deprecated since it does not handle extended projects
+    properly. Please use the :func:`GPS.Project.get_executable_file`
+    function instead.
+
     Return a :class:`File` instance of the executable associated with this
     file.
 
@@ -9055,6 +9061,16 @@ def get_executable_name(self, main):
         """
         pass  # implemented in Ada
 
+    def get_executable_file(self, main):
+        """
+        Returns the executable file computed from `main`.
+        This handles extended projects as well.
+
+        :param GPS.File main: the main source file
+        :return: An instance of :class:`GPS.Project`
+        """
+        pass  # implemented via a Python extension
+
     def get_extended_project(self):
         """
         Return the project extended by project.

share/support/core/projects.py

@@ -11,6 +11,8 @@
 
 
 import GPS
+import extensions
+import os.path
 
 XML = r"""<?xml version="1.0" ?>
 <GNAT_Studio>
@@ -513,3 +515,25 @@
 """
 
 GPS.parse_xml(XML)
+
+
+"""
+Extension of the GPS.Project class.
+
+Used to provide small helpers on top of existing functions
+implemented in Ada.
+"""
+@extensions.extend_module(GPS)
+class Project:
+    def get_executable_file(self, main):
+        """
+        Returns the executable file computed from `main`.
+        This handles extended projects as well.
+
+        :param GPS.File main: the main source file
+        :return: An instance of :class:`GPS.Project`
+        """
+        exe_name = self.get_executable_name(main)
+        exec_dir = self.exec_dir()
+        exec_file = GPS.File(os.path.join(exec_dir, exe_name))
+        return exec_file

share/support/ui/board_support.py

@@ -497,7 +497,7 @@ def __flash_wf(self, main_name):
             return
 
         # Get the executable path
-        exe = GPS.File(main_name).executable_path.path
+        exe = GPS.Project.root().get_executable_file(GPS.File(main_name)).path
 
         # Retrieve the load address of the executable with objdump
         self.__display_message("Retrieving the load address.")

share/support/ui/gnatcov.py

@@ -797,7 +797,7 @@ def run_gnatcov_wf(self, main_name):
             return
 
         # Get the executable to analyze
-        exe = str(GPS.File(main_name).executable_path)
+        exe = GPS.Project.root().get_executable_file(GPS.File(main_name)).path
 
         # Run GNATcov on it
         p = promises.TargetWrapper("Run under GNATcov")
@@ -910,7 +910,7 @@ def run_gnatcov_with_instrumentation_wf(self, main_name):
         GNATcovPlugin.check_for_defined_level(cmds=["instrument", "coverage"])
 
         # Get the executable to analyze
-        exe = str(GPS.File(main_name).executable_path)
+        exe = GPS.Project.root().get_executable_file(GPS.File(main_name)).path
 
         # Don't build/install the GNATcov runtime if a prebuilt one has been
         # specified.

share/support/ui/gnatemulator.py

@@ -11,6 +11,7 @@
 from modules import Module
 import workflows.promises as promises
 import workflows
+import os.path
 from os_utils import locate_exec_on_path
 from gs_utils.console_process import Console_Process
 
@@ -224,11 +225,11 @@ def build_and_run(main_name, in_console=True):
         except RuntimeError:
             return
 
-        # Get the name of the generated binary
-        bin_name = GPS.File(main_name).executable_path.path
+        # Get the path of the generated binary, computing it from the root project.
+        exec_file = GPS.Project.root().get_executable_file(GPS.File(main_name))
 
         # STEP 2 launch with Emulator
-        yield GNATemulator.run_gnatemu([bin_name], in_console)
+        yield GNATemulator.run_gnatemu([exec_file.path], in_console)
 
     @staticmethod
     def build_and_debug(main_name):
@@ -249,7 +250,9 @@ def build_and_debug(main_name):
             # Build error, we stop there
             return
 
-        binary = GPS.File(main_name).executable_path.path
+        # Get the executable path
+        exe = GPS.Project.root().get_executable_file(GPS.File(main_name)).path
+
         # STEP 2 Switch to the "Debug" perspective To have GNATemu console in
         # the debugger perspective.
 
@@ -266,14 +269,14 @@ def build_and_debug(main_name):
 
         yield GNATemulator.run_gnatemu(["--freeze-on-startup",
                                         "--gdb=%s" % debug_port,
-                                        binary])
+                                        exe])
 
         log("... done.")
 
         # STEP 3 launch the debugger
         try:
             debugger_promise = promises.DebuggerWrapper(
-                GPS.File(binary),
+                GPS.File(exe),
                 remote_target="localhost:" + debug_port,
                 remote_protocol="remote")
         except Exception: