NxWidgets::CNxString: Add a getAllocSize() method to make it easier to convert CNxStrings to NUL-terminated C strings

1 files changed, 16 insertions, 4 deletions

diff --git a/NxWidgets/libnxwidgets/include/cnxstring.hxx b/NxWidgets/libnxwidgets/include/cnxstring.hxx
index 50adea21c..2fa230ab1 100644
--- a/NxWidgets/libnxwidgets/include/cnxstring.hxx
+++ b/NxWidgets/libnxwidgets/include/cnxstring.hxx
@@ -239,9 +239,9 @@ namespace NXWidgets
     /**
      * Copy the internal array to the supplied buffer.  The buffer must be
      * large enough to contain the full text in the string.  The
-     * getByteCount() method can be used to obtain the length of the string.
+     * getAllocSize() method can be used to obtain the length of the string.
      * Unlike the CNxString class, the char array is null-terminated.
-     * The buffer must be (getByteCount() + 1) bytes long, in order to
+     * The buffer must be (getAllocSize() + 1) bytes long, in order to
      * accommodate the terminator.
      *
      * @param buffer Buffer to copy the internal char array to.
@@ -322,12 +322,24 @@ namespace NXWidgets
      * @return The length of the string.
      */
 
-    inline const int getLength(void) const
+    inline const unsigned int getLength(void) const
     {
       return m_stringLength;
     };
 
     /**
+     * Get the size of a buffer (in bytes) required in order to copy the
+     * internal string into an the array.  This is normally used in
+     * conjunction with copyToCharArray().  Note that the returned size
+     * includes additional byte(s) to hold NUL termination.
+     */
+
+    inline const unsigned int getAllocSize(void) const
+    {
+      return sizeof(nxwidget_char_t) * (m_stringLength + 1);
+    }
+
+    /**
      * Get the character at the specified index.  This function is useful
      * for finding the occasional character at an index, but for iterating
      * over strings it is exceptionally slow.  The newStringIterator()
@@ -463,7 +475,7 @@ namespace NXWidgets
      * @return This string.
      */
 
-    CNxString& operator=(nxwidget_char_t letter);
+    CNxString &operator=(nxwidget_char_t letter);
 
     /**
      * Compares this string to the argument.