#include <UT_WorkBuffer.h>

Classes
class	AutoLock

Public Types
typedef char	value_type

Public Member Functions
SYS_FORCE_INLINE	UT_WorkBuffer ()

SYS_FORCE_INLINE	UT_WorkBuffer (const char *str)

SYS_FORCE_INLINE	UT_WorkBuffer (const char *data, exint size)

SYS_FORCE_INLINE	UT_WorkBuffer (const UT_String &str)

SYS_FORCE_INLINE	UT_WorkBuffer (const UT_StringRef &str)

SYS_FORCE_INLINE	UT_WorkBuffer (const UT_WorkBuffer &other)

SYS_FORCE_INLINE	~UT_WorkBuffer ()

SYS_FORCE_INLINE const char *	buffer () const

SYS_FORCE_INLINE const char *	data () const

char *	lock (exint offset=0, exint reserve_bytes=0)

void	release (bool recompute_length=false)

void	releaseSetLength (exint new_length)

SYS_FORCE_INLINE exint	getAllocatedSize () const

int64	getMemoryUsage (bool inclusive) const

void	reserve (exint bytes=0)

SYS_FORCE_INLINE char	operator() (exint idx) const

SYS_FORCE_INLINE char	first () const

SYS_FORCE_INLINE char	last () const

int	isNullTerminated () const

SYS_FORCE_INLINE UT_WorkBuffer &	operator= (const UT_WorkBuffer &other)

SYS_FORCE_INLINE UT_WorkBuffer &	operator= (const char *str)

SYS_FORCE_INLINE UT_WorkBuffer &	operator= (const std::string &str)

SYS_FORCE_INLINE void	strcpy (const char *src)

SYS_FORCE_INLINE void	strcpy (const UT_String &src)

SYS_FORCE_INLINE void	strcpy (const UT_StringRef &src)

SYS_FORCE_INLINE void	strcpy (const UT_WorkBuffer &src)

SYS_FORCE_INLINE void	strncpy (const char *src, exint maxlen)

SYS_FORCE_INLINE exint	strlen () const

SYS_FORCE_INLINE exint	length () const

SYS_FORCE_INLINE 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, exint size, bool force_quote=false)

SYS_FORCE_INLINE void	strncat (const char *src, exint len)

void	strcatFirstWord (const char *src)

SYS_FORCE_INLINE int	strcmp (const char *src) const

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

SYS_FORCE_INLINE char *	strdup () const

SYS_FORCE_INLINE void	clear ()

SYS_FORCE_INLINE bool	isEmpty () const

SYS_FORCE_INLINE bool	isstring () const

SYS_FORCE_INLINE void	write (exint offset, char c)

void	write (exint offset, const char *src)

void	write (exint offset, const UT_StringHolder &src)

bool	readFile (const char *filename)

bool	getline (std::istream &is)

bool	getline (FILE *fp)

bool	cmdGetLine (std::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)

template<typename... Args>
size_t	format (const char *fmt, const Args &...args)

template<typename... Args>
size_t	appendFormat (const char *fmt, const Args &...args)

template<typename... Args>
size_t	print (const Args &...args)

template<typename... Args>
size_t	appendPrint ()

template<typename T , typename... Args>
size_t	appendPrint (const T &value, const Args &...args)

SYS_FORCE_INLINE void	append (char character)

void	printMemory (int64 mem)

void	appendPrintMemory (int64 mem)

void	append (exint n, char character)

void	append (utf32 cp)
	Append a single Unicode code point, converted to UTF8. More...

void	append (const char *data, exint size)

SYS_FORCE_INLINE void	append (const char *str)

SYS_FORCE_INLINE void	append (const UT_String &str)

SYS_FORCE_INLINE void	append (const UT_StringRef &str)

void	append (const UT_StringArray &strs, const UT_StringRef &sep)

SYS_FORCE_INLINE void	append (const UT_WorkBuffer &wb)

SYS_FORCE_INLINE UT_WorkBuffer &	operator+= (const char *str)

