path: root/attoconf/lib/install.py

#   Copyright 2013 Ben Longbons <b.r.longbons@gmail.com>
#
#   This file is part of attoconf.
#
#   attoconf is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#
#   attoconf is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with attoconf.  If not, see <http://www.gnu.org/licenses/>.

from __future__ import print_function, division, absolute_import

import os

from ..classy import ClassyProject
from ..types import shell_word, filepath, quoted_string, maybe


def package(build, PACKAGE):
    pass

def package_name(build, NAME):
    pass

def prefix(build, PREFIX):
    pass

def exec_prefix(build, EPREFIX):
    if not EPREFIX:
        PREFIX = build.vars['PREFIX']
        build.vars['EXEC_PREFIX'] = PREFIX
    build.vars['EPREFIX'] = build.vars['EXEC_PREFIX']

def bindir(build, DIR):
    if not DIR:
        EPREFIX = build.vars['EPREFIX']
        build.vars['BINDIR'] = os.path.join(EPREFIX, 'bin')

def sbindir(build, DIR):
    if not DIR:
        EPREFIX = build.vars['EPREFIX']
        build.vars['SBINDIR'] = os.path.join(EPREFIX, 'sbin')

def libexecdir(build, DIR):
    if not DIR:
        EPREFIX = build.vars['EPREFIX']
        build.vars['LIBEXECDIR'] = os.path.join(EPREFIX, 'libexec')

def sysconfdir(build, DIR):
    if not DIR:
        PREFIX = build.vars['PREFIX']
        build.vars['SYSCONFDIR'] = os.path.join(PREFIX, 'etc')

def sharedstatedir(build, DIR):
    if not DIR:
        PREFIX = build.vars['PREFIX']
        build.vars['SHAREDSTATEDIR'] = os.path.join(PREFIX, 'com')

def localstatedir(build, DIR):
    if not DIR:
        PREFIX = build.vars['PREFIX']
        build.vars['LOCALSTATEDIR'] = os.path.join(PREFIX, 'var')

def libdir(build, DIR):
    if not DIR:
        EPREFIX = build.vars['EPREFIX']
        build.vars['LIBDIR'] = os.path.join(EPREFIX, 'lib')

def includedir(build, DIR):
    if not DIR:
        PREFIX = build.vars['PREFIX']
        build.vars['INCLUDEDIR'] = os.path.join(PREFIX, 'include')

def oldincludedir(build, DIR):
    pass

def datarootdir(build, DIR):
    if not DIR:
        PREFIX = build.vars['PREFIX']
        build.vars['DATAROOTDIR'] = os.path.join(PREFIX, 'share')

def datadir(build, DIR):
    if not DIR:
        DATAROOTDIR = build.vars['DATAROOTDIR']
        build.vars['DATADIR'] = DATAROOTDIR

def packagedatadir(build, DIR):
    if not DIR:
        DATADIR = build.vars['DATADIR']
        PACKAGE = build.vars['PACKAGE']
        build.vars['PACKAGEDATADIR'] = os.path.join(DATADIR, PACKAGE)

def infodir(build, DIR):
    if not DIR:
        DATAROOTDIR = build.vars['DATAROOTDIR']
        build.vars['INFODIR'] = os.path.join(DATAROOTDIR, 'info')

def localedir(build, DIR):
    if not DIR:
        DATAROOTDIR = build.vars['DATAROOTDIR']
        build.vars['LOCALEDIR'] = os.path.join(DATAROOTDIR, 'locale')

def mandir(build, DIR):
    if not DIR:
        DATAROOTDIR = build.vars['DATAROOTDIR']
        build.vars['MANDIR'] = os.path.join(DATAROOTDIR, 'man')

def docdir(build, DIR):
    if not DIR:
        DATAROOTDIR = build.vars['DATAROOTDIR']
        PACKAGE = build.vars['PACKAGE']
        build.vars['DOCDIR'] = os.path.join(DATAROOTDIR, 'doc', PACKAGE)

def htmldir(build, DIR):
    if not DIR:
        DOCDIR = build.vars['DOCDIR']
        build.vars['HTMLDIR'] = DOCDIR

def dvidir(build, DIR):
    if not DIR:
        DOCDIR = build.vars['DOCDIR']
        build.vars['DVIDIR'] = DOCDIR

def pdfdir(build, DIR):
    if not DIR:
        DOCDIR = build.vars['DOCDIR']
        build.vars['PDFDIR'] = DOCDIR

def psdir(build, DIR):
    if not DIR:
        DOCDIR = build.vars['DOCDIR']
        build.vars['PSDIR'] = DOCDIR


