#include <String.h>
Public Types | |
| enum | Mode { INVALID = 0 , READ_ONLY , COPY_ON_WRITE , READ_WRITE , HANDOFF , MODE_MAX } |
Static Public Member Functions | |
| static const char * | GetCloneOf (const char *source, ::std::size_t length=0) |
| static String & | SetMode (const String &string, Mode desiredMode) |
| template<typename T > | |
| static String | From (const T &value) |
Protected Member Functions | |
| virtual void | Clear () |
Protected Attributes | |
| Mode | mMode |
 Protected Attributes inherited from bio::ImmutableString | |
| const char * | mString |
| ::std::size_t | mLength |
Detailed Description
We use our own String implementation in order to ensure consistency across the library and to provide a single point of optimization for all String operations.
We would like bio::Strings to encompass both the compile-time behavior of std::string_view and run-time versatility of std::string while being fully backwards compatible.
Like other Biology classes, String is inheritable and designed to be extended.
String is implemented as the addition of mutability to ImmutableString by way of a non-trivial destructor with the ability to allocate and delete data.
ImmutableStrings can be used in constexpr while Strings cannot.
Strings have different Modes. These Modes indicate how to handle internal operations.
The Mode of a String is set depending on how it is constructed.
You may change the String::Mode using the static SetMode method, which will produce a new String.
A READ_ONLY String cannot be set by any means. If you wish to edit a READ_ONLY String, you must SetMode first.
A COPY_ON_WRITE String will automatically become a READ_WRITE String when written to.
NOTE: There are no "WRITE" operation for COPY_ON_WRITE to use. This will likely change in a future release.
Member Enumeration Documentation
◆ Mode
Constructor & Destructor Documentation
◆ String() [1/5]
An empty string will point to NULL, have a length of 0.
You may specify the Mode of an empty String.
◆ String() [2/5]
Constructing a String from a const char* clones the provided contents into READ_WRITE storage.
Use ImmutableString or View() for borrowed read-only access.
- Parameters
-
string
◆ String() [3/5]
| bio::String::String | ( | ::std::string | string | ) |
Constructing a String from a std::string basically gives back an std::string.
std::strings can only ever READ_WRITE, since their c_str() method goes out of scope on subsequent access.
- Parameters
-
string
◆ String() [4/5]
| bio::String::String | ( | const ImmutableString & | string | ) |
ImmutableStrings are treated as const char* and will yield a READ_ONLY String.
- Parameters
-
string
◆ String() [5/5]
◆ ~String()
|
virtual |
Member Function Documentation
◆ AsBool()
|
virtual |
Convert "true" or "false" to bool.
This is essentially just {== "true"} with no extra test for "false".
This behavior may change in a future release.
Case insensitive.
- Returns
- *this as a bool, false by default.
◆ AsCharString()
Get a new const char* from *this.
YOU MUST delete THE RETURNED VALUE TO AVOID MEMORY LEAKS!
- Returns
- a new const char* copy of *this.
◆ AsFloat()
|
virtual |
convert *this to a float.
- Returns
- *this as a float; 0.0f by default.
◆ AsInt()
|
virtual |
convert *this to an integer.
- Returns
- *this as an integer; 0 by default.
◆ AsNumber()
|
virtual |
Convert *this to a number.
Uses the most permissive numeric notation available.
- Returns
- *this as a Number; 0.0f by default.
◆ AsStdString()
| std::string bio::String::AsStdString | ( | ) | const |
Get *this as an std::string.
- Returns
- *this as an std::string.
◆ AsUInt()
|
virtual |
convert *this to an unsigned integer.
- Returns
- *this as an unsigned integer; 0 by default.
◆ Clear()
|
protectedvirtual |
Will delete mString if *this is READ_WRITE, etc.
◆ Contains()
Check if *this contains other.
- Parameters
-
other
- Returns
- whether or not *this contains other.
◆ EndsWith()
Check if *this ends with other.
- Parameters
-
other
- Returns
- whether or not *this ends with other.
◆ From()
Converts the given value to a string.
- Parameters
-
value
◆ GetCloneOf()
Copies the contents of source, up to length characters, into a new const char*.
NOTE: because "new" is used here, a delete needs to be called elsewhere.
- Parameters
-
source length if 0, the whole source is copied.
- Returns
- a new const char* with the contents of source.
◆ GetMode()
|
virtual |
- Returns
- the Mode of *this.
◆ IsBoolean()
|
virtual |
Check if *this can be cast AsBool().
- Returns
- whether or not *this contains only text that can be converted into a boolean value.
◆ IsNumeric()
|
virtual |
Check if this can be cast AsNumber().
In order to make this method more useful than just a simple boolean check, the return format is encoded such that you are given details on the numeric format of *this.
The format is like -?count(\d+).count(\d), where the leading - is optional, first count is the number of digits before the decimal point, and the second count is the number of digits after the decimal point.
A number like 123 would return 3.0f, since it has 3 digits before the decimal point and 0 after.
A number like -1234.567 would return -4.3f, since it has 4 digits before the decimal point and 3 after and is negative.
A number like -.123 would return -0.3f, since it has 0 digits before the decimal point and 3 after.
You can use this to check if *this can be cast as a UInt, etc. (e.g. check = maybeUint.IsNumeric(); check > 1 && !std::fmod(check, 1.0).
- Returns
- a float with the number of numbers before and after the decimal point.
◆ operator bool()
|
virtual |
You can implicitly treat Strings as booleans the same way you do pointers (specifically char*).
NOTE: THIS IS NOT this->AsBool()!!!
- Returns
- whether or not *this is empty.
◆ operator+=()
Append other to *this.
- Parameters
-
other
- Returns
- the result of appending other to *this.
◆ operator::std::string()
|
virtual |
- Returns
- *this as an std::string.
◆ operator=() [1/5]
|
virtual |
NOTE: Assigning *this an std::string forces it to be READ_WRITE!
- Parameters
-
string
- Returns
- *this.
◆ operator=() [2/5]
◆ operator=() [3/5]
|
virtual |
- Parameters
-
toAssign
- Returns
- *this.
◆ operator=() [4/5]
NOTE: Mode is NOT copied.
- Parameters
-
toCopy
- Returns
- *this.
◆ operator=() [5/5]
This is just lies: we const_cast(this) and change the values..
This is used in places where a move operation would be performed but since that can't be done prior to c++11, we hack it.
All Values are moved, including Mode,
- Parameters
-
toMoveHack
- Returns
- *this.
◆ operator==() [1/4]
- Parameters
-
other
- Returns
- whether or not the contents of *this match those of other.
◆ operator==() [2/4]
- Parameters
-
other
- Returns
- whether or not the contents of *this match those of other.
◆ operator==() [3/4]
|
virtual |
NOTE: We ignore Mode when comparing Strings.
- Parameters
-
other
- Returns
- whether or not the contents of *this match those of other.
◆ operator==() [4/4]
NOTE: We ignore Mode when comparing Strings.
- Parameters
-
other
- Returns
- whether or not the contents of *this match those of other.
◆ SetMode()
In order to change the Mode of a String, you must create a new String.
UNDEFINED BEHAVIOR if you:
◆ StartsWith()
Check if *this starts with other.
- Parameters
-
other
- Returns
- whether or not *this starts with other.
◆ SubString()
|
virtual |
Get a smaller string from *this.
- Parameters
-
start end
- Returns
- a READ_ONLY String consisting of the contents of *this between start and end.
◆ View()
| ImmutableString bio::String::View | ( | ) | const |
Get a borrowed read-only view of *this without allocating or copying.
The returned view remains valid until *this is destroyed or mutated in a way that replaces the backing storage.
- Returns
- a non-owning view into the current contents of *this.
Member Data Documentation
◆ mMode
|
protected |
The documentation for this class was generated from the following files:
