String_64 Class Reference

Extends its String base class to become fixed-length and atomically allocatable, ie. a failed constructor call for this class will never leave the object in an illegal state. More...

#include <fixstr64.h>

Inheritance diagram for String_64:

List of all members.

Public Member Functions
	String_64 (const TCHAR *psz=TEXT(""))
	Constructs a string of the appropriate maximum length.
	String_64 (const StringBase &other)
	String_64 (const String_64 &other)
	String_64 (UINT32 resID, UINT32 hinst=0)
	Loads the string resource into this String.
	String_64 (const wxString &wxs)
	Constructs a string of the appropriate maximum length.
virtual	~String_64 ()
	Destroys this fixed-length string.
virtual BOOL	Alloc (INT32 nSize)
	Fixes Alloc() for fixed-length strings, which CAN be safely changed# to use a buffer on the heap. Scope: Public.
Private Member Functions
void	CopyConstruct (const StringBase &other)
	Duplicates the text of the other string.
Private Attributes
TCHAR	fixedbuf [(((64)+1)*2)]
Static Private Attributes
static const INT32	FIX_LEN_BUFSIZE

---

Detailed Description

Extends its String base class to become fixed-length and atomically allocatable, ie. a failed constructor call for this class will never leave the object in an illegal state.

class String_64 : public StringBase

Author:

Justin_Flude (Xara Group Ltd) <camelotdev@xara.com>

Date:

12th August 1993

Definition at line 116 of file fixstr64.h.

---

Constructor & Destructor Documentation

String_64::String_64 (  const TCHAR *  psz = TEXT("")  )

Constructs a string of the appropriate maximum length. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 12th August 1993 Parameters: An  optional pointer to a (constant) Unicode character array - if [INPUTS] omitted then the String becomes empty (NOT the null pointer). Returns: Errors: ASSERTion failure if the passed character array is too long for this length of string, or if psz is NULL. Scope: Public Definition at line 117 of file fixstr64.cpp. { *(text = fixedbuf) = 0; length = FIX_LEN_BUFSIZE; if (psz != 0) { ERROR3IF(camStrlen(psz) >= length, "String_64::String_64 overflow"); camStrcpy(text, psz); } }

String_64::String_64 (  const StringBase &  other  )  [inline]

Definition at line 125 of file fixstr64.h. { CopyConstruct( other ); }

String_64::String_64 (  const String_64 &  other  )  [inline]

Definition at line 126 of file fixstr64.h. { CopyConstruct( other ); }

String_64::String_64 (  UINT32  resID, UINT32  hinst = 0 )

Loads the string resource into this String. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 12th August 1993 Parameters: A  string resource numeric identifier, an optional resource module [INPUTS] handle (if not supplied, the default resource module is used). Returns: Errors: ENSURE failure if this string is not long enough to hold the resource, or if the resource cannot be found in the module. If it cannot be found, a very short temp string is built of the form "<%X:%X>" containing the ID and the module number, or if that is too long then simply "!". Scope: Public See also: SmartLoadString Definition at line 172 of file fixstr64.cpp. { *(text = fixedbuf) = 0; length = FIX_LEN_BUFSIZE; if (!Load(resID, hinst)) { ERROR3("String resource failed to load"); TCHAR buf[128]; camSnprintf(buf, 128, TEXT("<%X:%X>"), (INT32) resID, (INT32) hinst); camStrcpy(text, (camStrlen(buf) <= 64) ? buf : TEXT("!")); } }

String_64::String_64 (  const wxString &  wxs  )

Constructs a string of the appropriate maximum length. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 28th January 2006 Parameters: A  wxString [INPUTS] Returns: Errors: ASSERTion failure if the passed character array is too long for this length of string, or if psz is NULL. Scope: Public Definition at line 199 of file fixstr64.cpp. { *(text = fixedbuf) = 0; length = FIX_LEN_BUFSIZE; ERROR3IF(wxs.Len() >= length, "String_64::String_64 overflow"); camStrcpy(text, (LPCTSTR)wxs); }

String_64::~String_64 (   )  [inline, virtual]

Destroys this fixed-length string. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 12th August 1993 Definition at line 148 of file fixstr64.h. { // If the string is using the fixed-length buffer then make sure the // base class doesn't try to delete[] it. if (text == fixedbuf) text = 0; }

---

Member Function Documentation

BOOL String_64::Alloc (  INT32  nSize  )  [virtual]

Fixes Alloc() for fixed-length strings, which CAN be safely changed# to use a buffer on the heap. Scope: Public. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> & Andy Date: 12th August 1993 See also: StringBase::Alloc Reimplemented from StringBase. Definition at line 220 of file fixstr64.cpp. { if (text == fixedbuf) text = 0; return StringBase::Alloc(nSize); }

void String_64::CopyConstruct (  const StringBase &  other  )  [private]

Duplicates the text of the other string. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 12th August 1993 Parameters: A  constant reference to another string (can be of any length) [INPUTS] Returns: Errors: ASSERTion failure if this string is not long enough to hold a copy of the other string's text, or if the copied String has not been allocated. Scope: Public Definition at line 143 of file fixstr64.cpp. { *(text = fixedbuf) = 0; length = FIX_LEN_BUFSIZE; ERROR3IF((const TCHAR*) other == 0, "StringBase to be copied has not been ALLOCated"); ERROR3IF(camStrlen((const TCHAR*) other) >= length, "Constructed String_64 not large enough to hold StringBase copy"); camStrcpy(text, (const TCHAR*) other); }

---

Member Data Documentation

const INT32 String_64::FIX_LEN_BUFSIZE [static, private]

Definition at line 118 of file fixstr64.h.

TCHAR String_64::fixedbuf[(((64)+1)*2)] [private]

Definition at line 134 of file fixstr64.h.

---

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

• wxOil/fixstr64.h (r1785/r1283)
• wxOil/fixstr64.cpp (r1785/r1283)

---