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 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
use alloc::{string::ToString, sync::Arc};
use core::{
fmt,
hash::{Hash, Hasher},
str::FromStr,
};
use crate::{
ast::{CaseKindError, Ident, IdentError},
diagnostics::{IntoDiagnostic, Report},
LibraryNamespace, LibraryPath, SourceSpan, Span, Spanned,
};
// QUALIFIED PROCEDURE NAME
// ================================================================================================
/// Represents a qualified procedure name, e.g. `std::math::u64::add`, parsed into it's
/// constituent [LibraryPath] and [ProcedureName] components.
///
/// A qualified procedure name can be context-sensitive, i.e. the module path might refer
/// to an imported
#[derive(Clone)]
pub struct QualifiedProcedureName {
/// The source span associated with this identifier.
pub span: SourceSpan,
/// The module path for this procedure.
pub module: LibraryPath,
/// The name of the procedure.
pub name: ProcedureName,
}
impl QualifiedProcedureName {
/// Create a new [QualifiedProcedureName] with the given fully-qualified module path
/// and procedure name.
pub fn new(module: LibraryPath, name: ProcedureName) -> Self {
Self {
span: SourceSpan::default(),
module,
name,
}
}
/// Returns the namespace of this fully-qualified procedure name.
pub fn namespace(&self) -> &LibraryNamespace {
self.module.namespace()
}
}
impl FromStr for QualifiedProcedureName {
type Err = Report;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s.rsplit_once("::") {
None => Err(Report::msg("invalid fully-qualified procedure name, expected namespace")),
Some((path, name)) => {
let name = name.parse::<ProcedureName>().into_diagnostic()?;
let path = path.parse::<LibraryPath>().into_diagnostic()?;
Ok(Self::new(path, name))
},
}
}
}
impl Eq for QualifiedProcedureName {}
impl PartialEq for QualifiedProcedureName {
fn eq(&self, other: &Self) -> bool {
self.name == other.name && self.module == other.module
}
}
impl Ord for QualifiedProcedureName {
fn cmp(&self, other: &Self) -> core::cmp::Ordering {
self.module.cmp(&other.module).then_with(|| self.name.cmp(&other.name))
}
}
impl PartialOrd for QualifiedProcedureName {
fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl From<QualifiedProcedureName> for miette::SourceSpan {
fn from(fqn: QualifiedProcedureName) -> Self {
fqn.span.into()
}
}
impl Spanned for QualifiedProcedureName {
fn span(&self) -> SourceSpan {
self.span
}
}
impl fmt::Debug for QualifiedProcedureName {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("FullyQualifiedProcedureName")
.field("module", &self.module)
.field("name", &self.name)
.finish()
}
}
impl crate::prettier::PrettyPrint for QualifiedProcedureName {
fn render(&self) -> vm_core::prettier::Document {
use crate::prettier::*;
display(self)
}
}
impl fmt::Display for QualifiedProcedureName {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{}::{}", &self.module, &self.name)
}
}
// PROCEDURE NAME
// ================================================================================================
/// Procedure name.
///
/// The symbol represented by this type must comply with the following rules:
///
/// - It must start with an ASCII alphabetic character, or one of: `_`, `.`, or `$`
/// - If it starts with a non-ASCII alphabetic character, it must contain at least one ASCII
/// alphabetic character, e.g. `_`, `$_` are not valid symbols, but `_a` or `$_a` are.
/// - Otherwise, the name may consist of any number of printable ASCII characters, e.g.
/// alphanumerics, punctuation, etc. Control characters and the like are explicitly not allowed.
///
/// NOTE: In Miden Assembly source files, a procedure name must be quoted in double-quotes if it
/// contains any characters other than ASCII alphanumerics, or `_`. See examples below.
///
/// ## Examples
///
/// ```masm,ignore
/// # All ASCII alphanumeric, bare identifier
/// proc.foo
/// ...
/// end
///
/// # All ASCII alphanumeric, leading underscore
/// proc._foo
/// ...
/// end
///
/// # A symbol which contains `::`, which would be treated as a namespace operator, so requires quoting
/// proc."std::foo"
/// ...
/// end
///
/// # A complex procedure name representing a monomorphized Rust function, requires quoting
/// proc."alloc::alloc::box_free::<dyn alloc::boxed::FnBox<(), Output = ()>>"
/// ...
/// end
/// ```
#[derive(Debug, Clone)]
pub struct ProcedureName(Ident);
impl ProcedureName {
/// Reserved name for a main procedure.
pub const MAIN_PROC_NAME: &'static str = "#main";
/// Creates a [ProcedureName] from `name`.
pub fn new(name: impl AsRef<str>) -> Result<Self, IdentError> {
name.as_ref().parse()
}
/// Creates a [ProcedureName] from `name`
pub fn new_with_span(span: SourceSpan, name: impl AsRef<str>) -> Result<Self, IdentError> {
name.as_ref().parse::<Self>().map(|name| name.with_span(span))
}
/// Sets the span for this [ProcedureName].
pub fn with_span(self, span: SourceSpan) -> Self {
Self(self.0.with_span(span))
}
/// Creates a [ProcedureName] from its raw components.
///
/// It is expected that the caller has already validated that the name meets all validity
/// criteria for procedure names, for example, the parser only lexes/parses valid identifiers,
/// so by construction all such identifiers are valid.
///
/// NOTE: This function is perma-unstable, it may be removed or modified at any time.
pub fn new_unchecked(name: Ident) -> Self {
Self(name)
}
/// Obtains a procedure name representing the reserved name for the executable entrypoint
/// (i.e., `main`).
pub fn main() -> Self {
let name = Arc::from(Self::MAIN_PROC_NAME.to_string().into_boxed_str());
Self(Ident::new_unchecked(Span::unknown(name)))
}
/// Is this the reserved name for the executable entrypoint (i.e. `main`)?
pub fn is_main(&self) -> bool {
self.0.as_str() == Self::MAIN_PROC_NAME
}
/// Returns a string reference for this procedure name.
pub fn as_str(&self) -> &str {
self.as_ref()
}
}
impl Eq for ProcedureName {}
impl PartialEq for ProcedureName {
fn eq(&self, other: &Self) -> bool {
self.0 == other.0
}
}
impl Ord for ProcedureName {
fn cmp(&self, other: &Self) -> core::cmp::Ordering {
self.0.cmp(&other.0)
}
}
impl PartialOrd for ProcedureName {
fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Hash for ProcedureName {
fn hash<H: Hasher>(&self, state: &mut H) {
self.0.hash(state);
}
}
impl Spanned for ProcedureName {
fn span(&self) -> SourceSpan {
self.0.span()
}
}
impl From<ProcedureName> for miette::SourceSpan {
fn from(name: ProcedureName) -> Self {
name.span().into()
}
}
impl core::ops::Deref for ProcedureName {
type Target = str;
#[inline(always)]
fn deref(&self) -> &Self::Target {
self.0.as_str()
}
}
impl AsRef<Ident> for ProcedureName {
#[inline(always)]
fn as_ref(&self) -> &Ident {
&self.0
}
}
impl AsRef<str> for ProcedureName {
#[inline(always)]
fn as_ref(&self) -> &str {
self.0.as_str()
}
}
impl PartialEq<str> for ProcedureName {
fn eq(&self, other: &str) -> bool {
self.0.as_ref() == other
}
}
impl PartialEq<Ident> for ProcedureName {
fn eq(&self, other: &Ident) -> bool {
&self.0 == other
}
}
impl fmt::Display for ProcedureName {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(&self.0)
}
}
/// Parsing
impl FromStr for ProcedureName {
type Err = IdentError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let mut chars = s.char_indices();
let raw = match chars.next() {
None => Err(IdentError::Empty),
Some((_, '"')) => loop {
if let Some((pos, c)) = chars.next() {
match c {
'"' => {
if chars.next().is_some() {
break Err(IdentError::InvalidChars);
}
let tok = &s[1..pos];
break Ok(Arc::from(tok.to_string().into_boxed_str()));
},
c if c.is_alphanumeric() => continue,
'_' | '$' | '-' | '!' | '?' | '<' | '>' | ':' | '.' => continue,
_ => break Err(IdentError::InvalidChars),
}
} else {
break Err(IdentError::InvalidChars);
}
},
Some((_, c)) if c.is_ascii_lowercase() || c == '_' || c == '$' => {
if chars.as_str().contains(|c| match c {
c if c.is_ascii_alphanumeric() => false,
'_' | '$' => false,
_ => true,
}) {
Err(IdentError::InvalidChars)
} else {
Ok(Arc::from(s.to_string().into_boxed_str()))
}
},
Some((_, c)) if c.is_ascii_uppercase() => Err(IdentError::Casing(CaseKindError::Snake)),
Some(_) => Err(IdentError::InvalidChars),
}?;
Ok(Self(Ident::new_unchecked(Span::unknown(raw))))
}
}