ObjFW  Changes To API Review for 1.0

Changes to "API Review for 1.0" between 2021-04-07 13:56:48 and 2021-04-07 14:08:05

1
2
3
4
5


6
7
8
9
10
11
12
1
2
3
4

5
6
7
8
9
10
11
12
13




-
+
+







For the 1.0 release, all APIs should be reviewed, as starting 1.0, they are supposed to be stable.

Right now, we have the following classes (generated using `find src -name '*.h' -and -not -name '*+Private.h' -and -not -wholename 'src/bridge/*' -and -not -wholename 'src/runtime/*' -exec grep '^@interface ' {} \; | sed 's/^@interface /* ❌ /' | sed 's/:.*//' | sed 's/OF_GENERIC(.*)//' | sed 's/</\&lt;/' | sed 's/>/\&gt;/' | sort`):

*  NSString
*  NSString
  * Fake class has no API and is only used to make string boxing via `@(cString)` work.
* ❌ OFAAAADNSResourceRecord
* ❌ OFAcceptFailedException
* ❌ OFAdjacentArray
* ❌ OFAdjacentSubarray
* ❌ OFADNSResourceRecord
* ❌ OFAllocFailedException
* ❌ OFAlreadyConnectedException
49
50
51
52
53
54
55
56


57
58
59
60
61
62
63
64


65
66
67
68
69
70
71
50
51
52
53
54
55
56

57
58
59
60
61
62
63
64
65

66
67
68
69
70
71
72
73
74







-
+
+







-
+
+







* ❌ OFDNSQueryFailedException
* ❌ OFDNSResolver
* ❌ OFDNSResolverSettings
* ❌ OFDNSResourceRecord
* ❌ OFDNSResponse
* ❌ OFEnumerationMutationException
* ❌ OFEnumerator 
*  OFEpollKernelEventObserver
*  OFEpollKernelEventObserver
  * Private
* ❌ OFException
* ❌ OFFile
* ❌ OFFileManager
* ❌ OFFileURLHandler
* ❌ OFGetCurrentDirectoryPathFailedException
* ❌ OFGetOptionFailedException
* ❌ OFGetWindowsRegistryValueFailedException
*  OFGlobalBlock
*  OFGlobalBlock
  * Doesn't have an API
* ❌ OFGZIPStream
* ❌ OFHashAlreadyCalculatedException
* ❌ OFHINFODNSResourceRecord
* ❌ OFHMAC
* ❌ OFHostAddressResolver
* ❌ OFHTTPClient
* ❌ OFHTTPCookie
84
85
86
87
88
89
90
91


92
93
94


95
96
97
98
99
100
101
102
103
104
105


106
107
108
109
110
111
112
87
88
89
90
91
92
93

94
95
96
97

98
99
100
101
102
103
104
105
106
107
108
109

110
111
112
113
114
115
116
117
118







-
+
+


-
+
+










-
+
+







* ❌ OFInvalidArgumentException
* ❌ OFInvalidEncodingException
* ❌ OFInvalidFormatException
* ❌ OFInvalidJSONException
* ❌ OFInvalidServerReplyException
* ❌ OFInvertedCharacterSet
* ❌ OFInvocation
*  OFIPSocketAsyncConnector
*  OFIPSocketAsyncConnector
  * Private
* ❌ OFIPXSocket
* ❌ OFKernelEventObserver
*  OFKqueueKernelEventObserver
*  OFKqueueKernelEventObserver
  * Private
* ❌ OFLHAArchive
* ❌ OFLHAArchiveEntry
* ❌ OFLHADecompressingStream
* ❌ OFLinkFailedException
* ❌ OFList 
* ❌ OFListenFailedException
* ❌ OFLoadPluginFailedException
* ❌ OFLocale
* ❌ OFLockFailedException
* ❌ OFMalformedXMLException
*  OFMallocBlock
*  OFMallocBlock
  * Doesn't have an API
* ❌ OFMapTable
* ❌ OFMapTableDictionary
* ❌ OFMapTableEnumerator
* ❌ OFMapTableSet
* ❌ OFMD5Hash
* ❌ OFMemoryNotPartOfObjectException
* ❌ OFMessagePackExtension
144
145
146
147
148
149
150
151


152
153
154
155
156
157
158
159
160
161
162
163
164
165
166




167
168
169
170


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189


190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209


210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230


231
232
233
234
235
236
237
150
151
152
153
154
155
156

