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

Go to the documentation of this file.

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


  This file is part of the ``utils'' package of NuSMV version 2.
  Copyright (C) 1998-2001 by CMU and 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_UTILS_H__
#define __NUSMV_CORE_UTILS_UTILS_H__

#if HAVE_CONFIG_H
#include "nusmv-config.h"
#else

#define NUSMV_FUNCATTR_NORETURN
#endif

#include "nusmv/core/utils/defs.h"
#include "nusmv/core/cinit/NuSMVEnv.h"
#include "nusmv/core/utils/list.h" /* MD: it should be better to remove this dependency */

/* --------------------------------------------------------------------- */
/*      Exported functions                                               */
/* --------------------------------------------------------------------- */

void Utils_pkg_init(const NuSMVEnv_ptr env);

void Utils_pkg_quit(const NuSMVEnv_ptr env);

/* String Manipulation ********************************************************/

char* Utils_int_to_str(const int an_int);

size_t Utils_int_size_as_string(const int an_int);

/* FileSystem *****************************************************************/

const char* Utils_StripPath(const char* pathfname);

void
Utils_StripPathNoExtension(const char* fpathname, char* filename);

void Utils_StripPathNoFilenameNoExtension(const char* fpathname,
                                          char* dirname);

char* Utils_get_temp_filename_in_dir(const char* dir,
                                     const char* templ);

int Utils_file_exists_in_paths(const char* filename,
                               const char* paths,
                               const char* delimiters);

int Utils_file_exists_in_directory(const char* filename,
                                   char* directory);

boolean Utils_file_exists(const char* filename);

boolean Utils_files_are_the_same(const char* fname1, const char* fname3);

boolean Utils_file_can_be_written(const char* filename);

boolean Utils_exe_file_exists(const char* filename);


/* Miscellaneous **************************************************************/

int Utils_strcasecmp(const char* s1, const char* s2);

int Utils_log2_round(unsigned long long int a);

int Utils_ptr_compar(const void* a, const void* b);

void Utils_str_escape_xml_file(const char* str, FILE* file);

void Utils_FreeListOfLists(lsList list_of_lists);


/* High-level support for timers used in benchmarking ************************/

void Utils_start_timer(const NuSMVEnv_ptr env, const char* name);

void Utils_stop_timer(const NuSMVEnv_ptr env, const char* name);

void Utils_reset_timer(const NuSMVEnv_ptr env, const char* name);

void Utils_print_timer(const NuSMVEnv_ptr env,
                       const char* name, const char* msg);


/* Draft of an interface to cudd util subpackage ******************************/

char* Utils_util_tilde_expand(char* fname);


#endif /* __NUSMV_CORE_UTILS_UTILS_H__ */

---