NuSMV/code/nusmv/core/utils/OStream.h

Go to the documentation of this file.

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


  This file is part of the ``utils'' package of NuSMV version 2.
  Copyright (C) 2011 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_UTILS_OSTREAM_H__
#define __NUSMV_CORE_UTILS_OSTREAM_H__


#include <stdarg.h>
#include "nusmv/core/node/printers/MasterPrinter.h"
#include "nusmv/core/utils/utils.h"

typedef struct OStream_TAG*  OStream_ptr;

#define OSTREAM(self) \
         ((OStream_ptr) self)

#define OSTREAM_CHECK_INSTANCE(self) \
         (nusmv_assert(OSTREAM(self) != OSTREAM(NULL)))



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

/* Constructors, Destructors, Copiers and Cleaners ****************************/

OStream_ptr OStream_create(FILE* stream);

OStream_ptr OStream_create_file(const char* fname, boolean append);

OStream_ptr OStream_copy(OStream_ptr self);

void OStream_destroy(OStream_ptr self);

void OStream_destroy_safe(OStream_ptr self);


/* Getters and Setters ********************************************************/

FILE* OStream_get_stream(const OStream_ptr self);

void OStream_printf(const OStream_ptr self,
                           const char* format, ...);

void OStream_nprintf(const OStream_ptr self,
                            const MasterPrinter_ptr node_printer,
                            const char* format, ...);

void OStream_vprintf(const OStream_ptr self,
                            const char* format, va_list args);

void OStream_nvprintf(const OStream_ptr self,
                             const MasterPrinter_ptr node_printer,
                             const char* format, va_list args);

void OStream_flush(const OStream_ptr self);

void OStream_inc_indent_size(OStream_ptr self);

void OStream_dec_indent_size(OStream_ptr self);

int OStream_get_indent_size(const OStream_ptr self);

void OStream_reset_indent_size(OStream_ptr self);

void OStream_set_indent_size(OStream_ptr self, int n);

void OStream_set_split_newline(OStream_ptr self, boolean enabled);

void OStream_set_stream(OStream_ptr self, FILE* stream);

FILE* OStream_reset_stream(OStream_ptr self);

#endif /* __NUSMV_CORE_UTILS_OSTREAM_H__ */

---