Memory allocation and deallocation declarations. More...

#include "rnr/rnrconfig.h"
#include <sys/types.h>
#include <stdlib.h>
#include <stdarg.h>

Macros
#define	NEW(T) (T *)new(sizeof(T))
	Allocate new type. More...

#define	NEWSTR(len) (char )new( sizeof(char)((size_t)((len)+1)) )
	Allocate new string buffer of length len+1. More...

Functions
INLINE_IN_H void	delete (void *p)
	delete() "operator" More...

void *	new (size_t size)
	new() "operator" More...

void *	new_overs (void *pSrc, size_t sizeDup, size_t sizeNew)
	Allocate and duplicate. More...

void *	new_memdup (size_t size, void *data)
	Duplicate data. More...

char *	new_strdup (const char *s)
	Duplicate a string. More...

char *	new_strndup (const char *s, size_t n)
	Duplicate not more than n characters of string. More...

char *	strcpy_s (char dest, size_t n, const char src)
	Copy source string to destinations string. At most n bytes will be copied. The destination string is guaranteed to be null terminated. More...

int	sprintf_s (char str, size_t n, const char format,...)
	Format print to string up to n-1 characters. String is guaranteed to be null terminated. More...

Detailed Description

Memory allocation and deallocation declarations.

General purpose dynamic memory allocate and deallocate declarations and defines. None of the calls will fail, unless fatally for the entire program. Modeled on C++ new() and delete() operators.

Package: RoadNarrows Robotics Common Library 1

Library: librnr

File: rnr/new.h

Author: Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright: © 2005-2018. RoadNarrows LLC..
http://www.roadnarrows.com
All Rights Reserved

License: MIT

EULA: See the README and EULA files for any copyright and licensing information.

—

Definition in file new.h.

Macro Definition Documentation

#define NEW ( T ) (T *)new(sizeof(T))

Allocate new type.

Parameters

T	Data type.

Returns: Pointer T* to allocated memory

Exceptions

Bad Allocation Program is terminated with exit code EC_ERROR.

Definition at line 49 of file new.h.

Referenced by AddNewBody(), ConfigDbIterNew(), ConfigDbNew(), ConfigSectionIterNew(), ConfigSectionNew(), DListVoidAppend(), DListVoidInsert(), DListVoidNew(), DListVoidPrepend(), hash_table_create(), hnode_create(), NewZooAnimal(), OptsNew(), SearchPathIterNew(), SimpleBufNew(), SimpleBufNewWithBuf(), SocketNew(), SockSetNew(), and UriParseNew().

#define NEWSTR ( len ) (char *)new( sizeof(char)*((size_t)((len)+1)) )

Allocate new string buffer of length len+1.

Parameters

len	Length of string buffer less null-termination character.

Returns: Returns char * to allocated, zero'ed out memory.

Exceptions

Bad Allocation Program is terminated with exit code EC_ERROR.

Definition at line 64 of file new.h.

Referenced by new_strdup(), new_strndup(), NewJoinedPath(), NewNormPath(), NewPrettyBuf(), NewSearchPathCanonicalized(), NewSearchPathExpanded(), SearchPathIterFirst(), SearchPathIterNext(), SocketAddrNameInet(), SocketAddrNameUnix(), SocketThisHostName(), and UriStrNew().

Function Documentation

INLINE_IN_H void delete ( void * p )

delete() "operator"

Frees previously allocated memory. NULL pointer produce no action.

Parameters

p	Pointer to memory.

Definition at line 77 of file new.h.

References C_DECLS_BEGIN, C_DECLS_END, new_memdup(), new_overs(), new_strdup(), new_strndup(), NULL, sprintf_s(), and strcpy_s().

 {
   if( p != NULL )
   {
     free(p);
   }
 }

void* new ( size_t size )

new() "operator"

Dynamic memory allocator. All allocated data are zero'ed (i.e. set to 0).

Parameters

size	Number of bytes.

Returns: Return void * to newly allocated memory. Memory is zero'ed.

Exceptions

Bad Allocation Program is terminated with exit code EC_ERROR.

Definition at line 73 of file new.c.

References EC_ERROR, and NULL.

 {
   void  *p;
 
   if( size == 0 )
   {
     size = 1;
   }
 
   if( (p = malloc(size)) == NULL )
   {
     fprintf(stderr, "new(): malloc() failed\n");
     exit(EC_ERROR);
   }
   memset(p, 0, size);
   return p;
 }

void* new_memdup	(	size_t	size,
		void *	data
	)

Duplicate data.

Parameters

size	Number of bytes.
data	Data to duplicate

Returns: Return pointer to duplicated memory.

Exceptions

Bad Allocation Program is terminated with exit code EC_ERROR.

Note: If size is zero or data is NULL, one byte is allocated.

Definition at line 146 of file new.c.

References NULL.

