summaryrefslogtreecommitdiff
path: root/var/spack/repos/builtin/packages/m4/package.py
blob: aa639c717edbaf46de1e28fe9ec3365461b27fcd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# Copyright 2013-2022 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)

import os
import re


class M4(AutotoolsPackage, GNUMirrorPackage):
    """GNU M4 is an implementation of the traditional Unix macro processor."""

    homepage = "https://www.gnu.org/software/m4/m4.html"
    gnu_mirror_path = "m4/m4-1.4.18.tar.gz"

    version('1.4.19', sha256='3be4a26d825ffdfda52a56fc43246456989a3630093cced3fbddf4771ee58a70')
    version('1.4.18', sha256='ab2633921a5cd38e48797bf5521ad259bdc4b979078034a3b790d7fec5493fab')
    version('1.4.17', sha256='3ce725133ee552b8b4baca7837fb772940b25e81b2a9dc92537aeaf733538c9e')

    patch('gnulib-pgi.patch', when='@1.4.18')
    patch('pgi.patch', when='@1.4.17')
    # The NVIDIA compilers do not currently support some GNU builtins.
    # Detect this case and use the fallback path.
    patch('nvhpc.patch', when='@1.4.18 %nvhpc')
    patch('nvhpc-1.4.19.patch', when='@1.4.19 %nvhpc')
    # Workaround bug where __LONG_WIDTH__ is not defined
    patch('nvhpc-long-width.patch', when='@1.4.19 %nvhpc')
    patch('oneapi.patch', when='@1.4.18 %oneapi')
    # from: https://github.com/Homebrew/homebrew-core/blob/master/Formula/m4.rb
    # Patch credit to Jeremy Huddleston Sequoia <jeremyhu@apple.com>
    patch('secure_snprintf.patch', when='@:1.4.18 os=highsierra')
    patch('secure_snprintf.patch', when='@:1.4.18 os=mojave')
    patch('secure_snprintf.patch', when='@:1.4.18 os=catalina')
    patch('secure_snprintf.patch', when='@:1.4.18 os=bigsur')
    # https://bugzilla.redhat.com/show_bug.cgi?id=1573342
    patch('https://src.fedoraproject.org/rpms/m4/raw/5d147168d4b93f38a4833f5dd1d650ad88af5a8a/f/m4-1.4.18-glibc-change-work-around.patch', sha256='fc9b61654a3ba1a8d6cd78ce087e7c96366c290bc8d2c299f09828d793b853c8', when='@1.4.18')
    # from: https://www.mail-archive.com/m4-patches@gnu.org/msg01208.html
    # tests: Fix failing test checks/198.sysval with upstream patch for doc/m4.texi
    patch('http://git.savannah.gnu.org/cgit/m4.git/patch/?id=a1354086',
          sha256='bfdffa7c2eb01021d5849b36972c069693654ad826c1a20b53534009a4ec7a89', when='@1.4.19')
    patch('http://git.savannah.gnu.org/cgit/m4.git/patch/?id=cd7f4d15',
          sha256='9dc5fbd0d5cb1037ab1e6d0ecc74a30df218d0a94bdd5a02759a97f62daca573', when='@1.4.19')

    variant('sigsegv', default=True,
            description="Build the libsigsegv dependency")

    depends_on('libsigsegv', when='+sigsegv')

    build_directory = 'spack-build'

    tags = ['build-tools']

    executables = ['^g?m4$']

    @when('@1.4.19')
    def patch(self):
        """ skip texinfo of m4.info for patched m4.texi (patched only a test in it) """
        timestamp = os.path.getmtime('doc/m4.info')
        os.utime('doc/m4.texi', (timestamp, timestamp))

    @classmethod
    def determine_version(cls, exe):
        # Output on macOS:
        #   GNU M4 1.4.6
        # Output on Linux:
        #   m4 (GNU M4) 1.4.18
        output = Executable(exe)('--version', output=str, error=str)
        match = re.search(r'GNU M4\)?\s+(\S+)', output)
        return match.group(1) if match else None

    def setup_dependent_build_environment(self, env, dependent_spec):
        # Inform autom4te if it wasn't built correctly (some external
        # installations such as homebrew). See
        # https://www.gnu.org/software/autoconf/manual/autoconf-2.67/html_node/autom4te-Invocation.html
        env.set('M4', self.prefix.bin.m4)

    def setup_run_environment(self, env):
        env.set('M4', self.prefix.bin.m4)

    def configure_args(self):
        spec = self.spec
        args = ['--enable-c++']

        if spec.satisfies('%cce@9:'):
            args.append('LDFLAGS=-rtlib=compiler-rt')

        if (spec.satisfies('%clang') or
            spec.satisfies('%aocc') or
            spec.satisfies('%arm') or
            spec.satisfies('%fj')) and not spec.satisfies('platform=darwin'):
            args.append('LDFLAGS=-rtlib=compiler-rt')

        if spec.satisfies('%intel@:18'):
            args.append('CFLAGS=-no-gcc')

        if '+sigsegv' in spec:
            args.append('--with-libsigsegv-prefix={0}'.format(
                spec['libsigsegv'].prefix))
        else:
            args.append('--without-libsigsegv-prefix')

        # https://lists.gnu.org/archive/html/bug-m4/2016-09/msg00002.html
        arch = spec.architecture
        if (arch.platform == 'darwin' and arch.os == 'sierra' and
                '%gcc' in spec):
            args.append('ac_cv_type_struct_sched_param=yes')

        return args

    def test(self):
        spec_vers = str(self.spec.version)
        reason = 'test: ensuring m4 version is {0}'.format(spec_vers)
        self.run_test('m4', '--version', spec_vers, installed=True,
                      purpose=reason, skip_missing=False)

        reason = 'test: ensuring m4 example succeeds'
        test_data_dir = self.test_suite.current_test_data_dir
        hello_file = test_data_dir.join('hello.m4')
        expected = get_escaped_text_output(test_data_dir.join('hello.out'))
        self.run_test('m4', hello_file, expected, installed=True,
                      purpose=reason, skip_missing=False)