Example of a SUIF IR Module

A simple example that illustrates how to define and generate a simple SUIF IR module from a Hoof specification.

Files

test.hoof: Source code of a hoof specification
Makefile: Make file that produces a testnodes library in ${NCIHOME}/solib

Generating the definition

# build the library and generate the include files.
hoof> gmake
...

Input File(test.hoof)

module test {
   concrete Example : SuifObject
   {
       int x;
   };
}

Output Files

A library: ${NCIHOME}/solib/sotestnodes.so
- Usage: Use import testnodes to import library in suifdriver
Header files in ${NCIHOME}/include/testnodes

test.h
Usage: Use #include "testnodes/test.h" to include the header file in your .h files.
Contents:

#include "suifkernel/suifkernel_forwarders.h"
#include "suifkernel/suif_object.h"
#include "common/suif_list.h"
#include "common/suif_vector.h"
#include "common/suif_indexed_list.h"
#include "test_forwarders.h"
#include "common/formatted.h"
#include "suifkernel/iter.h"
#include "common/i_integer.h"
#include "iokernel/meta_class.h"
extern "C" void EXPORT init_testnodes(SuifEnv* suif);

class Example : public  SuifObject {
  public:
    virtual int get_x () const;
    virtual void set_x(int the_value);
    virtual ~Example();
    virtual void print(FormattedText &x) const;
    static const LString &get_class_name();
  protected:
    //use the factory to create objects
    friend class TestObjectFactory;
    
    Example();
    static void constructor_function( Address address );
  private:
    int _x;
    };

test_factory.h - Interface for the object factory to create objects of the class.
test_forwarders.h - Forward declarations for the class. This is all you need to declare pointers to the class.

Implementation: test.cpp in the source directory