summaryrefslogtreecommitdiff
path: root/bitbake/lib/bb/msg.py
blob: 5bb30e8dd30b230dfa09a3fd7dc93ccf1fbd18f0 (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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# ex:ts=4:sw=4:sts=4:et
# -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
"""
BitBake 'msg' implementation

Message handling infrastructure for bitbake

"""

# Copyright (C) 2006        Richard Purdie
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# 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 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.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

import sys
import collections
import bb
import bb.event

debug_level = collections.defaultdict(lambda: 0)
verbose = False

def _NamedTuple(name, fields):
    Tuple = collections.namedtuple(name, " ".join(fields))
    return Tuple(*range(len(fields)))

domain = _NamedTuple("Domain", (
    "Default",
    "Build",
    "Cache",
    "Collection",
    "Data",
    "Depends",
    "Fetcher",
    "Parsing",
    "PersistData",
    "Provider",
    "RunQueue",
    "TaskData",
    "Util"))


class MsgBase(bb.event.Event):
    """Base class for messages"""

    def __init__(self, msg):
        self._message = msg
        bb.event.Event.__init__(self)

class MsgDebug(MsgBase):
    """Debug Message"""

class MsgNote(MsgBase):
    """Note Message"""

class MsgWarn(MsgBase):
    """Warning Message"""

class MsgError(MsgBase):
    """Error Message"""

class MsgFatal(MsgBase):
    """Fatal Message"""

class MsgPlain(MsgBase):
    """General output"""

#
# Message control functions
#

def set_debug_level(level):
    for d in domain:
        debug_level[d] = level
    debug_level[domain.Default] = level

def get_debug_level(msgdomain = domain.Default):
    return debug_level[msgdomain]

def set_verbose(level):
    verbose = level

def set_debug_domains(strdomains):
    for domainstr in strdomains:
        for d in domain:
            if domain._fields[d] == domainstr:
                debug_level[d] += 1
                break
        else:
            warn(None, "Logging domain %s is not valid, ignoring" % domainstr)

#
# Message handling functions
#

def debug(level, msgdomain, msg, fn = None):
    if not msgdomain:
        msgdomain = domain.Default

    if debug_level[msgdomain] >= level:
        bb.event.fire(MsgDebug(msg), None)
        if bb.event.useStdout:
            print('DEBUG: %s' % (msg))

def note(level, msgdomain, msg, fn = None):
    if not msgdomain:
        msgdomain = domain.Default

    if level == 1 or verbose or debug_level[msgdomain] >= 1:
        bb.event.fire(MsgNote(msg), None)
        if bb.event.useStdout:
            print('NOTE: %s' % (msg))

def warn(msgdomain, msg, fn = None):
    bb.event.fire(MsgWarn(msg), None)
    if bb.event.useStdout:
        print('WARNING: %s' % (msg))

def error(msgdomain, msg, fn = None):
    bb.event.fire(MsgError(msg), None)
    if bb.event.useStdout:
       print('ERROR: %s' % (msg))

def fatal(msgdomain, msg, fn = None):
    bb.event.fire(MsgFatal(msg), None)
    print('FATAL: %s' % (msg))
    sys.exit(1)

def plain(msg, fn = None):
    bb.event.fire(MsgPlain(msg), None)
    if bb.event.useStdout:
        print(msg)