sergiotarxz/nuttx-apps
sergiotarxz/nuttx-apps
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source
This commit is contained in:
Gregory Nutt 2014-07-24 14:57:38 -06:00
parent 80be4efcf1
commit 061e95bd91
2 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
libnxwidgets/include/cnxstring.hxx
View File

@ -239,9 +239,9 @@ namespace NXWidgets
/** /**
* Copy the internal array to the supplied buffer. The buffer must be * Copy the internal array to the supplied buffer. The buffer must be
* large enough to contain the full text in the string. The * 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. * 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. * accommodate the terminator.
* *
* @param buffer Buffer to copy the internal char array to. * @param buffer Buffer to copy the internal char array to.
@ -322,11 +322,23 @@ namespace NXWidgets
* @return The length of the string. * @return The length of the string.
*/ */
inline const int getLength(void) const inline const unsigned int getLength(void) const
{ {
return m_stringLength; 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 * Get the character at the specified index. This function is useful
* for finding the occasional character at an index, but for iterating * for finding the occasional character at an index, but for iterating
@ -463,7 +475,7 @@ namespace NXWidgets
* @return This string. * @return This string.
*/ */
CNxString& operator=(nxwidget_char_t letter); CNxString &operator=(nxwidget_char_t letter);
/** /**
* Compares this string to the argument. * Compares this string to the argument.

7
libnxwidgets/src/cnxstring.cxx
View File

@ -161,9 +161,9 @@ CStringIterator *CNxString::newStringIterator() const
/** /**
* Copy the internal array to the supplied buffer. The buffer must be * Copy the internal array to the supplied buffer. The buffer must be
* large enough to contain the full text in the string. The * 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. * Unlike the CNxString class, the char array is null-terminated.
* The buffer must be (getByteCount() + 2) bytes long, in order to * The buffer must be (getAllocSize() + 2) bytes long, in order to
* accommodate the terminator. * accommodate the terminator.
* *
* @param buffer Buffer to copy the internal char array to. * @param buffer Buffer to copy the internal char array to.
@ -677,6 +677,7 @@ CNxString& CNxString::operator=(const CNxString &string)
{ {
setText(string); setText(string);
} }
return *this; return *this;
} }
@ -688,7 +689,7 @@ CNxString& CNxString::operator=(const CNxString &string)
* @return This string. * @return This string.
*/ */
CNxString& CNxString::operator=(const char *string) CNxString& CNxString::operator=(FAR const char *string)
{ {
setText(string); setText(string);
return *this; return *this;