Merge branch 'topic/vadim/image' into 'master'

Report error when image directory is parent of output directory

Closes #139 and #140

See merge request eng/ide/gnatdoc!200

Author: godunko

source/backend/gnatdoc-backend-html.adb

@@ -23,13 +23,16 @@ with GNATCOLL.VFS;
 with Input_Sources.File;
 
 with VSS.HTML.Writers;
+with VSS.Strings.Formatters.Virtual_Files;
 with VSS.Strings.Conversions;
+with VSS.Strings.Templates;
 with VSS.String_Vectors;
 with VSS.XML.Templates.Processors;
 with VSS.XML.Templates.Proxies.Booleans;
 with VSS.XML.XmlAda_Readers;
 
 with GNATdoc.Entities.Proxies;
+with GNATdoc.Messages;
 with Streams;
 
 package body GNATdoc.Backend.HTML is
@@ -419,7 +422,19 @@ package body GNATdoc.Backend.HTML is
             Images_Dir.Make_Dir;
 
             for Directory of reverse Self.Image_Directories loop
-               Directory.Copy (Images_Dir.Full_Name.all, Success);
+               if GNATCOLL.VFS.Greatest_Common_Path
+                 ([Self.Output_Root, Directory]) = Directory
+               then
+                  GNATdoc.Messages.Report_Warning
+                    (VSS.Strings.Templates.To_Virtual_String_Template
+                     ("image directory `{:fullname}` can't be parent of"
+                        & " output directory").Format
+                       (VSS.Strings.Formatters.Virtual_Files.Image
+                            (Directory)));
+
+               else
+                  Directory.Copy (Images_Dir.Full_Name.all, Success);
+               end if;
             end loop;
          end;
       end if;

source/gnatdoc/gnatdoc-projects.adb

@@ -206,6 +206,13 @@ package body GNATdoc.Projects is
 
                   if Directory.Is_Directory then
                      Result.Append (Directory);
+
+                  else
+                     GNATdoc.Messages.Report_Warning
+                       (VSS.Strings.Templates.Virtual_String_Template'
+                          ("`{:fullname}` is not a directory").Format
+                            (VSS.Strings.Formatters.Virtual_Files.Image
+                                 (Directory)));
                   end if;
                end loop;
             end;

source/vss-strings-formatters-virtual_files.adb

@@ -1,7 +1,7 @@
 ------------------------------------------------------------------------------
 --                    GNAT Documentation Generation Tool                    --
 --                                                                          --
---                       Copyright (C) 2024, AdaCore                        --
+--                     Copyright (C) 2024-2025, AdaCore                     --
 --                                                                          --
 -- This is free software;  you can redistribute it  and/or modify it  under --
 -- terms of the  GNU General Public License as published  by the Free Soft- --
@@ -28,9 +28,19 @@ package body VSS.Strings.Formatters.Virtual_Files is
       Format : VSS.Strings.Formatters.Format_Information)
       return VSS.Strings.Virtual_String is
    begin
-      return
-        VSS.Strings.Conversions.To_Virtual_String
-          (Self.Value.Display_Base_Name);
+      if Format.Format.Is_Empty or Format.Format = "basename" then
+         return
+           VSS.Strings.Conversions.To_Virtual_String
+             (Self.Value.Display_Base_Name);
+
+      elsif Format.Format = "fullname" then
+         return
+           VSS.Strings.Conversions.To_Virtual_String
+             (Self.Value.Display_Full_Name);
+
+      else
+         raise Program_Error;
+      end if;
    end Format;
 
    -----------

testsuite/executable/html-image_dirs-warnings/default.gpr

@@ -0,0 +1,8 @@
+
+project Default is
+
+  package Documentation is
+    for Image_Dirs ("html") use (".", "images");
+  end Documentation;
+
+end Default;

testsuite/executable/html-image_dirs-warnings/p.ads

@@ -0,0 +1,4 @@
+
+package P is
+
+end P;

testsuite/executable/html-image_dirs-warnings/test.out

@@ -0,0 +1,2 @@
+warning: `<<WORKING_DIR>>/images` is not a directory
+warning: image directory `<<WORKING_DIR>>/./` can't be parent of output directory

testsuite/executable/html-image_dirs-warnings/test.sh

@@ -0,0 +1 @@
+$GNATDOC4 default.gpr

testsuite/executable/html-image_dirs-warnings/test.yaml

@@ -0,0 +1,2 @@
+description: Check that message is reported when image directory is parent of output directory
+driver: executable

testsuite/testsuite.py

@@ -3,9 +3,10 @@
 from os import environ
 from os.path import abspath, dirname, join
 import sys
+from typing import List
 
 from e3.testsuite import Testsuite
-from e3.testsuite.driver.diff import DiffTestDriver
+from e3.testsuite.driver.diff import DiffTestDriver, OutputRefiner, ReplacePath
 
 
 class LibGNATdocExtractorDriver(DiffTestDriver):
@@ -49,6 +50,12 @@ def run(self):
 
         self.shell(args=["bash", script_path], env=self.test_environ)
 
+    @property
+    def output_refiners(self) -> List[OutputRefiner]:
+        return super(GNATdocExecutableDriver, self).output_refiners + [
+            ReplacePath(self.working_dir(), "<<WORKING_DIR>>")
+        ]
+
 
 class LibGNATdocTestsuite(Testsuite):
     """Testsuite for the LibGNATdoc library"""