@@ -94,35 +94,37 @@ @property (readonly) size_t cStringLength; @property (readonly) size_t length; #endif /** - * \return A new autoreleased OFString + * \brief Creates a new OFString. + * + * \return A new, autoreleased OFString */ + string; /** - * Creates a new OFString from a UTF-8 encoded C string. + * \brief Creates a new OFString from a UTF-8 encoded C string. * * \param cString A UTF-8 encoded C string to initialize the OFString with * \return A new autoreleased OFString */ + stringWithCString: (const char*)cString; /** - * Creates a new OFString from a C string with the specified encoding. + * \brief Creates a new OFString from a C string with the specified encoding. * * \param string A C string to initialize the OFString with * \param encoding The encoding of the C string * \return A new autoreleased OFString */ + stringWithCString: (const char*)cString encoding: (of_string_encoding_t)encoding; /** - * Creates a new OFString from a C string with the specified encoding and - * length. + * \brief Creates a new OFString from a C string with the specified encoding + * and length. * * \param cString A C string to initialize the OFString with * \param encoding The encoding of the C string * \param cStringLength The length of the C string * \return A new autoreleased OFString @@ -130,60 +132,61 @@ + stringWithCString: (const char*)cString encoding: (of_string_encoding_t)encoding length: (size_t)cStringLength; /** - * Creates a new OFString from a UTF-8 encoded C string with the specified - * length. + * \brief Creates a new OFString from a UTF-8 encoded C string with the + * specified length. * * \param cString A UTF-8 encoded C string to initialize the OFString with * \param cStringLength The length of the UTF-8 encoded C string * \return A new autoreleased OFString */ + stringWithCString: (const char*)cString length: (size_t)cStringLength; /** - * Creates a new OFString from another string. + * \brief Creates a new OFString from another string. * * \param string A string to initialize the OFString with * \return A new autoreleased OFString */ + stringWithString: (OFString*)string; /** - * Creates a new OFString from a unicode string. + * \brief Creates a new OFString from a unicode string. * * \param string The unicode string * \return A new autoreleased OFString */ + stringWithUnicodeString: (of_unichar_t*)string; /** - * Creates a new OFString from a unicode string, assuming the specified byte - * order if no BOM is found. + * \brief Creates a new OFString from a unicode string, assuming the specified + * byte order if no BOM is found. * * \param string The unicode string * \param byteOrder The byte order to assume if there is no BOM * \return A new autoreleased OFString */ + stringWithUnicodeString: (of_unichar_t*)string byteOrder: (of_endianess_t)byteOrder; /** - * Creates a new OFString from a unicode string with the specified length. + * \brief Creates a new OFString from a unicode string with the specified + * length. * * \param string The unicode string * \param length The length of the unicode string * \return A new autoreleased OFString */ + stringWithUnicodeString: (of_unichar_t*)string length: (size_t)length; /** - * Creates a new OFString from a unicode string with the specified length, - * assuming the specified byte order if no BOM is found. + * \brief Creates a new OFString from a unicode string with the specified + * length, assuming the specified byte order if no BOM is found. * * \param string The unicode string * \param byteOrder The byte order to assume if there is no BOM * \param length The length of the unicode string * \return A new autoreleased OFString @@ -191,42 +194,43 @@ + stringWithUnicodeString: (of_unichar_t*)string byteOrder: (of_endianess_t)byteOrder length: (size_t)length; /** - * Creates a new OFString from a UTF-16 encoded string. + * \brief Creates a new OFString from a UTF-16 encoded string. * * \param string The UTF-16 string * \return A new autoreleased OFString */ + stringWithUTF16String: (uint16_t*)string; /** - * Creates a new OFString from a UTF-16 encoded string, assuming the specified - * byte order if no BOM is found. + * \brief Creates a new OFString from a UTF-16 encoded string, assuming the + * specified byte order if no BOM is found. * * \param string The UTF-16 string * \param byteOrder The byte order to assume if there is no BOM * \return A new autoreleased OFString */ + stringWithUTF16String: (uint16_t*)string byteOrder: (of_endianess_t)byteOrder; /** - * Creates a new OFString from a UTF-16 encoded string with the specified - * length. + * \brief Creates a new OFString from a UTF-16 encoded string with the specified + * length. * * \param string The UTF-16 string * \param length The length of the unicode string * \return A new autoreleased OFString */ + stringWithUTF16String: (uint16_t*)string length: (size_t)length; /** - * Creates a new OFString from a UTF-16 encoded string with the specified - * length, assuming the specified byte order if no BOM is found. + * \brief Creates a new OFString from a UTF-16 encoded string with the + * specified length, assuming the specified byte order if no BOM is + * found. * * \param string The UTF-16 string * \param byteOrder The byte order to assume if there is no BOM * \param length The length of the unicode string * \return A new autoreleased OFString @@ -234,11 +238,11 @@ + stringWithUTF16String: (uint16_t*)string byteOrder: (of_endianess_t)byteOrder length: (size_t)length; /** - * Creates a new OFString from a format string. + * \brief Creates a new OFString from a format string. * * See printf for the format syntax. As an addition, %@ is available as format * specifier for objects. * * \param format A string used as format to initialize the OFString @@ -245,38 +249,39 @@ * \return A new autoreleased OFString */ + stringWithFormat: (OFConstantString*)format, ...; /** - * Creates a new OFString containing the constructed specified path. + * \brief Creates a new OFString containing the constructed specified path. * * \param firstComponent The first component of the path * \return A new autoreleased OFString */ + stringWithPath: (OFString*)firstComponent, ...; /** - * Creates a new OFString with the contents of the specified UTF-8 encoded file. + * \brief Creates a new OFString with the contents of the specified UTF-8 + * encoded file. * * \param path The path to the file * \return A new autoreleased OFString */ + stringWithContentsOfFile: (OFString*)path; /** - * Creates a new OFString with the contents of the specified file in the - * specified encoding. + * \brief Creates a new OFString with the contents of the specified file in the + * specified encoding. * * \param path The path to the file * \param encoding The encoding of the file * \return A new autoreleased OFString */ + stringWithContentsOfFile: (OFString*)path encoding: (of_string_encoding_t)encoding; /** - * Creates a new OFString with the contents of the specified URL. + * \brief 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 @@ -286,42 +291,43 @@ * \return A new autoreleased OFString */ + stringWithContentsOfURL: (OFURL*)URL; /** - * Creates a new OFString with the contents of the specified URL in the - * specified encoding. + * \brief Creates a new OFString with the contents of the specified URL in the + * specified encoding. * * \param URL The URL to the contents for the string * \param encoding The encoding to assume * \return A new autoreleased OFString */ + stringWithContentsOfURL: (OFURL*)URL encoding: (of_string_encoding_t)encoding; /** - * Initializes an already allocated OFString from a UTF-8 encoded C string. + * \brief Initializes an already allocated OFString from a UTF-8 encoded C + * string. * * \param cString A UTF-8 encoded C string to initialize the OFString with * \return An initialized OFString */ - initWithCString: (const char*)cString; /** - * Initializes an already allocated OFString from a C string with the specified - * encoding. + * \brief Initializes an already allocated OFString from a C string with the + * specified encoding. * * \param cString A C string to initialize the OFString with * \param encoding The encoding of the C string * \return An initialized OFString */ - initWithCString: (const char*)cString encoding: (of_string_encoding_t)encoding; /** - * Initializes an already allocated OFString from a C string with the specified - * encoding and length. + * \brief Initializes an already allocated OFString from a C string with the + * specified encoding and length. * * \param cString A C string to initialize the OFString with * \param encoding The encoding of the C string * \param cStringLength The length of the C string * \return An initialized OFString @@ -329,61 +335,62 @@ - initWithCString: (const char*)cString encoding: (of_string_encoding_t)encoding length: (size_t)cStringLength; /** - * Initializes an already allocated OFString from a UTF-8 encoded C string with - * the specified length. + * \brief Initializes an already allocated OFString from a UTF-8 encoded C + * string with the specified length. * * \param cString A UTF-8 encoded C string to initialize the OFString with * \param cStringLength The length of the UTF-8 encoded C string * \return An initialized OFString */ - initWithCString: (const char*)cString length: (size_t)cStringLength; /** - * Initializes an already allocated OFString with another string. + * \brief Initializes an already allocated OFString with another string. * * \param string A string to initialize the OFString with * \return An initialized OFString */ - initWithString: (OFString*)string; /** - * Initializes an already allocated OFString with a unicode string. + * \brief Initializes an already allocated OFString with a unicode string. * * \param string The unicode string * \return An initialized OFString */ - initWithUnicodeString: (of_unichar_t*)string; /** - * Initializes an already allocated OFString with a unicode string, assuming the - * specified byte order if no BOM is found. + * \brief Initializes an already allocated OFString with a unicode string, + * assuming the specified byte order if no BOM is found. * * \param string The unicode string * \param byteOrder The byte order to assume if there is no BOM * \return An initialized OFString */ - initWithUnicodeString: (of_unichar_t*)string byteOrder: (of_endianess_t)byteOrder; /** - * Initializes an already allocated OFString with a unicode string with the - * specified length. + * \brief Initializes an already allocated OFString with a unicode string with + * the specified length. * * \param string The unicode string * \param length The length of the unicode string * \return An initialized OFString */ - initWithUnicodeString: (of_unichar_t*)string length: (size_t)length; /** - * Initializes an already allocated OFString with a unicode string with the - * specified length, assuming the specified byte order if no BOM is found. + * \brief Initializes an already allocated OFString with a unicode string with + * the specified length, assuming the specified byte order if no BOM is + * found. * * \param string The unicode string * \param byteOrder The byte order to assume if there is no BOM * \param length The length of the unicode string * \return An initialized OFString @@ -391,42 +398,43 @@ - initWithUnicodeString: (of_unichar_t*)string byteOrder: (of_endianess_t)byteOrder length: (size_t)length; /** - * Initializes an already allocated OFString with a UTF-16 string. + * \brief Initializes an already allocated OFString with a UTF-16 string. * * \param string The UTF-16 string * \return An initialized OFString */ - initWithUTF16String: (uint16_t*)string; /** - * Initializes an already allocated OFString with a UTF-16 string, assuming the - * specified byte order if no BOM is found. + * \brief Initializes an already allocated OFString with a UTF-16 string, + * assuming the specified byte order if no BOM is found. * * \param string The UTF-16 string * \param byteOrder The byte order to assume if there is no BOM * \return An initialized OFString */ - initWithUTF16String: (uint16_t*)string byteOrder: (of_endianess_t)byteOrder; /** - * Initializes an already allocated OFString with a UTF-16 string with the - * specified length. + * \brief Initializes an already allocated OFString with a UTF-16 string with + * the specified length. * * \param string The UTF-16 string * \param length The length of the UTF-16 string * \return An initialized OFString */ - initWithUTF16String: (uint16_t*)string length: (size_t)length; /** - * Initializes an already allocated OFString with a UTF-16 string with the - * specified length, assuming the specified byte order if no BOM is found. + * \brief Initializes an already allocated OFString with a UTF-16 string with + * the specified length, assuming the specified byte order if no BOM is + * found. * * \param string The UTF-16 string * \param byteOrder The byte order to assume if there is no BOM * \param length The length of the UTF-16 string * \return An initialized OFString @@ -434,11 +442,11 @@ - initWithUTF16String: (uint16_t*)string byteOrder: (of_endianess_t)byteOrder length: (size_t)length; /** - * Initializes an already allocated OFString with a format string. + * \brief 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. * * \param format A string used as format to initialize the OFString @@ -445,11 +453,11 @@ * \return An initialized OFString */ - initWithFormat: (OFConstantString*)format, ...; /** - * Initializes an already allocated OFString with a format string. + * \brief 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. * * \param format A string used as format to initialize the OFString @@ -458,52 +466,52 @@ */ - initWithFormat: (OFConstantString*)format arguments: (va_list)arguments; /** - * Initializes an already allocated OFString with the constructed specified - * path. + * \brief Initializes an already allocated OFString with the constructed + * specified path. * * \param firstComponent The first component of the path * \return A new autoreleased OFString */ - initWithPath: (OFString*)firstComponent, ...; /** - * Initializes an already allocated OFString with the constructed specified - * path. + * \brief Initializes an already allocated OFString with the constructed + * specified path. * * \param firstComponent The first component of the path * \param arguments A va_list with the other components of the path * \return A new autoreleased OFString */ - initWithPath: (OFString*)firstComponent arguments: (va_list)arguments; /** - * Initializes an already allocated OFString with the contents of the specified - * file in the specified encoding. + * \brief Initializes an already allocated OFString with the contents of the + * specified file in the specified encoding. * * \param path The path to the file * \return An initialized OFString */ - initWithContentsOfFile: (OFString*)path; /** - * Initializes an already allocated OFString with the contents of the specified - * file in the specified encoding. + * \brief Initializes an already allocated OFString with the contents of the + * specified file in the specified encoding. * * \param path The path to the file * \param encoding The encoding of the file * \return An initialized OFString */ - initWithContentsOfFile: (OFString*)path encoding: (of_string_encoding_t)encoding; /** - * Initializes an already allocated OFString with the contents of the specified - * URL. + * \brief 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 @@ -513,215 +521,252 @@ * \return An initialized OFString */ - initWithContentsOfURL: (OFURL*)URL; /** - * Initializes an already allocated OFString with the contents of the specified - * URL in the specified encoding. + * \brief Initializes an already allocated OFString with the contents of the + * specified URL in the specified encoding. * * \param URL The URL to the contents for the string * \param encoding The encoding to assume * \return An initialized OFString */ - initWithContentsOfURL: (OFURL*)URL encoding: (of_string_encoding_t)encoding; /** + * \brief Returns the OFString as a UTF-8 encoded C string. + * * \return The OFString as a UTF-8 encoded C string */ - (const char*)cString; /** + * \brief Returns the length of the string in Unicode characters. + * * \return The length of the string in Unicode characters */ - (size_t)length; /** + * \brief Returns the length of the string which cString would return. + * * \return The length of the string which cString would return */ - (size_t)cStringLength; /** - * Compares the OFString to another OFString without caring about the case. + * \brief Compares the OFString to another OFString without caring about the + * case. * * \param otherString A string to compare with * \return An of_comparison_result_t */ - (of_comparison_result_t)caseInsensitiveCompare: (OFString*)otherString; /** + * \brief Returns the Unicode character at the specified index. + * * \param index The index of the Unicode character to return * \return The Unicode character at the specified index */ - (of_unichar_t)characterAtIndex: (size_t)index; /** + * \brief Returns the index of the first occurrence of the string. + * * \param string The string to search * \return The index of the first occurrence of the string or OF_INVALID_INDEX * if it was not found */ - (size_t)indexOfFirstOccurrenceOfString: (OFString*)string; /** + * \brief Returns the index of the last occurrence of the string. + * * \param string The string to search * \return The index of the last occurrence of the string or OF_INVALID_INDEX if * it was not found */ - (size_t)indexOfLastOccurrenceOfString: (OFString*)string; /** + * \brief Returns whether the string contains the specified string. + * * \param string The string to search * \return Whether the string contains the specified string */ - (BOOL)containsString: (OFString*)string; /** + * \brief Creates a substring with the specified range. + * * \param range The range of the substring * \return The substring as a new autoreleased OFString */ - (OFString*)substringWithRange: (of_range_t)range; /** - * Creates a new string by appending another string. + * \brief Creates a new string by appending another string. * * \param string The string to append * \return A new autoreleased OFString with the specified string appended */ - (OFString*)stringByAppendingString: (OFString*)string; /** - * Creates a new string by prepending another string. + * \brief Creates a new string by prepending another string. * * \param string The string to prepend * \return A new autoreleased OFString with the specified string prepended */ - (OFString*)stringByPrependingString: (OFString*)string; /** - * Creates a new string by replacing the occurrences of the specified string - * with the specified replacement. + * \brief Creates a new string by replacing the occurrences of the specified + * string with the specified replacement. * * \param string The string to replace * \param replacement The string with which it should be replaced * \return A new string with the occurrences of the specified string replaced */ - (OFString*)stringByReplacingOccurrencesOfString: (OFString*)string withString: (OFString*)replacement; /** + * \brief Returns the string in uppercase. + * * \return The string in uppercase */ - (OFString*)uppercaseString; /** + * \brief Returns the string in lowercase. + * * \return The string in lowercase */ - (OFString*)lowercaseString; /** - * Creates a new string by deleting leading whitespaces. + * \brief Creates a new string by deleting leading whitespaces. * * \return A new autoreleased OFString with leading whitespaces deleted */ - (OFString*)stringByDeletingLeadingWhitespaces; /** - * Creates a new string by deleting trailing whitespaces. + * \brief Creates a new string by deleting trailing whitespaces. * * \return A new autoreleased OFString with trailing whitespaces deleted */ - (OFString*)stringByDeletingTrailingWhitespaces; /** - * Creates a new string by deleting leading and trailing whitespaces. + * \brief Creates a new string by deleting leading and trailing whitespaces. * * \return A new autoreleased OFString with leading and trailing whitespaces * deleted */ - (OFString*)stringByDeletingEnclosingWhitespaces; /** - * Checks whether the string has the specified prefix. + * \brief Checks whether the string has the specified prefix. * * \param prefix The prefix to check for * \return A boolean whether the string has the specified prefix */ - (BOOL)hasPrefix: (OFString*)prefix; /** - * Checks whether the string has the specified suffix. + * \brief Checks whether the string has the specified suffix. * * \param suffix The suffix to check for * \return A boolean whether the string has the specified suffix */ - (BOOL)hasSuffix: (OFString*)suffix; /** - * Splits an OFString into an OFArray of OFStrings. + * \brief Splits an OFString into an OFArray of OFStrings. * * \param delimiter The delimiter for splitting * \return An autoreleased OFArray with the split string */ - (OFArray*)componentsSeparatedByString: (OFString*)delimiter; /** + * \brief Returns the components of the path. + * * \return The components of the path */ - (OFArray*)pathComponents; /** + * \brief Returns the last component of the path. + * * \return The last component of the path */ - (OFString*)lastPathComponent; /** + * \brief Returns the directory name of the path. + * * \return The directory name of the path */ - (OFString*)stringByDeletingLastPathComponent; /** - * Returns the decimal value of the string as an intmax_t or throws an - * OFInvalidEncodingException if the string contains any non-number characters. + * \brief 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. * * \return An intmax_t with the value of the string */ - (intmax_t)decimalValue; /** - * Returns the hexadecimal value of the string as an uintmax_t or throws an - * OFInvalidEncodingException if the string contains any non-number characters. + * \brief 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. * * \return A uintmax_t with the value of the string */ - (uintmax_t)hexadecimalValue; /** - * Returns the float value of the string as a float or throws an - * OFInvalidEncodingException if the string contains any non-number characters. + * \brief Returns the float value of the string as a float. + * + * If the string contains any non-number characters, an + * OFInvalidEncodingException is thrown. * * \return A float with the value of the string */ - (float)floatValue; /** - * Returns the double value of the string as a float or throws an - * OFInvalidEncodingException if the string contains any non-number characters. + * \brief Returns the double value of the string as a double. + * + * If the string contains any non-number characters, an + * OFInvalidEncodingException is thrown. * * \return A double with the value of the string */ - (double)doubleValue; /** - * Returns the string as an array of of_unichar_t. + * \brief Returns the string as an array of of_unichar_ts. * * 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. * @@ -728,11 +773,11 @@ * \return The string as an array of Unicode characters */ - (of_unichar_t*)unicodeString; /** - * Writes the string into the specified file using UTF-8 encoding. + * \brief Writes the string into the specified file using UTF-8 encoding. * * \param path The path of the file to write to */ - (void)writeToFile: (OFString*)path; @end