blob: 7997e11ca08f406195a3fedced0422954be4c489 [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 Crichtondafaca92015-09-09 21:50:47 -070013#![allow(bad_style, raw_pointer_derive)]
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(
20 html_root_url = "http://alexcrichton.com/libc/x86_64-unknown-linux-gnu"
21))]
22#![cfg_attr(all(target_os = "linux", target_arch = "x86"), doc(
23 html_root_url = "http://alexcrichton.com/libc/i686-unknown-linux-gnu"
24))]
25#![cfg_attr(all(target_os = "linux", target_arch = "arm"), doc(
26 html_root_url = "http://alexcrichton.com/libc/arm-unknown-linux-gnueabihf"
27))]
28#![cfg_attr(all(target_os = "linux", target_arch = "mips"), doc(
29 html_root_url = "http://alexcrichton.com/libc/mips-unknown-linux-gnu"
30))]
Alex Crichtond13e1e42015-09-17 17:29:18 -070031#![cfg_attr(all(target_os = "linux", target_arch = "aarch64"), doc(
32 html_root_url = "http://alexcrichton.com/libc/aarch64-unknown-linux-gnu"
33))]
Alex Crichton730a17f2015-09-17 10:05:36 -070034#![cfg_attr(all(target_os = "linux", target_env = "musl"), doc(
35 html_root_url = "http://alexcrichton.com/libc/x86_64-unknown-linux-musl"
36))]
37#![cfg_attr(all(target_os = "macos", target_arch = "x86_64"), doc(
38 html_root_url = "http://alexcrichton.com/libc/x86_64-apple-darwin"
39))]
40#![cfg_attr(all(target_os = "macos", target_arch = "x86"), doc(
41 html_root_url = "http://alexcrichton.com/libc/i686-apple-darwin"
42))]
43#![cfg_attr(all(windows, target_arch = "x86_64", target_env = "gnu"), doc(
44 html_root_url = "http://alexcrichton.com/libc/x86_64-pc-windows-gnu"
45))]
Alex Crichton611e9a32015-09-17 10:06:19 -070046#![cfg_attr(all(windows, target_arch = "x86", target_env = "gnu"), doc(
Alex Crichton730a17f2015-09-17 10:05:36 -070047 html_root_url = "http://alexcrichton.com/libc/i686-pc-windows-gnu"
48))]
49#![cfg_attr(all(windows, target_arch = "x86_64", target_env = "msvc"), doc(
50 html_root_url = "http://alexcrichton.com/libc/x86_64-pc-windows-msvc"
51))]
Alex Crichton611e9a32015-09-17 10:06:19 -070052#![cfg_attr(all(windows, target_arch = "x86", target_env = "msvc"), doc(
Alex Crichton730a17f2015-09-17 10:05:36 -070053 html_root_url = "http://alexcrichton.com/libc/i686-pc-windows-msvc"
54))]
55#![cfg_attr(all(target_os = "android"), doc(
56 html_root_url = "http://alexcrichton.com/libc/arm-linux-androideabi"
57))]
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 Crichton5d6cf052015-09-11 14:52:34 -070080pub enum FILE {}
81pub enum fpos_t {}
82pub enum DIR {}
83pub enum dirent {}
Alex Crichtondafaca92015-09-09 21:50:47 -070084
Alex Crichton5d6cf052015-09-11 14:52:34 -070085extern {
86 pub fn isalnum(c: c_int) -> c_int;
87 pub fn isalpha(c: c_int) -> c_int;
88 pub fn iscntrl(c: c_int) -> c_int;
89 pub fn isdigit(c: c_int) -> c_int;
90 pub fn isgraph(c: c_int) -> c_int;
91 pub fn islower(c: c_int) -> c_int;
92 pub fn isprint(c: c_int) -> c_int;
93 pub fn ispunct(c: c_int) -> c_int;
94 pub fn isspace(c: c_int) -> c_int;
95 pub fn isupper(c: c_int) -> c_int;
96 pub fn isxdigit(c: c_int) -> c_int;
97 pub fn tolower(c: c_int) -> c_int;
98 pub fn toupper(c: c_int) -> c_int;
Alex Crichtondafaca92015-09-09 21:50:47 -070099
Alex Crichton5d6cf052015-09-11 14:52:34 -0700100 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
101 link_name = "fopen$UNIX2003")]
102 pub fn fopen(filename: *const c_char,
103 mode: *const c_char) -> *mut FILE;
104 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
105 link_name = "freopen$UNIX2003")]
106 pub fn freopen(filename: *const c_char, mode: *const c_char,
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700107 file: *mut FILE) -> *mut FILE;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700108 pub fn fflush(file: *mut FILE) -> c_int;
109 pub fn fclose(file: *mut FILE) -> c_int;
110 pub fn remove(filename: *const c_char) -> c_int;
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700111 pub fn rename(oldname: *const c_char, newname: *const c_char) -> c_int;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700112 pub fn tmpfile() -> *mut FILE;
113 pub fn setvbuf(stream: *mut FILE,
114 buffer: *mut c_char,
115 mode: c_int,
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700116 size: size_t) -> c_int;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700117 pub fn setbuf(stream: *mut FILE, buf: *mut c_char);
Alex Crichton5d6cf052015-09-11 14:52:34 -0700118 pub fn fgetc(stream: *mut FILE) -> c_int;
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700119 pub fn fgets(buf: *mut c_char, n: c_int, stream: *mut FILE) -> *mut c_char;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700120 pub fn fputc(c: c_int, stream: *mut FILE) -> c_int;
121 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
122 link_name = "fputs$UNIX2003")]
123 pub fn fputs(s: *const c_char, stream: *mut FILE)-> c_int;
124 pub fn puts(s: *const c_char) -> c_int;
125 pub fn ungetc(c: c_int, stream: *mut FILE) -> c_int;
126 pub fn fread(ptr: *mut c_void,
127 size: size_t,
128 nobj: size_t,
129 stream: *mut FILE)
130 -> size_t;
131 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
132 link_name = "fwrite$UNIX2003")]
133 pub fn fwrite(ptr: *const c_void,
134 size: size_t,
135 nobj: size_t,
136 stream: *mut FILE)
137 -> size_t;
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700138 pub fn fseek(stream: *mut FILE, offset: c_long, whence: c_int) -> c_int;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700139 pub fn ftell(stream: *mut FILE) -> c_long;
140 pub fn rewind(stream: *mut FILE);
141 pub fn fgetpos(stream: *mut FILE, ptr: *mut fpos_t) -> c_int;
142 pub fn fsetpos(stream: *mut FILE, ptr: *const fpos_t) -> c_int;
143 pub fn feof(stream: *mut FILE) -> c_int;
144 pub fn ferror(stream: *mut FILE) -> c_int;
145 pub fn perror(s: *const c_char);
Alex Crichton5d6cf052015-09-11 14:52:34 -0700146 pub fn atoi(s: *const c_char) -> c_int;
147 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
148 link_name = "strtod$UNIX2003")]
Alex Crichtonbfc6ebc2015-09-11 15:29:40 -0700149 pub fn strtod(s: *const c_char, endp: *mut *mut c_char) -> c_double;
Alex Crichton5d6cf052015-09-11 14:52:34 -0700150 pub fn strtol(s: *const c_char,
151 endp: *mut *mut c_char, base: c_int) -> c_long;
152 pub fn strtoul(s: *const c_char, endp: *mut *mut c_char,
153 base: c_int) -> c_ulong;
154 pub fn calloc(nobj: size_t, size: size_t) -> *mut c_void;
155 pub fn malloc(size: size_t) -> *mut c_void;
156 pub fn realloc(p: *mut c_void, size: size_t) -> *mut c_void;
157 pub fn free(p: *mut c_void);
158 pub fn exit(status: c_int) -> !;
159 pub fn _exit(status: c_int) -> !;
160 pub fn atexit(cb: extern fn()) -> c_int;
161 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
162 link_name = "system$UNIX2003")]
163 pub fn system(s: *const c_char) -> c_int;
164 pub fn getenv(s: *const c_char) -> *mut c_char;
Alex Crichtondafaca92015-09-09 21:50:47 -0700165
Alex Crichton5d6cf052015-09-11 14:52:34 -0700166 pub fn strcpy(dst: *mut c_char, src: *const c_char) -> *mut c_char;
167 pub fn strncpy(dst: *mut c_char, src: *const c_char, n: size_t)
168 -> *mut c_char;
169 pub fn strcat(s: *mut c_char, ct: *const c_char) -> *mut c_char;
170 pub fn strncat(s: *mut c_char, ct: *const c_char, n: size_t) -> *mut c_char;
171 pub fn strcmp(cs: *const c_char, ct: *const c_char) -> c_int;
172 pub fn strncmp(cs: *const c_char, ct: *const c_char, n: size_t) -> c_int;
173 pub fn strcoll(cs: *const c_char, ct: *const c_char) -> c_int;
174 pub fn strchr(cs: *const c_char, c: c_int) -> *mut c_char;
175 pub fn strrchr(cs: *const c_char, c: c_int) -> *mut c_char;
176 pub fn strspn(cs: *const c_char, ct: *const c_char) -> size_t;
177 pub fn strcspn(cs: *const c_char, ct: *const c_char) -> size_t;
178 pub fn strpbrk(cs: *const c_char, ct: *const c_char) -> *mut c_char;
179 pub fn strstr(cs: *const c_char, ct: *const c_char) -> *mut c_char;
180 pub fn strlen(cs: *const c_char) -> size_t;
181 #[cfg_attr(all(target_os = "macos", target_arch = "x86"),
182 link_name = "strerror$UNIX2003")]
183 pub fn strerror(n: c_int) -> *mut c_char;
184 pub fn strtok(s: *mut c_char, t: *const c_char) -> *mut c_char;
185 pub fn strxfrm(s: *mut c_char, ct: *const c_char, n: size_t) -> size_t;
186 pub fn wcslen(buf: *const wchar_t) -> size_t;
Alex Crichtondafaca92015-09-09 21:50:47 -0700187
Alex Crichton5d6cf052015-09-11 14:52:34 -0700188 pub fn memcmp(cx: *const c_void, ct: *const c_void, n: size_t) -> c_int;
189 pub fn memchr(cx: *const c_void, c: c_int, n: size_t) -> *mut c_void;
Alex Crichtondafaca92015-09-09 21:50:47 -0700190}
Alex Crichtond3d77922015-09-11 17:03:39 -0700191
192// These are all inline functions on android
193#[cfg(not(target_os = "android"))]
194extern {
195 pub fn abs(i: c_int) -> c_int;
196 pub fn atof(s: *const c_char) -> c_double;
197 pub fn labs(i: c_long) -> c_long;
198 pub fn rand() -> c_int;
199 pub fn srand(seed: c_uint);
200}
Alex Crichton50a42e22015-09-15 14:27:15 -0700201
202cfg_if! {
203 if #[cfg(windows)] {
204 mod windows;
205 pub use windows::*;
206 } else {
207 mod unix;
208 pub use unix::*;
209 }
210}