openssl/util/mkinstallvars.pl
Richard Levitte c768ccebc7 Add exporters for CMake
CMake's older package finder, FindOpenSSL.cmake, does a best guess effort
and doesn't always get it right.

By CMake's own documentation, that's what such modules are (best effort
attempts), and package producers are (strongly) encouraged to help out by
producing and installing <PackageName>Config.cmake files to get a more
deterministic configuration.

The resulting OpenSSLConfig.cmake tries to mimic the result from CMake's
FindOpenSSL.cmake, by using the same variable and imported target names.
It also adds a few extra variables of its own, such as:

    OPENSSL_MODULES_DIR     Indicates the default installation directory
                            for OpenSSL loadable modules, such as providers.
    OPENSSL_RUNTIME_DIR     Indicates the default runtime directory, where
                            for example the openssl program is located.
    OPENSSL_PROGRAM         Is the full directory-and-filename of the
                            openssl program.

The imported targets OpenSSL::Crypto and OpenSSL::SSL are as precisely
specified as possible, so for example, they are specified with the both the
import library and the DLL on Windows, which should make life easier on that
platform.

For the moment, one of the following must be done in your CMake project for
this CMake configuration to take priority over CMake's FindOpenSSL.cmake:

-   The variable CMAKE_FIND_PACKAGE_PREFER_CONFIG must be set to true prior
    to the 'find_package(OpenSSL)' call.
-   The 'find_package' call itself must use the "Full Signature".  If you
    don't know any better, simply add the 'CONFIG' option, i.e. from this
    example:

        find_package(OpenSSL 3.0 REQUIRED)

    to this:

        find_package(OpenSSL 3.0 REQUIRED CONFIG)

Just as with the 'pkg-config' exporters, two variants of the .cmake files
are produced:

- Those in 'exporters/' are installed in the location that 'pkg-config'
  itself prefers for installed packages.
- Those in the top directory are to be used when it's desirable to build
  directly against an OpenSSL build tree.

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20878)
2023-11-15 08:22:29 +01:00

96 lines
3.4 KiB
Perl

#! /usr/bin/env perl
# Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
#
# 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
# All variables are supposed to come from Makefile, in environment variable
# form, or passed as variable assignments on the command line.
# The result is a Perl module creating the package OpenSSL::safe::installdata.
use File::Spec;
# These are expected to be set up as absolute directories
my @absolutes = qw(PREFIX);
# These may be absolute directories, and if not, they are expected to be set up
# as subdirectories to PREFIX
my @subdirs = qw(BINDIR LIBDIR INCLUDEDIR APPLINKDIR ENGINESDIR MODULESDIR
PKGCONFIGDIR CMAKECONFIGDIR);
my %keys = ();
foreach (@ARGV) {
(my $k, my $v) = m|^([^=]*)=(.*)$|;
$keys{$k} = 1;
$ENV{$k} = $v;
}
foreach my $k (sort keys %keys) {
my $v = $ENV{$k};
$v = File::Spec->rel2abs($v) if $v && grep { $k eq $_ } @absolutes;
$ENV{$k} = $v;
}
foreach my $k (sort keys %keys) {
my $v = $ENV{$k} || '.';
# Absolute paths for the subdir variables are computed. This provides
# the usual form of values for names that have become norm, known as GNU
# installation paths.
# For the benefit of those that need it, the subdirectories are preserved
# as they are, using the same variable names, suffixed with '_REL', if they
# are indeed subdirectories.
if (grep { $k eq $_ } @subdirs) {
if (File::Spec->file_name_is_absolute($v)) {
$ENV{"${k}_REL"} = File::Spec->abs2rel($v, $ENV{PREFIX});
} else {
$ENV{"${k}_REL"} = $v;
$v = File::Spec->rel2abs($v, $ENV{PREFIX});
}
}
$ENV{$k} = $v;
}
print <<_____;
package OpenSSL::safe::installdata;
use strict;
use warnings;
use Exporter;
our \@ISA = qw(Exporter);
our \@EXPORT = qw(\$PREFIX
\$BINDIR \$BINDIR_REL
\$LIBDIR \$LIBDIR_REL
\$INCLUDEDIR \$INCLUDEDIR_REL
\$APPLINKDIR \$APPLINKDIR_REL
\$ENGINESDIR \$ENGINESDIR_REL
\$MODULESDIR \$MODULESDIR_REL
\$PKGCONFIGDIR \$PKGCONFIGDIR_REL
\$CMAKECONFIGDIR \$CMAKECONFIGDIR_REL
\$VERSION \@LDLIBS);
our \$PREFIX = '$ENV{PREFIX}';
our \$BINDIR = '$ENV{BINDIR}';
our \$BINDIR_REL = '$ENV{BINDIR_REL}';
our \$LIBDIR = '$ENV{LIBDIR}';
our \$LIBDIR_REL = '$ENV{LIBDIR_REL}';
our \$INCLUDEDIR = '$ENV{INCLUDEDIR}';
our \$INCLUDEDIR_REL = '$ENV{INCLUDEDIR_REL}';
our \$APPLINKDIR = '$ENV{APPLINKDIR}';
our \$APPLINKDIR_REL = '$ENV{APPLINKDIR_REL}';
our \$ENGINESDIR = '$ENV{ENGINESDIR}';
our \$ENGINESDIR_REL = '$ENV{ENGINESDIR_REL}';
our \$MODULESDIR = '$ENV{MODULESDIR}';
our \$MODULESDIR_REL = '$ENV{MODULESDIR_REL}';
our \$PKGCONFIGDIR = '$ENV{PKGCONFIGDIR}';
our \$PKGCONFIGDIR_REL = '$ENV{PKGCONFIGDIR_REL}';
our \$CMAKECONFIGDIR = '$ENV{CMAKECONFIGDIR}';
our \$CMAKECONFIGDIR_REL = '$ENV{CMAKECONFIGDIR_REL}';
our \$VERSION = '$ENV{VERSION}';
our \@LDLIBS =
# Unix and Windows use space separation, VMS uses comma separation
split(/ +| *, */, '$ENV{LDLIBS}');
1;
_____