SYS_FORCE_INLINE UT_WorkBuffer &	operator+= (const std::string &str)

SYS_FORCE_INLINE UT_WorkBuffer &	operator+= (const UT_WorkBuffer &wb)

SYS_FORCE_INLINE UT_WorkBuffer &	operator+= (const UT_String &str)

SYS_FORCE_INLINE UT_WorkBuffer &	operator+= (const UT_StringRef &str)

void	prepend (char character)

void	prepend (const char *data, exint size)

SYS_FORCE_INLINE void	prepend (const char *str)

SYS_FORCE_INLINE void	prepend (const UT_String &str)

SYS_FORCE_INLINE void	prepend (const UT_StringRef &str)

void	insert (exint pos, const char *str, exint slen)

void	erase (exint pos, exint len)
	Erase `len` characters from location `pos` in the string. More...

void	rewind ()

SYS_FORCE_INLINE void	backup (exint by_length)
	Rewind by the given length. More...

SYS_FORCE_INLINE void	truncate (exint new_length)

void	backupTo (char c)

void	advance (exint by_length)

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

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

const char *	findCharFrom (char c, exint position, int occurance_number=1) const

void	adoptFromMalloc (char *data, exint length)

void	adoptFromCharArray (UT_Array< char > &data)

exint	count (const char *needle) const
	Count the occurrences of the text in the current string. More...

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

void	copyIntoString (UT_String &str) const

void	copyIntoString (char *str, exint max_length) const

void	stealIntoString (UT_String &str)

void	stealIntoStringHolder (UT_StringHolder &str)

std::string	toStdString () const

bool	stripComments (char comment_char= '#')

int	strip (const char *chars)

void	removeTrailingSpaceLines ()
	Remove trailing whitespace lines. More...

bool	removeTrailingSpace ()
	Remove trailing whitespace, return true if whitespace was removed. More...

bool	removeLeadingSpace ()
	Remove leading white space, return true if whitespace was removed. More...

bool	removeTrailingDigits ()
	Remove trailing digits, return true if some were removed. More...

void	lower ()
	Convert string to lower case. More...

void	upper ()
	Convert string to upper case. More...

void	makeIndentString (exint indent, exint tabstop=8)
	Create a string of tabs & spaces which represents the given indent. More...

void	eraseHead (exint n)
	Remove the first n characters. More...

int	substitute (const char find, const char replacement, int count=-1)

int	substitute (const char find, const char replacement, bool all)
	Convenience version of substitute() for all or single occurrence. More...

bool	subPatterns (const char to_pattern, const char from_name, const char *from_pattern)

void	setFromUTF16 (const utf16 *str)
	UTF-16 / UTF-8 conversions. More...

void	setAsUTF16 (const utf8 *str)

SYS_FORCE_INLINE const utf16 *	castToUTF16 () const
	Once set as UTF16-LE, get it back as such a pointer. More...

utf16 *	lockUTF16 (exint offset=0, exint len=0)
	Lock buffer for `len` utf-16 characters. More...

void	swap (UT_WorkBuffer &other)

SYS_FORCE_INLINE const char *	begin () const
	Iterator compatibility. More...

SYS_FORCE_INLINE const char *	end () const


SYS_FORCE_INLINE bool	operator== (const char *str) const

SYS_FORCE_INLINE bool	operator== (const UT_String &str) const

SYS_FORCE_INLINE bool	operator== (const UT_StringRef &str) const

SYS_FORCE_INLINE bool	operator== (const UT_WorkBuffer &buf) const

SYS_FORCE_INLINE bool	operator!= (const char *str) const

SYS_FORCE_INLINE bool	operator!= (const UT_String &str) const

SYS_FORCE_INLINE bool	operator!= (const UT_StringRef &str) const

SYS_FORCE_INLINE bool	operator!= (const UT_WorkBuffer &buf) const


void	itoa (int64 i)

void	utoa (uint64 i)

Static Public Member Functions
static SYS_FORCE_INLINE UT_WorkBuffer	widen (const utf8 *str)

static SYS_FORCE_INLINE UT_WorkBuffer	narrow (const utf16 *str)

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

Detailed Description

Examples:: COP2/COP2_PixelAdd.C, DM/DM_OverdrawHook.C, field3d/f3d_io.C, field3d/GEO_Field3DTranslator.C, FS/FS_HomeHelper.C, GEO/GEO_VoxelTranslator.C, packedshareddata/GU_PackedSharedData.C, ROP/ROP_Dumper.C, SHOP/SHOP_POVMaterial.C, SIM/GAS_NetVDBSliceExchange.C, SIM/SIM_RadialEmit.C, SIM/SNOW_Solver.C, SOP/SOP_ArrayAttrib.C, SOP/SOP_BouncyAgent.C, SOP/SOP_CustomBrush.C, SOP/SOP_IKSample.C, standalone/dsmprint.C, standalone/geo2voxel.C, and VOP/VOP_CustomContext.C.

Definition at line 68 of file UT_WorkBuffer.h.

Member Typedef Documentation

typedef char UT_WorkBuffer::value_type

Definition at line 71 of file UT_WorkBuffer.h.

Constructor & Destructor Documentation

SYS_FORCE_INLINE UT_WorkBuffer::UT_WorkBuffer ( )

inline

Definition at line 74 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer::UT_WorkBuffer ( const char * str )

inlineexplicit

Definition at line 82 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer::UT_WorkBuffer	(	const char *	data,
		exint	size
	)

inlineexplicit

Definition at line 90 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer::UT_WorkBuffer ( const UT_String & str )

inlineexplicit

Definition at line 98 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer::UT_WorkBuffer ( const UT_StringRef & str )

inlineexplicit

Definition at line 106 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer::UT_WorkBuffer ( const UT_WorkBuffer & other )

inline

Definition at line 114 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer::~UT_WorkBuffer ( )

inline

Definition at line 122 of file UT_WorkBuffer.h.

Member Function Documentation

void UT_WorkBuffer::adoptFromCharArray ( UT_Array< char > & data )

void UT_WorkBuffer::adoptFromMalloc	(	char *	data,
		exint	length
	)

Adopt a string from an outside source. The passed string is now owned by the workbuffer.

void UT_WorkBuffer::advance ( exint by_length )

inline

Definition at line 846 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::append ( char character )

inline

Examples:: FS/FS_HomeHelper.C, and SIM/GAS_NetVDBSliceExchange.C.

Definition at line 639 of file UT_WorkBuffer.h.

void UT_WorkBuffer::append	(	exint	n,
		char	character
	)

inline

Definition at line 652 of file UT_WorkBuffer.h.

void UT_WorkBuffer::append ( utf32 cp )

inline

Append a single Unicode code point, converted to UTF8.

Definition at line 664 of file UT_WorkBuffer.h.

void UT_WorkBuffer::append	(	const char *	data,
		exint	size
	)

inline

Definition at line 679 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::append ( const char * str )

inline

Definition at line 691 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::append ( const UT_String & str )

inline

Definition at line 698 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::append ( const UT_StringRef & str )

inline

Definition at line 705 of file UT_WorkBuffer.h.

void UT_WorkBuffer::append	(	const UT_StringArray &	strs,
		const UT_StringRef &	sep
	)

inline

Definition at line 711 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::append ( const UT_WorkBuffer & wb )

inline

Definition at line 722 of file UT_WorkBuffer.h.

template<typename... Args>

size_t UT_WorkBuffer::appendFormat	(	const char *	fmt,
		const Args &...	args
	)

inline

Append to the work buffer using the same formatting as UTformat. Returns the size of the appended portion, in bytes.

Definition at line 583 of file UT_WorkBuffer.h.

template<typename... Args>

size_t UT_WorkBuffer::appendPrint ( )

inline

Append to the work buffer using the UTformat with an implicit "{} " format for each parameter. Returns the size of the appended portion, in bytes.

