ObjFW  History of src/OFString.h of 6b34f309da448edf

In order to not accidentally have C strings with \0, an
OFInvalidEncodingException is thrown when trying to get a C string for a
string that contains \0.

In order to get a C string with \0 anyway, a new method
-[insecureCStringWithEncoding:] is added. file: [dfff2d8730] check-in: [6fbc3b18c7] user: js, branch: trunk, size: 47454 [annotate] [blame] [check-ins using] [diff]

Also fixes Doxygen not creating documentation for `static OF_INLINE`
functions. file: [5ec6a2e4f7] check-in: [0c3c3b6efa] user: js, branch: trunk, size: 47114 [annotate] [blame] [check-ins using] [diff]

It has been moved to the "unicode-normalization" branch until it is
ready. file: [d0bd857da9] check-in: [149874777c] user: js, branch: trunk, size: 46484 [annotate] [blame] [check-ins using] [diff]

A better approach would probably be to have a separate header which
makes some classes available to pure C. file: [edccd3970b] check-in: [14c70763b0] user: js, branch: trunk, size: 46643 [annotate] [blame] [check-ins using] [diff]

While the idea sounds nice that the tag name is the class, this means the
serialization includes whether something is mutable or immutable. This means
doing as much as making something immutable changes the serialization, which
can then cause issues after being deserialized. file: [55ba0a041b] check-in: [6ce0093f8d] user: js, branch: trunk, size: 46873 [annotate] [blame] [check-ins using] [diff]

A subclass is free to implement each of those methods however it wants
and doesn't necessarily indeed return an inner pointer, so it is safer
to declare none of them as returning an inner pointer. file: [0d179dd073] check-in: [c8e1b0c2b9] user: js, branch: trunk, size: 46955 [annotate] [blame] [check-ins using] [diff]

The same can be achieved using -[OFString stringByAppendingString:] and
swapping the order of arguments. file: [d0122c5cef] check-in: [114576fe94] user: js, branch: trunk, size: 42752 [annotate] [blame] [check-ins using] [diff]

With TYPEDEF_HIDES_STRUCT set, Doxygen properly handles anonymous
structs and enums that are typedef'd. file: [e4caed5e17] check-in: [2fcf5a3052] user: js, branch: trunk, size: 42489 [annotate] [blame] [check-ins using] [diff]

Even when there is neither files nor sockets, a scheme could still be
registered, for example for files embedded into the binary. file: [d557fd2664] check-in: [1a49ef773d] user: js, branch: trunk, size: 42910 [annotate] [blame] [check-ins using] [diff]

This is only migrating some places, others will be migrated as they are
touched. file: [8eb0a45d6e] check-in: [a0fd103a0b] user: js, branch: trunk, size: 42974 [annotate] [blame] [check-ins using] [diff]

It is not guaranteed that a type encoding for it exists. file: [9976ca688e] check-in: [d74f244ab7] user: js, branch: trunk, size: 42554 [annotate] [blame] [check-ins using] [diff]

This solves the old signed vs. unsigned problem and allows for more
bases than just 8, 10 and 16, as well as auto-detection of the base (if
base is 0). file: [0749f31524] check-in: [b6ee372b98] user: js, branch: trunk, size: 42556 [annotate] [blame] [check-ins using] [diff]

This requires a slight API change to OFWindowsRegistryKey, as the
previous API was depending on RegGetValueW(), which is not available on
Windows XP. file: [18fc9bbd71] check-in: [94f1f0f479] user: js, branch: trunk, size: 41484 [annotate] [blame] [check-ins using] [diff]

This allows ABI stability with the fragile ABI. file: [6ace318746] check-in: [496695d778] user: js, branch: trunk, size: 41069 [annotate] [blame] [check-ins using] [diff]

This is the first step to have different versions of those for different
operating systems, rather than #ifdefs everywhere.

This also has the nice side-effect of not having one implementation in
OFString and another one in OFString_UTF8 anymore. The one in OFString
was a generic version, while the one in OFString_UTF8 was one optimized
for UTF-8 strings. Now only the version optimized for UTF-8 strings
exists, as this is by far the most common string implementation used,
and the overhead of converting from something else to UTF-8 is not more
than converting to UTF-32. file: [47bba28c27] check-in: [7a488c3062] user: js, branch: trunk, size: 40414 [annotate] [blame] [check-ins using] [diff]

There is no reliable way to check if C++ already defined those, as Clang
now defines char{16,32}_t even when it is not in C++ 11 mode. So we
cannot check if we are not in C++ 11 and then define them and otherwise
rely on the C++ 11 types. file: [70879a2fc2] check-in: [505137f25f] user: js, branch: trunk, size: 41759 [annotate] [blame] [check-ins using] [diff]

This improves Swift compatibility. file: [37d4036ea2] check-in: [f3ccf14461] user: js, branch: trunk, size: 37333 [annotate] [blame] [check-ins using] [diff]

Instead, explicitly declare them, as OF_ASSUME_NONNULL_{BEGIN,END} does
not apply to implicit return types. This means that after this commit,
all init methods have a nonnull return type, as they should have. file: [54b5ea6d82] check-in: [2f4e0df8be] user: js, branch: trunk, size: 38342 [annotate] [blame] [check-ins using] [diff]

Casts are now written like types in variable declarations. file: [1f9f9bd1d3] check-in: [4af49a13c3] user: js, branch: trunk, size: 36658 [annotate] [blame] [check-ins using] [diff]

While C11 uses uint_least{16,32}_t for char{16,32}_t in case a system
does not support uint{16,32}_t, we require uint{16,32}_t anyway and want
to make sure that of_char{16,32}_t always have the expected size. file: [df25fe3eba] check-in: [af56e971bd] user: js, branch: trunk, size: 36518 [annotate] [blame] [check-ins using] [diff]

This only differs from codepage 850 by a single code point. file: [c6d4af2673] check-in: [adbf31f2f9] user: js, branch: trunk, size: 36277 [annotate] [blame] [check-ins using] [diff]

Forgot to add 2017, even though I already did quite some changes in
2017. file: [79bdbf48d8] check-in: [44f45c2e35] user: js, branch: trunk, size: 36060 [annotate] [blame] [check-ins using] [diff]

This singleton gives access to all things locale, including the ability
to get localized strings.

This also adds the OF_LOCALIZED() macro. Its first argument is an ID for
the string to be localized and its second argument is the fallback
string to be used if it cannot retrieve the localized string. Following
that are variable name / value pairs to be replaced in the localized
string.

Getting translated strings is not implemented yet: Instead, it always
uses the fallback string.

This also switches ofhttp to localized strings. file: [0fabfb3f71] check-in: [06bcb21fc7] user: js, branch: trunk, size: 36054 [annotate] [blame] [check-ins using] [diff]

This fixes including a non-module header in a module. file: [fa0e84e6e6] check-in: [9c108208ef] user: js, branch: trunk, size: 35885 [annotate] [blame] [check-ins using] [diff]

OFHash is too generic, as this protocol is for cryptographic hashes. It
also solves the ambiguity of the +[hash] method (which is now
+[cryptoHash]), which conflicted with -[hash] on the class itself,
resulting in classes conforming to OFHash not being able to be used as a
key in an OFDictionary. file: [ac066f58da] check-in: [951f530aee] user: js, branch: trunk, size: 35887 [annotate] [blame] [check-ins using] [diff]

It now returns <= 0 on error, with negative values being the number of
bytes it would have needed * -1.

This can be used to detect cut off and how many bytes are missing. file: [f6c039afa4] check-in: [5e2ef97c35] user: js, branch: trunk, size: 35431 [annotate] [blame] [check-ins using] [diff]

While at it, also update the mail address. file: [de3798d3c2] check-in: [cec0f072f8] user: js, branch: 0.8, size: 35500 [annotate] [blame] [check-ins using] [diff]

While at it, also update the mail address. file: [a580fc1ea1] check-in: [2a27cf3000] user: js, branch: trunk, size: 35430 [annotate] [blame] [check-ins using] [diff]

This increases the required GCC version from 4.0 to 4.6 (exception:
Apple GCC, which already supports this with >= 4.0 starting with OS X
10.5). Since even GCC 4.6 is really old by now, there is no point in
still supporting something even older and making the code ugly because
of that. While some hardware and OS support was dropped from GCC 4.6
compared to GCC 4.0, there is nothing in there that would be an
interesting target with the exception of BeOS maybe - but a port to BeOS
can also be achieved using the Haiku support. The other dropped OSes are
mostly old versions of OSes while newer ones are still being supported
(and those newer versions of those OSes still support the same
hardware). file: [df4375ca6f] check-in: [48980f2297] user: js, branch: trunk, size: 35426 [annotate] [blame] [check-ins using] [diff]

This replaces +[OFString nativeOSEncoding]. file: [77d2e6f919] check-in: [ec66e49dca] user: js, branch: trunk, size: 35199 [annotate] [blame] [check-ins using] [diff]

This makes it possible to import ObjFW from Swift. file: [096e5cd183] check-in: [c8a562d8d7] user: js, branch: trunk, size: 35481 [annotate] [blame] [check-ins using] [diff]

@compatibility_alias breaks when enabling the new Clang module support. file: [cf35fc260b] check-in: [ac1ae59c91] user: js, branch: trunk, size: 34978 [annotate] [blame] [check-ins using] [diff]

This replaces OF_STRING_ENCODING_NATIVE, as a define was not flexible
enough (determining the native OS encoding at startup was not possible). file: [0173474bc3] check-in: [e54c8c0368] user: js, branch: trunk, size: 33501 [annotate] [blame] [check-ins using] [diff]

This actually belonged to a commit that has not been pushed yet. file: [2365ec48aa] check-in: [8486e8c42a] user: js, branch: trunk, size: 33201 [annotate] [blame] [check-ins using] [diff]

This reverts 2943b43. It turned out that using %C and %S is possible,
even when mixing code with Cocoa code, as it is possible to introduce
__attribute__((format(__OFString__, ...))) to Clang which just handles
%C and %S as being of_unichar_t instead of unichar like they are handled
for __attribute__((format(__NSString__, ...))).

The Clang patch for __attribute__((format(__OFString__, ...))) has been
submitted, but is not upstream yet, thus the changes for that are not
being committed yet. file: [a2cf91e1c0] check-in: [4b56450a24] user: js, branch: trunk, size: 33226 [annotate] [blame] [check-ins using] [diff]

%K is for const of_unichar_t*. file: [add596737a] check-in: [945ff1043d] user: js, branch: trunk, size: 33226 [annotate] [blame] [check-ins using] [diff]

In Cocoa, %C means unichar, which is unsigned short and thus compilers
expect %C to be unichar when the language is set to ObjC. It would be
hard to let compilers detect whether %C should be unichar or
of_unichar_t, especially when mixing ObjFW and Cocoa code, thus the
change to %k. file: [ddf9f2532e] check-in: [5eada9f7b0] user: js, branch: trunk, size: 33117 [annotate] [blame] [check-ins using] [diff]

This removes -[initWithPath:,...], so that it's finally possible to use
-[initWithPath:] for many places where a workaround like
-[initWithDirectoryPath:] was required before. file: [f3d3ca44b0] check-in: [7c4179ab9b] user: js, branch: trunk, size: 32716 [annotate] [blame] [check-ins using] [diff]

This is required for ZIP files, which can use either codepage 437 or
Unicode. file: [5f3de292e6] check-in: [3912669d91] user: js, branch: trunk, size: 33359 [annotate] [blame] [check-ins using] [diff]

No support for extensions yet.

This obsoletes BinaryPack. file: [eaa607fa2a] check-in: [cba771824e] user: js, branch: trunk, size: 33304 [annotate] [blame] [check-ins using] [diff]

This also removes "bool *stop" from some blocks where it does not make
sense. file: [7dbf74822f] check-in: [e8473b9db8] user: js, branch: trunk, size: 33302 [annotate] [blame] [check-ins using] [diff]

The only places where BOOL is left are those where they are required by
the ABI. file: [855049f2d1] check-in: [c5ef582958] user: js, branch: trunk, size: 33105 [annotate] [blame] [check-ins using] [diff]

For ObjC++, these are defined to char{16,32}_t if C++11 is used. This
means passing e.g. a C++11 UTF-16 string to -[initWithUTF16String:]
works without a warning.

For C11, this is not necessary, as char{16,32}_t are just typedef'd to
uint_least{16,32}_t in <uchar.h> and thus compatible to the definition
of of_char{16,32}_t. The reason for not defining of_char{16,32}_t to
char{16,32}_t when using C11 is that <uchar.h> might be missing and that
char{16,32}_t are not required to be UTF-{16,32}, whereas in C++, they
are required to be UTF-{16,32}. file: [0efe0688a9] check-in: [545b6f740e] user: js, branch: trunk, size: 32041 [annotate] [blame] [check-ins using] [diff]

This reverts 5362941.

Even though *UsingEncoding: is what Foundation uses, *WithEncoding: is
more natural and is more consistent with the rest. Also, this means this
restores it to the API of 0.7. file: [5446e12756] check-in: [9ddd33a258] user: js, branch: trunk, size: 31367 [annotate] [blame] [check-ins using] [diff]

With this change, there is a clear separation between characters and
UTF-32 strings now. Characters are just an array of characters in the
native endianess, with no BOM prepended. UTF-32 on the other hand may
have a BOM and can be swapped and is optionally zero-terminated.

This also fixes a few missing UTF-16 init methods in OFMutableString. file: [da0e74ec07] check-in: [50916b8dbe] user: js, branch: trunk, size: 31369 [annotate] [blame] [check-ins using] [diff]

This partly reverts e8502c7.

The rationale behind this is that, on some OSes, native APIs (on e.g.
Windows) take UTF-16 strings that are zero-terminated.

However, forcing zero-termination for every string so that -[characters]
returns a zero-terminated UTF-32 string does not make sense. Therefore,
in the future, -[UTF32String] will be added, which will include
zero-termination. OFString subclasses can then just return their
internal representation if it includes a terminating zero or create a
copy that has a terminating zero if not. file: [31ec44e41b] check-in: [9d3cd5e5fe] user: js, branch: trunk, size: 28671 [annotate] [blame] [check-ins using] [diff]

* Instead of Unicode "strings", it uses the term "Unicode character
array".
* No terminating 0 character anymore, as these are not C strings
anyway. file: [05df72695a] check-in: [640b225ba7] user: js, branch: trunk, size: 26791 [annotate] [blame] [check-ins using] [diff]

This should make it more future-proof, as adding new options is easier
than adding new methods for each and every combination of options. file: [1cf435b925] check-in: [fcaa549324] user: js, branch: trunk, size: 28036 [annotate] [blame] [check-ins using] [diff]

It is a class cluster now, but there is still much to improve. file: [8719bc5cf6] check-in: [301ee63212] user: js, branch: trunk, size: 24126 [annotate] [blame] [check-ins using] [diff]

This was changed from native to big endian because UCS-2 is defined to
be big endian. file: [2bb04bd0ef] check-in: [f412995e6a] user: js, branch: trunk, size: 24100 [annotate] [blame] [check-ins using] [diff]

This way, we also don't need -std=gnu99 in objfw-config anymore.

Fixes ObjC++, for which -std=gnu99 is invalid and where there is no
restrict. file: [9c1d78f2d3] check-in: [77fe5572fe] user: js, branch: trunk, size: 21388 [annotate] [blame] [check-ins using] [diff]

Also removes -[appendCStringWithoutUTF8Checking:] as it is dangerous and
not compatible with this optimization. file: [d7444f1cd5] check-in: [36e8a94f34] user: js, branch: trunk, size: 21371 [annotate] [blame] [check-ins using] [diff]

ivars are now named like this: thisIsAnIVar. If an accessor exists for
the ivar, the ivar is named like the accessor. This is required for
@property to work. file: [1828092a6a] check-in: [37db8f0fb3] user: js, branch: trunk, size: 10096 [annotate] [blame] [check-ins using] [diff]

Changesets:
* b95fcaa6d694
* 804c68d222b4
* da8cd738da3d
* 1109d5ce3419
* d03f5c1ca95d
* 2a7017722165
* 4fccdc79eeb7
* d228149fbc04
* 8782d412a4a6 file: [8df36d219e] check-in: [b91a8283fe] user: js, branch: 0.2, size: 8093 [annotate] [blame] [check-ins using] [diff]

* Add OFComparable protocol.
* Add OFInvalidArgument exception - needs that sel_getName vs.
sel_get_name stuff again, therefore reintroduce it.
* Implement proper copy method for OFString and OFArray.
* Add isEqual: and compare: for OFString and OFArray. file: [d0143637ff] check-in: [61a6ac873a] user: js, branch: trunk, size: 3549 [annotate] [blame] [check-ins using] [diff]

Just to be sure that we won't get any conflicts when someone addes new
hashes. file: [71a7d2b095] check-in: [9759533b97] user: js, branch: trunk, size: 815 [annotate] [blame] [check-ins using] [diff]

The reworked OFObject lets one test fail on the GNU runtime.
Unfortunately, I have no idea why... file: [19fb63cd94] check-in: [e47ad44290] user: js, branch: trunk, size: 819 [annotate] [blame] [check-ins using] [diff]

* OFObject getMem: renamd to getMemWithSize:.
* OFString compare: renamed to compareTo:.
* Exceptions don't throw itself anymore.
* Exceptions include an error string now.
* Exceptions now got raise and string.
* New methods for OFFile:
* changeModeOfFile:toMode:
* changeOwnerOfFile:toOwner:andGroup:
* delete:
* link:to:
* symlink:to:
* OFFile isEndOfFile renamd to atEndOfFile
* OFNotImplementedExeception newWithObject:andMethod renamed to
newWithObject:andSelector:.
* Tests updated accordingly.
* TODO list added. file: [6806a7a1f1] check-in: [b597d49f43] user: js, branch: trunk, size: 744 [annotate] [blame] [check-ins using] [diff]