157
158
159
160
161
162
163
164
165
166
167
168
169
170
171


172
173
174
175
176
177
178

179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198

199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

242
243
244
245
246
247
248
249
250







-
+
+













-
-
+
+
+
+



-
+
+


















-
+
+



















-
+
+




















-
+
+







* ❌ OFOptionsParser
* ❌ OFOutOfMemoryException
* ❌ OFOutOfRangeException
* ❌ OFPair 
* ❌ OFPlugin
* ❌ OFPointerValue
* ❌ OFPointValue
*  OFPollKernelEventObserver
*  OFPollKernelEventObserver
  * Private
* ❌ OFPTRDNSResourceRecord
* ❌ OFRangeCharacterSet
* ❌ OFRangeValue
* ❌ OFReadFailedException
* ❌ OFReadOrWriteFailedException
* ❌ OFRectangleValue
* ❌ OFRecursiveMutex
* ❌ OFRemoveItemFailedException
* ❌ OFResolveHostFailedException
* ❌ OFRetrieveItemAttributesFailedException
* ❌ OFRIPEMD160Hash
* ❌ OFRPDNSResourceRecord
* ❌ OFRunLoop
*  OFSandbox
*  OFSandboxActivationFailedException
*  OFSandbox
  * Private in 1.0 (but public in trunk)
*  OFSandboxActivationFailedException
  * Private in 1.0 (but public in trunk)
* ❌ OFSecureData
* ❌ OFSeekableStream
* ❌ OFSeekFailedException
*  OFSelectKernelEventObserver
*  OFSelectKernelEventObserver
  * Private
* ❌ OFSequencedPacketSocket
* ❌ OFSet 
* ❌ OFSetItemAttributesFailedException
* ❌ OFSetOptionFailedException
* ❌ OFSettings
* ❌ OFSetWindowsRegistryValueFailedException
* ❌ OFSHA1Hash
* ❌ OFSHA224Hash
* ❌ OFSHA224Or256Hash
* ❌ OFSHA256Hash
* ❌ OFSHA384Hash
* ❌ OFSHA384Or512Hash
* ❌ OFSHA512Hash
* ❌ OFSOADNSResourceRecord
* ❌ OFSortedList 
* ❌ OFSPXSocket
* ❌ OFSPXStreamSocket
* ❌ OFSRVDNSResourceRecord
*  OFStackBlock
*  OFStackBlock
  * Doesn't have an API
* ❌ OFStdIOStream
* ❌ OFStillLockedException
* ❌ OFStream
* ❌ OFStreamSocket
* ❌ OFString
* ❌ OFString (CryptoHashing)
* ❌ OFString (JSONParsing)
* ❌ OFString (PathAdditions)
* ❌ OFString (PropertyListParsing)
* ❌ OFString (Serialization)
* ❌ OFString (URLEncoding)
* ❌ OFString (XMLEscaping)
* ❌ OFString (XMLUnescaping)
* ❌ OFSubarray
* ❌ OFSubprocess
* ❌ OFSystemInfo
* ❌ OFTarArchive
* ❌ OFTarArchiveEntry
* ❌ OFTCPSocket
*  OFTCPSocketSOCKS5Connector
*  OFTCPSocketSOCKS5Connector
  * Private
* ❌ OFThread
* ❌ OFThreadJoinFailedException
* ❌ OFThreadStartFailedException
* ❌ OFThreadStillRunningException
* ❌ OFTimer
* ❌ OFTriple 
* ❌ OFTruncatedDataException
* ❌ OFTXTDNSResourceRecord
* ❌ OFUDPSocket
* ❌ OFUnboundNamespaceException
* ❌ OFUnboundPrefixException
* ❌ OFUndefinedKeyException
* ❌ OFUnknownXMLEntityException
* ❌ OFUnlockFailedException
* ❌ OFUnsupportedProtocolException
* ❌ OFUnsupportedVersionException
* ❌ OFURL
* ❌ OFURLHandler
* ❌ OFUTF8String
* ❌ OFValue
*  OFWin32ConsoleStdIOStream
*  OFWin32ConsoleStdIOStream
  * Private
* ❌ OFWindowsRegistryKey
* ❌ OFWriteFailedException
* ❌ OFXMLAttribute
* ❌ OFXMLCDATA
* ❌ OFXMLCharacters
* ❌ OFXMLComment
* ❌ OFXMLElement