NuSMV/code/nusmv/core/node/printers/MasterPrinter.h

Go to the documentation of this file.

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


  This file is part of the ``node.printers'' package of NuSMV version 2.
  Copyright (C) 2006 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_NODE_PRINTERS_MASTER_PRINTER_H__
#define __NUSMV_CORE_NODE_PRINTERS_MASTER_PRINTER_H__

#include "nusmv/core/node/NodeMgr.h"
#include "nusmv/core/node/MasterNodeWalker.h"

typedef struct MasterPrinter_TAG*  MasterPrinter_ptr;

#define MASTER_PRINTER(self) \
         ((MasterPrinter_ptr) self)

#define MASTER_PRINTER_CHECK_INSTANCE(self) \
         (nusmv_assert(MASTER_PRINTER(self) != MASTER_PRINTER(NULL)))


typedef enum StreamType_TAG {
  STREAM_TYPE_DEFAULT,  /* the default stream type (STREAM_TYPE_STDOUT) */
  STREAM_TYPE_STDOUT,
  STREAM_TYPE_STDERR,
  STREAM_TYPE_STRING,
  STREAM_TYPE_FILE,     /* This requires a parameter */
  STREAM_TYPE_FUNCTION  /* This requires a parameter */
} StreamType;

typedef int (*StreamTypeFunction_ptr)(const char* str, void* arg);


union StreamTypeArg
{
  /* for STREAM_TYPE_FILE */
  FILE* file;

  /* for STREAM_TYPE_FUNCTION */
  struct {
    /* The function pointer */
    StreamTypeFunction_ptr func_ptr;
    /* The argument to pass to each function call */
    void* argument;
  } function;
};


#define STREAM_TYPE_ARG_UNUSED   \
  NULL


/*---------------------------------------------------------------------------*/
/* Function prototypes                                                       */
/*---------------------------------------------------------------------------*/

/* Fast and ready to use functions */

int print_node(MasterPrinter_ptr wffprinter, FILE *, node_ptr);

char* sprint_node(MasterPrinter_ptr wffprinter, node_ptr);

int print_node_indent_at(MasterPrinter_ptr iwffprinter,
                                FILE *stream, node_ptr n, int ofs);

char* sprint_node_indent_at(MasterPrinter_ptr iwffprinter,
                                   node_ptr n, int ofs);

int print_node_indent(MasterPrinter_ptr iwffprinter,
                             FILE *stream, node_ptr n);

char* sprint_node_indent(MasterPrinter_ptr iwffprinter,
                                node_ptr n);


/* MasterPrinter class methods */

MasterPrinter_ptr MasterPrinter_create(const NuSMVEnv_ptr env);

int
MasterPrinter_print_node(MasterPrinter_ptr self, node_ptr n);

int
MasterPrinter_print_string(MasterPrinter_ptr self, const char* str);

const char*
MasterPrinter_get_streamed_string(const MasterPrinter_ptr self);

void
MasterPrinter_reset_stream(MasterPrinter_ptr self, int offs);

void
MasterPrinter_set_stream_type(MasterPrinter_ptr self,
                              StreamType type,
                              const union StreamTypeArg* arg);

StreamType
MasterPrinter_get_stream_type(const MasterPrinter_ptr self);

int
MasterPrinter_flush_stream(MasterPrinter_ptr self);

void
MasterPrinter_close_stream(MasterPrinter_ptr self);

void debug_print_node(NuSMVEnv_ptr env, node_ptr node);

void debug_print_sexp(NuSMVEnv_ptr env, node_ptr node);

#endif /* __NUSMV_CORE_NODE_PRINTERS_MASTER_PRINTER_H__ */

---