summaryrefslogtreecommitdiffstats
path: root/devshell/modules/buildsystem.py
blob: a0cb99de04c90d183d17b57e0978ede375593eb0 (plain)
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
# Fedora Developer Shell
#
# This program 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; version 2 of the License.
#
# This program 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 Library General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# Authors: Yaakov M. Nemoy <[email protected]>
#
from __future__ import with_statement

from os.path import join
from contextlib import contextmanager

import devshell.base.factories as factories
import devshell.base.validators as validators
from devshell.base.module import Module
from devshell.base.util import log_file

from devshell.modules.directory import DirFactory
from devshell.modules.packagesource import PackageSourceValidator

class MetaBuildSystem(type):
    def __init__(cls, name, bases, attrs):
        t = name.lower()
        cls._type = t
        factories.register_buildsystem(cls, t)

class BuildSystem(Module):
    __metaclass__ = MetaBuildSystem

    @validators.validate(PackageSourceValidator(1))
    def __init__(self, pkg_src):
        self.pkg_src = pkg_src
        self.name = pkg_src.name

    def prepare(self, install=False, force=False, *args):
        '''runs the preparation/distribution stage of a build system

        does not apply to all systems, in particular this is analogous
        to autoreconf of the autotools package

        install has the preparer copy in any shell scripts or other bits
        that need to be distributed

        force forces the preparer to copy in any bits even if they are already there
        '''
        raise NotImplementedError

    def configure(self, target='home', *args):
        '''runs the configure stage of cabal
        
        target is either 'home' or 'root' and will configure the package to
        install either to the user's home directory, or to the system
        wide haskell.

        Some help is needed making this more flexible
        '''
        raise NotImplementedError

    def build(self, *args):
        '''runs the build stage of cabal

        This is not safe to run on an unconfigured source dir, because
        this module does not track the state of cabal systems. The user
        must do this on their own.
        '''
        raise NotImplementedError

    def install(self, *args):
        '''runs the install stage of cabal

        This is not safe to run on an unconfigured source dir, because
        this module does not track the state of cabal systems. The user
        must do this on their own.
        '''
        raise NotImplementedError

    def install_source(self, target='home', *args):
        '''perform configure, build, and install steps in one
        '''
        raise NotImplementedError

    def gen_spec(self, name):
        raise NotImplementedError

    @contextmanager
    def logged(self, name=""):
        with log_file(join(self.pkg_src.pkg_src_dir, 
                           (name if name else self._type) + '.log')) \
                as log_out:
            yield log_out

__all__ = ['MetaBuildSystem', 'BuildSystem']