rust/src/libcore/ptr.rs

305 lines
8.2 KiB
Rust
Raw Normal View History

//! Unsafe pointer utility functions
2012-03-10 02:04:09 -06:00
export addr_of;
export to_unsafe_ptr;
2012-09-02 17:54:05 -05:00
export to_mut_unsafe_ptr;
2012-03-10 02:04:09 -06:00
export mut_addr_of;
export offset;
export const_offset;
2012-03-10 02:04:09 -06:00
export mut_offset;
export null;
2012-04-04 00:32:55 -05:00
export is_null;
export is_not_null;
2012-03-10 02:04:09 -06:00
export memcpy;
export memmove;
export memset;
export to_uint;
2012-08-11 14:42:58 -05:00
export ref_eq;
2012-04-15 02:40:47 -05:00
export buf_len;
export position;
2012-08-14 18:54:13 -05:00
export Ptr;
2012-03-10 02:04:09 -06:00
2012-08-27 18:26:35 -05:00
import cmp::{Eq, Ord};
import libc::{c_void, size_t};
#[nolink]
#[abi = "cdecl"]
extern mod libc_ {
#[rust_stack]
fn memcpy(dest: *c_void, src: *c_void, n: libc::size_t) -> *c_void;
#[rust_stack]
fn memmove(dest: *c_void, src: *c_void, n: libc::size_t) -> *c_void;
#[rust_stack]
fn memset(dest: *c_void, c: libc::c_int, len: libc::size_t) -> *c_void;
}
#[abi = "rust-intrinsic"]
extern mod rusti {
fn addr_of<T>(val: T) -> *T;
}
/// Get an unsafe pointer to a value
#[inline(always)]
2012-06-07 09:18:24 -05:00
pure fn addr_of<T>(val: T) -> *T { unchecked { rusti::addr_of(val) } }
/// Get an unsafe mut pointer to a value
#[inline(always)]
pure fn mut_addr_of<T>(val: T) -> *mut T {
unsafe {
2012-08-29 18:00:36 -05:00
unsafe::reinterpret_cast(&rusti::addr_of(val))
}
}
/// Calculate the offset from a pointer
#[inline(always)]
fn offset<T>(ptr: *T, count: uint) -> *T {
unsafe {
(ptr as uint + count * sys::size_of::<T>()) as *T
}
}
/// Calculate the offset from a const pointer
#[inline(always)]
fn const_offset<T>(ptr: *const T, count: uint) -> *const T {
unsafe {
(ptr as uint + count * sys::size_of::<T>()) as *T
}
}
/// Calculate the offset from a mut pointer
#[inline(always)]
2012-03-26 20:35:18 -05:00
fn mut_offset<T>(ptr: *mut T, count: uint) -> *mut T {
(ptr as uint + count * sys::size_of::<T>()) as *mut T
}
/// Return the offset of the first null pointer in `buf`.
#[inline(always)]
unsafe fn buf_len<T>(buf: **T) -> uint {
2012-06-30 18:19:07 -05:00
position(buf, |i| i == null())
}
/// Return the first offset `i` such that `f(buf[i]) == true`.
#[inline(always)]
unsafe fn position<T>(buf: *T, f: fn(T) -> bool) -> uint {
let mut i = 0u;
loop {
2012-08-01 19:30:05 -05:00
if f(*offset(buf, i)) { return i; }
else { i += 1u; }
}
}
/// Create an unsafe null pointer
#[inline(always)]
2012-08-29 18:00:36 -05:00
pure fn null<T>() -> *T { unsafe { unsafe::reinterpret_cast(&0u) } }
2012-04-03 23:56:16 -05:00
/// Returns true if the pointer is equal to the null pointer.
2012-04-03 23:56:16 -05:00
pure fn is_null<T>(ptr: *const T) -> bool { ptr == null() }
/// Returns true if the pointer is not equal to the null pointer.
2012-04-03 23:56:16 -05:00
pure fn is_not_null<T>(ptr: *const T) -> bool { !is_null(ptr) }
2012-01-17 19:28:21 -06:00
/**
* Copies data from one location to another
*
* Copies `count` elements (not bytes) from `src` to `dst`. The source
* and destination may not overlap.
*/
#[inline(always)]
2012-02-07 15:21:11 -06:00
unsafe fn memcpy<T>(dst: *T, src: *T, count: uint) {
let n = count * sys::size_of::<T>();
libc_::memcpy(dst as *c_void, src as *c_void, n as size_t);
2012-02-07 15:21:11 -06:00
}
/**
* Copies data from one location to another
*
* Copies `count` elements (not bytes) from `src` to `dst`. The source
* and destination may overlap.
*/
#[inline(always)]
2012-02-07 15:21:11 -06:00
unsafe fn memmove<T>(dst: *T, src: *T, count: uint) {
let n = count * sys::size_of::<T>();
libc_::memmove(dst as *c_void, src as *c_void, n as size_t);
2012-02-07 15:21:11 -06:00
}
#[inline(always)]
unsafe fn memset<T>(dst: *mut T, c: int, count: uint) {
let n = count * sys::size_of::<T>();
libc_::memset(dst as *c_void, c as libc::c_int, n as size_t);
}
/**
Transform a region pointer - &T - to an unsafe pointer - *T.
This is safe, but is implemented with an unsafe block due to
reinterpret_cast.
*/
#[inline(always)]
fn to_unsafe_ptr<T>(thing: &T) -> *T unsafe {
2012-08-29 18:00:36 -05:00
unsafe::reinterpret_cast(&thing)
}
2012-09-02 17:54:05 -05:00
/**
Transform a mutable region pointer - &mut T - to a mutable unsafe pointer -
*mut T. This is safe, but is implemented with an unsafe block due to
reinterpret_cast.
*/
#[inline(always)]
fn to_mut_unsafe_ptr<T>(thing: &mut T) -> *mut T unsafe {
unsafe::reinterpret_cast(&thing)
2012-09-02 17:54:05 -05:00
}
/**
Cast a region pointer - &T - to a uint.
This is safe, but is implemented with an unsafe block due to
reinterpret_cast.
(I couldn't think of a cutesy name for this one.)
*/
#[inline(always)]
fn to_uint<T>(thing: &T) -> uint unsafe {
2012-08-29 18:00:36 -05:00
unsafe::reinterpret_cast(&thing)
}
2012-08-11 14:42:58 -05:00
/// Determine if two borrowed pointers point to the same thing.
#[inline(always)]
fn ref_eq<T>(thing: &a/T, other: &b/T) -> bool {
2012-08-11 14:42:58 -05:00
to_uint(thing) == to_uint(other)
}
2012-08-14 18:54:13 -05:00
trait Ptr {
pure fn is_null() -> bool;
pure fn is_not_null() -> bool;
}
/// Extension methods for pointers
2012-08-14 18:54:13 -05:00
impl<T> *T: Ptr {
/// Returns true if the pointer is equal to the null pointer.
pure fn is_null() -> bool { is_null(self) }
/// Returns true if the pointer is not equal to the null pointer.
pure fn is_not_null() -> bool { is_not_null(self) }
}
// Equality for pointers
impl<T> *const T : Eq {
2012-08-27 18:26:35 -05:00
pure fn eq(&&other: *const T) -> bool unsafe {
2012-08-29 18:00:36 -05:00
let a: uint = unsafe::reinterpret_cast(&self);
let b: uint = unsafe::reinterpret_cast(&other);
2012-08-27 18:26:35 -05:00
return a == b;
}
}
// Comparison for pointers
impl<T> *const T : Ord {
pure fn lt(&&other: *const T) -> bool unsafe {
2012-08-29 18:00:36 -05:00
let a: uint = unsafe::reinterpret_cast(&self);
let b: uint = unsafe::reinterpret_cast(&other);
2012-08-27 18:26:35 -05:00
return a < b;
}
pure fn le(&&other: *const T) -> bool unsafe {
2012-08-29 18:00:36 -05:00
let a: uint = unsafe::reinterpret_cast(&self);
let b: uint = unsafe::reinterpret_cast(&other);
return a <= b;
}
pure fn ge(&&other: *const T) -> bool unsafe {
2012-08-29 18:00:36 -05:00
let a: uint = unsafe::reinterpret_cast(&self);
let b: uint = unsafe::reinterpret_cast(&other);
return a >= b;
}
pure fn gt(&&other: *const T) -> bool unsafe {
2012-08-29 18:00:36 -05:00
let a: uint = unsafe::reinterpret_cast(&self);
let b: uint = unsafe::reinterpret_cast(&other);
return a > b;
}
2012-08-27 18:26:35 -05:00
}
// Equality for region pointers
impl<T:Eq> &const T : Eq {
pure fn eq(&&other: &const T) -> bool {
return *self == *other;
}
}
// Comparison for region pointers
impl<T:Ord> &const T : Ord {
pure fn lt(&&other: &const T) -> bool { *self < *other }
pure fn le(&&other: &const T) -> bool { *self <= *other }
pure fn ge(&&other: &const T) -> bool { *self >= *other }
pure fn gt(&&other: &const T) -> bool { *self > *other }
}
2012-01-17 19:28:21 -06:00
#[test]
fn test() {
unsafe {
2012-08-15 16:10:46 -05:00
type Pair = {mut fst: int, mut snd: int};
let p = {mut fst: 10, mut snd: 20};
2012-08-15 16:10:46 -05:00
let pptr: *mut Pair = mut_addr_of(p);
2012-08-29 18:00:36 -05:00
let iptr: *mut int = unsafe::reinterpret_cast(&pptr);
assert (*iptr == 10);;
*iptr = 30;
assert (*iptr == 30);
assert (p.fst == 30);;
*pptr = {mut fst: 50, mut snd: 60};
assert (*iptr == 50);
assert (p.fst == 50);
assert (p.snd == 60);
let v0 = ~[32000u16, 32001u16, 32002u16];
let v1 = ~[0u16, 0u16, 0u16];
ptr::memcpy(ptr::offset(vec::unsafe::to_ptr(v1), 1u),
ptr::offset(vec::unsafe::to_ptr(v0), 1u), 1u);
assert (v1[0] == 0u16 && v1[1] == 32001u16 && v1[2] == 0u16);
ptr::memcpy(vec::unsafe::to_ptr(v1),
ptr::offset(vec::unsafe::to_ptr(v0), 2u), 1u);
assert (v1[0] == 32002u16 && v1[1] == 32001u16 && v1[2] == 0u16);
ptr::memcpy(ptr::offset(vec::unsafe::to_ptr(v1), 2u),
vec::unsafe::to_ptr(v0), 1u);
assert (v1[0] == 32002u16 && v1[1] == 32001u16 && v1[2] == 32000u16);
}
}
#[test]
fn test_position() {
import str::as_c_str;
import libc::c_char;
let s = ~"hello";
unsafe {
2012-06-30 18:19:07 -05:00
assert 2u == as_c_str(s, |p| position(p, |c| c == 'l' as c_char));
assert 4u == as_c_str(s, |p| position(p, |c| c == 'o' as c_char));
assert 5u == as_c_str(s, |p| position(p, |c| c == 0 as c_char));
}
}
#[test]
fn test_buf_len() {
let s0 = ~"hello";
let s1 = ~"there";
let s2 = ~"thing";
2012-06-30 18:19:07 -05:00
do str::as_c_str(s0) |p0| {
do str::as_c_str(s1) |p1| {
do str::as_c_str(s2) |p2| {
let v = ~[p0, p1, p2, null()];
do vec::as_buf(v) |vp, len| {
assert unsafe { buf_len(vp) } == 3u;
assert len == 4u;
}
}
}
}
2012-04-15 02:40:47 -05:00
}
#[test]
fn test_is_null() {
let p: *int = ptr::null();
assert p.is_null();
assert !p.is_not_null();
let q = ptr::offset(p, 1u);
assert !q.is_null();
assert q.is_not_null();
2012-08-11 14:42:58 -05:00
}