]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - make/configure.pm
Update copyright headers.
[user/henk/code/inspircd.git] / make / configure.pm
index 2864240808883b5ce94b4fef470d59e182d20e55..1ce5a1c1e24a942c6de774cd400d4c62f3c30f49 100644 (file)
@@ -1,10 +1,9 @@
 #
 # InspIRCd -- Internet Relay Chat Daemon
 #
-#   Copyright (C) 2012 Peter Powell <petpow@saberuk.com>
-#   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
-#   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
-#   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+#   Copyright (C) 2013-2019 Sadie Powell <sadie@witchery.services>
+#   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+#   Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
 #   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
 #
 # This file is part of InspIRCd.  InspIRCd is free software: you can
 
 
 BEGIN {
-       require 5.8.0;
+       require 5.10.0;
 }
 
 package make::configure;
 
+use feature ':5.10';
 use strict;
 use warnings FATAL => qw(all);
 
-use Cwd;
-use Exporter 'import';
-
-use make::utilities;
-
-our @EXPORT = qw(cmd_clean cmd_help cmd_update
-                 read_configure_cache write_configure_cache
-                 get_compiler_info find_compiler
-                 run_test test_file test_header
-                 get_property get_revision
-                 dump_hash);
-
-my $revision;
-
-sub __get_socketengines() {
+use Cwd                   qw(getcwd);
+use Exporter              qw(import);
+use File::Basename        qw(basename dirname);
+use File::Spec::Functions qw(catdir catfile);
+
+use make::common;
+use make::console;
+
+use constant CONFIGURE_ROOT          => dirname dirname __FILE__;
+use constant CONFIGURE_DIRECTORY     => catdir(CONFIGURE_ROOT, '.configure');
+use constant CONFIGURE_CACHE_FILE    => catfile(CONFIGURE_DIRECTORY, 'cache.cfg');
+use constant CONFIGURE_CACHE_VERSION => '1';
+use constant CONFIGURE_ERROR_PIPE    => $ENV{INSPIRCD_VERBOSE} ? '' : '1>/dev/null 2>/dev/null';
+
+our @EXPORT = qw(CONFIGURE_CACHE_FILE
+                 CONFIGURE_CACHE_VERSION
+                 cmd_clean
+                 cmd_help
+                 cmd_update
+                 run_test
+                 test_file
+                 test_header
+                 write_configure_cache
+                 get_compiler_info
+                 find_compiler
+                 parse_templates);
+
+sub __get_socketengines {
        my @socketengines;
        foreach (<src/socketengines/socketengine_*.cpp>) {
                s/src\/socketengines\/socketengine_(\w+)\.cpp/$1/;
@@ -53,8 +66,43 @@ sub __get_socketengines() {
        return @socketengines;
 }
 
+# TODO: when buildtool is done this can be mostly removed with
+#       the remainder being merged into parse_templates.
+sub __get_template_settings($$$) {
+
+       # These are actually hash references
+       my ($config, $compiler, $version) = @_;
+
+       # Start off by populating with the config
+       my %settings = %$config;
+
+       # Compiler information
+       while (my ($key, $value) = each %{$compiler}) {
+               $settings{'COMPILER_' . $key} = $value;
+       }
+
+       # Version information
+       while (my ($key, $value) = each %{$version}) {
+               $settings{'VERSION_' . $key} = $value;
+       }
+
+       # Miscellaneous information
+       $settings{CONFIGURE_DIRECTORY} = CONFIGURE_DIRECTORY;
+       $settings{CONFIGURE_CACHE_FILE} = CONFIGURE_CACHE_FILE;
+       $settings{SYSTEM_NAME} = lc $^O;
+
+       return %settings;
+}
+
+sub __test_compiler($) {
+       my $compiler = shift;
+       return 0 unless run_test("`$compiler`", !system "$compiler -v ${\CONFIGURE_ERROR_PIPE}");
+       return 0 unless run_test("`$compiler`", test_file($compiler, 'compiler.cpp', '-fno-rtti'), 'compatible');
+       return 1;
+}
+
 sub cmd_clean {
-       unlink '.config.cache';
+       unlink CONFIGURE_CACHE_FILE;
 }
 
 sub cmd_help {
@@ -83,13 +131,19 @@ PATH OPTIONS
   --data-dir=[dir]              The location where the data files, such as the
                                 pid file, are stored.
                                 [$PWD/run/data]
+  --example-dir=[dir]           The location where the example configuration files
+                                and SQL schemas are stored.
+                                [$PWD/run/conf/examples]
   --log-dir=[dir]               The location where the log files are stored.
                                 [$PWD/run/logs]
+  --manual-dir=[dir]            The location where the manual files are stored.
+                                [$PWD/run/manuals]
   --module-dir=[dir]            The location where the loadable modules are
                                 stored.
                                 [$PWD/run/modules]
-  --build-dir=[dir]             The location to store files in while building.
-
+  --script-dir=[dir]            The location where the scripts, such as the
+                                init scripts, are stored.
+                                [$PWD/run]
 
 EXTRA MODULE OPTIONS
 
@@ -102,12 +156,18 @@ MISC OPTIONS
 
   --clean                       Remove the configuration cache file and start
                                 the interactive configuration wizard.
+  --disable-auto-extras         Disables automatically enabling extra modules
+                                for which the dependencies are available.
   --disable-interactive         Disables the interactive configuration wizard.
+  --distribution-label=[text]   Sets a distribution specific version label in
+                                the build configuration.
+  --gid=[id|name]               Sets the group to run InspIRCd as.
   --help                        Show this message and exit.
-  --uid=[name]                  Sets the user to run InspIRCd as.
   --socketengine=[name]         Sets the socket engine to be used. Possible
                                 values are $SELIST.
-  --update                      Updates the build environment.
+  --uid=[id|name]               Sets the user to run InspIRCd as.
+  --update                      Updates the build environment with the settings
+                                from the cache.
 
 
 FLAGS
@@ -117,150 +177,168 @@ FLAGS
                                 will search for c++, g++, clang++ or icpc.
 
 If you have any problems with configuring InspIRCd then visit our IRC channel
-at irc.ChatSpike.net #InspIRCd.
+at irc.inspircd.org #InspIRCd for support.
 
 EOH
        exit 0;
 }
 
 sub cmd_update {
-       unless (-f '.config.cache') {
-               print "You have not run $0 before. Please do this before trying to update the build files.\n";
-               exit 1;
-       }
-       print "Updating...\n";
-       %main::config = read_configure_cache();
-       %main::cxx = get_compiler_info($main::config{CXX});
-       $main::topdir = getcwd();
-       main::writefiles();
-       print "Update complete!\n";
+       print_error "You have not run $0 before. Please do this before trying to update the generated files." unless -f CONFIGURE_CACHE_FILE;
+       say 'Updating...';
+       my %config = read_config_file(CONFIGURE_CACHE_FILE);
+       my %compiler = get_compiler_info($config{CXX});
+       my %version = get_version $config{DISTRIBUTION};
+       parse_templates(\%config, \%compiler, \%version);
+       say 'Update complete!';
        exit 0;
 }
 
-sub read_configure_cache {
-       my %cfg = ();
-       open(CACHE, '.config.cache') or return %cfg;
-       while (my $line = <CACHE>) {
-               next if $line =~ /^\s*($|\#)/;
-               my ($key, $value) = ($line =~ /^(\S+)="(.*)"$/);
-               $cfg{$key} = $value;
-       }
-       close(CACHE);
-       return %cfg;
-}
-
-sub write_configure_cache(%) {
-       my %cfg = @_;
-       open(CACHE, ">.config.cache") or return 0;
-       while (my ($key, $value) = each %cfg) {
-               $value = "" unless defined $value;
-               print CACHE "$key=\"$value\"\n";
-       }
-       close(CACHE);
-       return 1;
-}
-
-sub get_compiler_info($) {
-       my $binary = shift;
-       my $version = `$binary -v 2>&1`;
-       if ($version =~ /(?:clang|llvm)\sversion\s(\d+\.\d+)/i) {
-               return (
-                       NAME => 'Clang',
-                       VERSION => $1,
-                       UNSUPPORTED => $1 lt '3.0',
-                       REASON => 'Clang 2.9 and older do not have adequate C++ support.'
-               );
-       } elsif ($version =~ /gcc\sversion\s(\d+\.\d+)/i) {
-               return (
-                       NAME => 'GCC',
-                       VERSION => $1,
-                       UNSUPPORTED => $1 lt '4.1',
-                       REASON => 'GCC 4.0 and older do not have adequate C++ support.'
-               );
-       } elsif ($version =~ /(?:icc|icpc)\sversion\s(\d+\.\d+).\d+\s\(gcc\sversion\s(\d+\.\d+).\d+/i) {
-               return (
-                       NAME => 'ICC',
-                       VERSION => $1,
-                       UNSUPPORTED => $2 lt '4.1',
-                       REASON => "ICC $1 (GCC $2 compatibility mode) does not have adequate C++ support."
-               );
-       }
-       return (
-               NAME => $binary,
-               VERSION => '0.0'
-       );
-}
-
-sub find_compiler {
-       foreach my $compiler ('c++', 'g++', 'clang++', 'icpc') {
-               return $compiler unless system "$compiler -v > /dev/null 2>&1";
-               if ($^O eq 'Darwin') {
-                       return $compiler unless system "xcrun $compiler -v > /dev/null 2>&1";
-               }
-       }
-       return "";
-}
-
-sub run_test($$) {
-       my ($what, $result) = @_;
-       print "Checking whether $what is available... ";
-       print $result ? "yes\n" : "no\n";
+sub run_test($$;$) {
+       my ($what, $result, $adjective) = @_;
+       $adjective //= 'available';
+       print_format "Checking whether <|GREEN $what|> is $adjective ... ";
+       print_format $result ? "<|GREEN yes|>\n" : "<|RED no|>\n";
        return $result;
 }
 
 sub test_file($$;$) {
-       my ($cc, $file, $args) = @_;
+       my ($compiler, $file, $args) = @_;
        my $status = 0;
-       $args ||= '';
-       $status ||= system "$cc -o __test_$file make/test/$file $args >/dev/null 2>&1";
-       $status ||= system "./__test_$file >/dev/null 2>&1";
-       unlink  "./__test_$file";
+       $args //= '';
+       $status ||= system "$compiler -o __test_$file ${\CONFIGURE_ROOT}/make/test/$file $args ${\CONFIGURE_ERROR_PIPE}";
+       $status ||= system "./__test_$file ${\CONFIGURE_ERROR_PIPE}";
+       unlink "./__test_$file";
        return !$status;
 }
 
 sub test_header($$;$) {
-       my ($cc, $header, $args) = @_;
-       $args ||= '';
-       open(CC, "| $cc -E - $args >/dev/null 2>&1") or return 0;
-       print CC "#include <$header>";
-       close(CC);
+       my ($compiler, $header, $args) = @_;
+       $args //= '';
+       open(my $fh, "| $compiler -E - $args ${\CONFIGURE_ERROR_PIPE}") or return 0;
+       print $fh "#include <$header>";
+       close $fh;
        return !$?;
 }
 
-sub get_property($$;$)
-{
-       my ($file, $property, $default) = @_;
-       open(MODULE, $file) or return $default;
-       while (<MODULE>) {
-               if ($_ =~ /^\/\* \$(\S+): (.+) \*\/$/) {
-                       next unless $1 eq $property;
-                       close(MODULE);
-                       return translate_functions($2, $file);
-               }
+sub write_configure_cache(%) {
+       unless (-e CONFIGURE_DIRECTORY) {
+               print_format "Creating <|GREEN ${\CONFIGURE_DIRECTORY}|> ...\n";
+               create_directory CONFIGURE_DIRECTORY, 0750 or print_error "unable to create ${\CONFIGURE_DIRECTORY}: $!";
+       }
+
+       print_format "Writing <|GREEN ${\CONFIGURE_CACHE_FILE}|> ...\n";
+       my %config = @_;
+       write_config_file CONFIGURE_CACHE_FILE, %config;
+}
+
+sub get_compiler_info($) {
+       my $binary = shift;
+       my %info = (NAME => 'Unknown', VERSION => '0.0');
+       return %info if system "$binary -o __compiler_info ${\CONFIGURE_ROOT}/make/test/compiler_info.cpp ${\CONFIGURE_ERROR_PIPE}";
+       open(my $fh, '-|', './__compiler_info 2>/dev/null');
+       while (my $line = <$fh>) {
+               $info{$1} = $2 if $line =~ /^([A-Z]+)\s(.+)$/;
        }
-       close(MODULE);
-       return defined $default ? $default : '';
+       close $fh;
+       unlink './__compiler_info';
+       return %info;
 }
 
-sub get_revision {
-       return $revision if defined $revision;
-       chomp(my $tags = `git describe --tags 2>/dev/null`);
-       $revision = $tags || 'release';
-       return $revision;
+sub find_compiler {
+       my @compilers = qw(c++ g++ clang++ icpc);
+       foreach my $compiler (shift // @compilers) {
+               return $compiler if __test_compiler $compiler;
+               return "xcrun $compiler" if $^O eq 'darwin' && __test_compiler "xcrun $compiler";
+       }
 }
 
-sub dump_hash()
-{
-       print "\n\e[1;32mPre-build configuration is complete!\e[0m\n\n";
-       print "\e[0mBase install path:\e[1;32m\t\t$main::config{BASE_DIR}\e[0m\n";
-       print "\e[0mConfig path:\e[1;32m\t\t\t$main::config{CONFIG_DIR}\e[0m\n";
-       print "\e[0mData path:\e[1;32m\t\t\t$main::config{DATA_DIR}\e[0m\n";
-       print "\e[0mLog path:\e[1;32m\t\t\t$main::config{LOG_DIR}\e[0m\n";
-       print "\e[0mModule path:\e[1;32m\t\t\t$main::config{MODULE_DIR}\e[0m\n";
-       print "\e[0mCompiler:\e[1;32m\t\t\t$main::cxx{NAME} $main::cxx{VERSION}\e[0m\n";
-       print "\e[0mSocket engine:\e[1;32m\t\t\t$main::config{SOCKETENGINE}\e[0m\n";
-       print "\e[0mGnuTLS support:\e[1;32m\t\t\t$main::config{USE_GNUTLS}\e[0m\n";
-       print "\e[0mOpenSSL support:\e[1;32m\t\t$main::config{USE_OPENSSL}\e[0m\n";
+sub parse_templates($$$) {
+
+       # These are actually hash references
+       my ($config, $compiler, $version) = @_;
+
+       # Collect settings to be used when generating files
+       my %settings = __get_template_settings($config, $compiler, $version);
+
+       # Iterate through files in make/template.
+       foreach (<make/template/*>) {
+               print_format "Parsing <|GREEN $_|> ...\n";
+               open(my $fh, $_) or print_error "unable to read $_: $!";
+               my (@lines, $mode, @platforms, @targets);
+
+               # First pass: parse template variables and directives.
+               while (my $line = <$fh>) {
+                       chomp $line;
+
+                       # Does this line match a variable?
+                       while ($line =~ /(@(\w+?)@)/) {
+                               my ($variable, $name) = ($1, $2);
+                               if (defined $settings{$name}) {
+                                       $line =~ s/\Q$variable\E/$settings{$name}/;
+                               } else {
+                                       print_warning "unknown template variable '$name' in $_!";
+                                       last;
+                               }
+                       }
+
+                       # Does this line match a directive?
+                       if ($line =~ /^(\s*)%(\w+)\s+(.+)$/) {
+                               if ($2 eq 'define') {
+                                       if ($settings{$3}) {
+                                               push @lines, "#$1define $3";
+                                       } else {
+                                               push @lines, "#$1undef $3";
+                                       }
+                               } elsif ($2 eq 'mode') {
+                                       $mode = oct $3;
+                               } elsif ($2 eq 'platform') {
+                                       push @platforms, $3;
+                               } elsif ($2 eq 'target') {
+                                       push @targets, $3
+                               } else {
+                                       print_warning "unknown template command '$2' in $_!";
+                                       push @lines, $line;
+                               }
+                               next;
+                       }
+                       push @lines, $line;
+               }
+               close $fh;
+
+               # Only proceed if this file should be templated on this platform.
+               if ($#platforms < 0 || grep { $_ eq $^O } @platforms) {
+
+                       # Add a default target if the template has not defined one.
+                       unless (@targets) {
+                               push @targets, catfile(CONFIGURE_DIRECTORY, basename $_);
+                       }
+
+                       # Write the templated files to disk.
+                       for my $target (@targets) {
+
+                               # Create the directory if it doesn't already exist.
+                               my $directory = dirname $target;
+                               unless (-e $directory) {
+                                       print_format "Creating <|GREEN $directory|> ...\n";
+                                       create_directory $directory, 0750 or print_error "unable to create $directory: $!";
+                               };
+
+                               # Write the template file.
+                               print_format "Writing <|GREEN $target|> ...\n";
+                               open(my $fh, '>', $target) or print_error "unable to write $target: $!";
+                               foreach (@lines) {
+                                       say $fh $_;
+                               }
+                               close $fh;
+
+                               # Set file permissions.
+                               if (defined $mode) {
+                                       chmod $mode, $target;
+                               }
+                       }
+               }
+       }
 }
 
 1;