1
2
3
4
5
6
7
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
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
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
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
238
239
240
241
242
243
244
245
246
247
248
249
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_storage_SQLCollations_h
#define mozilla_storage_SQLCollations_h
#include "mozStorageService.h"
#include "nscore.h"
#include "nsString.h"
#include "sqlite3.h"
namespace mozilla {
namespace storage {
/**
* Registers the collating sequences declared here with the specified
* database and Service.
*
* @param aDB
* The database we'll be registering the collations with.
* @param aService
* The Service that owns the nsICollation used by our collations.
* @return the SQLite status code indicating success or failure.
*/
int registerCollations(sqlite3 *aDB, Service *aService);
////////////////////////////////////////////////////////////////////////////////
//// Predefined Functions
/**
* Custom UTF-8 collating sequence that respects the application's locale.
* Comparison is case- and accent-insensitive. This is called by SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @param aLen2
* The number of bytes in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollation8(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-8 collating sequence that respects the application's locale.
* Comparison is case-sensitive and accent-insensitive. This is called by
* SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @param aLen2
* The number of bytes in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationCaseSensitive8(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-8 collating sequence that respects the application's locale.
* Comparison is case-insensitive and accent-sensitive. This is called by
* SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @param aLen2
* The number of bytes in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationAccentSensitive8(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-8 collating sequence that respects the application's locale.
* Comparison is case- and accent-sensitive. This is called by SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @param aLen2
* The number of bytes in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationCaseAccentSensitive8(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-16 collating sequence that respects the application's locale.
* Comparison is case- and accent-insensitive. This is called by SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes (not characters) in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @param aLen2
* The number of bytes (not characters) in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollation16(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-16 collating sequence that respects the application's locale.
* Comparison is case-sensitive and accent-insensitive. This is called by
* SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes (not characters) in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @param aLen2
* The number of bytes (not characters) in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationCaseSensitive16(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-16 collating sequence that respects the application's locale.
* Comparison is case-insensitive and accent-sensitive. This is called by
* SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes (not characters) in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @param aLen2
* The number of bytes (not characters) in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationAccentSensitive16(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-16 collating sequence that respects the application's locale.
* Comparison is case- and accent-sensitive. This is called by SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes (not characters) in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @param aLen2
* The number of bytes (not characters) in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationCaseAccentSensitive16(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
} // namespace storage
} // namespace mozilla
#endif // mozilla_storage_SQLCollations_h
|
