1# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
2# Copyright (c) 2009 The Hewlett-Packard Development Company
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions are
7# met: redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer;
9# redistributions in binary form must reproduce the above copyright
10# notice, this list of conditions and the following disclaimer in the
11# documentation and/or other materials provided with the distribution;
12# neither the name of the copyright holders nor the names of its
13# contributors may be used to endorse or promote products derived from
14# this software without specific prior written permission.
15#
16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
28from slicc.util import PairContainer
29
30class Symbol(PairContainer):
31    def __init__(self, symtab, ident, location, pairs=None):
32        super(Symbol, self).__init__()
33
34        from slicc.util import Location
35        from slicc.symbols import SymbolTable
36        if not isinstance(symtab, SymbolTable): raise AttributeError
37        if not isinstance(ident, str): raise AttributeError
38        if not isinstance(location, Location): raise AttributeError
39
40        self.symtab = symtab
41        self.ident = ident
42        self.location = location
43        if pairs:
44            self.pairs.update(getattr(pairs, "pairs", pairs))
45        if "short" not in self:
46            self["short"] = self.ident
47        self.used = False
48
49    def __repr__(self):
50        return "[Symbol: %s]" % self.ident
51
52    def __str__(self):
53        return str(self.ident)
54
55    def __setitem__(self, key, value):
56        if key in self.pairs:
57            self.warning("Pair key '%s' re-defined. new: '%s' old: '%s'",
58                         key, value, self.pairs[key])
59        super(Symbol, self).__setitem__(key, value)
60
61    @property
62    def short(self):
63        return self["short"]
64
65    @property
66    def desc(self):
67        return self["desc"]
68
69    def error(self, message, *args):
70        self.location.error(message, *args)
71
72    def warning(self, message, *args):
73        self.location.warning(message, *args)
74
75    def writeHTMLFiles(self, path):
76        pass
77
78__all__ = [ "Symbol" ]
79