Contents

/*
  Copyright 2006 Suraj N. Kurapati

  This file is part of Ruby-VPI.

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

  Ruby-VPI 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with Ruby-VPI; if not, write to the Free Software Foundation,
  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/
/**\file
  Things common to all Ruby-VPI code.
*/

#ifndef COMMON_H
#define	COMMON_H

  #include <stddef.h>
  #include "verilog.h"


  /**
    A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI and ends the message with a new line.

    @param	...	Arguments to vpi_printf()
  */
  #define common_printf(...)	vpi_printf("Ruby-VPI: "); vpi_printf(__VA_ARGS__); vpi_printf("\n");

  /**
    A wrapper for common_printf() which marks the given message as being debugging output.
  */
  #ifdef DEBUG
    #define common_debug(...) vpi_printf("(%s:%d) ", __FILE__, __LINE__); common_printf(__VA_ARGS__);
  #else
    #define common_debug(...)
  #endif

  /**
    A boolean variable with two possible values: true and false. Pass aroung this value instead of zero and non-zero integers.
  */
  typedef enum { false = 0, true = 1 } bool;

  /**
    Returns the string "true" if the given boolean expression is true. Otherwise returns the string "false".
  */
  #define common_boolToStr(aBoolExpr)	( (aBoolExpr) ? "true" : "false" )

#endif

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
ruby-vpi-13.0.0	ext/common.h
ruby-vpi-14.0.0	ext/common.h
ruby-vpi-15.0.1	ext/common.h
ruby-vpi-15.0.0	ext/common.h
ruby-vpi-15.0.2	ext/common.h