args.rs

// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Global storage for command line arguments
//!
//! The current incarnation of the Rust runtime expects for
//! the processes `argc` and `argv` arguments to be stored
//! in a globally-accessible location for use by the `os` module.
//!
//! Only valid to call on linux. Mac and Windows use syscalls to
//! discover the command line arguments.
//!
//! FIXME #7756: Would be nice for this to not exist.
//! FIXME #7756: This has a lot of C glue for lack of globals.

use option::Option;
#[cfg(test)] use option::{Some, None};
#[cfg(test)] use realstd;
#[cfg(test)] use realargs = realstd::rt::args;

/// One-time global initialization.
#[cfg(not(test))]
pub unsafe fn init(argc: int, argv: **u8) { imp::init(argc, argv) }
#[cfg(test)]
pub unsafe fn init(argc: int, argv: **u8) { realargs::init(argc, argv) }

/// One-time global cleanup.
#[cfg(not(test))] pub unsafe fn cleanup() { imp::cleanup() }
#[cfg(test)]      pub unsafe fn cleanup() { realargs::cleanup() }

/// Take the global arguments from global storage.
#[cfg(not(test))] pub fn take() -> Option<~[~str]> { imp::take() }
#[cfg(test)]      pub fn take() -> Option<~[~str]> {
    match realargs::take() {
        realstd::option::Some(a) => Some(a),
        realstd::option::None => None,
    }
}

/// Give the global arguments to global storage.
///
/// It is an error if the arguments already exist.
#[cfg(not(test))] pub fn put(args: ~[~str]) { imp::put(args) }
#[cfg(test)]      pub fn put(args: ~[~str]) { realargs::put(args) }

/// Make a clone of the global arguments.
#[cfg(not(test))] pub fn clone() -> Option<~[~str]> { imp::clone() }
#[cfg(test)]      pub fn clone() -> Option<~[~str]> {
    match realargs::clone() {
        realstd::option::Some(a) => Some(a),
        realstd::option::None => None,
    }
}

#[cfg(target_os = "linux")]
#[cfg(target_os = "android")]
#[cfg(target_os = "freebsd")]
mod imp {
    use cast;
    use clone::Clone;
    #[cfg(not(test))] use libc;
    use option::{Option, Some, None};
    use ptr::RawPtr;
    use iter::Iterator;
    #[cfg(not(test))] use str;
    use unstable::finally::Finally;
    use unstable::mutex::{Mutex, MUTEX_INIT};
    use util;
    #[cfg(not(test))] use vec;

    static mut global_args_ptr: uint = 0;
    static mut lock: Mutex = MUTEX_INIT;

    #[cfg(not(test))]
    pub unsafe fn init(argc: int, argv: **u8) {
        let args = load_argc_and_argv(argc, argv);
        put(args);
    }

    #[cfg(not(test))]
    pub unsafe fn cleanup() {
        rtassert!(take().is_some());
        lock.destroy();
    }

    pub fn take() -> Option<~[~str]> {
        with_lock(|| unsafe {
            let ptr = get_global_ptr();
            let val = util::replace(&mut *ptr, None);
            val.as_ref().map(|s: &~~[~str]| (**s).clone())
        })
    }

    pub fn put(args: ~[~str]) {
        with_lock(|| unsafe {
            let ptr = get_global_ptr();
            rtassert!((*ptr).is_none());
            (*ptr) = Some(~args.clone());
        })
    }

    pub fn clone() -> Option<~[~str]> {
        with_lock(|| unsafe {
            let ptr = get_global_ptr();
            (*ptr).as_ref().map(|s: &~~[~str]| (**s).clone())
        })
    }

    fn with_lock<T>(f: || -> T) -> T {
        (|| {
            unsafe {
                lock.lock();
                f()
            }
        }).finally(|| {
            unsafe {
                lock.unlock();
            }
        })
    }

    fn get_global_ptr() -> *mut Option<~~[~str]> {
        unsafe { cast::transmute(&global_args_ptr) }
    }

    // Copied from `os`.
    #[cfg(not(test))]
    unsafe fn load_argc_and_argv(argc: int, argv: **u8) -> ~[~str] {
        vec::from_fn(argc as uint, |i| {
            str::raw::from_c_str(*(argv as **libc::c_char).offset(i as int))
        })
    }

    #[cfg(test)]
    mod tests {
        use prelude::*;
        use super::*;
        use unstable::finally::Finally;

        #[test]
        fn smoke_test() {
            // Preserve the actual global state.
            let saved_value = take();

            let expected = ~[~"happy", ~"today?"];

            put(expected.clone());
            assert!(clone() == Some(expected.clone()));
            assert!(take() == Some(expected.clone()));
            assert!(take() == None);

            (|| {
            }).finally(|| {
                // Restore the actual global state.
                match saved_value {
                    Some(ref args) => put(args.clone()),
                    None => ()
                }
            })
        }
    }
}

#[cfg(target_os = "macos", not(test))]
#[cfg(target_os = "win32", not(test))]
mod imp {
    use option::Option;

    pub unsafe fn init(_argc: int, _argv: **u8) {
    }

    pub fn cleanup() {
    }

    pub fn take() -> Option<~[~str]> {
        fail!()
    }

    pub fn put(_args: ~[~str]) {
        fail!()
    }

    pub fn clone() -> Option<~[~str]> {
        fail!()
    }
}