1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

//! Javascript values that user code can interact with.
//!
//! The [Value](struct.Value.html) object acts as the base type for all others
//! using dereference.  Therefore all types have access to the `Value` type's
//! methods and traits.  Implicit traits such as `Debug`, must be accessed by
//! dereferencing. For example: `Function` inherits `Object`, which in turn
//! inherits `Value`. To print a function using the debug trait, you need to
//! dereference twice.
//!
//! ```norun
//! println("Output: {:?}", **function_value);
//! ```
//!
//! Please note that the `Debug` trait should be carefully used. It relies
//! implicitly on an active context, and that it's the same context the value
//! was created with. Therefore it's mostly implemented to ease debugging.
//! Prefer `to_string` for safety.
//!
//! All created values are tied to a specific context. Because of this a
//! `ContextGuard` is required whenever creating new values, and they should
//! not be passed between different contexts.
use context::ContextGuard;
use chakracore_sys::*;

// TODO: Add typed arrays and buffer view.
pub use self::array::*;
pub use self::boolean::Boolean;
pub use self::error::Error;
pub use self::external::External;
pub use self::function::Function;
pub use self::number::Number;
pub use self::object::Object;
pub use self::promise::Promise;
pub use self::string::String;
pub use self::value::Value;

#[macro_use]
mod macros;

// Modules
pub mod function;
pub mod promise;
mod object;
mod array;
mod boolean;
mod error;
mod external;
mod number;
mod string;
mod value;

/// Creates a `false` value.
pub fn false_(_guard: &ContextGuard) -> Value {
    let mut value = JsValueRef::new();
    unsafe {
        jsassert!(JsGetFalseValue(&mut value));
        Value::from_raw(value)
    }
}

/// Creates a `true` value.
pub fn true_(_guard: &ContextGuard) -> Value {
    let mut value = JsValueRef::new();
    unsafe {
        jsassert!(JsGetTrueValue(&mut value));
        Value::from_raw(value)
    }
}

/// Creates a `null` value.
pub fn null(_guard: &ContextGuard) -> Value {
    let mut value = JsValueRef::new();
    unsafe {
        jsassert!(JsGetNullValue(&mut value));
        Value::from_raw(value)
    }
}

/// Creates an `undefined` value.
pub fn undefined(_guard: &ContextGuard) -> Value {
    let mut value = JsValueRef::new();
    unsafe {
        jsassert!(JsGetUndefinedValue(&mut value));
        Value::from_raw(value)
    }
}

// These are hidden and exists merely for the `is_same` functionality.
struct Null;
struct Undefined;

impl Null { is_same!(Null, "Returns true if the value is `null`"); }
impl Undefined { is_same!(Undefined, "Returns true if the value is `undefined`"); }