UT_WorkBuffer Class Reference

#include <UT_WorkBuffer.h>

List of all members.

Public Member Functions

UT_WorkBuffer ()

~UT_WorkBuffer ()

const char * buffer () const

char * lock (int offset=0, size_t reserve_bytes=0)

void release (int recomputeLength=0)

void releaseSetLength (int new_length)

int getAllocatedSize () const

void reserve (size_t bytes=0)

char operator() (int idx) const

int isNullTerminated () const

void strcpy (const char *src)

void strcpy (const UT_WorkBuffer &src)

void strncpy (const char *src, int maxlen)

int strlen () const

int length () const

void strcat (const char *src)

void protectedStrcat (const char *str, bool force_quote=false)

void fullyProtectedStrcat (const char *str, bool force_quote=false)

void fullyProtectedBinaryStrcat (const char *str, int size, bool force_quote=false)

void strncat (const char *src, int len)

void strcatFirstWord (const char *src)

int strcmp (const char *src) const

int strncmp (const char *src, int n) const

char * strdup () const

void clear ()

void write (int offset, char c)

void write (int offset, const char *src)

bool getline (istream &is)

bool getline (FILE *fp)

bool cmdGetLine (istream &is, UT_WorkArgs &args, int &line_num, const char *comment_chars="#", const char *separators=" \t\n\r")

bool cmdGetLine (UT_IStream &is, UT_WorkArgs &args, int &line_num, const char *comment_chars="#", const char *separators=" \t\n\r")

bool cmdGetLine (FILE *fp, UT_WorkArgs &args, int &line_num, const char *comment_chars="#", const char *separators=" \t\n\r")

