ObjFW  Check-in [df75a3df04]

Overview
Comment:Emphasize UTF-8 encoding of C strings in documentation.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: df75a3df045c3544ba5348f612850946c3d6737de03d765ee1adacf453247126
User & Date: js on 2009-07-19 13:11:20
Other Links: manifest | tags
Context
2009-07-19
14:05
Rename andFoo: to foo: in all methods. check-in: 4eae61a78f user: js tags: trunk
13:11
Emphasize UTF-8 encoding of C strings in documentation. check-in: df75a3df04 user: js tags: trunk
13:04
A few new string methods. check-in: 1bbc11d7a5 user: js tags: trunk
Changes

Modified src/OFMutableString.h from [d521da8eed] to [d951857644].

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
48
49
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
75
76

77
78
79
80
81
82
83
84

85
86
87
88
89
90
91
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
48
49
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
75

76
77
78
79
80
81
82
83

84
85
86
87
88
89
90
91







-
+

-
+




-
+

-
+




-
+

-
-
+
+





-
-
+
+




-
+




-
-
+
+




-
-
+
+












-
+







-
+







#import "OFString.h"

/**
 * A class for storing and modifying strings.
 */
@interface OFMutableString: OFString {}
/**
 * Sets the OFString to the specified OFString.
 * Sets the OFString to the specified UTF-8 encoded C string.
 *
 * \param str An OFString to set the OFString to.
 * \param str A UTF-8 encoded C string to set the OFString to.
 */
- setToCString: (const char*)str;

/**
 * Appends a C string to the OFString.
 * Appends a UTF-8 encoded C string to the OFString.
 *
 * \param str A C string to append
 * \param str A UTF-8 encoded C string to append
 */
- appendCString: (const char*)str;

/**
 * Appends a C string with the specified length to the OFString.
 * Appends a UTF-8 encoded C string with the specified length to the OFString.
 *
 * \param str A C string to append
 * \param len The length of the C string
 * \param str A UTF-8 encoded C string to append
 * \param len The length of the UTF-8 encoded C string
 */
- appendCString: (const char*)str
     withLength: (size_t)len;

/**
 * Appends a C string to the OFString without checking whether it is valid
 * UTF-8.
 * Appends a UTF-8 encoded C string to the OFString without checking whether it
 * is valid UTF-8.
 *
 * Only use this if you are 100% sure the string you append is either ASCII or
 * UTF-8!
 *
 * \param str A C string to append
 * \param str A UTF-8 encoded C string to append
 */
- appendCStringWithoutUTF8Checking: (const char*)str;

/**
 * Appends a C string with the specified length to the OFString without checking
 * whether it is valid UTF-8.
 * Appends a UTF-8 encoded C string with the specified length to the OFString
 * without checking whether it is valid UTF-8.
 *
 * Only use this if you are 100% sure the string you append is either ASCII or
 * UTF-8!
 *
 * \param str A C string to append
 * \param len The length of the C string
 * \param str A UTF-8 encoded C string to append
 * \param len The length of the UTF-8 encoded C string
 */
- appendCStringWithoutUTF8Checking: (const char*)str
			 andLength: (size_t)len;

/**
 * Appends another OFString to the OFString.
 *
 * \param str An OFString to append
 */
- appendString: (OFString*)str;

/**
 * Appends a formatted C string to the OFString.
 * Appends a formatted UTF-8 encoded C string to the OFString.
 * See printf for the format syntax.
 *
 * \param fmt A format string which generates the string to append
 */
- appendWithFormat: (OFString*)fmt, ...;

/**
 * Appends a formatted C string to the OFString.
 * Appends a formatted UTF-8 encoded C string to the OFString.
 * See printf for the format syntax.
 *
 * \param fmt A format string which generates the string to append
 * \param args The arguments used in the format string
 */
- appendWithFormat: (OFString*)fmt
      andArguments: (va_list)args;

Modified src/OFString.h from [a4f1a280cf] to [e0cc0b9e88].

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
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







-
+

-
+





-
+
+

-
+








/**
 * \return A new autoreleased OFString
 */
+ string;

/**
 * Creates a new OFString from a C string.
 * Creates a new OFString from a UTF-8 encoded C string.
 *
 * \param str A C string to initialize the OFString with
 * \param str A UTF-8 encoded C string to initialize the OFString with
 * \return A new autoreleased OFString
 */
+ stringWithCString: (const char*)str;

/**
 * Creates a new OFString from a C string with the specified length.
 * Creates a new OFString from a UTF-8 encoded C string with the specified
 * length.
 *
 * \param str A C string to initialize the OFString with
 * \param str A UTF-8 encoded C string to initialize the OFString with
 * \param len The length of the string
 * \return A new autoreleased OFString
 */
+ stringWithCString: (const char*)str
	  andLength: (size_t)len;

/**
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
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







-
+

-
+





-
-
+
+

-
+







 * Initializes an already allocated OFString.
 *
 * \return An initialized OFString
 */
- init;

/**
 * Initializes an already allocated OFString from a C string.
 * Initializes an already allocated OFString from a UTF-8 encoded C string.
 *
 * \param str A C string to initialize the OFString with
 * \param str A UTF-8 encoded C string to initialize the OFString with
 * \return An initialized OFString
 */
- initWithCString: (const char*)str;

/**
 * Initializes an already allocated OFString from a C string with the specified
 * length.
 * Initializes an already allocated OFString from a UTF-8 encoded C string with
 * the specified length.
 *
 * \param str A C string to initialize the OFString with
 * \param str A UTF-8 encoded C string to initialize the OFString with
 * \param len The length of the string
 * \return An initialized OFString
 */
- initWithCString: (const char*)str
	andLength: (size_t)len;

/**
126
127
128
129
130
131
132
133

134
135
136
137
138
139
140
127
128
129
130
131
132
133

134
135
136
137
138
139
140
141







-
+







 *
 * \param str A string to initialize the OFString with
 * \return An initialized OFString
 */
- initWithString: (OFString*)str;

/**
 * \return The OFString as a C string
 * \return The OFString as a UTF-8 encoded C string
 */
- (const char*)cString;

/**
 * \return The length of the OFString
 */
- (size_t)length;