util/add-depends.pl: Adapt to localized /showIncludes output

[openssl.git] / util / add-depends.pl

diff --git a/util/add-depends.pl b/util/add-depends.pl
index 31996c4edd89770aea85877bac7e2004d92f0b4e..5aa03c4740798fbe283a90eb7025829996479ca1 100644 (file)
--- a/util/add-depends.pl
+++ b/util/add-depends.pl
@@ -1,7 +1,7 @@
 #! /usr/bin/env perl
 #! /usr/bin/env perl

-# Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
+# Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.

 #
 #

-# Licensed under the OpenSSL license (the "License").  You may not use
+# Licensed under the Apache License 2.0 (the "License").  You may not use

 # this file except in compliance with the License.  You can obtain a copy
 # in the file LICENSE in the source distribution or at
 # https://www.openssl.org/source/license.html
 # this file except in compliance with the License.  You can obtain a copy
 # in the file LICENSE in the source distribution or at
 # https://www.openssl.org/source/license.html


@@ -12,13 +12,15 @@ use warnings;
 use lib '.';
 use configdata;
 
 use lib '.';
 use configdata;
 

-use File::Spec::Functions qw(canonpath rel2abs);
+use File::Spec::Functions qw(:DEFAULT rel2abs);

 use File::Compare qw(compare_text);
 use File::Compare qw(compare_text);

+use feature 'state';

 
 # When using stat() on Windows, we can get it to perform better by avoid some
 # data.  This doesn't affect the mtime field, so we're not losing anything...
 ${^WIN32_SLOPPY_STAT} = 1;
 
 
 # When using stat() on Windows, we can get it to perform better by avoid some
 # data.  This doesn't affect the mtime field, so we're not losing anything...
 ${^WIN32_SLOPPY_STAT} = 1;
 

+my $debug = $ENV{ADD_DEPENDS_DEBUG};

 my $buildfile = $config{build_file};
 my $build_mtime = (stat($buildfile))[9];
 my $rebuild = 0;
 my $buildfile = $config{build_file};
 my $build_mtime = (stat($buildfile))[9];
 my $rebuild = 0;


@@ -34,19 +36,38 @@ my @depfiles =
         scalar @st > 0;         # Determines the grep result
     }
     map { (my $x = $_) =~ s|\.o$|$depext|; $x; }
         scalar @st > 0;         # Determines the grep result
     }
     map { (my $x = $_) =~ s|\.o$|$depext|; $x; }

-    grep { $unified_info{sources}->{$_}->[0] =~ /\.cc?$/ }
-    keys %{$unified_info{sources}};
+    ( ( grep { $unified_info{sources}->{$_}->[0] =~ /\.cc?$/ }
+            keys %{$unified_info{sources}} ),
+      ( grep { $unified_info{shared_sources}->{$_}->[0] =~ /\.cc?$/ }
+            keys %{$unified_info{shared_sources}} ) );

 
 exit 0 unless $rebuild;
 
 # Ok, primary checks are done, time to do some real work
 
 
 exit 0 unless $rebuild;
 
 # Ok, primary checks are done, time to do some real work
 

-my $abs_srcdir = rel2abs($config{sourcedir});
-my $abs_blddir = rel2abs($config{builddir});
-

 my $producer = shift @ARGV;
 die "Producer not given\n" unless $producer;
 
 my $producer = shift @ARGV;
 die "Producer not given\n" unless $producer;
 

