libFirm
Library Initialization

The functions in this section deal with initialization and deinitalization of the libFirm library. More...

Enumerations

enum  firm_kind {
  k_BAD = 0, k_entity, k_type, k_ir_graph,
  k_ir_node, k_ir_mode, k_tarval, k_ir_loop,
  k_ir_max
}
 A list of firm kinds. More...
 

Functions

void ir_init (void)
 Initializes the firm library. More...
 
void ir_finish (void)
 Frees all memory occupied by the firm library. More...
 
unsigned ir_get_version_major (void)
 returns the libFirm major version number More...
 
unsigned ir_get_version_minor (void)
 returns libFirm minor version number More...
 
unsigned ir_get_version_micro (void)
 returns libFirm micro version number More...
 
const char * ir_get_version_revision (void)
 returns string describing libFirm revision More...
 
const char * ir_get_version_build (void)
 returns string describing libFirm build More...
 
firm_kind get_kind (const void *firm_thing)
 Returns the kind of a thing. More...
 

Detailed Description

The functions in this section deal with initialization and deinitalization of the libFirm library.

Enumeration Type Documentation

enum firm_kind

A list of firm kinds.

Most important data structures in firm contain a firm_kind field at the beginning so given void* pointer you can usually still guess the kind of thing the pointer points to. This is used in debug helper functions and printers.

Enumerator
k_BAD 

An invalid firm node.

k_entity 

An entity.

k_type 

A type.

k_ir_graph 

An IR graph.

k_ir_node 

An IR node.

k_ir_mode 

An IR mode.

k_tarval 

A tarval.

k_ir_loop 

A loop.

k_ir_max 

maximum value – illegal for firm nodes.

Definition at line 52 of file firm_common.h.

Function Documentation

firm_kind get_kind ( const void *  firm_thing)

Returns the kind of a thing.

Parameters
firm_thingpointer representing a firm object
void ir_finish ( void  )

Frees all memory occupied by the firm library.

const char* ir_get_version_build ( void  )

returns string describing libFirm build

unsigned ir_get_version_major ( void  )

returns the libFirm major version number

unsigned ir_get_version_micro ( void  )

returns libFirm micro version number

unsigned ir_get_version_minor ( void  )

returns libFirm minor version number

const char* ir_get_version_revision ( void  )

returns string describing libFirm revision

void ir_init ( void  )

Initializes the firm library.

Allocates default data structures.