NuSMV/code/nusmv/core/utils/Olist.h File Reference

#include "nusmv/core/utils/defs.h"
#include "nusmv/core/node/printers/MasterPrinter.h"

Go to the source code of this file.

Data Structures

struct  Oiter

Defines

#define OLIST(x)   ((Olist_ptr) x)
#define OLIST_CHECK_INSTANCE(x)   ( nusmv_assert(OLIST(x) != OLIST(NULL)) )
#define OLIST_FOREACH(list, iter)   for (iter = Olist_first(list); !Oiter_is_end(iter); iter = Oiter_next(iter))

Typedefs

typedef struct Olist_TAG * Olist_ptr
typedef struct Onode_TAG * Onode_ptr

Functions

void * Oiter_element (Oiter iter)
 Returns a value of a list element pointed by a provided iterator.
boolean Oiter_is_end (Oiter iter)
 Returns true iff an iterator points past the last element of a list.
Oiter Oiter_next (Oiter iter)
 Returns an iterator pointing to the next element of a list w.r.t. the element pointed by a provided iterator.
void Oiter_set_element (Oiter iter, void *element)
 Sets a new value to the list element pointed by a provided iterator.
void olist_testing_function (const NuSMVEnv_ptr env)
 This is a test function.

Define Documentation

#define OLIST (  )     ((Olist_ptr) x)
Todo:
Missing synopsis
Todo:
Missing description
#define OLIST_CHECK_INSTANCE (  )     ( nusmv_assert(OLIST(x) != OLIST(NULL)) )
Todo:
Missing synopsis
Todo:
Missing description
#define OLIST_FOREACH ( list,
iter   )     for (iter = Olist_first(list); !Oiter_is_end(iter); iter = Oiter_next(iter))
Todo:
Missing synopsis
Todo:
Missing description

Typedef Documentation

typedef struct Olist_TAG* Olist_ptr
typedef struct Onode_TAG* Onode_ptr

Function Documentation

void* Oiter_element ( Oiter  iter  ) 

Returns a value of a list element pointed by a provided iterator.

Precondition: this function can be applied only if Oiter_is_end(iter) returns false

See also:
Olist_first, Oiter_is_end, Oiter_next
boolean Oiter_is_end ( Oiter  iter  ) 

Returns true iff an iterator points past the last element of a list.

The iterator must have been created with function Olist_first, Olist_end or Olist_next

See also:
Olist_first, Olist_end, Oiter_next, Oiter_element
Oiter Oiter_next ( Oiter  iter  ) 

Returns an iterator pointing to the next element of a list w.r.t. the element pointed by a provided iterator.

Precondition: this function can be applied only if Oiter_is_end(iter) returns false

See also:
Olist_first, Oiter_is_end, Oiter_element
void Oiter_set_element ( Oiter  iter,
void *  element 
)

Sets a new value to the list element pointed by a provided iterator.

Precondition: this function can be applied only if Oiter_is_end(iter) returns false

See also:
Olist_first, Oiter_is_end, Oiter_next, Oiter_element
void olist_testing_function ( const NuSMVEnv_ptr  env  ) 

This is a test function.

Prototype of this function is not defined anywhere. Thus to use it define the prototype where you want and then invoke this function. MD: I added the prototype to avoid having missing prototypes. A better way to hide the function is to use a macro to compile it away.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on 14 Oct 2015 for NuSMV Developers Manual by  doxygen 1.6.1