String object held in a cache. More...

#include <CachedString.h>

Inheritance diagram for CXXR::CachedString:

Collaboration diagram for CXXR::CachedString:

Public Member Functions
const std::string &	stdstring () const
	Access encapsulated std::string.
const char *	typeName () const
	Name within R of this type of object.
Public Member Functions inherited from CXXR::String
char	operator[] (unsigned int index) const
	Read-only character access.
const char *	c_str () const
	Access as a C-style string.
cetype_t	encoding () const
	Character encoding.
bool	isASCII () const
	Is this Stringpure ASCII?
bool	isNA () const
	Test if 'not available'.
unsigned int	packGPBits () const
	Reproduce the `gp` bits field used in CR.
Public Member Functions inherited from CXXR::VectorBase
	VectorBase (SEXPTYPE stype, std::size_t sz)
	VectorBase (const VectorBase &pattern)
	Copy constructor.
const ListVector *	dimensionNames () const
	Names associated with the rows, columns or other dimensions of an R matrix or array.
const StringVector *	dimensionNames (unsigned int d) const
	Names associated with a particular dimension of an R matrix or array.
const IntVector *	dimensions () const
	Dimensions of R matrix or array.
const StringVector *	names () const
	Names of vector elements.
void	setDimensionNames (ListVector *names)
	Associate names with the rows, columns or other dimensions of an R matrix or array.
void	setDimensionNames (unsigned int d, StringVector *names)
	Associate names with a particular dimension of an R matrix or array.
void	setDimensions (IntVector *dims)
	Define the dimensions of R matrix or array.
void	setNames (StringVector *names)
	Associate names with the elements of a VectorBase.
virtual void	setSize (std::size_t new_size)
	Adjust the number of elements in the vector.
std::size_t	size () const
	Number of elements in the vector.
VectorBase *	clone () const
	Return pointer to a copy of this object.
Public Member Functions inherited from CXXR::RObject
virtual const PairList *	attributes () const
	Get object attributes.
virtual void	clearAttributes ()
	Remove all attributes.
void	copyAttribute (const Symbol name, const RObject source)
	Copy an attribute from one RObject to another.
void	copyAttributes (const RObject *source, bool copyS4)
	Copy attributes from one RObject to another.
virtual RObject *	evaluate (Environment *env)
	Evaluate object in a specified Environment.
virtual RObject *	getAttribute (const Symbol *name) const
	Get the value a particular attribute.
virtual bool	hasAttributes () const
	Has this object any attributes?
bool	hasClass () const
	Has this object the class attribute?
bool	isS4Object () const
	Is this an S4 object?
void	maybeTraceMemory (const RObject *src)
	Carry out memory tracing.
void	maybeTraceMemory (const RObject src1, const RObject src2)
	Carry out memory tracing.
void	maybeTraceMemory (const RObject src1, const RObject src2, const RObject *src3)
	Carry out memory tracing.
bool	memoryTraced () const
	Is copying etc. of this object being traced?
virtual void	setAttribute (const Symbol name, RObject value)
	Set or remove an attribute.
void	setAttributes (const PairList *new_attributes)
	Replace the attributes of an object.
void	setMemoryTracing (bool on)
	Enable/disable tracing of copying etc.
void	setS4Object (bool on)
	Set the status of this RObject as an S4 object.
SEXPTYPE	sexptype () const
	Get an object's SEXPTYPE.
virtual void	unpackGPBits (unsigned int gpbits)
	Interpret the `gp` bits field used in CR.
void	detachReferents ()
	Null out all references from this node to other nodes.
void	visitReferents (const_visitor *v) const
	Conduct a visitor to the nodes referred to by this one.
Public Member Functions inherited from CXXR::GCNode
void	expose () const
	Record that construction of a node is complete.
bool	isExposed () const
	Has this node been exposed to garbage collection?
Public Member Functions inherited from CXXR::HeterogeneousListBase::Link
	Link ()
	Default constructor.
	Link (HeterogeneousListBase *list)
	Appending constructor.
void	freeLink ()
	Detach Link from any list.

Static Public Member Functions
static CachedString *	blank ()
	Blank string.
static CachedString *	obtain (const std::string &str, cetype_t encoding=CE_NATIVE)
	Get a pointer to a CachedString object.
static const char *	staticTypeName ()
	The name by which this type is known in R.
Static Public Member Functions inherited from CXXR::String
static cetype_t	GPBits2Encoding (unsigned int gpbits)
	Extract encoding information from CR's `gp` bits field.
static String *	NA ()
	'Not available' string.
Static Public Member Functions inherited from CXXR::VectorBase
template<class V >
static V *	resize (const V *pattern, std::size_t new_size)
	Create an extended or shrunken copy of an R vector.
static PairList *	resizeAttributes (const PairList *attributes, std::size_t new_size)
	Adjust attributes for a resized vector.
Static Public Member Functions inherited from CXXR::RObject
template<class T >
static T *	clone (const T *pattern)
	Return a pointer to a copy of an object.
Static Public Member Functions inherited from CXXR::GCNode
static void *	operator new (size_t bytes)
	Allocate memory.
static void *	operator new (size_t, void *where)
	Placement new for GCNode.
static void	operator delete (void *p, size_t bytes)
	Deallocate memory.
static bool	check ()
	Integrity check.
template<class T >
static T *	expose (T *node)
	Record that construction of a node is complete.
static void	gc ()
	Initiate a garbage collection.
static void	gclite ()
	Lightweight garbage collection.
static void	maybeCheckExposed (const GCNode *node)
	Subject to configuration, check that a GCNode is exposed.
static size_t	numNodes ()
	Number of GCNode objects in existence.

Friends
class	SchwarzCounter< CachedString >
class	Symbol

Detailed Description

String object held in a cache.

At any one time, at most one CachedString object with a particular text and encoding may exist.

Member Function Documentation

static CachedString* CXXR::CachedString::blank ( )

inlinestatic

Blank string.

Returns:: const pointer to the string "".

Reimplemented from CXXR::String.

static CachedString* CXXR::CachedString::obtain	(	const std::string &	str,
		cetype_t	encoding = `CE_NATIVE`
	)

static

Get a pointer to a CachedString object.

If no CachedString with the specified text and encoding currently exists, one will be created, and a pointer to it returned. Otherwise a pointer to the existing CachedString will be returned.

Parameters:

str	The text of the required CachedString. (Embedded null characters are permissible.)
encoding	The encoding of the required CachedString. Only CE_NATIVE, CE_UTF8 or CE_LATIN1 are permitted in this context (checked). Note that if str contains no non-ASCII characters, then the encoding is set to CE_NATIVE regardless of the value of the encoding parameter.

Returns:: Pointer to a CachedString (preexisting or newly created) representing the specified text in the specified encoding.

Reimplemented from CXXR::String.

static const char* CXXR::CachedString::staticTypeName ( )

inlinestatic

The name by which this type is known in R.

Returns:: the name by which this type is known in R.

Reimplemented from CXXR::String.

const std::string& CXXR::CachedString::stdstring ( ) const

inline

Access encapsulated std::string.

Returns:: Reference to the encapsulated std::string.

Reimplemented from CXXR::String.

const char* CXXR::CachedString::typeName ( ) const

virtual

Name within R of this type of object.

Returns:: the name by which this type of object is known within R.

Reimplemented from CXXR::String.

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

CachedString.h ($Id: CachedString.h 1275 2012-03-17 14:01:29Z arr $)

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation