#ifndef IVL_subprogram_H
#define IVL_subprogram_H
/*
 * Copyright (c) 2013-2014 Stephen Williams (steve@icarus.com)
 * Copyright CERN 2013 / Stephen Williams (steve@icarus.com)
 * Copyright CERN 2015
 * @author Maciej Suminski (maciej.suminski@cern.ch)
 *
 *    This source code is free software; you can redistribute it
 *    and/or modify it in source code form under the terms of the GNU
 *    General Public License as published by the Free Software
 *    Foundation; either version 2 of the License, or (at your option)
 *    any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

# include  "StringHeap.h"
# include  "LineInfo.h"
# include  "scope.h"
# include  <iostream>
# include  <list>

class InterfacePort;
class SequentialStmt;
class VType;

class Subprogram : public LineInfo, public ScopeBase {

    public:
      Subprogram(perm_string name, std::list<InterfacePort*>*ports,
		 const VType*return_type);
      ~Subprogram();

      void set_parent(const ScopeBase*par);
      inline const ScopeBase*get_parent() const { return parent_; }

      inline const perm_string&name() const { return name_; }

      void set_program_body(std::list<SequentialStmt*>*statements);

	// Return true if the specification (name, types, ports)
	// matches this subprogram and that subprogram.
      bool compare_specification(Subprogram*that) const;

      const InterfacePort*find_param(perm_string nam) const;
      const VType*peek_param_type(int idx) const;
      const VType*peek_return_type() const { return return_type_; }

      int emit(ostream&out, Entity*ent, ScopeBase*scope);

	// Emit a definition as it would show up in a package.
      int emit_package(std::ostream&fd) const;

      void write_to_stream(std::ostream&fd) const;
      void dump(std::ostream&fd) const;

    private:
	// Tries to set the return type to a fixed type. VHDL functions that
	// return std_logic_vectors do not specify its length, as SystemVerilog
	// demands.
	// The function goes through the function body looking for return
	// statments and probes the returned type. If it is the same for every
	// statemnt then we can assume that the function returns vector of a
	// fixed size.
      bool fixed_return_type();

	// Iterates through the list of function ports to fix all quirks related
	// to translation between VHDL and SystemVerilog.
      void fix_port_types();

	// SystemVerilog does not allow to have signals/variables which size is
	// evaluated at runtime. This function finds such variables and modifies
	// their type to dynamic array and adds appropriate 'new' statement in
	// the program body.
      void fix_variables();

	// For the time being, dynamic arrays work exclusively with vectors.
	// To emulate dynamic array of 'logic'/'bit' type, we need to create a vector
	// of width == 1, to be used as the array element type.
	// Effectively 'logic name []' becomes 'logic [0:0] name []'.
      VTypeArray*fix_logic_darray(const VTypeArray*type);

	// Creates a typedef for an unbounded vector and updates the given type.
      bool check_unb_vector(const VType*&type);

      perm_string name_;
      const ScopeBase*parent_;
      std::list<InterfacePort*>*ports_;
      const VType*return_type_;
      std::list<SequentialStmt*>*statements_;
};

#endif /* IVL_subprogram_H */