Definition at line 618 of file UT_WorkBuffer.h.

template<typename T , typename... Args>

size_t UT_WorkBuffer::appendPrint	(	const T &	value,
		const Args &...	args
	)

inline

Definition at line 623 of file UT_WorkBuffer.h.

void UT_WorkBuffer::appendPrintMemory ( int64 mem )

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

Examples:: SIM/GAS_NetVDBSliceExchange.C.

SYS_FORCE_INLINE void UT_WorkBuffer::backup ( exint by_length )

inline

Rewind by the given length.

Definition at line 812 of file UT_WorkBuffer.h.

void UT_WorkBuffer::backupTo ( char c )

inline

Definition at line 837 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE const char* UT_WorkBuffer::begin ( void ) const

inline

Iterator compatibility.

Definition at line 1080 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE const char* UT_WorkBuffer::buffer ( ) const

inline

Examples:: COP2/COP2_PixelAdd.C, field3d/f3d_io.C, field3d/GEO_Field3DTranslator.C, GEO/GEO_VoxelTranslator.C, ROP/ROP_Dumper.C, SIM/GAS_NetVDBSliceExchange.C, SIM/SNOW_Solver.C, SOP/SOP_ArrayAttrib.C, SOP/SOP_BlindData.C, SOP/SOP_BouncyAgent.C, SOP/SOP_CustomBrush.C, SOP/SOP_IKSample.C, standalone/dsmprint.C, standalone/geo2voxel.C, standalone/standalone.C, VOP/VOP_CustomContext.C, and VOP/VOP_Switch.C.

Definition at line 156 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE const utf16* UT_WorkBuffer::castToUTF16 ( ) const

inline

Once set as UTF16-LE, get it back as such a pointer.

Definition at line 1034 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::clear ( void )

inline

Examples:: SIM/GAS_NetVDBSliceExchange.C.

Definition at line 477 of file UT_WorkBuffer.h.

