NuSMV/code/nusmv/core/sexp/SexpInliner.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------


  This file is part of the ``sexp'' package of NuSMV version 2.
  Copyright (C) 2008 by FBK-irst.

  NuSMV version 2 is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  NuSMV version 2 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

  For more information on NuSMV see <http://nusmv.fbk.eu>
  or email to <nusmv-users@fbk.eu>.
  Please report bugs to <nusmv-users@fbk.eu>.

  To contact the NuSMV development board, email to <nusmv@fbk.eu>. 

-----------------------------------------------------------------------------*/

#ifndef __NUSMV_CORE_SEXP_SEXP_INLINER_H__
#define __NUSMV_CORE_SEXP_SEXP_INLINER_H__

#include "nusmv/core/wff/ExprMgr.h"
#include "nusmv/core/compile/symb_table/SymbTable.h"
#include "nusmv/core/set/set.h"
#include "nusmv/core/utils/utils.h"

typedef struct SexpInliner_TAG* SexpInliner_ptr;

#define SEXP_INLINER(x) \
         ((SexpInliner_ptr) x)

#define SEXP_INLINER_CHECK_INSTANCE(x) \
         (nusmv_assert(SEXP_INLINER(x) != SEXP_INLINER(NULL)))

typedef struct InlineRes_TAG* InlineRes_ptr;

#define INLINE_RES(x) \
         ((InlineRes_ptr) x)

#define INLINE_RES_CHECK_INSTANCE(x) \
         (nusmv_assert(INLINE_RES(x) != INLINE_RES(NULL)))


/*---------------------------------------------------------------------------*/
/* Public Function Interface                                                 */
/*---------------------------------------------------------------------------*/


/* ===================  SexpInliner  =================== */

SexpInliner_ptr SexpInliner_create(SymbTable_ptr st,
                                          const size_t fixpoint_limit);

SexpInliner_ptr SexpInliner_copy(const SexpInliner_ptr self);

void SexpInliner_destroy(SexpInliner_ptr self);

SymbTable_ptr
SexpInliner_get_symb_table(const SexpInliner_ptr self);

boolean
SexpInliner_force_equivalence(SexpInliner_ptr self,
                              node_ptr var, Expr_ptr expr);

boolean
SexpInliner_force_equivalences(SexpInliner_ptr self, Set_t equivs);

boolean
SexpInliner_force_invariant(SexpInliner_ptr self,
                            node_ptr var, Expr_ptr expr);

boolean
SexpInliner_force_invariants(SexpInliner_ptr self, Set_t invars);

void
SexpInliner_blacklist_name(SexpInliner_ptr self, node_ptr var);

void
SexpInliner_clear_equivalences(SexpInliner_ptr self);

void
SexpInliner_clear_invariants(SexpInliner_ptr self);

void
SexpInliner_clear_blacklist(SexpInliner_ptr self);

InlineRes_ptr
SexpInliner_inline(SexpInliner_ptr self, Expr_ptr expr,
                   boolean* changed);

Expr_ptr
SexpInliner_inline_no_learning(SexpInliner_ptr self, Expr_ptr expr,
                               boolean* changed);

hash_ptr
SexpInliner_get_var2expr_hash(SexpInliner_ptr self);

hash_ptr
SexpInliner_get_var2invar_hash(SexpInliner_ptr self);

/* ===================  InlineRes  =================== */

void InlineRes_destroy(InlineRes_ptr self);

Expr_ptr
InlineRes_get_original_expr(const InlineRes_ptr self);

Expr_ptr
InlineRes_get_result(const InlineRes_ptr self);

Expr_ptr
InlineRes_get_result_unique(const InlineRes_ptr self);

Expr_ptr
InlineRes_get_inlined_expr(const InlineRes_ptr self);

Expr_ptr
InlineRes_get_equivalences_expr(const InlineRes_ptr self);

Set_t
InlineRes_get_equivalences(const InlineRes_ptr self);

Expr_ptr
InlineRes_get_invariant_expr(const InlineRes_ptr self);

Set_t
InlineRes_get_invariants(const InlineRes_ptr self);

#endif /* __SEXP_INLINER_H__ */

---