solar_interface/
lib.rs

1#![doc = include_str!("../README.md")]
2#![doc(
3    html_logo_url = "https://raw.githubusercontent.com/paradigmxyz/solar/main/assets/logo.png",
4    html_favicon_url = "https://raw.githubusercontent.com/paradigmxyz/solar/main/assets/favicon.ico"
5)]
6#![cfg_attr(docsrs, feature(doc_cfg))]
7#![cfg_attr(feature = "nightly", feature(panic_update_hook))]
8
9#[macro_use]
10extern crate tracing;
11
12pub mod diagnostics;
13use diagnostics::ErrorGuaranteed;
14
15mod globals;
16use globals::SessionGlobals;
17
18mod pos;
19pub use pos::{BytePos, CharPos, RelativeBytePos};
20
21mod session;
22pub use session::{Session, SessionBuilder};
23
24pub mod source_map;
25pub use source_map::SourceMap;
26
27mod span;
28pub use span::{Span, Spanned, SpannedOption};
29
30mod symbol;
31pub use symbol::{ByteSymbol, Ident, Symbol, kw, sym};
32
33pub mod panic_hook;
34
35pub use config::ColorChoice;
36pub use dunce::canonicalize;
37pub use solar_config as config;
38pub use solar_data_structures as data_structures;
39
40/// Compiler result type.
41pub type Result<T = (), E = ErrorGuaranteed> = std::result::Result<T, E>;
42
43/// Pluralize a word based on a count.
44#[macro_export]
45#[rustfmt::skip]
46macro_rules! pluralize {
47    // Pluralize based on count (e.g., apples)
48    ($x:expr) => {
49        if $x == 1 { "" } else { "s" }
50    };
51    ("has", $x:expr) => {
52        if $x == 1 { "has" } else { "have" }
53    };
54    ("is", $x:expr) => {
55        if $x == 1 { "is" } else { "are" }
56    };
57    ("was", $x:expr) => {
58        if $x == 1 { "was" } else { "were" }
59    };
60    ("this", $x:expr) => {
61        if $x == 1 { "this" } else { "these" }
62    };
63}
64
65/// Creates new session globals on the current thread if they doesn't exist already and then
66/// executes the given closure.
67///
68/// Prefer [`Session::enter`] to this function if possible to also set the source map and thread
69/// pool.
70///
71/// Using this instead of [`Session::enter`] may cause unexpected panics.
72///
73/// See [`Session::enter`] for more details.
74#[inline]
75pub fn enter<R>(f: impl FnOnce() -> R) -> R {
76    SessionGlobals::with_or_default(|_| f())
77}
solar_interface/lib.rs

solar_interface/
lib.rs
