src/mem/slicc/symbols/Func.hh

   1
   2 /*
   3  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met: redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer;
  10  * redistributions in binary form must reproduce the above copyright
  11  * notice, this list of conditions and the following disclaimer in the
  12  * documentation and/or other materials provided with the distribution;
  13  * neither the name of the copyright holders nor the names of its
  14  * contributors may be used to endorse or promote products derived from
  15  * this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * Func.hh
  32  *
  33  * Description:
  34  *
  35  * $Id$
  36  *
  37  */
  38
  39 #ifndef FUNC_H
  40 #define FUNC_H
  41
  42 #include "mem/slicc/slicc_global.hh"
  43 #include "mem/slicc/symbols/Type.hh"
  44 class StateMachine;
  45
  46 class Func : public Symbol {
  47 public:
  48   // Constructors
  49   Func(string id, const Location& location,
  50        Type* type_ptr, const Vector<Type*>& param_type_vec, const Vector<string>& param_string_vec,
  51        string body, const Map<string, string>& pairs, StateMachine* machine_ptr);
  52
  53   // Destructor
  54   ~Func() {}
  55
  56   // Public Methods
  57   string cIdent() const { return m_c_ident; }
  58   const Vector<Type*>& getParamTypes() const { return m_param_type_vec; }
  59   Type* getReturnType() const { return m_type_ptr; }
  60   void writeCFiles(string path) ;
  61   void funcPrototype(string& code) const;
  62   bool isExternal() const { return existPair("external"); }
  63   bool isInternalMachineFunc() const { return m_isInternalMachineFunc; }
  64   void print(ostream& out) const;
  65 private:
  66   // Private Methods
  67
  68   // Private copy constructor and assignment operator
  69   Func(const Func& obj);
  70   Func& operator=(const Func& obj);
  71
  72   // Data Members (m_ prefix)
  73   Type* m_type_ptr;
  74   Vector<Type*> m_param_type_vec;
  75   Vector<string> m_param_string_vec;
  76   string m_body;
  77   string m_c_ident;
  78   string m_machineStr;
  79   bool m_isInternalMachineFunc;
  80 };
  81
  82 // Output operator declaration
  83 ostream& operator<<(ostream& out, const Func& obj);
  84
  85 // ******************* Definitions *******************
  86
  87 // Output operator definition
  88 extern inline
  89 ostream& operator<<(ostream& out, const Func& obj)
  90 {
  91   obj.print(out);
  92   out << flush;
  93   return out;
  94 }
  95
  96 #endif //FUNC_H