Util.h

Go to the documentation of this file.

/*
 *  CUnit - A Unit testing framework library for C.
 *  Copyright (C) 2001       Anil Kumar
 *  Copyright (C) 2004-2006  Anil Kumar, Jerry St.Clair
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library 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
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library 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
 */
 
/*
 *  Contains Type Definitions for some generic functions used across
 *  CUnit project files.
 *
 *  13/Oct/2001   Moved some of the generic functions declarations from
 *                other files to this one so as to use the functions
 *                consitently. This file is not included in the distribution
 *                headers because it is used internally by CUnit. (AK)
 *
 *  20-Jul-2004   New interface, support for deprecated version 1 names. (JDS)
 *
 *  5-Sep-2004    Added internal test interface. (JDS)
 *
 *  17-Apr-2006   Added CU_translated_strlen() and CU_number_width().
 *                Removed CUNIT_MAX_STRING_LENGTH - dangerous since not enforced.
 *                Fixed off-by-1 error in CU_translate_special_characters(),
 *                modifying implementation & results in some cases.  User can
 *                now tell if conversion failed. (JDS)
 */
 
#ifndef CUNIT_UTIL_H_SEEN
#define CUNIT_UTIL_H_SEEN
 
#include <stdlib.h>
#include "CUnit/CUnit.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CUNIT_MAX_ENTITY_LEN 5
CU_EXPORT size_t CU_translate_special_characters(const char *szSrc, char *szDest, size_t maxlen);
CU_EXPORT size_t CU_translated_strlen(const char *szSrc);
CU_EXPORT int CU_compare_strings(const char *szSrc, const char *szDest);
CU_EXPORT void CU_trim_left(char *szString);
CU_EXPORT void CU_trim_right(char *szString);
CU_EXPORT void CU_trim(char *szString);
CU_EXPORT size_t CU_number_width(int number);
CU_EXPORT const char* CU_get_basename(const char* path);
#define CU_MAIN_EXE_NAME CU_get_basename(argv[0])
 
// yes PATH_MAX and _MAX_PATH exist but both are caveats and are filesystem type dependant, not compile time
#define CUNIT_FILE_PATH_MAX 4096
 
#ifdef CUNIT_BUILD_TESTS
void test_cunit_Util(void);
#endif
 
#ifdef __cplusplus
}
#endif
 
#ifdef USE_DEPRECATED_CUNIT_NAMES
#define CUNIT_MAX_STRING_LENGTH 1024
#define translate_special_characters(src, dest, len) CU_translate_special_characters(src, dest, len)
#define compare_strings(src, dest) CU_compare_strings(src, dest)
#define trim_left(str) CU_trim_left(str)
#define trim_right(str) CU_trim_right(str)
#define trim(str) CU_trim(str)
#endif  /* USE_DEPRECATED_CUNIT_NAMES */
 
#endif /* CUNIT_UTIL_H_SEEN */