class Install(ClassyProject):
    __slots__ = ()

    @classmethod
    def slots(cls):
        return super(Install, cls).slots() + (
                'package', 'package_name')

    # Compatibility with configure written for attoconf < 0.7
    # In attoconf 1.0, the positional srcdir argument will go away,
    # the None default and the .set_package function will be removed.
    # (Note: when bisecting, always force checkout attoconf!)
    def __init__(self, srcdir, package=None, package_name=None, **kwargs):
        super(Install, self).__init__(srcdir=srcdir, **kwargs)
        self.set_package(package, package_name)

    def set_package(self, package, package_name):
        self.package = package
        self.package_name = package_name

    def general(self):
        super(Install, self).general()
        self.add_option('--package', init=self.package,
                type=shell_word, check=package,
                help='Short name of this package (don\'t change!)',
                hidden=True)
        self.add_option('--package-name', init=self.package_name,
                type=quoted_string, check=package_name,
                help='Long name of this package (don\'t change)',
                hidden=True,
                help_var='NAME')

    def paths(self):
        super(Install, self).paths()

        self.add_help('Installation directories:', hidden=False)
        self.add_option('--prefix', init='/usr/local',
                type=filepath, check=prefix,
                help='install architecture-independent files in PREFIX',
                hidden=False)
        self.add_option('--exec-prefix', init='',
                type=maybe(filepath), check=exec_prefix,
                help='install architecture-dependent files in EPREFIX',
                hidden=False,
                help_var='EPREFIX', help_def='PREFIX')
        self.order.append('EPREFIX') # TODO remove for 1.0
        self.order.append(None)

        self.add_help('Fine tuning of the installation directories:',
                hidden=False)
        self.add_option('--bindir', init='',
                type=maybe(filepath), check=bindir,
                help='user executables', hidden=False,
                help_var='DIR', help_def='EPREFIX/bin')
        self.add_option('--sbindir', init='',
                type=maybe(filepath), check=sbindir,
                help='system admin executables', hidden=False,
                help_var='DIR', help_def='EPREFIX/sbin')
        self.add_option('--libexecdir', init='',
                type=maybe(filepath), check=libexecdir,
                help='program executables', hidden=False,
                help_var='DIR', help_def='EPREFIX/libexec')
        self.add_option('--sysconfdir', init='',
                type=maybe(filepath), check=sysconfdir,
                help='read-only single-machine data', hidden=False,
                help_var='DIR', help_def='PREFIX/etc')
        self.add_option('--sharedstatedir', init='',
                type=maybe(filepath), check=sharedstatedir,
                help='modifiable architecture-independent data', hidden=False,
                help_var='DIR', help_def='PREFIX/com')
        self.add_option('--localstatedir', init='',
                type=maybe(filepath), check=localstatedir,
                help='modifiable single-machine data', hidden=False,
                help_var='DIR', help_def='PREFIX/var')
        self.add_option('--libdir', init='',
                type=maybe(filepath), check=libdir,
                help='object code libraries', hidden=False,
                help_var='DIR', help_def='EPREFIX/lib')
        self.add_option('--includedir', init='',
                type=maybe(filepath), check=includedir,
                help='C header files', hidden=False,
                help_var='DIR', help_def='PREFIX/include')
        self.add_option('--oldincludedir', init='/usr/include',
                type=filepath, check=oldincludedir,
                help='C header files for non-gcc', hidden=False,
                help_var='DIR')
        self.add_option('--datarootdir', init='',
                type=maybe(filepath), check=datarootdir,
                help='read-only arch.-independent data root', hidden=False,
                help_var='DIR', help_def='PREFIX/share')
        self.add_option('--datadir', init='',
                type=maybe(filepath), check=datadir,
                help='read-only architecture-independent data', hidden=False,
                help_var='DIR', help_def='DATAROOTDIR')
        self.add_option('--packagedatadir', init='',
                type=maybe(filepath), check=packagedatadir,
                help='data specific to this package (please set datadir instead)', hidden=False,
                help_var='DIR', help_def='DATADIR/PACKAGE')
        self.add_option('--infodir', init='',
                type=maybe(filepath), check=infodir,
                help='info documentation', hidden=False,
                help_var='DIR', help_def='DATAROOTDIR/info')
        self.add_option('--localedir', init='',
                type=maybe(filepath), check=localedir,
                help='locale-dependent data', hidden=False,
                help_var='DIR', help_def='DATAROOTDIR/locale')
        self.add_option('--mandir', init='',
                type=maybe(filepath), check=mandir,
                help='man documentation', hidden=False,
                help_var='DIR', help_def='DATAROOTDIR/man')
        self.add_option('--docdir', init='',
                type=maybe(filepath), check=docdir,
                help='documentation root', hidden=False,
                help_var='DIR', help_def='DATAROOTDIR/doc/PACKAGE')
        self.add_option('--htmldir', init='',
                type=maybe(filepath), check=htmldir,
                help='html documentation', hidden=False,
                help_var='DIR', help_def='DOCDIR')
        self.add_option('--dvidir', init='',
                type=maybe(filepath), check=dvidir,
                help='dvi documentation', hidden=False,
                help_var='DIR', help_def='DOCDIR')
        self.add_option('--pdfdir', init='',
                type=maybe(filepath), check=pdfdir,
                help='pdf documentation', hidden=False,
                help_var='DIR', help_def='DOCDIR')
        self.add_option('--psdir', init='',
                type=maybe(filepath), check=psdir,
                help='ps documentation', hidden=False,
                help_var='DIR', help_def='DOCDIR')