int sprintf (const char *fmt,...) SYS_PRINTF_CHECK_ATTRIBUTE(2

int int appendSprintf (const char *fmt,...) SYS_PRINTF_CHECK_ATTRIBUTE(2

int int int vsprintf (const char *fmt, va_list ap)

void append (char character)

void append (const char *data, int size)

void append (const char *str)

void append (const UT_String &str)

void append (const UT_WorkBuffer &wb)

void prepend (char character)

void prepend (const char *data, int size)

void prepend (const char *str)

void prepend (const UT_String &str)

void rewind ()

void backup (int by_length)

void backupTo (char c)

void advance (int by_length)

const char * findChar (char c, int occurance_number=1) const

bool getNextToken (const char *(&string), const UT_String separators=" \t\n")

void copyIntoString (UT_String &str)

void copyIntoString (char *str, int max_length)

std::string toStdString () const

bool stripComments (char comment_char= '#')

void removeTrailingSpaceLines ()

void lower ()

Convert string to lower case.

void upper ()

Convert string to upper case.

void makeIndentString (int indent, int tabstop=8)

Create a string of tabs & spaces which represents the given indent.

Friends

UT_API ostream & operator<< (ostream &os, const UT_WorkBuffer &buffer)

Detailed Description

Examples:: COP2/COP2_PixelAdd.C, ROP/ROP_Dumper.C, SIM/SNOW_Solver.C, SOP/SOP_CustomBrush.C, SOP/SOP_IKSample.C, SOP/SOP_PrimVOP.C, SOP/SOP_PrimVOP.h, standalone/dsmprint.C, standalone/geo2voxel.C, and VOP/VOP_CustomContext.C.

Definition at line 55 of file UT_WorkBuffer.h.

Constructor & Destructor Documentation

UT_WorkBuffer::UT_WorkBuffer ( )

UT_WorkBuffer::~UT_WorkBuffer ( )

Member Function Documentation

void UT_WorkBuffer::advance ( int by_length ) [inline]

Definition at line 373 of file UT_WorkBuffer.h.

void UT_WorkBuffer::append ( const UT_WorkBuffer & wb ) [inline]

Definition at line 314 of file UT_WorkBuffer.h.

void UT_WorkBuffer::append ( const UT_String & str ) [inline]

Definition at line 308 of file UT_WorkBuffer.h.

void UT_WorkBuffer::append ( const char * str ) [inline]

Definition at line 302 of file UT_WorkBuffer.h.

void UT_WorkBuffer::append	(	const char *	data,
		int	size
	)			`[inline]`

Definition at line 291 of file UT_WorkBuffer.h.

void UT_WorkBuffer::append ( char character ) [inline]

Definition at line 281 of file UT_WorkBuffer.h.

int int UT_WorkBuffer::appendSprintf	(	const char *	fmt,
			...
	)

void UT_WorkBuffer::backup ( int by_length ) [inline]

Definition at line 352 of file UT_WorkBuffer.h.

void UT_WorkBuffer::backupTo ( char c ) [inline]

Definition at line 364 of file UT_WorkBuffer.h.

const char* UT_WorkBuffer::buffer ( ) const [inline]

Examples:: COP2/COP2_PixelAdd.C, ROP/ROP_Dumper.C, SIM/SNOW_Solver.C, SOP/SOP_CustomBrush.C, SOP/SOP_IKSample.C, standalone/dsmprint.C, standalone/geo2voxel.C, and VOP/VOP_CustomContext.C.

Definition at line 64 of file UT_WorkBuffer.h.

void UT_WorkBuffer::clear ( void ) [inline]

Definition at line 214 of file UT_WorkBuffer.h.

bool UT_WorkBuffer::cmdGetLine	(	FILE *	fp,
		UT_WorkArgs &	args,
		int &	line_num,
		const char *	comment_chars = `"#"`,
		const char *	separators = `" \t\n\r"`
	)

bool UT_WorkBuffer::cmdGetLine	(	UT_IStream &	is,
		UT_WorkArgs &	args,
		int &	line_num,
		const char *	comment_chars = `"#"`,
		const char *	separators = `" \t\n\r"`
	)

bool UT_WorkBuffer::cmdGetLine	(	istream &	is,
		UT_WorkArgs &	args,
		int &	line_num,
		const char *	comment_chars = `"#"`,
		const char *	separators = `" \t\n\r"`
	)

void UT_WorkBuffer::copyIntoString	(	char *	str,
		int	max_length
	)

void UT_WorkBuffer::copyIntoString ( UT_String & str )

const char* UT_WorkBuffer::findChar	(	char	c,
		int	occurance_number = `1`
	)			const `[inline]`

Definition at line 385 of file UT_WorkBuffer.h.

void UT_WorkBuffer::fullyProtectedBinaryStrcat	(	const char *	str,
		int	size,
		bool	force_quote = `false`
	)

void UT_WorkBuffer::fullyProtectedStrcat	(	const char *	str,
		bool	force_quote = `false`
	)

int UT_WorkBuffer::getAllocatedSize ( ) const [inline]

Definition at line 87 of file UT_WorkBuffer.h.

bool UT_WorkBuffer::getline ( FILE * fp )

bool UT_WorkBuffer::getline ( istream & is )

bool UT_WorkBuffer::getNextToken	(	const char *&	string,
		const UT_String	separators = `" \t\n"`
	)

int UT_WorkBuffer::isNullTerminated ( ) const

int UT_WorkBuffer::length ( void ) const [inline]

Examples:: SIM/SNOW_Solver.C.

Definition at line 152 of file UT_WorkBuffer.h.

char* UT_WorkBuffer::lock	(	int	offset = `0`,
		size_t	reserve_bytes = `0`
	)

Examples:: SIM/SNOW_Solver.C.

void UT_WorkBuffer::lower ( )

Convert string to lower case.

void UT_WorkBuffer::makeIndentString	(	int	indent,
		int	tabstop = `8`
	)

Create a string of tabs & spaces which represents the given indent.

char UT_WorkBuffer::operator() ( int idx ) const [inline]

Definition at line 95 of file UT_WorkBuffer.h.

void UT_WorkBuffer::prepend ( const UT_String & str ) [inline]

Definition at line 344 of file UT_WorkBuffer.h.

void UT_WorkBuffer::prepend ( const char * str ) [inline]

Definition at line 338 of file UT_WorkBuffer.h.

void UT_WorkBuffer::prepend	(	const char *	data,
		int	size
	)			`[inline]`

Definition at line 328 of file UT_WorkBuffer.h.

void UT_WorkBuffer::prepend ( char character ) [inline]

Definition at line 319 of file UT_WorkBuffer.h.

void UT_WorkBuffer::protectedStrcat	(	const char *	str,
		bool	force_quote = `false`
	)

void UT_WorkBuffer::release ( int recomputeLength = 0 )

Examples:: SIM/SNOW_Solver.C.

void UT_WorkBuffer::releaseSetLength ( int new_length )

void UT_WorkBuffer::removeTrailingSpaceLines ( )

void UT_WorkBuffer::reserve ( size_t bytes = 0 )

void UT_WorkBuffer::rewind ( ) [inline]

Definition at line 350 of file UT_WorkBuffer.h.

int UT_WorkBuffer::sprintf	(	const char *	fmt,
			...
	)

Examples:: COP2/COP2_PixelAdd.C, ROP/ROP_Dumper.C, SOP/SOP_CustomBrush.C, SOP/SOP_IKSample.C, standalone/geo2voxel.C, and VOP/VOP_CustomContext.C.

void UT_WorkBuffer::strcat ( const char * src ) [inline]

Definition at line 157 of file UT_WorkBuffer.h.

void UT_WorkBuffer::strcatFirstWord ( const char * src )

int UT_WorkBuffer::strcmp ( const char * src ) const [inline]

Definition at line 195 of file UT_WorkBuffer.h.

void UT_WorkBuffer::strcpy ( const UT_WorkBuffer & src ) [inline]

Definition at line 126 of file UT_WorkBuffer.h.

void UT_WorkBuffer::strcpy ( const char * src ) [inline]

Examples:: standalone/dsmprint.C, and VOP/VOP_CustomContext.C.

Definition at line 121 of file UT_WorkBuffer.h.

char* UT_WorkBuffer::strdup ( ) const [inline]

Definition at line 207 of file UT_WorkBuffer.h.

bool UT_WorkBuffer::stripComments ( char comment_char = '#' )

int UT_WorkBuffer::strlen ( ) const [inline]

Definition at line 146 of file UT_WorkBuffer.h.

void UT_WorkBuffer::strncat	(	const char *	src,
		int	len
	)			`[inline]`

Definition at line 179 of file UT_WorkBuffer.h.

int UT_WorkBuffer::strncmp	(	const char *	src,
		int	n
	)			const `[inline]`

Definition at line 201 of file UT_WorkBuffer.h.

void UT_WorkBuffer::strncpy	(	const char *	src,
		int	maxlen
	)			`[inline]`

Definition at line 132 of file UT_WorkBuffer.h.

std::string UT_WorkBuffer::toStdString ( ) const [inline]

Definition at line 416 of file UT_WorkBuffer.h.

void UT_WorkBuffer::upper ( )

Convert string to upper case.

int int int UT_WorkBuffer::vsprintf	(	const char *	fmt,
		va_list	ap
	)

void UT_WorkBuffer::write	(	int	offset,
		const char *	src
	)			`[inline]`

Definition at line 242 of file UT_WorkBuffer.h.

void UT_WorkBuffer::write	(	int	offset,
		char	c
	)			`[inline]`

Definition at line 224 of file UT_WorkBuffer.h.

Friends And Related Function Documentation

UT_API ostream& operator<<	(	ostream &	os,
		const UT_WorkBuffer &	buffer
	)			`[friend]`

The documentation for this class was generated from the following file:

UT/UT_WorkBuffer.h


Public Member Functions
	UT_WorkBuffer ()
	~UT_WorkBuffer ()
const char *	buffer () const
char *	lock (int offset=0, size_t reserve_bytes=0)
void	release (int recomputeLength=0)
void	releaseSetLength (int new_length)
int	getAllocatedSize () const
void	reserve (size_t bytes=0)
char	operator() (int idx) const
int	isNullTerminated () const
void	strcpy (const char *src)
void	strcpy (const UT_WorkBuffer &src)
void	strncpy (const char *src, int maxlen)
int	strlen () const
int	length () const
void	strcat (const char *src)
void	protectedStrcat (const char *str, bool force_quote=false)
void	fullyProtectedStrcat (const char *str, bool force_quote=false)
void	fullyProtectedBinaryStrcat (const char *str, int size, bool force_quote=false)
void	strncat (const char *src, int len)
void	strcatFirstWord (const char *src)
int	strcmp (const char *src) const
int	strncmp (const char *src, int n) const
char *	strdup () const
void	clear ()
void	write (int offset, char c)
void	write (int offset, const char *src)
bool	getline (istream &is)
bool	getline (FILE *fp)
bool	cmdGetLine (istream &is, UT_WorkArgs &args, int &line_num, const char comment_chars="#", const char separators=" \t\n\r")
bool	cmdGetLine (UT_IStream &is, UT_WorkArgs &args, int &line_num, const char comment_chars="#", const char separators=" \t\n\r")
bool	cmdGetLine (FILE fp, UT_WorkArgs &args, int &line_num, const char comment_chars="#", const char *separators=" \t\n\r")
int	sprintf (const char *fmt,...) SYS_PRINTF_CHECK_ATTRIBUTE(2
int int	appendSprintf (const char *fmt,...) SYS_PRINTF_CHECK_ATTRIBUTE(2
int int int	vsprintf (const char *fmt, va_list ap)
void	append (char character)
void	append (const char *data, int size)
void	append (const char *str)
void	append (const UT_String &str)
void	append (const UT_WorkBuffer &wb)
void	prepend (char character)
void	prepend (const char *data, int size)
void	prepend (const char *str)
void	prepend (const UT_String &str)
void	rewind ()
void	backup (int by_length)
void	backupTo (char c)
void	advance (int by_length)
const char *	findChar (char c, int occurance_number=1) const
bool	getNextToken (const char *(&string), const UT_String separators=" \t\n")
void	copyIntoString (UT_String &str)
void	copyIntoString (char *str, int max_length)
std::string	toStdString () const
bool	stripComments (char comment_char= '#')
void	removeTrailingSpaceLines ()
void	lower ()
	Convert string to lower case.
void	upper ()
	Convert string to upper case.
void	makeIndentString (int indent, int tabstop=8)
	Create a string of tabs & spaces which represents the given indent.
Friends
UT_API ostream &	operator<< (ostream &os, const UT_WorkBuffer &buffer)