File: thcoll.h

package info (click to toggle)
libthai 0.1.6-1%2Betch1
  • links: PTS
  • area: main
  • in suites: etch
  • size: 3,624 kB
  • ctags: 812
  • sloc: ansic: 29,368; sh: 8,919; makefile: 334
file content (50 lines) | stat: -rw-r--r-- 1,270 bytes parent folder | download | duplicates (3)
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
/*
 * $Id: thcoll.h,v 1.5 2006-07-31 12:54:02 thep Exp $
 * thcoll.h - Thai string collation
 * Created: 2001-05-17
 */

#ifndef THAI_THCOLL_H
#define THAI_THCOLL_H

#include <thai/thailib.h>

BEGIN_CDECL

/**
 * @file   thcoll.h
 * @brief  Thai string collation
 */

/**
 * @brief  Compare two Thai strings for collation
 *
 * @param  s1 : first string (null-terminated)
 * @param  s2 : second string (null-terminated)
 *
 * @return  < 0 if @a s1 precedes @a s2; 0 if @a s1 equals @a s2;
 *          > 0 if @a s1 succeeds @a s2
 */
extern int    th_strcoll(const thchar_t *s1, const thchar_t *s2);

/**
 * @brief  Transform string into collatable form
 *
 * @param  dest : the destination string buffer
 * @param  src  : the string to transform
 * @param  n    : the size of @a dest buffer
 *
 * @returns  the number of bytes required to store the result in @a dest,
 *           excluding the terminating '\\0'.
 *           If the return value >= @a n, @a dest is undefined.
 *
 * Transforms @a src into a form from which comparison using strcmp() yields
 * the same result as that from th_strcoll(). At most @a n characters are
 * put in @a dest.
 */
extern size_t th_strxfrm(thchar_t dest[], const thchar_t *src, size_t n);

END_CDECL

#endif  /* THAI_THCOLL_H */