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 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
//! <div align="center"> //! <img alt="Rune Logo" src="https://raw.githubusercontent.com/rune-rs/rune/main/assets/icon.png" /> //! </div> //! //! <br> //! //! <div align="center"> //! <a href="https://rune-rs.github.io"> //! <b>Visit the site 🌐</b> //! </a> //! - //! <a href="https://rune-rs.github.io/book/"> //! <b>Read the book 📖</b> //! </a> //! </div> //! //! <br> //! //! <div align="center"> //! <a href="https://github.com/rune-rs/rune/actions"> //! <img alt="Build Status" src="https://github.com/rune-rs/rune/workflows/Build/badge.svg"> //! </a> //! //! <a href="https://github.com/rune-rs/rune/actions"> //! <img alt="Site Status" src="https://github.com/rune-rs/rune/workflows/Site/badge.svg"> //! </a> //! //! <a href="https://crates.io/crates/rune"> //! <img alt="crates.io" src="https://img.shields.io/crates/v/rune.svg"> //! </a> //! //! <a href="https://docs.rs/rune"> //! <img alt="docs.rs" src="https://docs.rs/rune/badge.svg"> //! </a> //! //! <a href="https://discord.gg/v5AeNkT"> //! <img alt="Chat on Discord" src="https://img.shields.io/discord/558644981137670144.svg?logo=discord&style=flat-square"> //! </a> //! </div> //! //! <br> //! //! An embeddable dynamic programming language for Rust. //! //! ## Contributing //! //! If you want to help out, there should be a number of optimization tasks //! available in [Future Optimizations][future-optimizations]. Or have a look at //! [Open Issues]. //! //! Create an issue about the optimization you want to work on and communicate that //! you are working on it. //! //! <br> //! //! ## Highlights of Rune //! //! * Clean [Rust integration 💻][support-rust-integration]. //! * Memory safe through [reference counting 📖][support-reference-counted]. //! * [Template strings 📖][support-templates]. //! * [Try operators 📖][support-try]. //! * [Pattern matching 📖][support-patterns]. //! * [Structs and enums 📖][support-structs] with associated data and functions. //! * Dynamic [vectors 📖][support-dynamic-vectors], [objects 📖][support-anon-objects], and [tuples 📖][support-anon-tuples] with built-in [serde support 💻][support-serde]. //! * First-class [async support 📖][support-async]. //! * [Generators 📖][support-generators]. //! * Dynamic [instance functions 📖][support-instance-functions]. //! * [Stack isolation 📖][support-stack-isolation] between function calls. //! * Stack-based C FFI, like Lua's (TBD). //! //! <br> //! //! ## Rune scripts //! //! You can run Rune programs with the bundled CLI: //! //! ```text //! cargo run --bin rune -- run scripts/hello_world.rn //! ``` //! //! If you want to see detailed diagnostics of your program while it's running, //! you can use: //! //! ```text //! cargo run --bin rune -- run scripts/hello_world.rn --dump-unit --trace --dump-vm //! ``` //! //! See `--help` for more information. //! //! ## Running scripts from Rust //! //! > You can find more examples [in the `examples` folder]. //! //! The following is a complete example, including rich diagnostics using //! [`termcolor`]. It can be made much simpler if this is not needed. //! //! [`termcolor`]: https://docs.rs/termcolor //! //! ```rust //! use rune::termcolor::{ColorChoice, StandardStream}; //! use rune::EmitDiagnostics as _; //! use runestick::{Vm, FromValue as _, Item, Source}; //! //! use std::error::Error; //! use std::sync::Arc; //! //! #[tokio::main] //! async fn main() -> Result<(), Box<dyn Error>> { //! let context = runestick::Context::with_default_modules()?; //! let options = rune::Options::default(); //! //! let mut sources = rune::Sources::new(); //! sources.insert(Source::new( //! "script", //! r#" //! pub fn calculate(a, b) { //! println("Hello World"); //! a + b //! } //! "#, //! )); //! //! let mut diagnostics = rune::Diagnostics::new(); //! //! let result = rune::load_sources(&context, &options, &mut sources, &mut diagnostics); //! //! if !diagnostics.is_empty() { //! let mut writer = StandardStream::stderr(ColorChoice::Always); //! diagnostics.emit_diagnostics(&mut writer, &sources)?; //! } //! //! let unit = result?; //! let vm = Vm::new(Arc::new(context.runtime()), Arc::new(unit)); //! //! let mut execution = vm.execute(&["calculate"], (10i64, 20i64))?; //! let value = execution.async_complete().await?; //! //! let value = i64::from_value(value)?; //! //! println!("{}", value); //! Ok(()) //! } //! ``` //! //! [in the `examples` folder]: https://github.com/rune-rs/rune/tree/main/examples //! [future-optimizations]: https://github.com/rune-rs/rune/blob/main/FUTURE_OPTIMIZATIONS.md //! [Open Issues]: https://github.com/rune-rs/rune/issues //! [support-rust-integration]: https://github.com/rune-rs/rune/tree/main/crates/rune-modules //! [support-reference-counted]: https://rune-rs.github.io/book/variables.html //! [support-templates]: https://rune-rs.github.io/book/template_strings.html //! [support-try]: https://rune-rs.github.io/book/try_operator.html //! [support-patterns]: https://rune-rs.github.io/book/pattern_matching.html //! [support-structs]: https://rune-rs.github.io/book/structs.html //! [support-async]: https://rune-rs.github.io/book/async.html //! [support-generators]: https://rune-rs.github.io/book/generators.html //! [support-instance-functions]: https://rune-rs.github.io/book/instance_functions.html //! [support-stack-isolation]: https://rune-rs.github.io/book/call_frames.html //! [support-dynamic-vectors]: https://rune-rs.github.io/book/vectors.html //! [support-anon-objects]: https://rune-rs.github.io/book/objects.html //! [support-anon-tuples]: https://rune-rs.github.io/book/tuples.html //! [support-serde]: https://github.com/rune-rs/rune/blob/main/crates/rune-modules/src/json.rs #![deny(missing_docs)] #![allow( clippy::enum_variant_names, clippy::needless_doctest_main, clippy::never_loop, clippy::too_many_arguments )] #[macro_use] mod internal_macros; #[macro_use] pub mod ast; mod attrs; mod compiling; mod diagnostics; #[cfg(feature = "diagnostics")] mod emit_diagnostics; mod indexing; mod ir; mod load; pub mod macros; mod options; mod parsing; mod query; mod shared; mod spanned; mod worker; #[doc(hidden)] pub mod testing; /// Internal collection re-export. mod collections { pub use hashbrown::{hash_map, HashMap}; pub use hashbrown::{hash_set, HashSet}; } pub use self::compiling::{ BuildError, CompileError, CompileErrorKind, CompileResult, CompileVisitor, ImportEntryStep, LinkerError, NoopCompileVisitor, UnitBuilder, }; pub use self::diagnostics::{Diagnostic, Diagnostics, Error, ErrorKind, Warning, WarningKind}; #[cfg(feature = "diagnostics")] pub use self::emit_diagnostics::{ termcolor, DiagnosticsError, DumpInstructions, EmitDiagnostics, EmitSource, }; pub use self::ir::{IrError, IrErrorKind, IrValue}; pub use self::load::{load_sources, load_sources_with_visitor, LoadSourcesError}; pub use self::load::{FileSourceLoader, SourceLoader, Sources}; pub use self::macros::{ with_context, MacroContext, Quote, Storage, ToTokens, TokenStream, TokenStreamIter, }; pub use self::options::{ConfigurationError, Options}; pub use self::parsing::{ Id, Lexer, Parse, ParseError, ParseErrorKind, Parser, Peek, Peeker, Resolve, ResolveError, ResolveErrorKind, ResolveOwned, }; pub use self::query::{QueryError, QueryErrorKind, Used}; pub use self::shared::{ScopeError, ScopeErrorKind}; pub use self::spanned::{OptionSpanned, Spanned}; pub use compiling::compile; pub use rune_macros::quote; pub(crate) use rune_macros::{OptionSpanned, Parse, Spanned, ToTokens}; /// Parse the given input as the given type that implements /// [Parse][crate::parsing::Parse]. pub fn parse_all<T>(source: &str) -> Result<T, ParseError> where T: crate::parsing::Parse, { let mut parser = Parser::new(source); let ast = parser.parse::<T>()?; parser.eof()?; Ok(ast) }