xref: /gem5/src/mem/slicc/symbols/Func.py

# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
# Copyright (c) 2009 The Hewlett-Packard Development Company
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from slicc.symbols.Symbol import Symbol
from slicc.symbols.Type import Type

class Func(Symbol):
    def __init__(self, table, ident, name, location, return_type, param_types,
                 proto_param_strings, body_param_strings, body,
                 pairs, default_count = 0):
        super(Func, self).__init__(table, ident, location, pairs)
        self.return_type = return_type
        self.param_types = param_types
        self.proto_param_strings = proto_param_strings
        self.body_param_strings = body_param_strings
        self.body = body
        self.isInternalMachineFunc = False
        self.c_ident = ident
        self.c_name = name
        self.class_name = ""
        self.default_count = default_count

    def __repr__(self):
        return ""

    @property
    def prototype(self):
        if "external" in self:
            return ""

        return_type = self.return_type.c_ident
        void_type = self.symtab.find("void", Type)
        if "return_by_ref" in self and self.return_type != void_type:
            return_type += "&"
        elif "return_by_pointer" in self and self.return_type != void_type:
            return_type += "*"

        return "%s %s(%s);" % (return_type, self.c_name,
                               ", ".join(self.proto_param_strings))

    def writeCodeFiles(self, path, includes):
        return

    def checkArguments(self, args):
        if len(args) + self.default_count < len(self.param_types) or \
           len(args) > len(self.param_types):
            self.error("Wrong number of arguments passed to function: '%s'" + \
                       " Expected at least: %d, got: %d", self.c_ident,
                       len(self.param_types) - self.default_count, len(args))

        cvec = []
        type_vec = []
        for expr,expected_type in zip(args, self.param_types):
            # Check the types of the parameter
            actual_type,param_code = expr.inline(True)
            if str(actual_type) != 'OOD' and \
               str(actual_type) != str(expected_type) and \
               str(actual_type["interface"]) != str(expected_type):
                expr.error("Type mismatch: expected: %s actual: %s" % \
                           (expected_type, actual_type))
            cvec.append(param_code)
            type_vec.append(expected_type)

        return cvec, type_vec

    def generateCode(self):
        '''This write a function of object Chip'''
        if "external" in self:
            return ""

        code = self.symtab.codeFormatter()

        # Generate function header
        return_type = self.return_type.c_ident
        void_type = self.symtab.find("void", Type)
        if "return_by_ref" in self and self.return_type != void_type:
            return_type += "&"
        if "return_by_pointer" in self and self.return_type != void_type:
            return_type += "*"

        params = ', '.join(self.body_param_strings)

        code('''
$return_type
${{self.class_name}}::${{self.c_name}}($params)
{
${{self.body}}
}
''')
        return str(code)

__all__ = [ "Func" ]