fa93c88fa2
This is a more convenient behaviour (truncating on overflow and always null terminating the buffer) compared to the MSVC safe strcat_s which aborts the process if the string doesn't fit into the target buffer. Also mark the source buffer as const in the function prototype.
257 lines
6.6 KiB
C++
257 lines
6.6 KiB
C++
/*!
|
|
* \copy
|
|
* Copyright (c) 2009-2013, Cisco Systems
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*
|
|
* \file crt_utils_safe_x.cpp
|
|
*
|
|
* \brief common tool/function utilization
|
|
*
|
|
* \date 03/10/2009 Created
|
|
*
|
|
*************************************************************************************
|
|
*/
|
|
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
#include <math.h>
|
|
#include <time.h>
|
|
#if defined(_WIN32)
|
|
#include <windows.h>
|
|
#include <sys/types.h>
|
|
#include <sys/timeb.h>
|
|
#ifndef _MSC_VER
|
|
#include <sys/time.h>
|
|
#endif //!_MSC_VER
|
|
#else
|
|
#include <sys/time.h>
|
|
#include <sys/timeb.h>
|
|
#endif //_WIN32
|
|
|
|
#include "macros.h"
|
|
#include "crt_util_safe_x.h" // Safe CRT routines like utils for cross platforms
|
|
|
|
#if defined(_WIN32) && defined(_MSC_VER)
|
|
|
|
#if defined(_MSC_VER) && (_MSC_VER>=1500)
|
|
|
|
int32_t WelsSnprintf (str_t* pBuffer, int32_t iSizeOfBuffer, const str_t* kpFormat, ...) {
|
|
va_list pArgPtr;
|
|
int32_t iRc;
|
|
|
|
va_start (pArgPtr, kpFormat);
|
|
|
|
iRc = vsnprintf_s (pBuffer, iSizeOfBuffer, _TRUNCATE, kpFormat, pArgPtr);
|
|
|
|
va_end (pArgPtr);
|
|
|
|
return iRc;
|
|
}
|
|
|
|
str_t* WelsStrncpy (str_t* pDest, int32_t iSizeInBytes, const str_t* kpSrc) {
|
|
strncpy_s (pDest, iSizeInBytes, kpSrc, _TRUNCATE);
|
|
|
|
return pDest;
|
|
}
|
|
|
|
int32_t WelsVsnprintf (str_t* pBuffer, int32_t iSizeOfBuffer, const str_t* kpFormat, va_list pArgPtr) {
|
|
return vsnprintf_s (pBuffer, iSizeOfBuffer, _TRUNCATE, kpFormat, pArgPtr);
|
|
}
|
|
|
|
WelsFileHandle* WelsFopen (const str_t* kpFilename, const str_t* kpMode) {
|
|
WelsFileHandle* pFp = NULL;
|
|
if (fopen_s (&pFp, kpFilename, kpMode) != 0) {
|
|
return NULL;
|
|
}
|
|
|
|
return pFp;
|
|
}
|
|
|
|
int32_t WelsFclose (WelsFileHandle* pFp) {
|
|
return fclose (pFp);
|
|
}
|
|
|
|
int32_t WelsGetTimeOfDay (SWelsTime* pTp) {
|
|
return _ftime_s (pTp);
|
|
}
|
|
|
|
int32_t WelsStrftime (str_t* pBuffer, int32_t iSize, const str_t* kpFormat, const SWelsTime* kpTp) {
|
|
struct tm sTimeNow;
|
|
int32_t iRc;
|
|
|
|
localtime_s (&sTimeNow, &kpTp->time);
|
|
|
|
iRc = strftime (pBuffer, iSize, kpFormat, &sTimeNow);
|
|
if (iRc == 0)
|
|
pBuffer[0] = '\0';
|
|
return iRc;
|
|
}
|
|
|
|
#else
|
|
|
|
int32_t WelsSnprintf (str_t* pBuffer, int32_t iSizeOfBuffer, const str_t* kpFormat, ...) {
|
|
va_list pArgPtr;
|
|
int32_t iRc;
|
|
|
|
va_start (pArgPtr, kpFormat);
|
|
|
|
iRc = vsnprintf (pBuffer, iSizeOfBuffer, kpFormat, pArgPtr); //confirmed_safe_unsafe_usage
|
|
if (iRc < 0)
|
|
pBuffer[iSizeOfBuffer - 1] = '\0';
|
|
|
|
va_end (pArgPtr);
|
|
|
|
return iRc;
|
|
}
|
|
|
|
str_t* WelsStrncpy (str_t* pDest, int32_t iSizeInBytes, const str_t* kpSrc) {
|
|
strncpy (pDest, kpSrc, iSizeInBytes); //confirmed_safe_unsafe_usage
|
|
pDest[iSizeInBytes - 1] = '\0';
|
|
|
|
return pDest;
|
|
}
|
|
|
|
int32_t WelsVsnprintf (str_t* pBuffer, int32_t iSizeOfBuffer, const str_t* kpFormat, va_list pArgPtr) {
|
|
int32_t iRc = vsnprintf (pBuffer, iSizeOfBuffer, kpFormat, pArgPtr); //confirmed_safe_unsafe_usage
|
|
if (iRc < 0)
|
|
pBuffer[iSizeOfBuffer - 1] = '\0';
|
|
return iRc;
|
|
}
|
|
|
|
|
|
WelsFileHandle* WelsFopen (const str_t* kpFilename, const str_t* kpMode) {
|
|
return fopen (kpFilename, kpMode);
|
|
}
|
|
|
|
int32_t WelsFclose (WelsFileHandle* pFp) {
|
|
return fclose (pFp);
|
|
}
|
|
|
|
int32_t WelsGetTimeOfDay (SWelsTime* pTp) {
|
|
_ftime (pTp);
|
|
return 0;
|
|
}
|
|
|
|
int32_t WelsStrftime (str_t* pBuffer, int32_t iSize, const str_t* kpFormat, const SWelsTime* kpTp) {
|
|
struct tm* pTnow;
|
|
int32_t iRc;
|
|
|
|
pTnow = localtime (&kpTp->time);
|
|
|
|
iRc = strftime (pBuffer, iSize, kpFormat, pTnow);
|
|
if (iRc == 0)
|
|
pBuffer[0] = '\0';
|
|
return iRc;
|
|
}
|
|
|
|
|
|
#endif // _MSC_VER
|
|
|
|
#else //GCC
|
|
|
|
int32_t WelsSnprintf (str_t* pBuffer, int32_t iSizeOfBuffer, const str_t* kpFormat, ...) {
|
|
va_list pArgPtr;
|
|
int32_t iRc;
|
|
|
|
va_start (pArgPtr, kpFormat);
|
|
|
|
iRc = vsnprintf (pBuffer, iSizeOfBuffer, kpFormat, pArgPtr);
|
|
|
|
va_end (pArgPtr);
|
|
|
|
return iRc;
|
|
}
|
|
|
|
str_t* WelsStrncpy (str_t* pDest, int32_t iSizeInBytes, const str_t* kpSrc) {
|
|
strncpy (pDest, kpSrc, iSizeInBytes); //confirmed_safe_unsafe_usage
|
|
pDest[iSizeInBytes - 1] = '\0';
|
|
return pDest;
|
|
}
|
|
|
|
int32_t WelsVsnprintf (str_t* pBuffer, int32_t iSizeOfBuffer, const str_t* kpFormat, va_list pArgPtr) {
|
|
return vsnprintf (pBuffer, iSizeOfBuffer, kpFormat, pArgPtr); //confirmed_safe_unsafe_usage
|
|
}
|
|
|
|
WelsFileHandle* WelsFopen (const str_t* kpFilename, const str_t* kpMode) {
|
|
return fopen (kpFilename, kpMode);
|
|
}
|
|
|
|
int32_t WelsFclose (WelsFileHandle* pFp) {
|
|
return fclose (pFp);
|
|
}
|
|
|
|
int32_t WelsGetTimeOfDay (SWelsTime* pTp) {
|
|
struct timeval sTv;
|
|
|
|
if (gettimeofday (&sTv, NULL)) {
|
|
return -1;
|
|
}
|
|
|
|
pTp->time = sTv.tv_sec;
|
|
pTp->millitm = (uint16_t)sTv.tv_usec / 1000;
|
|
|
|
return 0;
|
|
}
|
|
|
|
int32_t WelsStrftime (str_t* pBuffer, int32_t iSize, const str_t* kpFormat, const SWelsTime* kpTp) {
|
|
struct tm* pTnow;
|
|
int32_t iRc;
|
|
|
|
pTnow = localtime (&kpTp->time);
|
|
|
|
iRc = strftime (pBuffer, iSize, kpFormat, pTnow);
|
|
if (iRc == 0)
|
|
pBuffer[0] = '\0';
|
|
return iRc;
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
str_t* WelsStrcat (str_t* pDest, int32_t iSizeInBytes, const str_t* kpSrc) {
|
|
int32_t iCurLen = strlen(pDest);
|
|
return WelsStrncpy(pDest + iCurLen, iSizeInBytes - iCurLen, kpSrc);
|
|
}
|
|
|
|
int32_t WelsFwrite (const void_t* kpBuffer, int32_t iSize, int32_t iCount, WelsFileHandle* pFp) {
|
|
return fwrite (kpBuffer, iSize, iCount, pFp);
|
|
}
|
|
|
|
uint16_t WelsGetMillisecond (const SWelsTime* kpTp) {
|
|
return kpTp->millitm;
|
|
}
|
|
|
|
int32_t WelsFseek (WelsFileHandle* fp, int32_t offset, int32_t origin) {
|
|
return fseek(fp, offset, origin);
|
|
}
|
|
|
|
int32_t WelsFflush (WelsFileHandle* pFp) {
|
|
return fflush (pFp);
|
|
}
|