Comment: | Documentation improvements. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
72caeab860c5586efc4a99c8394614be |
User & Date: | js on 2010-02-11 14:58:52 |
Other Links: | manifest | tags |
2010-02-12
| ||
22:09 | Fix version in configure.ac. check-in: 760c45b8e5 user: js tags: trunk | |
2010-02-11
| ||
14:58 | Documentation improvements. check-in: 72caeab860 user: js tags: trunk | |
14:05 | Add of_range_t and add methods taking an of_range_t. check-in: a7bed8325c user: js tags: trunk | |
Modified src/OFArray.h from [b25e7c62a4] to [7213c9a36c].
︙ | |||
14 15 16 17 18 19 20 | 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | - + | #import "OFObject.h" #import "OFEnumerator.h" @class OFDataArray; @class OFString; /** |
︙ | |||
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 | 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | + + | /** * \return An OFEnumerator to enumarate through the array's objects */ - (OFEnumerator*)enumerator; @end /// \cond internal @interface OFArrayEnumerator: OFEnumerator { OFDataArray *array; size_t count; unsigned long mutations; unsigned long *mutations_ptr; size_t pos; } - initWithDataArray: (OFDataArray*)data mutationsPointer: (unsigned long*)mutations_ptr; @end /// \endcond #import "OFMutableArray.h" |
Modified src/OFArray.m from [752a63309a] to [31cc237dd8].
︙ | |||
348 349 350 351 352 353 354 355 356 357 358 359 360 361 | 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 | + | [array release]; [super dealloc]; } @end /// \cond internal @implementation OFArrayEnumerator - initWithDataArray: (OFDataArray*)array_ mutationsPointer: (unsigned long*)mutations_ptr_; { self = [super init]; array = array_; |
︙ | |||
383 384 385 386 387 388 389 | 384 385 386 387 388 389 390 391 | + | @throw [OFEnumerationMutationException newWithClass: isa]; pos = 0; return self; } @end /// \endcond |
Modified src/OFAutoreleasePool.h from [049148d03d] to [d36ba6919e].
︙ | |||
10 11 12 13 14 15 16 17 18 19 20 21 22 23 | 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | + + | */ #import "OFObject.h" @class OFMutableArray; /** * \brief A pool that keeps track of objects to release. * * The OFAutoreleasePool class is a class that keeps track of objects that will * be released when the autorelease pool is released. * * Every thread has its own stack of autorelease pools. */ @interface OFAutoreleasePool: OFObject { |
︙ |
Modified src/OFConstString.h from [1fa39e7915] to [68ea1dca07].
︙ | |||
12 13 14 15 16 17 18 | 12 13 14 15 16 17 18 19 20 21 22 | - + | #import "OFString.h" #ifdef OF_APPLE_RUNTIME extern void *_OFConstStringClassReference; #endif /** |
Modified src/OFDataArray.h from [f2ebd3c096] to [843790424c].
︙ | |||
8 9 10 11 12 13 14 | 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | - + | * Q Public License 1.0, which can be found in the file LICENSE included in * the packaging of this file. */ #import "OFObject.h" /** |
︙ | |||
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | + + | * \param index The index at which the items are removed */ - removeNItems: (size_t)nitems atIndex: (size_t)index; @end /** * \brief A class for storing arbitrary big data in an array. * * The OFBigDataArray class is a class for storing arbitrary data in an array * and is designed to store large hunks of data. Therefore, it allocates * memory in pages rather than a chunk of memory for each item. */ @interface OFBigDataArray: OFDataArray <OFCopying> { size_t size; } @end |
Modified src/OFDictionary.h from [a062c3e4f0] to [8c5528ce97].
︙ | |||
22 23 24 25 26 27 28 | 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | - + | OFObject <OFCopying> *key; OFObject *object; uint32_t hash; }; /// \endcond /** |
︙ | |||
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 | 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 | + + | /** * \return An OFEnumerator to enumerate through the dictionary's keys */ - (OFEnumerator*)keyEnumerator; @end /// \cond internal @interface OFDictionaryEnumerator: OFEnumerator { struct of_dictionary_bucket *data; size_t size; unsigned long mutations; unsigned long *mutations_ptr; size_t pos; } - initWithData: (struct of_dictionary_bucket*)data size: (size_t)size mutationsPointer: (unsigned long*)mutations_ptr; @end @interface OFDictionaryObjectEnumerator: OFDictionaryEnumerator @end @interface OFDictionaryKeyEnumerator: OFDictionaryEnumerator @end /// \endcond #import "OFMutableDictionary.h" |
Modified src/OFDictionary.m from [c2d0cafc7c] to [7f2b08c20e].
︙ | |||
581 582 583 584 585 586 587 588 589 590 591 592 593 594 | 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 | + | OF_HASH_FINALIZE(hash); return hash; } @end /// \cond internal @implementation OFDictionaryEnumerator - initWithData: (struct of_dictionary_bucket*)data_ size: (size_t)size_ mutationsPointer: (unsigned long*)mutations_ptr_ { self = [super init]; |
︙ | |||
636 637 638 639 640 641 642 | 637 638 639 640 641 642 643 644 | + | if (pos < size) return data[pos++].key; else return nil; } @end /// \endcond |
Modified src/OFEnumerator.h from [6eea1f0fa8] to [67a294e12a].
︙ | |||
8 9 10 11 12 13 14 | 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | - + | * Q Public License 1.0, which can be found in the file LICENSE included in * the packaging of this file. */ #import "OFObject.h" /** |
︙ | |||
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | + + + + + | * This needs to be exactly like this because it's hardcoded in the compiler. * * We need this bad check to see if we already imported Cocoa, which defines * this as well. */ #define of_fast_enumeration_state_t NSFastEnumerationState #ifndef NSINTEGER_DEFINED /** * \brief State information for fast enumerations. */ typedef struct __of_fast_enumeration_state { /// Arbitrary state information for the enumeration unsigned long state; /// Pointer to a C array of objects to return id *itemsPtr; /// Arbitrary state information to detect mutations unsigned long *mutationsPtr; /// Additional arbitrary state information unsigned long extra[5]; } of_fast_enumeration_state_t; #endif /** * \brief A protocol for fast enumeration. * * The OFFastEnumeration protocol needs to be implemented by all classes * supporting fast enumeration. */ @protocol OFFastEnumeration - (int)countByEnumeratingWithState: (of_fast_enumeration_state_t*)state objects: (id*)objects count: (int)count; @end |
Modified src/OFExceptions.h from [84921b5752] to [539f8bdc7a].
︙ | |||
12 13 14 15 16 17 18 | 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | - + | #include <sys/stat.h> #import "OFObject.h" @class OFString; /** |
︙ | |||
37 38 39 40 41 42 43 | 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | + + - + + | /** * \return An error message for the exception as a string */ - (OFString*)string; @end /** * \brief The base class for all exceptions in ObjFW * |
︙ | |||
76 77 78 79 80 81 82 | 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | - + | /** * \return An error message for the exception as a string */ - (OFString*)string; @end /** |
︙ | |||
108 109 110 111 112 113 114 | 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | - + + - + | /** * \return The size of the memoory that couldn't be allocated */ - (size_t)requestedSize; @end /** |
︙ | |||
146 147 148 149 150 151 152 | 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | - + + | /** * \return A pointer to the memory which is not part of the object */ - (void*)pointer; @end /** |
︙ | |||
173 174 175 176 177 178 179 | 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | - + - + | * \return An initialized not implemented exception */ - initWithClass: (Class)class_ selector: (SEL)selector; @end /** |
︙ | |||
206 207 208 209 210 211 212 | 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 | - + - + - + + - + - + | * \return An initialized invalid argument exception */ - initWithClass: (Class)class_ selector: (SEL)selector; @end /** |
︙ | |||
278 279 280 281 282 283 284 | 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | - + | /** * \return A string of the mode in which the file should have been opened */ - (OFString*)mode; @end /** |
︙ | |||
316 317 318 319 320 321 322 | 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 | - + - + - + | /** * \return The requested size of the data that couldn't be read / written */ - (size_t)requestedSize; @end /** |
︙ | |||
377 378 379 380 381 382 383 | 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 | - + | * \return The new mode for the file */ - (mode_t)mode; @end #ifndef _WIN32 /** |
︙ | |||
436 437 438 439 440 441 442 | 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 | - + | * \return The new group for the file */ - (gid_t)group; @end #endif /** |
︙ | |||
484 485 486 487 488 489 490 | 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 | - + | /** * \return The new path */ - (OFString*)to; @end /** |
︙ | |||
523 524 525 526 527 528 529 | 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 | - + | * \return The path of the file */ - (OFString*)path; @end #ifndef _WIN32 /** |
︙ | |||
571 572 573 574 575 576 577 | 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 | - + | /** * \return A string of the destination for the link */ - (OFString*)destination; @end /** |
︙ | |||
620 621 622 623 624 625 626 | 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 | - + - + - - + + - + | * \return A string of the destination for the symlink */ - (OFString*)destination; @end #endif /** |
︙ | |||
687 688 689 690 691 692 693 | 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 | - + | /** * \return The service of the node for which translation was requested */ - (OFString*)service; @end /** |
︙ | |||
735 736 737 738 739 740 741 | 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 | - + | /** * \return The service on the node to which the connection failed */ - (OFString*)service; @end /** |
︙ | |||
793 794 795 796 797 798 799 | 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 | - + | /** * \return The family for which binding failed */ - (int)family; @end /** |
︙ | |||
831 832 833 834 835 836 837 | 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 | - + - + - + - + - + | /** * \return The requested back log. */ - (int)backLog; @end /** |
Modified src/OFFile.h from [4c7924139a] to [3ab1067398].
︙ | |||
14 15 16 17 18 19 20 | 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | - + | #include <sys/types.h> #import "OFStream.h" @class OFString; /** |
︙ | |||
124 125 126 127 128 129 130 | 124 125 126 127 128 129 130 131 132 133 134 135 136 | - - - | * * \param fp A file pointer, returned from for example fopen(). * It is not closed when the OFFile object is deallocated! */ - initWithFilePointer: (FILE*)fp; @end |
Modified src/OFFile.m from [95e5eb4c36] to [8e229b8d40].
︙ | |||
25 26 27 28 29 30 31 32 33 34 35 36 37 38 | 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | + + + + + | #ifdef _WIN32 # import <windows.h> #endif OFFile *of_stdin = nil; OFFile *of_stdout = nil; OFFile *of_stderr = nil; /// \cond internal @interface OFFileSingleton: OFFile @end /// \endcond @implementation OFFile + (void)load { if (self != [OFFile class]) return; |
︙ | |||
220 221 222 223 224 225 226 227 228 229 230 231 232 233 | 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 | + | fclose(fp); fp = NULL; return self; } @end /// \cond internal @implementation OFFileSingleton - initWithPath: (OFString*)path mode: (OFString*)mode { @throw [OFNotImplementedException newWithClass: isa selector: _cmd]; } |
︙ | |||
254 255 256 257 258 259 260 | 260 261 262 263 264 265 266 267 | + | - (void)dealloc { @throw [OFNotImplementedException newWithClass: isa selector: _cmd]; [super dealloc]; /* Get rid of stupid warning */ } @end /// \endcond |
Modified src/OFHashes.h from [709542c883] to [395d640d76].
︙ | |||
14 15 16 17 18 19 20 | 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | - + | #define OF_MD5_DIGEST_SIZE 16 #define OF_SHA1_DIGEST_SIZE 20 extern int _OFHashing_reference; /** |
︙ | |||
47 48 49 50 51 52 53 | 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | - + | * \return A buffer containing the hash (OF_MD5_DIGEST_SIZE = 16 bytes). * The buffer is part of object's memory pool. */ - (uint8_t*)digest; @end /** |
︙ |
Modified src/OFList.h from [dd11b8683b] to [e8baae6cab].
︙ | |||
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | + + - + | * Q Public License 1.0, which can be found in the file LICENSE included in * the packaging of this file. */ #import "OFObject.h" /** * \brief A list object. * * A struct that contains a pointer to the next list object, the previous list * object and the object. */ typedef struct __of_list_object { /// A pointer to the next list object in the list struct __of_list_object *next; /// A pointer to the previous list object in the list struct __of_list_object *prev; /// The object for the list object id object; } of_list_object_t; /** |
︙ |
Modified src/OFMutableArray.h from [70b773a8e9] to [deee08f16c].
︙ | |||
8 9 10 11 12 13 14 | 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | - + - | * Q Public License 1.0, which can be found in the file LICENSE included in * the packaging of this file. */ #import "OFArray.h" /** |
︙ |
Modified src/OFMutableDictionary.h from [825c0561fc] to [a2f25e0a26].
︙ | |||
8 9 10 11 12 13 14 | 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | - + | * Q Public License 1.0, which can be found in the file LICENSE included in * the packaging of this file. */ #import "OFDictionary.h" /** |
︙ |
Modified src/OFMutableString.h from [f11024a606] to [1398e16fd0].
︙ | |||
11 12 13 14 15 16 17 | 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | - + | #include <stdio.h> #include <stdarg.h> #import "OFString.h" /** |
︙ |
Modified src/OFNumber.h from [fb94e23de6] to [e98b32202b].
︙ | |||
37 38 39 40 41 42 43 | 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | - + - | OF_NUMBER_PTRDIFF, OF_NUMBER_INTPTR, OF_NUMBER_FLOAT, OF_NUMBER_DOUBLE, }; /** |
︙ |
Modified src/OFObject.h from [db793b12be] to [f7abde26a3].
︙ | |||
13 14 15 16 17 18 19 | 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | - + - + - + | #include <stddef.h> #include <stdint.h> #import <objc/objc.h> /** |
︙ | |||
300 301 302 303 304 305 306 | 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 | - + + + | * * It is also called when the retain count reaches zero. */ - (void)dealloc; @end /** |
Modified src/OFPlugin.h from [81328c5acf] to [883312d8e9].
︙ | |||
12 13 14 15 16 17 18 | 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | - + - + | #import "OFObject.h" @class OFString; #ifndef _WIN32 typedef void* of_plugin_handle_t; #else |
︙ |
Modified src/OFSocket.h from [63006eb928] to [67cbf9c293].
︙ | |||
13 14 15 16 17 18 19 | 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | - + | #ifdef _WIN32 # define _WIN32_WINNT 0x0501 # include <winsock2.h> #endif /** |
︙ |
Modified src/OFStream.h from [1635dfcf25] to [8ae41c981b].
︙ | |||
10 11 12 13 14 15 16 | 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | - + | */ #import "OFObject.h" @class OFString; /** |
︙ |
Modified src/OFString.h from [d23b48aa76] to [9555bfe257].
︙ | |||
28 29 30 31 32 33 34 | 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | - + | extern size_t of_string_utf8_to_unicode(const char*, size_t, of_unichar_t*); extern size_t of_string_position_to_index(const char*, size_t); extern size_t of_string_index_to_position(const char*, size_t, size_t); @class OFArray; /** |
︙ |
Modified src/OFTCPSocket.h from [ee8abca60b] to [156c8c4b82].
︙ | |||
20 21 22 23 24 25 26 | 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | - + | #ifdef _WIN32 # include <ws2tcpip.h> #endif @class OFString; /** |
︙ |
Modified src/OFThread.h from [24a798f944] to [a32c294bc5].
︙ | |||
11 12 13 14 15 16 17 | 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | - + | #import "OFObject.h" #import "OFList.h" #import "threading.h" /** |
︙ | |||
48 49 50 51 52 53 54 | 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | - + - | * \param destructor A destructor that is called when the thread is terminated * \return An initialized Thread Local Storage key */ - initWithDestructor: (void(*)(id))destructor; @end /** |
︙ | |||
114 115 116 117 118 119 120 | 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | - + | * * \return The object returned by the main method of the thread. */ - join; @end /** |
︙ |
Modified src/OFURLEncoding.h from [5c77cce892] to [a68ac0b7c6].
︙ | |||
10 11 12 13 14 15 16 | 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | - + - | */ #import "OFString.h" extern int _OFURLEncoding_reference; /** |
︙ |
Modified src/OFXMLElement.h from [f359bb406c] to [4285b36cb9].
︙ | |||
14 15 16 17 18 19 20 | 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | - + | @class OFDictionary; @class OFMutableArray; extern int _OFXMLElement_reference; /** |
︙ | |||
72 73 74 75 76 77 78 79 80 81 82 83 84 85 | 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 | + + | /** * \return The string value of the attribute as an autoreleased OFString */ - (OFString*)stringValue; @end /** * \brief A representation of an XML element as an object. * * The OFXMLElement represents an XML element as an object which can be * modified and converted back to XML again. */ @interface OFXMLElement: OFObject { OFString *name; OFMutableArray *attrs; |
︙ | |||
149 150 151 152 153 154 155 | 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | - - + | * * \param child Another OFXMLElement which is added as a child */ - addChild: (OFXMLElement*)child; @end /** |
Modified src/OFXMLParser.h from [9941ba9dfc] to [2d67b38d4b].
︙ | |||
15 16 17 18 19 20 21 | 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | - + | extern int _OFXMLParser_reference; @class OFXMLParser; @class OFArray; @class OFMutableArray; /** |
︙ | |||
79 80 81 82 83 84 85 | 79 80 81 82 83 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 113 | - - + + + + - - + + | * \return A substitution for the entity or nil */ - (OFString*)xmlParser: (OFXMLParser*)parser foundUnknownEntityNamed: (OFString*)entity; @end /** |
︙ | |||
157 158 159 160 161 162 163 | 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | - + - | * \param size The size of the buffer */ - parseBuffer: (const char*)buf withSize: (size_t)size; @end /** |
︙ |
Modified src/asprintf.h from [90697b51e3] to [3b963d6ac9].
︙ | |||
8 9 10 11 12 13 14 | 8 9 10 11 12 13 14 15 16 17 18 19 | - + | * Q Public License 1.0, which can be found in the file LICENSE included in * the packaging of this file. */ #import "objfw-defs.h" #ifndef OF_HAVE_ASPRINTF |