+my $srcdir = $config{sourcedir};
+my $blddir = $config{builddir};
+my $abs_srcdir = rel2abs($srcdir);
+my $abs_blddir = rel2abs($blddir);
+
+# Convenient cache of absolute to relative map.  We start with filling it
+# with mappings for the known generated header files.  They are relative to
+# the current working directory, so that's an easy task.
+# NOTE: there's more than C header files that are generated.  They will also
+# generate entries in this map.  We could of course deal with C header files
+# only, but in case we decide to handle more than just C files in the future,
+# we already have the mechanism in place here.
+# NOTE2: we lower case the index to make it searchable without regard for
+# character case.  That could seem dangerous, but as long as we don't have
+# files we depend on in the same directory that only differ by character case,
+# we're fine.
+my %depconv_cache =
+    map { catfile($abs_blddir, $_) => $_ }
+    keys %{$unified_info{generate}};
+

 my %procedures = (
     'gcc' => undef,             # gcc style dependency files needs no mods
     'makedepend' =>
 my %procedures = (
     'gcc' => undef,             # gcc style dependency files needs no mods
     'makedepend' =>


@@ -78,6 +99,14 @@ my %procedures = (
         },
     'VMS C' =>
         sub {
         },
     'VMS C' =>
         sub {

+            state $abs_srcdir_shaved = undef;
+            state $srcdir_shaved = undef;
+
+            unless (defined $abs_srcdir_shaved) {
+                ($abs_srcdir_shaved = $abs_srcdir) =~ s|[>\]]$||;
+                ($srcdir_shaved = $srcdir) =~ s|[>\]]$||;
+            }
+

             # current versions of DEC / Compaq / HP / VSI C strips away all
             # directory information from the object file, so we must insert it
             # back.  To make life simpler, we simply replace it with the
             # current versions of DEC / Compaq / HP / VSI C strips away all
             # directory information from the object file, so we must insert it
             # back.  To make life simpler, we simply replace it with the


@@ -109,19 +138,45 @@ my %procedures = (
             # All we got now is a dependency, just shave off surrounding spaces
             $line =~ s/^\s+//;
             $line =~ s/\s+$//;
             # All we got now is a dependency, just shave off surrounding spaces
             $line =~ s/^\s+//;
             $line =~ s/\s+$//;

-            return ($objfile, $line);
+
+            # VMS C gives us absolute paths, always.  Let's see if we can
+            # make them relative instead.
+            $line = canonpath($line);
+
+            unless (defined $depconv_cache{$line}) {
+                my $dep = $line;
+                # Since we have already pre-populated the cache with
+                # mappings for generated headers, we only need to deal
+                # with the source tree.
+                if ($dep =~ s|^\Q$abs_srcdir_shaved\E([\.>\]])?|$srcdir_shaved$1|i) {
+                    $depconv_cache{$line} = $dep;
+                }
+            }
+            return ($objfile, $depconv_cache{$line})
+                if defined $depconv_cache{$line};
+            print STDERR "DEBUG[$producer]: ignoring $objfile <- $line\n"
+                if $debug;
+
+            return undef;

         },
     'VC' =>
         sub {
         },
     'VC' =>
         sub {

-            # For the moment, we only support Visual C on native Windows, or
-            # compatible compilers.  With those, the flags /Zs /showIncludes
-            # give us the necessary output to be able to create dependencies
-            # that nmake (or any 'make' implementation) should be able to read,
-            # with a bit of help.  The output we're interested in looks like
-            # this (it always starts the same)
+            # With Microsoft Visual C the flags /Zs /showIncludes give us the
+            # necessary output to be able to create dependencies that nmake
+            # (or any 'make' implementation) should be able to read, with a
+            # bit of help.  The output we're interested in looks something
+            # like this (it always starts the same)

             #
             #   Note: including file: {whatever header file}
             #
             #
             #   Note: including file: {whatever header file}
             #

+            # This output is localized, so for example, the German pack gives
+            # us this:
+            #
+            #   Hinweis: Einlesen der Datei:   {whatever header file}
+            #
+            # To accomodate, we need to use a very general regular expression
+            # to parse those lines.
+            #

             # Since there's no object file name at all in that information,
             # we must construct it ourselves.
 
             # Since there's no object file name at all in that information,
             # we must construct it ourselves.
 


@@ -132,17 +187,73 @@ my %procedures = (
             # warnings, so we simply discard anything that doesn't start with
             # the Note:
 
             # warnings, so we simply discard anything that doesn't start with
             # the Note:
 

-            if (/^Note: including file: */) {
+            if (/^[^:]*: [^:]*: */) {

                 (my $tail = $') =~ s/\s*\R$//;
 
                 # VC gives us absolute paths for all include files, so to
                 # remove system header dependencies, we need to check that
                 (my $tail = $') =~ s/\s*\R$//;
 
                 # VC gives us absolute paths for all include files, so to
                 # remove system header dependencies, we need to check that

-                # they don't match $abs_srcdir or $abs_blddir
+                # they don't match $abs_srcdir or $abs_blddir.

                 $tail = canonpath($tail);
                 $tail = canonpath($tail);

-                if ($tail =~ m|^\Q$abs_srcdir\E|i
-                        || $tail =~ m|^\Q$abs_blddir\E|i) {
-                    return ($objfile, "\"$tail\"");
+
+                unless (defined $depconv_cache{$tail}) {
+                    my $dep = $tail;
+                    # Since we have already pre-populated the cache with
+                    # mappings for generated headers, we only need to deal
+                    # with the source tree.
+                    if ($dep =~ s|^\Q$abs_srcdir\E\\|\$(SRCDIR)\\|i) {
+                        $depconv_cache{$tail} = $dep;
+                    }
+                }
+                return ($objfile, '"'.$depconv_cache{$tail}.'"')
+                    if defined $depconv_cache{$tail};
+                print STDERR "DEBUG[$producer]: ignoring $objfile <- $tail\n"
+                    if $debug;
+            }
+
+            return undef;
+        },
+    'embarcadero' =>
+        sub {
+            # With Embarcadero C++Builder's preprocessor (cpp32.exe) the -Sx -Hp
+            # flags give us the list of #include files read, like the following:
+            #
+            #   Including ->->{whatever header file}
+            #
+            # where each "->" indicates the nesting level of the #include.  The
+            # logic here is otherwise the same as the 'VC' scheme.
+            #
+            # Since there's no object file name at all in that information,
+            # we must construct it ourselves.
+
+            (my $objfile = shift) =~ s|\.d$|.obj|i;
+            my $line = shift;
+
+            # There are also other lines mixed in, for example compiler
+            # warnings, so we simply discard anything that doesn't start with
+            # the Note:
+
+            if (/^Including (->)*/) {
+                (my $tail = $') =~ s/\s*\R$//;
+
+                # C++Builder gives us relative paths when possible, so to
+                # remove system header dependencies, we convert them to
+                # absolute paths and check that they don't match $abs_srcdir
+                # or $abs_blddir, just as the 'VC' scheme.
+                $tail = rel2abs($tail);
+
+                unless (defined $depconv_cache{$tail}) {
+                    my $dep = $tail;
+                    # Since we have already pre-populated the cache with
+                    # mappings for generated headers, we only need to deal
+                    # with the source tree.
+                    if ($dep =~ s|^\Q$abs_srcdir\E\\|\$(SRCDIR)\\|i) {
+                        $depconv_cache{$tail} = $dep;
+                    }

                 }
                 }

+                return ($objfile, '"'.$depconv_cache{$tail}.'"')
+                    if defined $depconv_cache{$tail};
+                print STDERR "DEBUG[$producer]: ignoring $objfile <- $tail\n"
+                    if $debug;

             }
 
             return undef;
             }
 
             return undef;


@@ -153,6 +264,7 @@ my %continuations = (
     'makedepend' => "\\",
     'VMS C' => "-",
     'VC' => "\\",
     'makedepend' => "\\",
     'VMS C' => "-",
     'VC' => "\\",

+    'embarcadero' => "\\",

 );
 
 die "Producer unrecognised: $producer\n"
 );
 
 die "Producer unrecognised: $producer\n"