blob: 67d7416ad0f9e3ac3ff8b0f88a0e57f506ac625b [file] [log] [blame]
Alex Crichtondafaca92015-09-09 21:50:47 -07001// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
2// file at the top-level directory of this distribution and at
3// http://rust-lang.org/COPYRIGHT.
4//
5// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8// option. This file may not be copied, modified, or distributed
9// except according to those terms.
10
Alex Crichton95b18b72015-09-17 10:06:58 -070011//! Crate docs
12
Alex Crichton17910462015-09-22 19:11:04 -070013#![allow(bad_style, raw_pointer_derive, improper_ctypes)]
Alex Crichton24abc4f2015-09-16 23:54:56 -070014#![cfg_attr(dox, feature(no_core, lang_items))]
15#![cfg_attr(dox, no_core)]
16#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
17 html_favicon_url = "https://doc.rust-lang.org/favicon.ico")]
18
Alex Crichton730a17f2015-09-17 10:05:36 -070019#![cfg_attr(all(target_os = "linux", target_arch = "x86_64"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070020 html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-linux-gnu"
Alex Crichton730a17f2015-09-17 10:05:36 -070021))]
22#![cfg_attr(all(target_os = "linux", target_arch = "x86"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070023 html_root_url = "https://doc.rust-lang.org/libc/i686-unknown-linux-gnu"
Alex Crichton730a17f2015-09-17 10:05:36 -070024))]
25#![cfg_attr(all(target_os = "linux", target_arch = "arm"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070026 html_root_url = "https://doc.rust-lang.org/libc/arm-unknown-linux-gnueabihf"
Alex Crichton730a17f2015-09-17 10:05:36 -070027))]
28#![cfg_attr(all(target_os = "linux", target_arch = "mips"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070029 html_root_url = "https://doc.rust-lang.org/libc/mips-unknown-linux-gnu"
Alex Crichton730a17f2015-09-17 10:05:36 -070030))]
Alex Crichtond13e1e42015-09-17 17:29:18 -070031#![cfg_attr(all(target_os = "linux", target_arch = "aarch64"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070032 html_root_url = "https://doc.rust-lang.org/libc/aarch64-unknown-linux-gnu"
Alex Crichtond13e1e42015-09-17 17:29:18 -070033))]
Alex Crichton730a17f2015-09-17 10:05:36 -070034#![cfg_attr(all(target_os = "linux", target_env = "musl"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070035 html_root_url = "https://doc.rust-lang.org/libc/x86_64-unknown-linux-musl"
Alex Crichton730a17f2015-09-17 10:05:36 -070036))]
37#![cfg_attr(all(target_os = "macos", target_arch = "x86_64"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070038 html_root_url = "https://doc.rust-lang.org/libc/x86_64-apple-darwin"
Alex Crichton730a17f2015-09-17 10:05:36 -070039))]
40#![cfg_attr(all(target_os = "macos", target_arch = "x86"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070041 html_root_url = "https://doc.rust-lang.org/libc/i686-apple-darwin"
Alex Crichton730a17f2015-09-17 10:05:36 -070042))]
43#![cfg_attr(all(windows, target_arch = "x86_64", target_env = "gnu"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070044 html_root_url = "https://doc.rust-lang.org/libc/x86_64-pc-windows-gnu"
Alex Crichton730a17f2015-09-17 10:05:36 -070045))]
Alex Crichton611e9a32015-09-17 10:06:19 -070046#![cfg_attr(all(windows, target_arch = "x86", target_env = "gnu"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070047 html_root_url = "https://doc.rust-lang.org/libc/i686-pc-windows-gnu"
Alex Crichton730a17f2015-09-17 10:05:36 -070048))]
49#![cfg_attr(all(windows, target_arch = "x86_64", target_env = "msvc"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070050 html_root_url = "https://doc.rust-lang.org/libc/x86_64-pc-windows-msvc"
Alex Crichton730a17f2015-09-17 10:05:36 -070051))]
Alex Crichton611e9a32015-09-17 10:06:19 -070052#![cfg_attr(all(windows, target_arch = "x86", target_env = "msvc"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070053 html_root_url = "https://doc.rust-lang.org/libc/i686-pc-windows-msvc"
Alex Crichton730a17f2015-09-17 10:05:36 -070054))]
55#![cfg_attr(all(target_os = "android"), doc(
Alex Crichton13418a52015-10-29 11:54:12 -070056 html_root_url = "https://doc.rust-lang.org/libc/arm-linux-androideabi"
Alex Crichton730a17f2015-09-17 10:05:36 -070057))]
Alex Crichtondafaca92015-09-09 21:50:47 -070058
Alex Crichton5d6cf052015-09-11 14:52:34 -070059#[macro_use] mod macros;
Alex Crichton24abc4f2015-09-16 23:54:56 -070060mod dox;
Alex Crichton31504842015-09-10 23:43:41 -070061
Alex Crichton5d6cf052015-09-11 14:52:34 -070062#[repr(u8)]
63pub enum c_void {
Alex Crichton9f2b1012015-09-16 23:32:21 -070064 // Two dummy variants so the #[repr] attribute can be used
65 #[doc(hidden)]
Alex Crichton5d6cf052015-09-11 14:52:34 -070066 __variant1,
Alex Crichton9f2b1012015-09-16 23:32:21 -070067 #[doc(hidden)]
Alex Crichton5d6cf052015-09-11 14:52:34 -070068 __variant2,
69}
Alex Crichtondafaca92015-09-09 21:50:47 -070070
Alex Crichton5d6cf052015-09-11 14:52:34 -070071pub type int8_t = i8;
72pub type int16_t = i16;
73pub type int32_t = i32;
74pub type int64_t = i64;
75pub type uint8_t = u8;
76pub type uint16_t = u16;
77pub type uint32_t = u32;
78pub type uint64_t = u64;
Alex Crichtondafaca92015-09-09 21:50:47 -070079
Alex Crichton17910462015-09-22 19:11:04 -070080pub type c_schar = i8;
81pub type c_uchar = u8;
82pub type c_short = i16;
83pub type c_ushort = u16;
84pub type c_int = i32;
85pub type c_uint = u32;
86pub type c_float = f32;
87pub type c_double = f64;
88pub type c_longlong = i64;
89pub type c_ulonglong = u64;
90pub type intmax_t = i64;
91pub type uintmax_t = u64;
92
93pub type size_t = usize;
94pub type ptrdiff_t = isize;
95pub type intptr_t = isize;
96pub type uintptr_t = usize;
97pub type ssize_t = isize;
98
Alex Crichton5d6cf052015-09-11 14:52:34 -070099pub enum FILE {}
100pub enum fpos_t {}
101pub enum DIR {}
102pub enum dirent {}
Alex Crichtondafaca92015-09-09 21:50:47 -0700103
Alex Crichton5d6cf052015-09-11 14:52:34 -0700104extern {
105 pub fn isalnum(c: c_int) -> c_int;
106 pub fn isalpha(c: c_int) -> c_int;
107 pub fn iscntrl(c: c_int) -> c_int;
108 pub fn isdigit(c: c_int) -> c_int;
109 pub fn isgraph(c: c_int) -> c_int;
110 pub fn islower(c: c_int) -> c_int;
111 pub fn isprint(c: c_int) -> c_int;
112 pub fn ispunct(c: c_int) -> c_int;
113 pub fn isspace(c: c_int) -> c_int;
114 pub fn isupper(c: c_int) -> c_int;
115 pub fn isxdigit(c: c_int) -> c_int;
116 pub fn tolower(c: c_int) -> c_int;
117 pub fn toupper(c: c_int) -> c_int;
Alex Crichtondafaca92015-09-09 21:50:47 -0700118
Alex Crichton5d6cf052015-09-11 14:52:34 -0700119 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
120 link_name = "fopen$UNIX2003")]
121 pub fn fopen(filename: *const c_char,
122 mode: *const c_char) -> *mut FILE;
123 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
124 link_name = "freopen$UNIX2003")]
125 pub fn freopen(filename: *const c_char, mode: *const c_char,
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700126 file: *mut FILE) -> *mut FILE;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700127 pub fn fflush(file: *mut FILE) -> c_int;
128 pub fn fclose(file: *mut FILE) -> c_int;
129 pub fn remove(filename: *const c_char) -> c_int;
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700130 pub fn rename(oldname: *const c_char, newname: *const c_char) -> c_int;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700131 pub fn tmpfile() -> *mut FILE;
132 pub fn setvbuf(stream: *mut FILE,
133 buffer: *mut c_char,
134 mode: c_int,
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700135 size: size_t) -> c_int;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700136 pub fn setbuf(stream: *mut FILE, buf: *mut c_char);
Alex Crichton5d6cf052015-09-11 14:52:34 -0700137 pub fn fgetc(stream: *mut FILE) -> c_int;
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700138 pub fn fgets(buf: *mut c_char, n: c_int, stream: *mut FILE) -> *mut c_char;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700139 pub fn fputc(c: c_int, stream: *mut FILE) -> c_int;
140 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
141 link_name = "fputs$UNIX2003")]
142 pub fn fputs(s: *const c_char, stream: *mut FILE)-> c_int;
143 pub fn puts(s: *const c_char) -> c_int;
144 pub fn ungetc(c: c_int, stream: *mut FILE) -> c_int;
145 pub fn fread(ptr: *mut c_void,
146 size: size_t,
147 nobj: size_t,
148 stream: *mut FILE)
149 -> size_t;
150 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
151 link_name = "fwrite$UNIX2003")]
152 pub fn fwrite(ptr: *const c_void,
153 size: size_t,
154 nobj: size_t,
155 stream: *mut FILE)
156 -> size_t;
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700157 pub fn fseek(stream: *mut FILE, offset: c_long, whence: c_int) -> c_int;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700158 pub fn ftell(stream: *mut FILE) -> c_long;
159 pub fn rewind(stream: *mut FILE);
160 pub fn fgetpos(stream: *mut FILE, ptr: *mut fpos_t) -> c_int;
161 pub fn fsetpos(stream: *mut FILE, ptr: *const fpos_t) -> c_int;
162 pub fn feof(stream: *mut FILE) -> c_int;
163 pub fn ferror(stream: *mut FILE) -> c_int;
164 pub fn perror(s: *const c_char);
Alex Crichton5d6cf052015-09-11 14:52:34 -0700165 pub fn atoi(s: *const c_char) -> c_int;
166 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
167 link_name = "strtod$UNIX2003")]
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700168 pub fn strtod(s: *const c_char, endp: *mut *mut c_char) -> c_double;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700169 pub fn strtol(s: *const c_char,
170 endp: *mut *mut c_char, base: c_int) -> c_long;
171 pub fn strtoul(s: *const c_char, endp: *mut *mut c_char,
172 base: c_int) -> c_ulong;
173 pub fn calloc(nobj: size_t, size: size_t) -> *mut c_void;
174 pub fn malloc(size: size_t) -> *mut c_void;
175 pub fn realloc(p: *mut c_void, size: size_t) -> *mut c_void;
176 pub fn free(p: *mut c_void);
177 pub fn exit(status: c_int) -> !;
178 pub fn _exit(status: c_int) -> !;
179 pub fn atexit(cb: extern fn()) -> c_int;
180 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
181 link_name = "system$UNIX2003")]
182 pub fn system(s: *const c_char) -> c_int;
183 pub fn getenv(s: *const c_char) -> *mut c_char;
Alex Crichtondafaca92015-09-09 21:50:47 -0700184
Alex Crichton5d6cf052015-09-11 14:52:34 -0700185 pub fn strcpy(dst: *mut c_char, src: *const c_char) -> *mut c_char;
186 pub fn strncpy(dst: *mut c_char, src: *const c_char, n: size_t)
187 -> *mut c_char;
188 pub fn strcat(s: *mut c_char, ct: *const c_char) -> *mut c_char;
189 pub fn strncat(s: *mut c_char, ct: *const c_char, n: size_t) -> *mut c_char;
190 pub fn strcmp(cs: *const c_char, ct: *const c_char) -> c_int;
191 pub fn strncmp(cs: *const c_char, ct: *const c_char, n: size_t) -> c_int;
192 pub fn strcoll(cs: *const c_char, ct: *const c_char) -> c_int;
193 pub fn strchr(cs: *const c_char, c: c_int) -> *mut c_char;
194 pub fn strrchr(cs: *const c_char, c: c_int) -> *mut c_char;
195 pub fn strspn(cs: *const c_char, ct: *const c_char) -> size_t;
196 pub fn strcspn(cs: *const c_char, ct: *const c_char) -> size_t;
197 pub fn strpbrk(cs: *const c_char, ct: *const c_char) -> *mut c_char;
198 pub fn strstr(cs: *const c_char, ct: *const c_char) -> *mut c_char;
199 pub fn strlen(cs: *const c_char) -> size_t;
200 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
201 link_name = "strerror$UNIX2003")]
202 pub fn strerror(n: c_int) -> *mut c_char;
203 pub fn strtok(s: *mut c_char, t: *const c_char) -> *mut c_char;
204 pub fn strxfrm(s: *mut c_char, ct: *const c_char, n: size_t) -> size_t;
205 pub fn wcslen(buf: *const wchar_t) -> size_t;
Alex Crichtondafaca92015-09-09 21:50:47 -0700206
Alex Crichton5d6cf052015-09-11 14:52:34 -0700207 pub fn memcmp(cx: *const c_void, ct: *const c_void, n: size_t) -> c_int;
208 pub fn memchr(cx: *const c_void, c: c_int, n: size_t) -> *mut c_void;
Alex Crichtondafaca92015-09-09 21:50:47 -0700209}
Alex Crichtond3d77922015-09-11 17:03:39 -0700210
211// These are all inline functions on android
212#[cfg(not(target_os = "android"))]
213extern {
214 pub fn abs(i: c_int) -> c_int;
215 pub fn atof(s: *const c_char) -> c_double;
216 pub fn labs(i: c_long) -> c_long;
217 pub fn rand() -> c_int;
218 pub fn srand(seed: c_uint);
219}
Alex Crichton50a42e22015-09-15 14:27:15 -0700220
221cfg_if! {
222 if #[cfg(windows)] {
223 mod windows;
224 pub use windows::*;
225 } else {
226 mod unix;
227 pub use unix::*;
228 }
229}