bool UT_WorkBuffer::cmdGetLine	(	std::istream &	is,
		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	(	FILE *	fp,
		UT_WorkArgs &	args,
		int &	line_num,
		const char *	comment_chars = `"#"`,
		const char *	separators = `" \t\n\r"`
	)

void UT_WorkBuffer::copyIntoString ( UT_String & str ) const

Examples:: FS/FS_HomeHelper.C.

void UT_WorkBuffer::copyIntoString	(	char *	str,
		exint	max_length
	)		const

exint UT_WorkBuffer::count ( const char * needle ) const

Count the occurrences of the text in the current string.

SYS_FORCE_INLINE const char* UT_WorkBuffer::data ( ) const

inline

Alias for the common string access across all string types (including standard library)

Definition at line 160 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE const char* UT_WorkBuffer::end ( void ) const

inline

Definition at line 1082 of file UT_WorkBuffer.h.

void UT_WorkBuffer::erase	(	exint	pos,
		exint	len
	)

Erase len characters from location pos in the string.

void UT_WorkBuffer::eraseHead ( exint n )

inline

Remove the first n characters.

Definition at line 980 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE const char* UT_WorkBuffer::findChar	(	char	c,
		int	occurance_number = `1`
	)		const

inline

Definition at line 860 of file UT_WorkBuffer.h.

const char* UT_WorkBuffer::findCharFrom	(	char	c,
		exint	position,
		int	occurance_number = `1`
	)		const

inline

Definition at line 886 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE char UT_WorkBuffer::first ( ) const

inline

Definition at line 257 of file UT_WorkBuffer.h.

template<typename... Args>

size_t UT_WorkBuffer::format	(	const char *	fmt,
		const Args &...	args
	)

inline

Replace the contents of the work buffer using the same formatting as UTformat. Returns the size of the appended portion, in bytes.

Definition at line 574 of file UT_WorkBuffer.h.

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

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

SYS_FORCE_INLINE exint UT_WorkBuffer::getAllocatedSize ( ) const

inline

Definition at line 188 of file UT_WorkBuffer.h.

bool UT_WorkBuffer::getline ( std::istream & is )

bool UT_WorkBuffer::getline ( FILE * fp )

int64 UT_WorkBuffer::getMemoryUsage ( bool inclusive ) const

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

void UT_WorkBuffer::insert	(	exint	pos,
		const char *	str,
		exint	slen
	)

Insert slen characters from str, at location pos. If pos exceeds the current length, the position is truncated and to an append.

SYS_FORCE_INLINE bool UT_WorkBuffer::isEmpty ( ) const

inline

Definition at line 485 of file UT_WorkBuffer.h.

int UT_WorkBuffer::isNullTerminated ( ) const

SYS_FORCE_INLINE bool UT_WorkBuffer::isstring ( ) const

inline

Examples:: SIM/GAS_NetVDBSliceExchange.C.

Definition at line 490 of file UT_WorkBuffer.h.

void UT_WorkBuffer::itoa ( int64 i )

Fast integer to string conversion.

SYS_FORCE_INLINE char UT_WorkBuffer::last ( ) const

inline

Definition at line 264 of file UT_WorkBuffer.h.

const char* UT_WorkBuffer::lastChar	(	char	c,
		int	occurance_number = `1`
	)		const

inline

Definition at line 865 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE exint UT_WorkBuffer::length ( void ) const

inline

Examples:: SIM/GAS_NetVDBSliceExchange.C.

Definition at line 410 of file UT_WorkBuffer.h.

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

utf16* UT_WorkBuffer::lockUTF16	(	exint	offset = `0`,
		exint	len = `0`
	)

inline

Lock buffer for len utf-16 characters.

Definition at line 1037 of file UT_WorkBuffer.h.

void UT_WorkBuffer::lower ( )

Convert string to lower case.

Examples:: packedshareddata/GU_PackedSharedData.C.

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

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

static SYS_FORCE_INLINE UT_WorkBuffer UT_WorkBuffer::narrow ( const utf16 * str )

inlinestatic

Create a work buffer to contain the UTF-8 representation of the incoming UTF-16 string. The UTF-16 string is assumed to be little-endian, unless prefixed with BOM that indicates endianness. The incoming string should be zero-word terminated.

Definition at line 147 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE bool UT_WorkBuffer::operator!= ( const char * str ) const

inline

Comparison operator. Null strings are considered as empty strings.

Definition at line 327 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE bool UT_WorkBuffer::operator!= ( const UT_String & str ) const

inline

Comparison operator. Null strings are considered as empty strings.

Definition at line 332 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE bool UT_WorkBuffer::operator!= ( const UT_StringRef & str ) const

inline

Comparison operator. Null strings are considered as empty strings.

Definition at line 337 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE bool UT_WorkBuffer::operator!= ( const UT_WorkBuffer & buf ) const

inline

Comparison operator. Null strings are considered as empty strings.

Definition at line 342 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE char UT_WorkBuffer::operator() ( exint idx ) const

inline

Definition at line 247 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer& UT_WorkBuffer::operator+= ( const char * str )

inline

Definition at line 728 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer& UT_WorkBuffer::operator+= ( const std::string & str )

inline

Definition at line 735 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer& UT_WorkBuffer::operator+= ( const UT_WorkBuffer & wb )

inline

Definition at line 742 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer& UT_WorkBuffer::operator+= ( const UT_String & str )

inline

Definition at line 749 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer& UT_WorkBuffer::operator+= ( const UT_StringRef & str )

inline

Definition at line 756 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer& UT_WorkBuffer::operator= ( const UT_WorkBuffer & other )

inline

Definition at line 274 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer& UT_WorkBuffer::operator= ( const char * str )

inline

Definition at line 280 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer& UT_WorkBuffer::operator= ( const std::string & str )

inline

Definition at line 287 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE bool UT_WorkBuffer::operator== ( const char * str ) const

inline

Comparison operator. Null strings are considered as empty strings.

Definition at line 297 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE bool UT_WorkBuffer::operator== ( const UT_String & str ) const

inline

Comparison operator. Null strings are considered as empty strings.

Definition at line 304 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE bool UT_WorkBuffer::operator== ( const UT_StringRef & str ) const

inline

Comparison operator. Null strings are considered as empty strings.

Definition at line 311 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE bool UT_WorkBuffer::operator== ( const UT_WorkBuffer & buf ) const

inline

Comparison operator. Null strings are considered as empty strings.

Definition at line 318 of file UT_WorkBuffer.h.

void UT_WorkBuffer::prepend ( char character )

inline

Definition at line 762 of file UT_WorkBuffer.h.

void UT_WorkBuffer::prepend	(	const char *	data,
		exint	size
	)

inline

Definition at line 771 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::prepend ( const char * str )

inline

Definition at line 782 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::prepend ( const UT_String & str )

inline

Definition at line 789 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::prepend ( const UT_StringRef & str )

inline

Definition at line 795 of file UT_WorkBuffer.h.

template<typename... Args>

size_t UT_WorkBuffer::print ( const Args &... args )

inline

Replace the contents of the work buffer using UTformat formatting with an implicit "{} " for each argument, giving a Python-style print result.

Definition at line 608 of file UT_WorkBuffer.h.

void UT_WorkBuffer::printMemory ( int64 mem )

inline

Definition at line 649 of file UT_WorkBuffer.h.

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

bool UT_WorkBuffer::readFile ( const char * filename )

Load an entire file into the buffer. Returns false if there was an error reading the file

void UT_WorkBuffer::release ( bool recompute_length = false )

void UT_WorkBuffer::releaseSetLength ( exint new_length )

bool UT_WorkBuffer::removeLeadingSpace ( )

Remove leading white space, return true if whitespace was removed.

bool UT_WorkBuffer::removeTrailingDigits ( )

Remove trailing digits, return true if some were removed.

bool UT_WorkBuffer::removeTrailingSpace ( )

Remove trailing whitespace, return true if whitespace was removed.

void UT_WorkBuffer::removeTrailingSpaceLines ( )

Remove trailing whitespace lines.

void UT_WorkBuffer::reserve ( exint bytes = 0 )

void UT_WorkBuffer::rewind ( )

inline

Definition at line 808 of file UT_WorkBuffer.h.

void UT_WorkBuffer::setAsUTF16 ( const utf8 * str )

Set the work buffer to contain a UTF-16LE (little endian) representation of the incoming UTF-8 string. The work buffer will be zero-word terminated.

void UT_WorkBuffer::setFromUTF16 ( const utf16 * str )

UTF-16 / UTF-8 conversions.

Set the work buffer to contain the UTF-8 representation of the incoming UTF-16 string. The UTF-16 string is assumed to be little-endian, unless prefixed with BOM that indicates endianness. The incoming string should be zero-word terminated.

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

Examples:: COP2/COP2_PixelAdd.C, field3d/f3d_io.C, GEO/GEO_VoxelTranslator.C, packedshareddata/GU_PackedSharedData.C, ROP/ROP_Dumper.C, SHOP/SHOP_POVMaterial.C, SIM/GAS_NetVDBSliceExchange.C, SOP/SOP_ArrayAttrib.C, SOP/SOP_BouncyAgent.C, SOP/SOP_CustomBrush.C, SOP/SOP_IKSample.C, and VOP/VOP_CustomContext.C.

void UT_WorkBuffer::stealIntoString ( UT_String & str )

Examples:: SHOP/SHOP_POVMaterial.C.

void UT_WorkBuffer::stealIntoStringHolder ( UT_StringHolder & str )

SYS_FORCE_INLINE void UT_WorkBuffer::strcat ( const char * src )

inline

Definition at line 416 of file UT_WorkBuffer.h.

void UT_WorkBuffer::strcatFirstWord ( const char * src )

SYS_FORCE_INLINE int UT_WorkBuffer::strcmp ( const char * src ) const

inline

Examples:: SIM/GAS_NetVDBSliceExchange.C.

Definition at line 455 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::strcpy ( const char * src )

inline

Examples:: FS/FS_HomeHelper.C, packedshareddata/GU_PackedSharedData.C, standalone/dsmprint.C, and VOP/VOP_CustomContext.C.

Definition at line 364 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::strcpy ( const UT_String & src )

inline

Definition at line 370 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::strcpy ( const UT_StringRef & src )

inline

Definition at line 376 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::strcpy ( const UT_WorkBuffer & src )

inline

Definition at line 382 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE char* UT_WorkBuffer::strdup ( ) const

inline

Definition at line 469 of file UT_WorkBuffer.h.

int UT_WorkBuffer::strip ( const char * chars )

Strips out all characters found in 'chars'. The string length will be reduced by the number of characters removed. The number of characters removed is returned.

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

SYS_FORCE_INLINE exint UT_WorkBuffer::strlen ( ) const

inline

Definition at line 403 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::strncat	(	const char *	src,
		exint	len
	)

inline

Append a string of a given maximum length to the current string. Unlike the POSIX's strncat(3), we ignore any NUL bytes in the current string and blindly append at the end of the work buffer.

Definition at line 442 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE int UT_WorkBuffer::strncmp	(	const char *	src,
		exint	n
	)		const

inline

Definition at line 462 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::strncpy	(	const char *	src,
		exint	maxlen
	)

inline

Definition at line 390 of file UT_WorkBuffer.h.

bool UT_WorkBuffer::subPatterns	(	const char *	to_pattern,
		const char *	from_name,
		const char *	from_pattern
	)

Given from_name which is assumed to fit from_pattern, any assigned wildcards are subsitituted in to_pattern, writing the result to this. The wildcards may also be indexed. For example:

to_pattern = b* from_name = apple from_pattern = a*le —> this = bpp

to_pattern = *(1)_to_*(0) from_name = a_to_b from_pattern = *_to_* —> this = b_to_a

int UT_WorkBuffer::substitute	(	const char *	find,
		const char *	replacement,
		int	count = `-1`
	)

Replaces up to 'count' occurrences of 'find' with 'replacement', and returns the number of substitutions that occurred. If 'count' <= 0, all occurrences will be replaced.

int UT_WorkBuffer::substitute	(	const char *	find,
		const char *	replacement,
		bool	all
	)

inline

Convenience version of substitute() for all or single occurrence.

Definition at line 1000 of file UT_WorkBuffer.h.

void UT_WorkBuffer::swap ( UT_WorkBuffer & other )

inline

Definition at line 1042 of file UT_WorkBuffer.h.

std::string UT_WorkBuffer::toStdString ( ) const

inline

Definition at line 944 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::truncate ( exint new_length )

inline

Truncate the buffer to the specified length. Truncating to 0 is identical to clear().

Definition at line 825 of file UT_WorkBuffer.h.

void UT_WorkBuffer::upper ( )

Convert string to upper case.

void UT_WorkBuffer::utoa ( uint64 i )

Fast integer to string conversion.

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

static SYS_FORCE_INLINE UT_WorkBuffer UT_WorkBuffer::widen ( const utf8 * str )

inlinestatic

Create a work buffer to contain a UTF-16LE (little endian) representation of the incoming UTF-8 string. The work buffer will be zero-word terminated.

Definition at line 136 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::write	(	exint	offset,
		char	c
	)

inline

Definition at line 499 of file UT_WorkBuffer.h.

void UT_WorkBuffer::write	(	exint	offset,
		const char *	src
	)

inline

Definition at line 517 of file UT_WorkBuffer.h.

void UT_WorkBuffer::write	(	exint	offset,
		const UT_StringHolder &	src
	)

inline

Definition at line 527 of file UT_WorkBuffer.h.

Friends And Related Function Documentation

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

friend

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

UT/UT_WorkBuffer.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation