ObjFW  History of src/OFStream.m of 4cecf8225477979e

It doesn't seem to be needed anymore. file: [14f0d5ccca] check-in: [cf0effe834] user: js, branch: trunk, size: 30059 [annotate] [blame] [check-ins using] [diff]

This allows for a much cleaner solution to avoid the internal read
buffer of e.g. a TLS connection never being processed while waiting for
a delimiter. file: [be4eb53104] check-in: [a61e0594b4] user: js, branch: trunk, size: 30080 [annotate] [blame] [check-ins using] [diff]

This uses the same format as OFEnsure(). file: [5428225ee7] check-in: [c86b8f10f0] user: js, branch: trunk, size: 29986 [annotate] [blame] [check-ins using] [diff]

Those are never used in practice. file: [d373c9afb1] check-in: [808601a0cc] user: js, branch: trunk, size: 30001 [annotate] [blame] [check-ins using] [diff]

The old write API made it too easy to lose bytes when a stream is set to
non-blocking mode. The new API always throws when not all bytes were
written, which forces handling the number of bytes being written being
smaller than the number of bytes requested to be written. file: [e612790724] check-in: [d1d36ae522] user: js, branch: trunk, size: 39333 [annotate] [blame] [check-ins using] [diff]

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

The new names should be more accurate. file: [c6022abcb0] check-in: [627511b032] user: js, branch: trunk, size: 39565 [annotate] [blame] [check-ins using] [diff]

-[allocMemoryWithSize:] has book keeping overhead that is unnecessary
for temporary memory. file: [631572b875] check-in: [0ddaac3f5b] user: js, branch: trunk, size: 39862 [annotate] [blame] [check-ins using] [diff]

While it makes sense to wrap malloc and calloc to replace the error
checking with exceptions, it does not make sense to wrap free. file: [a4e5576272] check-in: [3d8286feee] user: js, branch: trunk, size: 40556 [annotate] [blame] [check-ins using] [diff]

This makes it easier to reuse code for other datagram sockets, namely
IPX. file: [c63329fd4a] check-in: [b02c4b05bb] user: js, branch: trunk, size: 40740 [annotate] [blame] [check-ins using] [diff]

This avoids accidentally trying to remove a closed file descriptor from
a kernel event observer. file: [2c231bfb94] check-in: [321fa12f9a] user: js, branch: trunk, size: 40812 [annotate] [blame] [check-ins using] [diff]

This avoids the entire problem of keeping the buffer alive until the
write finished. file: [4879805b8b] check-in: [f218986f51] user: js, branch: trunk, size: 38513 [annotate] [blame] [check-ins using] [diff]

The target / selector approach had several drawbacks:

* It was inconvenient to use, as for every read or write, a target,
selector and context would need to be specified.
* It lacked any kind of type-safety and would not even warn about using
a callback method with the wrong number of parameters.
* It encouraged using a different callback method for each read or
write call, which results in code that is hard to follow and also
slower (as it needs to recreate the async operation with a new
callback every time). file: [a08f06103a] check-in: [d16ad96cbd] user: js, branch: trunk, size: 38772 [annotate] [blame] [check-ins using] [diff]

This pretends that net_getsockopt() exists, which it does not yet. As
soon as it lands in libogc, this will work again. file: [e66876a272] check-in: [bed2db0fd3] user: js, branch: trunk, size: 36963 [annotate] [blame] [check-ins using] [diff]

Instead of letting OFStream conform to it, which itself does not really
conform to it, let all the subclasses that actually do conform to it. file: [e841a9f1c7] check-in: [69749b6a5b] user: js, branch: trunk, size: 36251 [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: [313554e809] check-in: [2f4e0df8be] user: js, branch: trunk, size: 35420 [annotate] [blame] [check-ins using] [diff]

Instead, let reads return 0 and let writes append after the end. file: [7e042e0447] check-in: [f9cd4f9cab] user: js, branch: trunk, size: 33838 [annotate] [blame] [check-ins using] [diff]

This reduces the ifdef hell and makes much more sense, as with ixemul,
no native calls are allowed. file: [ffb5628418] check-in: [c9621825fc] user: js, branch: trunk, size: 31597 [annotate] [blame] [check-ins using] [diff]

This matches Apple's style. file: [563c34066f] check-in: [6b77a5dd8b] user: js, branch: trunk, size: 31537 [annotate] [blame] [check-ins using] [diff]

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

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

Right now, this is only useful for OFTCPSocket, as this is the only
class so far not establishing the stream in the init method. However,
this adds the general infrastructure to allow reuse to all subclasses of
OFStream. file: [48141a71fe] check-in: [1de551cb5f] user: js, branch: trunk, size: 31424 [annotate] [blame] [check-ins using] [diff]

This was forgotten when adding the caching optimizations: It still tried
to free _readBuffer instead of _readBufferMemory, which failed as the
sanity checks noticed that _readBuffer is not the pointer that had been
allocated. file: [b4ba3031a1] check-in: [28fe0a104d] user: js, branch: trunk, size: 31187 [annotate] [blame] [check-ins using] [diff]

In some situations, this is 50x faster. file: [3e396d5660] check-in: [a7d66e7ab2] user: js, branch: trunk, size: 31181 [annotate] [blame] [check-ins using] [diff]

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

While at it, also update the mail address. file: [9229ae9098] check-in: [2a27cf3000] user: js, branch: trunk, size: 30769 [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: [dd5879d93a] check-in: [48980f2297] user: js, branch: trunk, size: 30765 [annotate] [blame] [check-ins using] [diff]

The old behaviour where the exception would access errno directly on
creation of the exception was very fragile. The two main problems with
it were that sometimes it would pick up an errno even though none had
been set and in other cases that when the exception was created errno
had already been overridden.

This also greatly increases errno handling on Win32, especially in
conjunction with sockets. It can still be improved further, though. file: [298e596b16] check-in: [62e2de30b9] user: js, branch: trunk, size: 30737 [annotate] [blame] [check-ins using] [diff]

This means that OFObject.h imports macros.h now, making it unnecessary
to manually import macros.h in almost every file. And while at it, also
import autorelease.h in OFObject.h, so that this doesn't need to be
manually imported in almost every file as well. file: [8ee1cb7e9e] check-in: [13ee56edf3] user: js, branch: trunk, size: 30658 [annotate] [blame] [check-ins using] [diff]

This replaces -[numberOfBytesInReadBuffer], as it's not always known how
many bytes there are exactly and thus the number would often be wrong
(e.g. because data is compressed). file: [6cbe514a9d] check-in: [acc999a75e] user: js, branch: trunk, size: 30677 [annotate] [blame] [check-ins using] [diff]

This mostly removes the argument for the class in which the exception
occurred. As backtraces were recently added for all platforms, the
passed class does not give any extra information on where the exception
occurred anymore.

This also removes a few other arguments which were not too helpful. In
the past, the idea was to pass as many arguments as possible so that it
is easier to find the origin of the exception. However, as backtraces
are a much better way to find the origin, those are not useful anymore
and just make the exception more cumbersome to use. The rule is now to
only pass arguments that might help in recovering from the exception or
provide information that is otherwise not easily accessible. file: [cfbf6fbabe] check-in: [3d16a30f41] user: js, branch: trunk, size: 30357 [annotate] [blame] [check-ins using] [diff]

It is now called -[readDataArrayWithCount:]. file: [2d4bdd05bf] check-in: [eceebefeab] user: js, branch: trunk, size: 30605 [annotate] [blame] [check-ins using] [diff]

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

It is now called -[numberOfBytesInReadBuffer].

Additionally, this commit renames OFStream's _cache to _readBuffer. file: [826cbee6d8] check-in: [efe7be259d] user: js, branch: trunk, size: 30470 [annotate] [blame] [check-ins using] [diff]

-[setBlocking:] correctly works for unidirectional streams now. file: [3a3eebc79f] check-in: [436f274d65] user: js, branch: trunk, size: 29696 [annotate] [blame] [check-ins using] [diff]

This also renames the getter to -[isWriteBufferEnabled]. file: [bb57582da1] check-in: [b96b150ce3] user: js, branch: trunk, size: 29043 [annotate] [blame] [check-ins using] [diff]

It is now -[write*:encoding:]. file: [94745f6f8c] check-in: [5405bd5c5f] user: js, branch: trunk, size: 29041 [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: [c8e036b974] check-in: [9ddd33a258] user: js, branch: trunk, size: 29055 [annotate] [blame] [check-ins using] [diff]

This makes it clear that multiple evaluation of parameters is possible. file: [1ba71f5d61] check-in: [1cb8fee5c3] user: js, branch: trunk, size: 28993 [annotate] [blame] [check-ins using] [diff]

Async connecting is still missing. file: [c4d6ff9c2a] check-in: [4d9a641d87] user: js, branch: trunk, size: 28993 [annotate] [blame] [check-ins using] [diff]

It is now -[fileDescriptorForReading] and -[fileDescriptorForWriting].
The split was necessary as some stream types (e.g. OFProcess) don't have
a single file descriptor, but two. This allows to use those stream types
with OFStreamObserver as well. file: [6992f1ccb5] check-in: [440e95fd4a] user: js, branch: trunk, size: 26949 [annotate] [blame] [check-ins using] [diff]

Also fix a bug where OFBigDataArray would waste memory. file: [a84cb06e69] check-in: [f7576a66ce] user: js, branch: trunk, size: 26916 [annotate] [blame] [check-ins using] [diff]

Also adds more checks. file: [4d96b81ee9] check-in: [d5ddb2cb48] user: js, branch: trunk, size: 26850 [annotate] [blame] [check-ins using] [diff]

This is safe as an "exception loop" can't happen, since if allocating
an exception fails, it throws an OFAllocFailedException which is
preallocated and can always be thrown.

So, the worst case would be that an autorelease of an exception fails,
triggering an OFOutOfMemoryException for which there is no memory,
resulting in an OFAllocFailedException to be thrown. file: [8092efbfd1] check-in: [e1e7ffa903] user: js, branch: trunk, size: 26808 [annotate] [blame] [check-ins using] [diff]

This makes it impossible for the developer to accidentally create a DoS.
When data has been received after calling -[tryReadLine] and the string
is still incomplete, -[streamIsReadyForReading:] will not be called
anymore until new data has been received, thus preventing spinning in a
loop. file: [d011dc479a] check-in: [535c2d5d9b] user: js, branch: trunk, size: 26698 [annotate] [blame] [check-ins using] [diff]

They should be as fast as they were before -[tryReadLine] etc. were
introduced now. file: [c69f9cbafe] check-in: [295193f0b9] user: js, branch: trunk, size: 27024 [annotate] [blame] [check-ins using] [diff]

Without this, the headers try to declare functions that use __block as
an argument name and thus fail to compile when using -fblocks. file: [3a59210341] check-in: [59e52af26d] user: js, branch: 0.5, size: 14217 [annotate] [blame] [check-ins using] [diff]

Without this, the headers try to declare functions that use __block as
an argument name and thus fail to compile when using -fblocks. file: [e3e9e24720] check-in: [da2701ad14] user: js, branch: trunk, size: 25828 [annotate] [blame] [check-ins using] [diff]

This way, the method to determine whether OFStreamSocket should
call the delegate can be overriden by subclasses, for example
for SSL sockets. file: [3989a671e1] check-in: [f4151a36e3] user: js, branch: trunk, size: 14214 [annotate] [blame] [check-ins using] [diff]

SIGPIPE is quite useless and contraproductive as we throw an
OFWriteFailedException anyway. file: [f885e71d37] check-in: [1404d33024] user: js, branch: trunk, size: 13954 [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: [451931881c] check-in: [37db8f0fb3] user: js, branch: trunk, size: 12405 [annotate] [blame] [check-ins using] [diff]

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

Before, it could call memcpy with size of 0 on a pointer that might be
NULL and thus might be undefined behaviour. This way, it's compatible to
the OFSocket change in the commit before. file: [b556a211fc] check-in: [b464ddcda5] user: js, branch: trunk, size: 4592 [annotate] [blame] [check-ins using] [diff]

OFExceptions:
* OFNoMemException to OFOutOfMemoryException.
* OFMemNotPartOfObjException to OFMemoryNotPartOfObjectException.

OFObject:
* -[addItemToMemoryPool:] to -[addMemoryToPool:].
* -[allocWithSize:] to -[allocMemoryWithSize:].
* -[allocNItems:withSize] to -[allocMemoryForNItems:withSize:].
* -[resizeMem:toSize] to -[resizeMemory:toSize:].
* -[resizeMem:toNItems:withSize:] to
-[resizeMemoryToNItems:withSize:].
* -[freeMem] to -[freeMemory:].

OFString:
* -[urlencode] to -[urlEncodedString].
* -[urldecode] to -[urlDecodedString]. file: [3f64dd68d8] check-in: [033054ad75] user: js, branch: trunk, size: 3921 [annotate] [blame] [check-ins using] [diff]

And while at it, change #import <config.h> in some files to
#import "config.h". file: [2bd6cd6bda] check-in: [2a4aa05a84] user: js, branch: trunk, size: 3323 [annotate] [blame] [check-ins using] [diff]