IIR.hh

Go to the documentation of this file.

#ifndef IIR_HH
#define IIR_HH

// Copyright (c) 1996-1999 The University of Cincinnati.  
// All rights reserved.

// UC MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF 
// THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE, OR NON-INFRINGEMENT.  UC SHALL NOT BE LIABLE
// FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING,
// RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
// DERIVATIVES.

// By using or copying this Software, Licensee agrees to abide by the
// intellectual property laws, and all other applicable laws of the
// U.S., and the terms of this license.


// You may modify, distribute, and use the software contained in this package
// under the terms of the "GNU LIBRARY GENERAL PUBLIC LICENSE" version 2,
// June 1991. A copy of this license agreement can be found in the file
// "LGPL", distributed with this archive.

// Authors: Philip A. Wilsey    phil.wilsey@uc.edu
//          Dale E. Martin      dmartin@cliftonlabs.com

//---------------------------------------------------------------------------

#include <iostream>
#include <string>
#include "IRBasicDataTypes.hh"
#include "savant.hh"

using std::string;

class IIR_Identifier;
class IIR_Declaration;
class IIR_DesignFile;
class IIR_TextLiteral;
class IIR_TypeDefinition;
class plugin_class_factory;

class IIR {
public:

  virtual IIR_Kind get_kind() const = 0;

  virtual IIR_Char *get_kind_text() const = 0;

  virtual string get_implementation_class() const = 0;

  virtual void set_file_name(IIR_Identifier *file_name, plugin_class_factory *) = 0;
  
  virtual void set_line_number(IIR_Int32 line_number) = 0;

  virtual IIR_Identifier *get_file_name() = 0;

  virtual IIR_Int32 get_line_number() const = 0;

  virtual IIR_DesignFile *get_design_file() const = 0;
  virtual void set_design_file(IIR_DesignFile *) = 0;
  
  virtual void set_base_info( IIR_DesignFile    *design_file,
                              int               line_number,
                              int               column_offset, 
                              int               character_offset ) = 0;

  virtual void copy_location( const IIR *, IIR *) = 0;
  virtual void copy_location(IIR *) = 0;
#ifdef SCHEMATIC_INFO

  
  virtual void set_sheet_name(IIR_Identifier *sheet_name) = 0;

  virtual void set_x_coordinate(IIR_Int32 x_coordinate) = 0;

  virtual void set_y_coordinate(IIR_Int32 y_coordinate) = 0;

  virtual IIR_Identifier *get_sheet_name() = 0;

  virtual IIR_Int32 get_x_coordinate() = 0;

  virtual IIR_Int32 get_y_coordinate() = 0;


#endif

#ifdef EXTRA_LOCATERS


  virtual void set_column_offset(IIR_Int32 column_offset) = 0;

  virtual void set_character_offset(IIR_Int32 character_offset) = 0;

  virtual IIR_Int32 get_column_offset() = 0;

  virtual IIR_Int32 get_character_offset() = 0;

#endif  
  
  virtual IIR_TextLiteral *get_prefix_string() = 0;

  virtual IIR* get_value() = 0;

  virtual ~IIR() {}

  virtual IIR* convert_tree(plugin_class_factory *) = 0;

  virtual IIR_SignalKind get_signal_kind() = 0;
  virtual IIR_Boolean is_guard_signal() = 0;

  virtual IIR_Boolean is_incomplete_type_declaration() = 0;

  virtual IIR_Boolean is_object() = 0;

  virtual IIR_Boolean is_name() = 0;
  virtual IIR_Boolean is_signal() = 0;
  virtual IIR_Boolean is_scalar_type() = 0;
  virtual IIR_Boolean is_record_type() = 0;
  virtual IIR_Boolean is_array_type() = 0;
  virtual IIR_Boolean is_entity_declaration() = 0;
  virtual IIR_Boolean is_resolved() = 0;
  virtual IIR_Boolean is_ascending_range() = 0;
  virtual IIR_Boolean is_subtype() = 0;
  virtual IIR_Boolean is_access_type() = 0;
  virtual IIR_Boolean is_interface() = 0;
  virtual IIR_Boolean is_enumeration_type() = 0;
  virtual IIR_Boolean is_text_literal() = 0;
  virtual IIR_Boolean is_aggregate_expression() = 0;
  virtual IIR_Boolean is_constant() = 0;
  virtual IIR_Boolean is_file_type() = 0;
  virtual IIR_Boolean is_type() = 0;
  virtual IIR_Boolean is_subprogram()  = 0;
  virtual IIR_Boolean is_integer_type() = 0;
  virtual IIR_Boolean is_character_type() = 0;
  virtual IIR_Boolean is_discrete_type() = 0;
  virtual IIR_Boolean is_variable() = 0;
  virtual IIR_Boolean is_literal() = 0;
  virtual IIR_Boolean is_operator() = 0;
  virtual IIR_Boolean is_above_attribute_found() = 0;
  virtual IIR_Boolean is_relational_operator() = 0;
  virtual IIR_Boolean is_logical_operator() = 0;

  virtual IIR_Boolean is_subtype_decl() = 0;

  virtual IIR_Boolean is_architecture_declaration() = 0;

  virtual IIR_Boolean is_attribute_declaration() = 0;

  virtual IIR_Boolean is_scalar_type_definition() = 0;

  virtual IIR_Boolean is_label() = 0;

  virtual IIR_Boolean is_component_declaration() = 0;

  virtual IIR_Boolean is_function_declaration() = 0;

  virtual IIR_Boolean is_configuration_declaration() = 0;

  virtual IIR_Boolean is_procedure_declaration() = 0;

  virtual IIR_Boolean is_package_declaration() = 0;

  virtual IIR_Boolean is_type_declaration() = 0;

  virtual IIR_Boolean is_subtype_declaration() = 0;

  virtual IIR_Boolean is_physical_unit() = 0;

  virtual IIR_Boolean is_group_declaration() = 0;

  virtual IIR_Boolean is_file() = 0;


  virtual IIR_Boolean is_locally_static() = 0;

  virtual IIR_TypeDefinition *get_subtype() = 0;
  virtual void set_subtype(IIR_TypeDefinition *) = 0;

  enum SignalAttribute {LAST_EVENT = 0, EVENT, ACTIVE, LAST_ACTIVE, LAST_VALUE,
                        DRIVING, DRIVING_VALUE, QUIET, STABLE, TRANSACTION,
                        INVALID};

  enum PublishedUnit {ENTITY_DECL, ARCHITECTURE_DECL, BLOCK, FUNCTION, 
                      PROCEDURE, PACKAGE_PUB, PACKAGE_BODY, PROCESS, 
                      PROCESS_STATE, TYPE, GENERIC_MAP, GENERATE_FOR, 
                      GENERATE_IF, DUMMY_ENTITY_DECL, CONFIGURATION_DECLARATION,
                      CASE_STATEMENT, NONE_PARSING, SIMULTANEOUS_STATEMENT, 
                      SIMULTANEOUS_IF, BREAK_STATEMENT, ABOVE_ATTRIBUTE, NONE}; 

  virtual IIR_Int32 get_num_indexes( ) = 0;


  virtual ostream &print( ostream & ) = 0;

  virtual IIR_TextLiteral *get_declarator() = 0;

  virtual IIR_Declaration* get_prefix_declaration() = 0;

  virtual void publish_vhdl( ostream &os ) = 0;

};


inline 
ostream &
operator<<(ostream &os, IIR &is ) {
  return is.print( os );
}

#endif

---