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 239 240 241 242 243 244 245 246 247 248 249 250 251
//! [ECMAScript Module Record](https://tc39.es/ecma262/#sec-abstract-module-records)
use std::{hash::BuildHasherDefault, path::PathBuf, sync::Arc};
use dashmap::DashMap;
use indexmap::IndexMap;
use oxc_span::{Atom, Span};
use rustc_hash::{FxHashMap, FxHasher};
/// Module Record
///
/// See
/// * <https://tc39.es/ecma262/#table-additional-fields-of-source-text-module-records>
/// * <https://tc39.es/ecma262/#cyclic-module-record>
#[derive(Default)]
pub struct ModuleRecord {
/// Resolved absolute path to this module record
pub resolved_absolute_path: PathBuf,
/// `[[RequestedModules]]`
///
/// A List of all the ModuleSpecifier strings used by the module represented by this record to request the importation of a module. The List is in source text occurrence order.
///
/// Module requests from:
/// import ImportClause FromClause
/// import ModuleSpecifier
/// export ExportFromClause FromClause
/// Keyed by ModuleSpecifier, valued by all node occurrences
pub requested_modules: IndexMap<Atom, Vec<Span>, BuildHasherDefault<FxHasher>>,
/// `[[LoadedModules]]`
///
/// A map from the specifier strings used by the module represented by this record to request the importation of a module to the resolved Module Record.
/// The list does not contain two different Records with the same `[[Specifier]]`.
pub loaded_modules: DashMap<Atom, Arc<ModuleRecord>, BuildHasherDefault<FxHasher>>,
/// `[[ImportEntries]]`
///
/// A List of ImportEntry records derived from the code of this module
pub import_entries: Vec<ImportEntry>,
/// `[[LocalExportEntries]]`
///
/// A List of ExportEntry records derived from the code of this module
/// that correspond to declarations that occur within the module
pub local_export_entries: Vec<ExportEntry>,
/// `[[IndirectExportEntries]]`
///
/// A List of ExportEntry records derived from the code of this module
/// that correspond to reexported imports that occur within the module
/// or exports from export * as namespace declarations.
pub indirect_export_entries: Vec<ExportEntry>,
/// `[[StarExportEntries]]`
///
/// A List of ExportEntry records derived from the code of this module
/// that correspond to export * declarations that occur within the module,
/// not including export * as namespace declarations.
pub star_export_entries: Vec<ExportEntry>,
pub exported_bindings: FxHashMap<Atom, Span>,
pub exported_bindings_duplicated: Vec<NameSpan>,
pub export_default: Option<Span>,
pub export_default_duplicated: Vec<Span>,
}
impl ModuleRecord {
pub fn new(resolved_absolute_path: PathBuf) -> Self {
Self { resolved_absolute_path, ..Self::default() }
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct NameSpan {
name: Atom,
span: Span,
}
impl NameSpan {
pub fn new(name: Atom, span: Span) -> Self {
Self { name, span }
}
pub fn name(&self) -> &Atom {
&self.name
}
pub fn span(&self) -> Span {
self.span
}
}
/// [`ImportEntry`](https://tc39.es/ecma262/#importentry-record)
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ImportEntry {
/// String value of the ModuleSpecifier of the ImportDeclaration.
pub module_request: NameSpan,
/// The name under which the desired binding is exported by the module identified by `[[ModuleRequest]]`.
pub import_name: ImportImportName,
/// The name that is used to locally access the imported value from within the importing module.
pub local_name: NameSpan,
}
/// `ImportName` For `ImportEntry`
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ImportImportName {
Name(NameSpan),
NamespaceObject,
Default(Span),
}
impl ImportImportName {
pub fn is_default(&self) -> bool {
matches!(self, Self::Default(_))
}
pub fn is_namespace_object(&self) -> bool {
matches!(self, Self::NamespaceObject)
}
}
/// [`ExportEntry`](https://tc39.es/ecma262/#exportentry-record)
#[derive(Debug, Default, Clone, PartialEq, Eq)]
pub struct ExportEntry {
/// Span for the entire export entry
pub span: Span,
/// The String value of the ModuleSpecifier of the ExportDeclaration.
/// null if the ExportDeclaration does not have a ModuleSpecifier.
pub module_request: Option<NameSpan>,
/// The name under which the desired binding is exported by the module identified by `[[ModuleRequest]]`.
/// null if the ExportDeclaration does not have a ModuleSpecifier.
/// "all" is used for `export * as ns from "mod"`` declarations.
/// "all-but-default" is used for `export * from "mod" declarations`.
pub import_name: ExportImportName,
/// The name used to export this binding by this module.
pub export_name: ExportExportName,
/// The name that is used to locally access the exported value from within the importing module.
/// null if the exported value is not locally accessible from within the module.
pub local_name: ExportLocalName,
}
/// `ImportName` for `ExportEntry`
#[derive(Debug, Default, Clone, PartialEq, Eq)]
pub enum ExportImportName {
Name(NameSpan),
/// all is used for export * as ns from "mod" declarations.
All,
/// all-but-default is used for export * from "mod" declarations.
AllButDefault,
/// the ExportDeclaration does not have a ModuleSpecifier
#[default]
Null,
}
impl ExportImportName {
pub fn is_all(&self) -> bool {
matches!(self, Self::All)
}
pub fn is_all_but_default(&self) -> bool {
matches!(self, Self::AllButDefault)
}
}
/// `ExportName` for `ExportEntry`
#[derive(Debug, Default, Clone, PartialEq, Eq)]
pub enum ExportExportName {
Name(NameSpan),
Default(Span),
#[default]
Null,
}
impl ExportExportName {
pub fn is_default(&self) -> bool {
matches!(self, Self::Default(_))
}
pub fn is_null(&self) -> bool {
matches!(self, Self::Null)
}
}
/// `LocalName` for `ExportEntry`
#[derive(Debug, Default, Clone, PartialEq, Eq)]
pub enum ExportLocalName {
Name(NameSpan),
Default(Span),
#[default]
Null,
}
impl ExportLocalName {
pub fn is_default(&self) -> bool {
matches!(self, Self::Default(_))
}
pub fn is_null(&self) -> bool {
matches!(self, Self::Null)
}
}
#[cfg(test)]
mod test {
use super::{ExportExportName, ExportLocalName, ImportImportName, NameSpan};
use oxc_span::Span;
#[test]
fn import_import_name() {
let name = NameSpan::new("name".into(), Span::new(0, 0));
assert!(!ImportImportName::Name(name.clone()).is_default());
assert!(!ImportImportName::NamespaceObject.is_default());
assert!(ImportImportName::Default(Span::new(0, 0)).is_default());
assert!(!ImportImportName::Name(name).is_namespace_object());
assert!(ImportImportName::NamespaceObject.is_namespace_object());
assert!(!ImportImportName::Default(Span::new(0, 0)).is_namespace_object());
}
#[test]
fn export_import_name() {
let name = NameSpan::new("name".into(), Span::new(0, 0));
assert!(!ExportExportName::Name(name.clone()).is_default());
assert!(ExportExportName::Default(Span::new(0, 0)).is_default());
assert!(!ExportExportName::Null.is_default());
assert!(!ExportExportName::Name(name).is_null());
assert!(!ExportExportName::Default(Span::new(0, 0)).is_null());
assert!(ExportExportName::Null.is_null());
}
#[test]
fn export_local_name() {
let name = NameSpan::new("name".into(), Span::new(0, 0));
assert!(!ExportLocalName::Name(name.clone()).is_default());
assert!(ExportLocalName::Default(Span::new(0, 0)).is_default());
assert!(!ExportLocalName::Null.is_default());
assert!(!ExportLocalName::Name(name).is_null());
assert!(!ExportLocalName::Default(Span::new(0, 0)).is_null());
assert!(ExportLocalName::Null.is_null());
}
}