Referenced by delete().

 {
   void *p;
 
   if( (size == 0) || (data == NULL) )
   {
     p = (void *)new((size_t)1);
     memset(p, 0, (size_t)1);
   }
   else
   {
     p = new(size);
     memcpy(p, data, size);
   }
   return p;
 }

void* new_overs	(	void *	pSrc,
		size_t	sizeDup,
		size_t	sizeNew
	)

Allocate and duplicate.

A new block a memory of sizeNew bytes is allocated. sizeDup bytes from the source data are copied to the new block. All allocated, but not duplicated data are zero'ed (i.e. set to 0).

Note: The actual size of source block is assumed to be >= sizeDup.

Parameters

pSrc	Source memory block to duplicate.
sizeDup	Number of bytes to duplicate, with sizeDup <= sizeNew.
sizeNew	Number of bytes for new block.

Returns: Return void * to newly allocated and duplicated memory.

Exceptions

Bad Allocation	Program is terminated with exit code EC_ERROR.
Bad Sizes	Program is terminated with exit code EC_ERROR.

Definition at line 112 of file new.c.

References EC_ERROR.

Referenced by delete(), grow_table(), and shrink_table().

 {
   void  *pNew;
   
   if( sizeDup > sizeNew )
   {
     fprintf(stderr, "new_overs(): duplicate size %lu > allocated size %lu\n",
         (unsigned long)sizeDup, (unsigned long)sizeNew);
     exit(EC_ERROR);
   }
 
   pNew = new(sizeNew);
 
   if( sizeDup > 0 )
   {
     memcpy(pNew, pSrc, sizeDup);
   }
 
   return pNew;
 }

char* new_strdup ( const char * s )

Duplicate a string.

Parameters

s	Null terminated string to duplicate.

Returns: Return pointer to duplicated string.

Exceptions

Bad Allocation Program is terminated with exit code EC_ERROR.

Note: Guaranteed to return a null terminated string. If string is NULL, one byte is allocated (== 0).

Definition at line 176 of file new.c.

References NEWSTR, and NULL.

Referenced by ConfigDbNew(), ConfigDbSetName(), ConfigSectionAddPair(), ConfigSectionNew(), delete(), force_grow(), LOG_ATTACH_LOGFP(), LOG_SET_LOGFILE(), LOGGER(), LOGGER_CALL(), main(), NewExpandTilde(), NewNormPath(), NewZooAnimal(), OptsCvtArgStr(), SocketAddrName(), SocketAttrSetLocalName(), SocketAttrSetRemoteName(), SocketThisHostName(), test_hash(), UriParseNew(), UriSetHostName(), UriSetPath(), and UriSetScheme().

 {
   char *t;
 
   if( (s != NULL) && (*s != 0) )
   {
     t = NEWSTR(strlen(s));
     strcpy(t, s);
   }
   else
   {
     t = NEWSTR(1);
     t[0] = 0;
   }
   return t;
 }

char* new_strndup	(	const char *	s,
		size_t	n
	)

Duplicate not more than n characters of string.

Duplicate the first n characters of string or until a null character is encounter, whichever comes first. Guaranteed to return a null terminated string.

Parameters

s	String to duplicate.
n	Maximum number of characters to duplicate.

Exceptions

Bad Allocation Program is terminated with exit code EC_ERROR.

Returns: Return pointer to duplicated string.

Definition at line 208 of file new.c.

References NEWSTR, and NULL.

Referenced by delete(), NewSearchPathExpanded(), UriParseHostNew(), and UriParseNew().

 {
   char *t;
 
   if( (s != NULL) && (*s != 0) && (n > 0) )
   {
     t = NEWSTR(n+1);
     strncpy(t, s, n);
     t[n] = 0;
   }
   else
   {
     t = NEWSTR(1);
     t[0] = 0;
   }
   return t;
 }

int sprintf_s	(	char *	str,
		size_t	n,
		const char *	format,
			...
	)

Format print to string up to n-1 characters. String is guaranteed to be null terminated.

Parameters

str	Destination string buffer.
n	Size of string buffer.
format	Standard printf formatting string.
...	Variable argument list.

Returns: Number of characters printed.

Definition at line 83 of file win.c.

Referenced by delete().

 {
   va_list ap;
   int     nPrinted;
 
   va_start(ap, format);
   nPrinted = vsnprintf(str, (size_t)n, format, ap);
   va_end(ap);
   str[n-1] = 0;
   return nPrinted;
 }

char* strcpy_s	(	char *	dest,
		size_t	n,
		const char *	src
	)

Copy source string to destinations string. At most n bytes will be copied. The destination string is guaranteed to be null terminated.

Parameters

dest	Pointer to destination string.
n	Maximum number of bytes to copy.
src	Pointer to source string.

Returns: Return pointer to destination string.

Definition at line 65 of file win.c.

Referenced by delete().

 {
   strncpy(dest, src, (size_t)n);
   dest[n-1] = 0;
   return dest;
 }

Macros

Functions

Detailed Description

Macro Definition Documentation

Function Documentation