Change uint_t to unsigned int in lib/replace
[ira/wip.git] / lib / replace / README
1 This subsystem ensures that we can always use a certain core set of 
2 functions and types, that are either provided by the OS or by replacement 
3 functions / definitions in this subsystem. The aim is to try to stick 
4 to POSIX functions in here as much as possible. Convenience functions 
5 that are available on no platform at all belong in other subsystems
6 (such as LIBUTIL).
7
8 The following functions are guaranteed:
9
10 ftruncate
11 strlcpy
12 strlcat
13 mktime
14 rename
15 initgroups
16 memmove
17 strdup
18 setlinebuf
19 vsyslog
20 timegm
21 setenv
22 unsetenv
23 strndup
24 strnlen
25 waitpid
26 seteuid
27 setegid
28 asprintf
29 snprintf
30 vasprintf
31 vsnprintf
32 opendir
33 readdir
34 telldir
35 seekdir
36 closedir
37 dlopen
38 dlclose
39 dlsym
40 dlerror
41 chroot
42 bzero
43 strerror
44 errno
45 mkdtemp
46 mkstemp (a secure one!)
47 pread
48 pwrite
49 chown
50 lchown
51 getpass
52 readline (the library)
53 inet_ntoa
54 inet_ntop
55 inet_pton
56 inet_aton
57 strtoll
58 strtoull
59 socketpair
60 strptime
61 getaddrinfo
62 freeaddrinfo
63 getnameinfo
64 gai_strerror
65 getifaddrs
66 freeifaddrs
67 utime
68 utimes
69 dup2
70 link
71 readlink
72 symlink
73 realpath
74
75 Types:
76 bool
77 socklen_t
78 uint{8,16,32,64}_t
79 int{8,16,32,64}_t
80 intptr_t
81 sig_atomic_t
82
83 Constants:
84 PATH_NAME_MAX
85 UINT{16,32,64}_MAX
86 INT32_MAX
87 RTLD_LAZY
88 HOST_NAME_MAX
89 UINT16_MAX
90 UINT32_MAX
91 UINT64_MAX
92 CHAR_BIT
93
94 Macros:
95 va_copy
96 __FUNCTION__
97 __FILE__
98 __LINE__
99 __LINESTR__
100 __location__
101 __STRING
102 __STRINGSTRING
103 MIN
104 MAX
105 QSORT_CAST
106 ZERO_STRUCT
107 ZERO_STRUCTP
108 ZERO_STRUCTPN
109 ZERO_ARRAY
110 ARRAY_SIZE
111 PTR_DIFF
112
113 Headers:
114 stdint.h
115 stdbool.h
116
117 Optional C keywords:
118 volatile
119
120 Prerequisites:
121 memset (for bzero)
122 syslog (for vsyslog)
123 mktemp (for mkstemp and mkdtemp)