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