Func.py revision 7007 
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.symbols.Symbol import Symbol
29from slicc.symbols.Type import Type
30
31class Func(Symbol):
32    def __init__(self, table, ident, location, return_type, param_types,
33                 param_strings, body, pairs, machine):
34        super(Func, self).__init__(table, ident, location, pairs)
35        self.return_type = return_type
36        self.param_types = param_types
37        self.param_strings = param_strings
38        self.body = body
39        self.isInternalMachineFunc = False
40
41        if machine is None:
42            self.c_ident = ident
43        elif "external" in self or "primitive" in self:
44            self.c_ident = ident
45        else:
46            self.machineStr = str(machine)
47            # Append with machine name
48            self.c_ident = "%s_%s" % (self.machineStr, ident)
49            self.isInternalMachineFunc = True
50
51    def __repr__(self):
52        return ""
53
54    @property
55    def prototype(self):
56        if "external" in self:
57            return ""
58
59        return_type = self.return_type.c_ident
60        void_type = self.symtab.find("void", Type)
61        if "return_by_ref" in self and self.return_type != void_type:
62            return_type += "&"
63
64        return "%s %s(%s);" % (return_type, self.c_ident,
65                               ", ".join(self.param_strings))
66
67    def writeCodeFiles(self, path):
68        '''This write a function of object Chip'''
69        if "external" in self:
70            return
71
72        code = self.symtab.codeFormatter()
73
74        # Header
75        code('''
76/** Auto generated C++ code started by $__file__:$__line__ */
77
78#include "mem/protocol/Types.hh"
79''')
80
81        if self.isInternalMachineFunc:
82            code('#include "mem/protocol/${{self.machineStr}}_Controller.hh"')
83
84        # Generate function header
85        void_type = self.symtab.find("void", Type)
86        return_type = self.return_type.c_ident
87        if "return_by_ref" in self and self.return_type != void_type:
88            return_type += "&"
89
90        if self.isInternalMachineFunc:
91            klass = "%s_Controller" % self.machineStr
92        else:
93            klass = "Chip"
94
95        params = ', '.join(self.param_strings)
96
97        code('''
98$return_type
99${klass}::${{self.c_ident}}($params)
100{
101${{self.body}}
102}
103''')
104        code.write(path, "%s.cc" % self.c_ident)
105
106__all__ = [ "Func" ]
107