go-engine 0.1.5

The wrapper of the Goscript project.
Documentation 
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

// Copyright 2022 The Goscript Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

use crate::ffi::Ffi;
#[cfg(feature = "go_std")]
use crate::std::os;
#[cfg(feature = "serde_borsh")]
use borsh::BorshSerialize;
use std::path::Path;
use std::rc::Rc;

#[cfg(feature = "codegen")]
pub use {cg::SourceRead, types::ImportKey};
#[cfg(feature = "codegen")]
extern crate go_codegen as cg;
#[cfg(feature = "codegen")]
extern crate go_parser as parser;
#[cfg(feature = "codegen")]
extern crate go_types as types;
extern crate go_vm as vm;

#[derive(Default)]
pub struct Config {
    /// print debug info in parser
    pub trace_parser: bool,
    /// print debug info in checker
    pub trace_checker: bool,
    /// custom std in
    pub std_in: Option<Box<dyn std::io::Read + Sync + Send>>,
    /// custom std out
    pub std_out: Option<Box<dyn std::io::Write + Sync + Send>>,
    /// custom std err
    pub std_err: Option<Box<dyn std::io::Write + Sync + Send>>,
}

pub struct Engine {
    ffi: vm::FfiFactory,
}

impl Engine {
    pub fn new() -> Engine {
        #[cfg(not(feature = "go_std"))]
        {
            Engine {
                ffi: vm::FfiFactory::new(),
            }
        }

        #[cfg(feature = "go_std")]
        {
            let mut e = Engine {
                ffi: vm::FfiFactory::new(),
            };
            crate::std::register(&mut e.ffi);
            e
        }
    }

    pub fn with_user_data(data: usize) -> Engine {
        #[cfg(not(feature = "go_std"))]
        {
            Engine {
                ffi: vm::FfiFactory::with_user_data(data),
            }
        }

        #[cfg(feature = "go_std")]
        {
            let mut e = Engine {
                ffi: vm::FfiFactory::with_user_data(data),
            };
            crate::std::register(&mut e.ffi);
            e
        }
    }

    #[cfg(feature = "go_std")]
    pub fn set_std_io(
        &self,
        std_in: Option<Box<dyn std::io::Read + Sync + Send>>,
        std_out: Option<Box<dyn std::io::Write + Sync + Send>>,
        std_err: Option<Box<dyn std::io::Write + Sync + Send>>,
    ) {
        os::set_std_io(std_in, std_out, std_err);
    }

    pub fn register_extension(&mut self, name: &'static str, proto: Rc<dyn Ffi>) {
        self.ffi.register(name, proto);
    }

    #[cfg(feature = "codegen")]
    pub fn compile<S: SourceRead>(
        &self,
        reader: &S,
        path: &Path,
        debug_info: bool,
        trace_parser: bool,
        trace_checker: bool,
    ) -> Result<vm::Bytecode, parser::ErrorList> {
        let cfg = types::TraceConfig {
            trace_parser,
            trace_checker,
        };
        cg::parse_check_gen(path, &cfg, reader, debug_info)
    }

    #[cfg(all(feature = "codegen", feature = "serde_borsh"))]
    pub fn compile_serialize<S: SourceRead>(
        &self,
        reader: &S,
        path: &Path,
        debug_info: bool,
        trace_parser: bool,
        trace_checker: bool,
    ) -> Result<Vec<u8>, parser::ErrorList> {
        self.compile(reader, path, debug_info, trace_parser, trace_checker)
            .map(|code| code.try_to_vec().unwrap())
    }

    pub fn run_bytecode(&self, bc: &vm::Bytecode) -> Option<vm::PanicData> {
        vm::run(bc, &self.ffi)
    }

    #[cfg(feature = "codegen")]
    pub fn run_source<S: SourceRead>(
        &self,
        trace_parser: bool,
        trace_checker: bool,
        reader: &S,
        path: &Path,
        panic_handler: Option<Rc<dyn Fn(String, String)>>,
    ) -> Result<(), parser::ErrorList> {
        self.compile(reader, path, true, trace_parser, trace_checker)
            .map(|code| {
                // let mut decoded;
                // #[cfg(feature = "serde_borsh")]
                // {
                //     let encoded = code.try_to_vec().unwrap();
                //     decoded = go_vm::Bytecode::try_from_slice(&encoded).unwrap();
                // }
                // #[cfg(not(feature = "serde_borsh"))]
                // {
                //     decoded = code;
                // }
                let pdata = vm::run(&code, &self.ffi);
                if let Some(pdata) = pdata {
                    let call_stack = vm::CallStackDisplay::new(&pdata, &code);
                    if let Some(handler) = panic_handler {
                        handler(format!("{}", pdata.msg), format!("{}", call_stack));
                    } else {
                        eprintln!("{}\n", pdata.msg);
                        eprintln!("{}\n", call_stack);
                    }
                }
            })
    }
}