xref: /gem5/src/mem/slicc/ast/StateDeclAST.py

# Copyright (c) 2011 Advanced Micro Devices, Inc.
# 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.ast.DeclAST import DeclAST
from slicc.symbols import Func, Type

class StateDeclAST(DeclAST):
    def __init__(self, slicc, type_ast, pairs, states):
        super(StateDeclAST, self).__init__(slicc, pairs)

        self.type_ast = type_ast
        self.states = states

    def __repr__(self):
        return "[StateDecl: %s]" % (self.type_ast)

    def files(self, parent=None):
        if "external" in self:
            return set()

        if parent:
            ident = "%s_%s" % (parent, self.type_ast.ident)
        else:
            ident = self.type_ast.ident
        s = set(("%s.hh" % ident, "%s.cc" % ident))
        return s

    def generate(self):
        ident = str(self.type_ast)

        # Make the new type
        t = Type(self.symtab, ident, self.location, self.pairs,
                 self.state_machine)
        self.symtab.newSymbol(t)

        # Add all of the states of the type to it
        for state in self.states:
            state.generate(t)

        # Add the implicit State_to_string method - FIXME, this is a bit dirty
        func_id = "%s_to_string" % t.c_ident

        pairs = { "external" : "yes" }
        func = Func(self.symtab, func_id, self.location,
                    self.symtab.find("std::string", Type), [ t ], [], "",
                    pairs, None)
        self.symtab.newSymbol(func)

        # Add the State_to_permission method
        func_id = "%s_to_permission" % t.c_ident

        pairs = { "external" : "yes" }
        func = Func(self.symtab, func_id, self.location,
                    self.symtab.find("AccessPermission", Type), [ t ], [], "",
                    pairs, None)
        self.symtab.newSymbol(func)