ObjFW
|
A class for handling strings. More...
#import <ObjFW/OFString.h>
Instance Methods | |
(id) | - initWithUTF8String: |
Initializes an already allocated OFString from a UTF-8 encoded C string. More... | |
(id) | - initWithUTF8String:length: |
Initializes an already allocated OFString from a UTF-8 encoded C string with the specified length. More... | |
(id) | - initWithUTF8StringNoCopy:freeWhenDone: |
Initializes an already allocated OFString from an UTF-8 encoded C string without copying it, if possible. More... | |
(id) | - initWithCString:encoding: |
Initializes an already allocated OFString from a C string with the specified encoding. More... | |
(id) | - initWithCString:encoding:length: |
Initializes an already allocated OFString from a C string with the specified encoding and length. More... | |
(id) | - initWithString: |
Initializes an already allocated OFString with another string. More... | |
(id) | - initWithCharacters:length: |
Initializes an already allocated OFString with a unicode string with the specified length. More... | |
(id) | - initWithUTF16String: |
Initializes an already allocated OFString with a UTF-16 string. More... | |
(id) | - initWithUTF16String:length: |
Initializes an already allocated OFString with a UTF-16 string with the specified length. More... | |
(id) | - initWithUTF16String:byteOrder: |
Initializes an already allocated OFString with a UTF-16 string, assuming the specified byte order if no byte order mark is found. More... | |
(id) | - initWithUTF16String:length:byteOrder: |
Initializes an already allocated OFString with a UTF-16 string with the specified length, assuming the specified byte order if no byte order mark is found. More... | |
(id) | - initWithUTF32String: |
Initializes an already allocated OFString with a UTF-32 string. More... | |
(id) | - initWithUTF32String:length: |
Initializes an already allocated OFString with a UTF-32 string with the specified length. More... | |
(id) | - initWithUTF32String:byteOrder: |
Initializes an already allocated OFString with a UTF-32 string, assuming the specified byte order if no byte order mark is found. More... | |
(id) | - initWithUTF32String:length:byteOrder: |
Initializes an already allocated OFString with a UTF-32 string with the specified length, assuming the specified byte order if no byte order mark is found. More... | |
(id) | - initWithFormat: |
Initializes an already allocated OFString with a format string. More... | |
(id) | - initWithFormat:arguments: |
Initializes an already allocated OFString with a format string. More... | |
(id) | - initWithContentsOfFile: |
Initializes an already allocated OFString with the contents of the specified file in the specified encoding. More... | |
(id) | - initWithContentsOfFile:encoding: |
Initializes an already allocated OFString with the contents of the specified file in the specified encoding. More... | |
(id) | - initWithContentsOfURL: |
Initializes an already allocated OFString with the contents of the specified URL. More... | |
(id) | - initWithContentsOfURL:encoding: |
Initializes an already allocated OFString with the contents of the specified URL in the specified encoding. More... | |
(size_t) | - getCString:maxLength:encoding: |
Writes the OFString into the specified C string with the specified encoding. More... | |
(size_t) | - getLossyCString:maxLength:encoding: |
Writes the OFString into the specified C string with the specified encoding, replacing characters that cannot be represented in the specified encoding with a question mark. More... | |
(const char *) | - cStringWithEncoding: |
Returns the OFString as a C string in the specified encoding. More... | |
(const char *) | - lossyCStringWithEncoding: |
Returns the OFString as a C string in the specified encoding, replacing characters that cannot be represented in the specified encoding with a question mark. More... | |
(const char *) | - UTF8String |
Returns the OFString as a UTF-8 encoded C string. More... | |
(size_t) | - length |
Returns the length of the string in Unicode characters. More... | |
(size_t) | - cStringLengthWithEncoding: |
Returns the number of bytes the string needs in the specified encoding. More... | |
(size_t) | - UTF8StringLength |
Returns the number of bytes the string needs in UTF-8 encoding. More... | |
(of_comparison_result_t) | - caseInsensitiveCompare: |
Compares the OFString to another OFString without caring about the case. More... | |
(of_unichar_t) | - characterAtIndex: |
Returns the Unicode character at the specified index. More... | |
(void) | - getCharacters:inRange: |
Copies the Unicode characters in the specified range to the specified buffer. More... | |
(of_range_t) | - rangeOfString: |
Returns the range of the first occurrence of the string. More... | |
(of_range_t) | - rangeOfString:options: |
Returns the range of the string. More... | |
(of_range_t) | - rangeOfString:options:range: |
Returns the range of the string in the specified range. More... | |
(bool) | - containsString: |
Returns whether the string contains the specified string. More... | |
(OFString *) | - substringWithRange: |
Creates a substring with the specified range. More... | |
(OFString *) | - stringByAppendingString: |
Creates a new string by appending another string. More... | |
(OFString *) | - stringByAppendingFormat: |
Creates a new string by appending the specified format. More... | |
(OFString *) | - stringByAppendingFormat:arguments: |
Creates a new string by appending the specified format. More... | |
(OFString *) | - stringByAppendingPathComponent: |
Creates a new string by appending a path component. More... | |
(OFString *) | - stringByPrependingString: |
Creates a new string by prepending another string. More... | |
(OFString *) | - stringByReplacingOccurrencesOfString:withString: |
Creates a new string by replacing the occurrences of the specified string with the specified replacement. More... | |
(OFString *) | - stringByReplacingOccurrencesOfString:withString:options:range: |
Creates a new string by replacing the occurrences of the specified string in the specified range with the specified replacement. More... | |
(OFString *) | - uppercaseString |
Returns the string in uppercase. More... | |
(OFString *) | - lowercaseString |
Returns the string in lowercase. More... | |
(OFString *) | - capitalizedString |
Returns the string capitalized. More... | |
(OFString *) | - stringByDeletingLeadingWhitespaces |
Creates a new string by deleting leading whitespaces. More... | |
(OFString *) | - stringByDeletingTrailingWhitespaces |
Creates a new string by deleting trailing whitespaces. More... | |
(OFString *) | - stringByDeletingEnclosingWhitespaces |
Creates a new string by deleting leading and trailing whitespaces. More... | |
(bool) | - hasPrefix: |
Checks whether the string has the specified prefix. More... | |
(bool) | - hasSuffix: |
Checks whether the string has the specified suffix. More... | |
(OFArray OF_GENERIC(OFString *) | - componentsSeparatedByString: |
Separates an OFString into an OFArray of OFStrings. More... | |
(OFArray OF_GENERIC(OFString *) | - componentsSeparatedByString:options: |
Separates an OFString into an OFArray of OFStrings. More... | |
(OFArray OF_GENERIC(OFString *) | - pathComponents |
Returns the components of the path. More... | |
(OFString *) | - lastPathComponent |
Returns the last component of the path. More... | |
(OFString *) | - pathExtension |
Returns the file extension of the path. More... | |
(OFString *) | - stringByDeletingLastPathComponent |
Returns the directory name of the path. More... | |
(OFString *) | - stringByDeletingPathExtension |
Returns a new string with the file extension of the path removed. More... | |
(OFString *) | - stringByStandardizingPath |
Returns the path with relative sub paths resolved. More... | |
(OFString *) | - stringByStandardizingURLPath |
Returns the URL path with relative sub paths resolved. More... | |
(intmax_t) | - decimalValue |
Returns the decimal value of the string as an intmax_t. More... | |
(uintmax_t) | - hexadecimalValue |
Returns the hexadecimal value of the string as an uintmax_t. More... | |
(float) | - floatValue |
Returns the float value of the string as a float. More... | |
(double) | - doubleValue |
Returns the double value of the string as a double. More... | |
(const of_unichar_t *) | - characters |
Returns the string as an array of Unicode characters. More... | |
(const of_char16_t *) | - UTF16String |
Returns the string in UTF-16 encoding with native byte order. More... | |
(const of_char16_t *) | - UTF16StringWithByteOrder: |
Returns the string in UTF-16 encoding with the specified byte order. More... | |
(size_t) | - UTF16StringLength |
Returns the length of the string in UTF-16 characters. More... | |
(const of_char32_t *) | - UTF32String |
Returns the string in UTF-32 encoding with native byte order. More... | |
(const of_char32_t *) | - UTF32StringWithByteOrder: |
Returns the string in UTF-32 encoding with the specified byte order. More... | |
(void) | - writeToFile: |
Writes the string into the specified file using UTF-8 encoding. More... | |
(void) | - writeToFile:encoding: |
Writes the string into the specified file using the specified encoding. More... | |
(void) | - enumerateLinesUsingBlock: |
block The block to call for each line More... | |
(OFString *) | - MD5Hash |
Returns the MD5 hash of the string as an autoreleased OFString. More... | |
(OFString *) | - RIPEMD160Hash |
Returns the RIPEMD-160 hash of the string as an autoreleased OFString. More... | |
(OFString *) | - SHA1Hash |
Returns the SHA-1 hash of the string as an autoreleased OFString. More... | |
(OFString *) | - SHA224Hash |
Returns the SHA-224 hash of the string as an autoreleased OFString. More... | |
(OFString *) | - SHA256Hash |
Returns the SHA-256 hash of the string as an autoreleased OFString. More... | |
(OFString *) | - SHA384Hash |
Returns the SHA-384 hash of the string as an autoreleased OFString. More... | |
(OFString *) | - SHA512Hash |
Returns the SHA-512 hash of the string as an autoreleased OFString. More... | |
(id) | - JSONValue |
Creates an object from the JSON value of the string. More... | |
(id) | - JSONValueWithDepthLimit: |
Creates an object from the JSON value of the string. More... | |
(id) | - objectByDeserializing |
Deserializes the receiver into an object. More... | |
(OFString *) | - stringByURLEncoding |
Encodes a string for use in a URL. More... | |
(OFString *) | - stringByURLEncodingWithIgnoredCharacters: |
Encodes a string for use in a URL, but does not escape the specified ignored characters. More... | |
(OFString *) | - stringByURLDecoding |
Decodes a string used in a URL. More... | |
(OFString *) | - stringByXMLEscaping |
Escapes a string for use in an XML document. More... | |
(OFString *) | - stringByXMLUnescaping |
Unescapes XML in the string. | |
(OFString *) | - stringByXMLUnescapingWithDelegate: |
Unescapes XML in the string and uses the specified delegate for unknown entities. More... | |
(OFString *) | - stringByXMLUnescapingWithBlock: |
Unescapes XML in the string and uses the specified block for unknown entities. More... | |
Instance Methods inherited from OFObject | |
(id) | - init |
Initializes an already allocated object. More... | |
(OFString *) | - className |
Returns the name of the object's class. More... | |
(OFString *) | - description |
Returns a description for the object. More... | |
(void *) | - allocMemoryWithSize: |
Allocates memory and stores it in the object's memory pool. More... | |
(void *) | - allocMemoryWithSize:count: |
Allocates memory for the specified number of items and stores it in the object's memory pool. More... | |
(nullable void *) | - resizeMemory:size: |
Resizes memory in the object's memory pool to the specified size. More... | |
(nullable void *) | - resizeMemory:size:count: |
Resizes memory in the object's memory pool to the specific number of items of the specified size. More... | |
(void) | - freeMemory: |
Frees allocated memory and removes it from the object's memory pool. More... | |
(void) | - dealloc |
Deallocates the object. More... | |
(void) | - performSelector:afterDelay: |
Performs the specified selector after the specified delay. More... | |
(void) | - performSelector:withObject:afterDelay: |
Performs the specified selector with the specified object after the specified delay. More... | |
(void) | - performSelector:withObject:withObject:afterDelay: |
Performs the specified selector with the specified objects after the specified delay. More... | |
(void) | - performSelector:onThread:waitUntilDone: |
Performs the specified selector on the specified thread. More... | |
(void) | - performSelector:onThread:withObject:waitUntilDone: |
Performs the specified selector on the specified thread with the specified object. More... | |
(void) | - performSelector:onThread:withObject:withObject:waitUntilDone: |
Performs the specified selector on the specified thread with the specified objects. More... | |
(void) | - performSelectorOnMainThread:waitUntilDone: |
Performs the specified selector on the main thread. More... | |
(void) | - performSelectorOnMainThread:withObject:waitUntilDone: |
Performs the specified selector on the main thread with the specified object. More... | |
(void) | - performSelectorOnMainThread:withObject:withObject:waitUntilDone: |
Performs the specified selector on the main thread with the specified objects. More... | |
(void) | - performSelector:onThread:afterDelay: |
Performs the specified selector on the specified thread after the specified delay. More... | |
(void) | - performSelector:onThread:withObject:afterDelay: |
Performs the specified selector on the specified thread with the specified object after the specified delay. More... | |
(void) | - performSelector:onThread:withObject:withObject:afterDelay: |
Performs the specified selector on the specified thread with the specified objects after the specified delay. More... | |
(nullable id) | - forwardingTargetForSelector: |
This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. More... | |
(void) | - doesNotRecognizeSelector: |
Handles messages which are not understood by the receiver. More... | |
(OFString *) | - stringBySerializing |
Creates a string by serializing the receiver. More... | |
Instance Methods inherited from <OFObject> | |
(bool) | - isKindOfClass: |
Returns a boolean whether the object of the specified kind. More... | |
(bool) | - isMemberOfClass: |
Returns a boolean whether the object is a member of the specified class. More... | |
(bool) | - respondsToSelector: |
Returns a boolean whether the object responds to the specified selector. More... | |
(nullable IMP) | - methodForSelector: |
Returns the implementation for the specified selector. More... | |
(nullable const char *) | - typeEncodingForSelector: |
Returns the type encoding for the specified selector. More... | |
(nullable id) | - performSelector: |
Performs the specified selector. More... | |
(nullable id) | - performSelector:withObject: |
Performs the specified selector with the specified object. More... | |
(nullable id) | - performSelector:withObject:withObject: |
Performs the specified selector with the specified objects. More... | |
(bool) | - isEqual: |
Checks two objects for equality. More... | |
(uint32_t) | - hash |
Calculates a hash for the object. More... | |
(id) | - retain |
Increases the retain count. More... | |
(unsigned int) | - retainCount |
Returns the retain count. More... | |
(void) | - release |
Decreases the retain count. More... | |
(id) | - autorelease |
Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More... | |
(id) | - self |
Returns the receiver. More... | |
(bool) | - isProxy |
Returns whether the object is a proxy object. More... | |
Instance Methods inherited from <OFCopying> | |
(id) | - copy |
Copies the object. More... | |
Instance Methods inherited from <OFMutableCopying> | |
(id) | - mutableCopy |
Creates a mutable copy of the object. More... | |
Instance Methods inherited from <OFComparing> | |
(of_comparison_result_t) | - compare: |
Compares the object with another object. More... | |
Instance Methods inherited from <OFSerialization> | |
(id) | - initWithSerialization: |
Initializes the object with the specified XML element serialization. More... | |
(OFXMLElement *) | - XMLElementBySerializing |
Serializes the object into an XML element. More... | |
Instance Methods inherited from <OFJSONRepresentation> | |
(OFString *) | - JSONRepresentation |
Returns the JSON representation of the object as a string. More... | |
(OFString *) | - JSONRepresentationWithOptions: |
Returns the JSON representation of the object as a string. More... | |
Instance Methods inherited from <OFMessagePackRepresentation> | |
(OFDataArray *) | - messagePackRepresentation |
Returns the MessagePack representation of the object as an OFDataArray. More... | |
Class Methods | |
(instancetype) | + string |
Creates a new OFString. More... | |
(instancetype) | + stringWithUTF8String: |
Creates a new OFString from a UTF-8 encoded C string. More... | |
(instancetype) | + stringWithUTF8String:length: |
Creates a new OFString from a UTF-8 encoded C string with the specified length. More... | |
(instancetype) | + stringWithUTF8StringNoCopy:freeWhenDone: |
Creates a new OFString from a UTF-8 encoded C string without copying the string. More... | |
(instancetype) | + stringWithCString:encoding: |
Creates a new OFString from a C string with the specified encoding. More... | |
(instancetype) | + stringWithCString:encoding:length: |
Creates a new OFString from a C string with the specified encoding and length. More... | |
(instancetype) | + stringWithString: |
Creates a new OFString from another string. More... | |
(instancetype) | + stringWithCharacters:length: |
Creates a new OFString from a unicode string with the specified length. More... | |
(instancetype) | + stringWithUTF16String: |
Creates a new OFString from a UTF-16 encoded string. More... | |
(instancetype) | + stringWithUTF16String:length: |
Creates a new OFString from a UTF-16 encoded string with the specified length. More... | |
(instancetype) | + stringWithUTF16String:byteOrder: |
Creates a new OFString from a UTF-16 encoded string, assuming the specified byte order if no byte order mark is found. More... | |
(instancetype) | + stringWithUTF16String:length:byteOrder: |
Creates a new OFString from a UTF-16 encoded string with the specified length, assuming the specified byte order if no byte order mark is found. More... | |
(instancetype) | + stringWithUTF32String: |
Creates a new OFString from a UTF-32 encoded string. More... | |
(instancetype) | + stringWithUTF32String:length: |
Creates a new OFString from a UTF-32 encoded string with the specified length. More... | |
(instancetype) | + stringWithUTF32String:byteOrder: |
Creates a new OFString from a UTF-32 encoded string, assuming the specified byte order if no byte order mark is found. More... | |
(instancetype) | + stringWithUTF32String:length:byteOrder: |
Creates a new OFString from a UTF-32 encoded string with the specified length, assuming the specified byte order if no byte order mark is found. More... | |
(instancetype) | + stringWithFormat: |
Creates a new OFString from a format string. More... | |
(instancetype) | + stringWithContentsOfFile: |
Creates a new OFString with the contents of the specified UTF-8 encoded file. More... | |
(instancetype) | + stringWithContentsOfFile:encoding: |
Creates a new OFString with the contents of the specified file in the specified encoding. More... | |
(instancetype) | + stringWithContentsOfURL: |
Creates a new OFString with the contents of the specified URL. More... | |
(instancetype) | + stringWithContentsOfURL:encoding: |
Creates a new OFString with the contents of the specified URL in the specified encoding. More... | |
(OFString *) | + pathWithComponents: |
Creates a path from the specified path components. More... | |
Class Methods inherited from OFObject | |
(void) | + load |
A method which is called once when the class is loaded into the runtime. More... | |
(void) | + unload |
A method which is called when the class is unloaded from the runtime. More... | |
(void) | + initialize |
A method which is called the moment before the first call to the class is being made. More... | |
(id) | + alloc |
Allocates memory for an instance of the class and sets up the memory pool for the object. More... | |
(id) | + new |
Allocates memory for a new instance and calls init on it. More... | |
(Class) | + class |
Returns the class. More... | |
(OFString *) | + className |
Returns the name of the class as a string. More... | |
(bool) | + isSubclassOfClass: |
Returns a boolean whether the class is a subclass of the specified class. More... | |
(Class) | + superclass |
Returns the superclass of the class. More... | |
(bool) | + instancesRespondToSelector: |
Checks whether instances of the class respond to a given selector. More... | |
(bool) | + conformsToProtocol: |
Checks whether the class conforms to a given protocol. More... | |
(nullable IMP) | + instanceMethodForSelector: |
Returns the implementation of the instance method for the specified selector. More... | |
(nullable const char *) | + typeEncodingForInstanceSelector: |
Returns the type encoding of the instance method for the specified selector. More... | |
(OFString *) | + description |
Returns a description for the class, which is usually the class name. More... | |
(nullable IMP) | + replaceClassMethod:withMethodFromClass: |
Replaces a class method with a class method from another class. More... | |
(nullable IMP) | + replaceInstanceMethod:withMethodFromClass: |
Replaces an instance method with an instance method from another class. More... | |
(nullable IMP) | + replaceClassMethod:withImplementation:typeEncoding: |
Replaces or adds a class method. More... | |
(nullable IMP) | + replaceInstanceMethod:withImplementation:typeEncoding: |
Replaces or adds an instance method. More... | |
(void) | + inheritMethodsFromClass: |
Adds all methods from the specified class to the class that is the receiver. More... | |
(bool) | + resolveClassMethod: |
Try to resolve the specified class method. More... | |
(bool) | + resolveInstanceMethod: |
Try to resolve the specified instance method. More... | |
(id) | + copy |
Returns the class. More... | |
A class for handling strings.
- (OFString *) capitalizedString |
Returns the string capitalized.
- (of_comparison_result_t) caseInsensitiveCompare: | (OFString*) | otherString |
- (of_unichar_t) characterAtIndex: | (size_t) | index |
Returns the Unicode character at the specified index.
index | The index of the Unicode character to return |
- (const of_unichar_t *) characters |
Returns the string as an array of Unicode characters.
The result is valid until the autorelease pool is released. If you want to use the result outside the scope of the current autorelease pool, you have to copy it.
- (OFArray *) componentsSeparatedByString: | (OFString*) | delimiter | |
options: | (int) | options | |
Separates an OFString into an OFArray of OFStrings.
delimiter | The delimiter for separating | ||||
options | Options according to which the string should be separated. Possible values are:
|
- (bool) containsString: | (OFString*) | string |
Returns whether the string contains the specified string.
string | The string to search |
- (size_t) cStringLengthWithEncoding: | (of_string_encoding_t) | encoding |
Returns the number of bytes the string needs in the specified encoding.
encoding | The encoding for the string |
- (const char *) cStringWithEncoding: | (of_string_encoding_t) | encoding |
Returns the OFString as a C string in the specified encoding.
The result is valid until the autorelease pool is released. If you want to use the result outside the scope of the current autorelease pool, you have to copy it.
encoding | The encoding for the C string |
- (intmax_t) decimalValue |
Returns the decimal value of the string as an intmax_t.
Leading and trailing whitespaces are ignored.
If the string contains any non-number characters, an OFInvalidEncodingException is thrown.
If the number is too big to fit into an intmax_t, an OFOutOfRangeException is thrown.
- (double) doubleValue |
Returns the double value of the string as a double.
If the string contains any non-number characters, an OFInvalidEncodingException is thrown.
- (void) enumerateLinesUsingBlock: | (of_string_line_enumeration_block_t) | block |
block The block to call for each line
Enumerates all lines in the receiver using the specified block.
- (float) floatValue |
Returns the float value of the string as a float.
If the string contains any non-number characters, an OFInvalidEncodingException is thrown.
- (void) getCharacters: | (of_unichar_t*) | buffer | |
inRange: | (of_range_t) | range | |
Copies the Unicode characters in the specified range to the specified buffer.
buffer | The buffer to store the Unicode characters |
range | The range of the Unicode characters to copy |
- (size_t) getCString: | (char*) | cString | |
maxLength: | (size_t) | maxLength | |
encoding: | (of_string_encoding_t) | encoding | |
Writes the OFString into the specified C string with the specified encoding.
cString | The C string to write into |
maxLength | The maximum number of bytes to write into the C string, including the terminating zero |
encoding | The encoding to use for writing into the C string |
- (size_t) getLossyCString: | (char*) | cString | |
maxLength: | (size_t) | maxLength | |
encoding: | (of_string_encoding_t) | encoding | |
Writes the OFString into the specified C string with the specified encoding, replacing characters that cannot be represented in the specified encoding with a question mark.
cString | The C string to write into |
maxLength | The maximum number of bytes to write into the C string, including the terminating zero |
encoding | The encoding to use for writing into the C string |
- (bool) hasPrefix: | (OFString*) | prefix |
Checks whether the string has the specified prefix.
prefix | The prefix to check for |
- (bool) hasSuffix: | (OFString*) | suffix |
Checks whether the string has the specified suffix.
suffix | The suffix to check for |
- (uintmax_t) hexadecimalValue |
Returns the hexadecimal value of the string as an uintmax_t.
Leading and trailing whitespaces are ignored.
If the string contains any non-number characters, an OFInvalidEncodingException is thrown.
If the number is too big to fit into an uintmax_t, an OFOutOfRangeException is thrown.
- (id) initWithCharacters: | (const of_unichar_t*) | characters | |
length: | (size_t) | length | |
- (id) initWithContentsOfFile: | (OFString*) | path |
- (id) initWithContentsOfFile: | (OFString*) | path | |
encoding: | (of_string_encoding_t) | encoding | |
- (id) initWithContentsOfURL: | (OFURL*) | URL |
Initializes an already allocated OFString with the contents of the specified URL.
If the URL's scheme is file, it tries UTF-8 encoding.
If the URL's scheme is http(s), it tries to detect the encoding from the HTTP headers. If it could not detect the encoding using the HTTP headers, it tries UTF-8.
URL | The URL to the contents for the string |
- (id) initWithContentsOfURL: | (OFURL*) | URL | |
encoding: | (of_string_encoding_t) | encoding | |
- (id) initWithCString: | (const char*) | cString | |
encoding: | (of_string_encoding_t) | encoding | |
- (id) initWithCString: | (const char*) | cString | |
encoding: | (of_string_encoding_t) | encoding | |
length: | (size_t) | cStringLength | |
- (id) initWithFormat: | (OFConstantString*) | format | |
, | ... | ||
Initializes an already allocated OFString with a format string.
See printf for the format syntax. As an addition, %@ is available as format specifier for objects, C for of_unichar_t and S for const of_unichar_t*.
format | A string used as format to initialize the OFString |
- (id) initWithFormat: | (OFConstantString*) | format | |
arguments: | (va_list) | arguments | |
Initializes an already allocated OFString with a format string.
See printf for the format syntax. As an addition, %@ is available as format specifier for objects, C for of_unichar_t and S for const of_unichar_t*.
format | A string used as format to initialize the OFString |
arguments | The arguments used in the format string |
- (id) initWithString: | (OFString*) | string |
- (id) initWithUTF16String: | (const of_char16_t*) | string |
- (id) initWithUTF16String: | (const of_char16_t*) | string | |
byteOrder: | (of_byte_order_t) | byteOrder | |
- (id) initWithUTF16String: | (const of_char16_t*) | string | |
length: | (size_t) | length | |
- (id) initWithUTF16String: | (const of_char16_t*) | string | |
length: | (size_t) | length | |
byteOrder: | (of_byte_order_t) | byteOrder | |
Initializes an already allocated OFString with a UTF-16 string with the specified length, assuming the specified byte order if no byte order mark is found.
string | The UTF-16 string |
length | The length of the UTF-16 string |
byteOrder | The byte order to assume if there is no byte order mark |
- (id) initWithUTF32String: | (const of_char32_t*) | string |
- (id) initWithUTF32String: | (const of_char32_t*) | string | |
byteOrder: | (of_byte_order_t) | byteOrder | |
- (id) initWithUTF32String: | (const of_char32_t*) | string | |
length: | (size_t) | length | |
- (id) initWithUTF32String: | (const of_char32_t*) | string | |
length: | (size_t) | length | |
byteOrder: | (of_byte_order_t) | byteOrder | |
Initializes an already allocated OFString with a UTF-32 string with the specified length, assuming the specified byte order if no byte order mark is found.
string | The UTF-32 string |
length | The length of the UTF-32 string |
byteOrder | The byte order to assume if there is no byte order mark |
- (id) initWithUTF8String: | (const char*) | UTF8String |
- (id) initWithUTF8String: | (const char*) | UTF8String | |
length: | (size_t) | UTF8StringLength | |
- (id) initWithUTF8StringNoCopy: | (char*) | UTF8String | |
freeWhenDone: | (bool) | freeWhenDone | |
Initializes an already allocated OFString from an UTF-8 encoded C string without copying it, if possible.
UTF8String | A UTF-8 encoded C string to initialize the OFString with |
freeWhenDone | Whether to free the C string when it is not needed anymore |
- (id) JSONValue |
Creates an object from the JSON value of the string.
- (id) JSONValueWithDepthLimit: | (size_t) | depthLimit |
Creates an object from the JSON value of the string.
depthLimit | The maximum depth the parser should accept (defaults to 32 if not specified, 0 means no limit (insecure!)) |
- (OFString *) lastPathComponent |
Returns the last component of the path.
- (size_t) length |
Returns the length of the string in Unicode characters.
- (const char *) lossyCStringWithEncoding: | (of_string_encoding_t) | encoding |
Returns the OFString as a C string in the specified encoding, replacing characters that cannot be represented in the specified encoding with a question mark.
The result is valid until the autorelease pool is released. If you want to use the result outside the scope of the current autorelease pool, you have to copy it.
encoding | The encoding for the C string |
- (OFString *) lowercaseString |
Returns the string in lowercase.
- (OFString *) MD5Hash |
- (id) objectByDeserializing |
Deserializes the receiver into an object.
- (OFArray *) pathComponents |
Returns the components of the path.
- (OFString *) pathExtension |
Returns the file extension of the path.
Creates a path from the specified path components.
components | An array of components for the path |
- (of_range_t) rangeOfString: | (OFString*) | string |
Returns the range of the first occurrence of the string.
string | The string to search |
OF_NOT_FOUND
as start position if it was not found - (of_range_t) rangeOfString: | (OFString*) | string | |
options: | (int) | options | |
Returns the range of the string.
string | The string to search | ||||
options | Options modifying search behaviour. Possible values are:
|
OF_NOT_FOUND
as start position if it was not found - (of_range_t) rangeOfString: | (OFString*) | string | |
options: | (int) | options | |
range: | (of_range_t) | range | |
Returns the range of the string in the specified range.
string | The string to search | ||||
options | Options modifying search behaviour. Possible values are:
| ||||
range | The range in which to search |
OF_NOT_FOUND
as start position if it was not found - (OFString *) RIPEMD160Hash |
- (OFString *) SHA1Hash |
- (OFString *) SHA224Hash |
- (OFString *) SHA256Hash |
- (OFString *) SHA384Hash |
- (OFString *) SHA512Hash |
- (OFString *) stringByAppendingFormat: | (OFConstantString*) | format | |
, | ... | ||
Creates a new string by appending the specified format.
format | A format string which generates the string to append |
- (OFString *) stringByAppendingFormat: | (OFConstantString*) | format | |
arguments: | (va_list) | arguments | |
Creates a new string by appending the specified format.
format | A format string which generates the string to append |
arguments | The arguments used in the format string |
Creates a new string by appending a path component.
component | The path component to append |
Creates a new string by appending another string.
string | The string to append |
- (OFString *) stringByDeletingEnclosingWhitespaces |
Creates a new string by deleting leading and trailing whitespaces.
- (OFString *) stringByDeletingLastPathComponent |
Returns the directory name of the path.
- (OFString *) stringByDeletingLeadingWhitespaces |
Creates a new string by deleting leading whitespaces.
- (OFString *) stringByDeletingPathExtension |
Returns a new string with the file extension of the path removed.
- (OFString *) stringByDeletingTrailingWhitespaces |
Creates a new string by deleting trailing whitespaces.
Creates a new string by prepending another string.
string | The string to prepend |
- (OFString *) stringByReplacingOccurrencesOfString: | (OFString*) | string | |
withString: | (OFString*) | replacement | |
Creates a new string by replacing the occurrences of the specified string with the specified replacement.
string | The string to replace |
replacement | The string with which it should be replaced |
- (OFString *) stringByReplacingOccurrencesOfString: | (OFString*) | string | |
withString: | (OFString*) | replacement | |
options: | (int) | options | |
range: | (of_range_t) | range | |
Creates a new string by replacing the occurrences of the specified string in the specified range with the specified replacement.
string | The string to replace |
replacement | The string with which it should be replaced |
options | Options modifying search behaviour. Possible values are:
|
range | The range in which to replace the string |
- (OFString *) stringByStandardizingPath |
Returns the path with relative sub paths resolved.
- (OFString *) stringByStandardizingURLPath |
Returns the URL path with relative sub paths resolved.
This works similar to stringByStandardizingPath, but is intended for standardization of paths that are part of a URL.
- (OFString *) stringByURLDecoding |
Decodes a string used in a URL.
- (OFString *) stringByURLEncoding |
Encodes a string for use in a URL.
- (OFString *) stringByURLEncodingWithIgnoredCharacters: | (const char*) | ignored |
Encodes a string for use in a URL, but does not escape the specified ignored characters.
ignored | A C string of characters that should not be escaped |
- (OFString *) stringByXMLEscaping |
Escapes a string for use in an XML document.
- (OFString *) stringByXMLUnescapingWithBlock: | (of_string_xml_unescaping_block_t) | block |
Unescapes XML in the string and uses the specified block for unknown entities.
block | A block which handles unknown entities |
- (OFString*) stringByXMLUnescapingWithDelegate: | (nullable id< OFStringXMLUnescapingDelegate >) | delegate |
Unescapes XML in the string and uses the specified delegate for unknown entities.
delegate | An OFXMLUnescapingDelegate as a handler for unknown entities |
+ (instancetype) stringWithCharacters: | (const of_unichar_t*) | characters | |
length: | (size_t) | length | |
+ (instancetype) stringWithContentsOfFile: | (OFString*) | path |
+ (instancetype) stringWithContentsOfFile: | (OFString*) | path | |
encoding: | (of_string_encoding_t) | encoding | |
+ (instancetype) stringWithContentsOfURL: | (OFURL*) | URL |
Creates a new OFString with the contents of the specified URL.
If the URL's scheme is file, it tries UTF-8 encoding.
If the URL's scheme is http(s), it tries to detect the encoding from the HTTP headers. If it could not detect the encoding using the HTTP headers, it tries UTF-8.
URL | The URL to the contents for the string |
+ (instancetype) stringWithContentsOfURL: | (OFURL*) | URL | |
encoding: | (of_string_encoding_t) | encoding | |
+ (instancetype) stringWithCString: | (const char*) | cString | |
encoding: | (of_string_encoding_t) | encoding | |
+ (instancetype) stringWithCString: | (const char*) | cString | |
encoding: | (of_string_encoding_t) | encoding | |
length: | (size_t) | cStringLength | |
+ (instancetype) stringWithFormat: | (OFConstantString*) | format | |
, | ... | ||
+ (instancetype) stringWithString: | (OFString*) | string |
+ (instancetype) stringWithUTF16String: | (const of_char16_t*) | string |
+ (instancetype) stringWithUTF16String: | (const of_char16_t*) | string | |
byteOrder: | (of_byte_order_t) | byteOrder | |
+ (instancetype) stringWithUTF16String: | (const of_char16_t*) | string | |
length: | (size_t) | length | |
+ (instancetype) stringWithUTF16String: | (const of_char16_t*) | string | |
length: | (size_t) | length | |
byteOrder: | (of_byte_order_t) | byteOrder | |
Creates a new OFString from a UTF-16 encoded string with the specified length, assuming the specified byte order if no byte order mark is found.
string | The UTF-16 string |
length | The length of the UTF-16 string |
byteOrder | The byte order to assume if there is no byte order mark |
+ (instancetype) stringWithUTF32String: | (const of_char32_t*) | string |
+ (instancetype) stringWithUTF32String: | (const of_char32_t*) | string | |
byteOrder: | (of_byte_order_t) | byteOrder | |
+ (instancetype) stringWithUTF32String: | (const of_char32_t*) | string | |
length: | (size_t) | length | |
+ (instancetype) stringWithUTF32String: | (const of_char32_t*) | string | |
length: | (size_t) | length | |
byteOrder: | (of_byte_order_t) | byteOrder | |
Creates a new OFString from a UTF-32 encoded string with the specified length, assuming the specified byte order if no byte order mark is found.
string | The UTF-32 string |
length | The length of the UTF-32 string |
byteOrder | The byte order to assume if there is no byte order mark |
+ (instancetype) stringWithUTF8String: | (const char*) | UTF8String |
+ (instancetype) stringWithUTF8String: | (const char*) | UTF8String | |
length: | (size_t) | UTF8StringLength | |
+ (instancetype) stringWithUTF8StringNoCopy: | (char*) | UTF8String | |
freeWhenDone: | (bool) | freeWhenDone | |
- (OFString *) substringWithRange: | (of_range_t) | range |
Creates a substring with the specified range.
range | The range of the substring |
- (OFString *) uppercaseString |
Returns the string in uppercase.
- (const of_char16_t *) UTF16String |
Returns the string in UTF-16 encoding with native byte order.
The result is valid until the autorelease pool is released. If you want to use the result outside the scope of the current autorelease pool, you have to copy it.
- (size_t) UTF16StringLength |
Returns the length of the string in UTF-16 characters.
- (const of_char16_t *) UTF16StringWithByteOrder: | (of_byte_order_t) | byteOrder |
Returns the string in UTF-16 encoding with the specified byte order.
The result is valid until the autorelease pool is released. If you want to use the result outside the scope of the current autorelease pool, you have to copy it.
byteOrder | The byte order for the UTF-16 encoding |
- (const of_char32_t *) UTF32String |
Returns the string in UTF-32 encoding with native byte order.
The result is valid until the autorelease pool is released. If you want to use the result outside the scope of the current autorelease pool, you have to copy it.
- (const of_char32_t *) UTF32StringWithByteOrder: | (of_byte_order_t) | byteOrder |
Returns the string in UTF-32 encoding with the specified byte order.
The result is valid until the autorelease pool is released. If you want to use the result outside the scope of the current autorelease pool, you have to copy it.
byteOrder | The byte order for the UTF-32 encoding |
- (const char *) UTF8String |
- (size_t) UTF8StringLength |
Returns the number of bytes the string needs in UTF-8 encoding.
- (void) writeToFile: | (OFString*) | path |
Writes the string into the specified file using UTF-8 encoding.
path | The path of the file to write to |
- (void) writeToFile: | (OFString*) | path | |
encoding: | (of_string_encoding_t) | encoding | |
Writes the string into the specified file using the specified encoding.
path | The path of the file to write to |
encoding | The encoding to use to write the string into the file |