lString_p.h File Reference

Definitions for linked list of strings routines. More...

#include <PBS/L.h>
#include <stdarg.h>
#include <stdlib.h>

Classes
struct	lString
	Node for a (singly) linked list of strings. More...
Functions
lString *	newlString (const char *fmt,...)
	Create a lString from fmt and the subsequent arguments.
char *	newString (const char *fmt,...)
	Create a string from fmt and the subsequent arguments.
size_t	getStrLen (const char *fmt, va_list ap)
	Reads the format string and calculates the total size of the string after completing the insertions.
void	copyStr (char *dest, const char *fmt, va_list ap)
	Read the format string and fill dest accordingly.
lString *	appendString (lString *os, const char *fmt,...)
	Combine an existing lString and additional elements into a new string.

---

Detailed Description

Definitions for linked list of strings routines.

Author:

James Swain & Owen Saxton

$Id: lString_p.h,v 1.3 2011/03/27 06:15:54 saxton Exp $

---

Function Documentation

lString* appendString	(	lString *	os,
		const char *	fmt,
			...
	)

Combine an existing lString and additional elements into a new string.

Parameters:

	os	Old string to append to
	fmt	Format of the additional string

Returns:

A new string which is the concaternation of the old string and the additional elements

References copyStr(), getStrLen(), and lString::string.

Referenced by ecpt_fileMapDTD(), ecpt_fileXMLDTD(), and ereg_fileXMLDTD().

void copyStr	(	char *	dest,
		const char *	fmt,
		va_list	ap
	)

Read the format string and fill dest accordingly.

Parameters:

	dest	Destination string
	fmt	Format string
	ap	Variable length list of arguments

Referenced by appendString(), newlString(), and newString().

size_t getStrLen	(	const char *	fmt,
		va_list	ap
	)

Reads the format string and calculates the total size of the string after completing the insertions.

Parameters:

	fmt	Format string
	ap	Variable length list of arguments

Returns:

Size of the complete string

Referenced by appendString(), newlString(), and newString().

lString* newlString	(	const char *	fmt,
			...
	)

Create a lString from fmt and the subsequent arguments.

Parameters:

fmt

Format of the string to create

Returns:

Ptr to initialised lString

References copyStr(), getStrLen(), and lString::string.

Referenced by ecpt_cptDetail(), ecpt_fileMapDTD(), ecpt_fileMapTags(), ecpt_fileXMLDTD(), ecpt_fileXMLTags(), ereg_cptDetail(), ereg_fileXMLDTD(), ereg_fileXMLTags(), init_fileAddr(), init_fileDescription(), init_fileFldEnum(), init_fileMapTags(), init_fileNumber(), init_fileNumEnum(), init_fileRegEnum(), init_fileRimType(), init_fileTree_h(), init_fileTypeEnum(), init_fileXMLTags(), scpt_cptDetail(), scpt_fileDescription(), scpt_fileMapDTD(), scpt_fileXMLDTD(), sfld_fileXMLDTD(), sfld_fileXMLTags(), sreg_cptDetail(), sreg_fileXMLDTD(), and sreg_fileXMLTags().

char* newString	(	const char *	fmt,
			...
	)

Create a string from fmt and the subsequent arguments.

Parameters:

fmt

Format of the string to create

Returns:

Ptr to initialised string

References copyStr(), and getStrLen().

Referenced by scpt_cptDetail().