cairo_lang_semantic/items/
functions.rs

1use std::sync::Arc;
2
3use cairo_lang_debug::DebugWithDb;
4use cairo_lang_defs::diagnostic_utils::StableLocation;
5use cairo_lang_defs::ids::{
6    ExternFunctionId, FreeFunctionId, FunctionTitleId, FunctionWithBodyId, ImplFunctionId,
7    LanguageElementId, ModuleId, ModuleItemId, NamedLanguageElementId, ParamLongId,
8    TopLevelLanguageElementId, TraitFunctionId,
9};
10use cairo_lang_diagnostics::{Diagnostics, Maybe, MaybeAsRef};
11use cairo_lang_filesystem::ids::{SmolStrId, Tracked};
12use cairo_lang_proc_macros::{DebugWithDb, HeapSize, SemanticObject};
13use cairo_lang_syntax as syntax;
14use cairo_lang_syntax::attribute::structured::Attribute;
15use cairo_lang_syntax::node::{Terminal, TypedSyntaxNode, ast};
16use cairo_lang_utils::ordered_hash_map::OrderedHashMap;
17use cairo_lang_utils::{Intern, OptionFrom, define_short_id, require, try_extract_matches};
18use itertools::{Itertools, chain};
19use salsa::Database;
20use syntax::attribute::consts::MUST_USE_ATTR;
21use syntax::node::TypedStablePtr;
22
23use super::attribute::SemanticQueryAttrs;
24use super::generics::{displayable_concrete, generic_params_to_args};
25use super::imp::{ImplId, ImplLongId};
26use super::modifiers;
27use super::trt::ConcreteTraitGenericFunctionId;
28use crate::corelib::{CorelibSemantic, fn_traits, unit_ty};
29use crate::diagnostic::{SemanticDiagnosticKind, SemanticDiagnostics, SemanticDiagnosticsBuilder};
30use crate::expr::compute::Environment;
31use crate::items::extern_function::ExternFunctionSemantic;
32use crate::items::free_function::FreeFunctionSemantic;
33use crate::items::imp::ImplSemantic;
34use crate::items::trt::TraitSemantic;
35use crate::resolve::{Resolver, ResolverData};
36use crate::substitution::GenericSubstitution;
37use crate::types::{add_value_type_based_diagnostics, resolve_type};
38use crate::{
39    ConcreteImplId, ConcreteImplLongId, ConcreteTraitLongId, GenericArgumentId, GenericParam,
40    SemanticDiagnostic, TypeId, semantic, semantic_object_for_id,
41};
42
43/// A generic function of an impl.
44#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, SemanticObject, HeapSize, salsa::SalsaValue)]
45pub struct ImplGenericFunctionId<'db> {
46    // TODO(spapini): Consider making these private and enforcing invariants in the ctor.
47    /// The impl the function is in.
48    pub impl_id: ImplId<'db>,
49    /// The trait function this impl function implements.
50    pub function: TraitFunctionId<'db>,
51}
52impl<'db> ImplGenericFunctionId<'db> {
53    /// Gets the impl function language element, if self.impl_id is of a concrete impl.
54    pub fn impl_function(&self, db: &'db dyn Database) -> Maybe<Option<ImplFunctionId<'db>>> {
55        match self.impl_id.long(db) {
56            ImplLongId::Concrete(concrete_impl_id) => {
57                concrete_impl_id.get_impl_function(db, self.function)
58            }
59            ImplLongId::GenericParameter(_)
60            | ImplLongId::ImplVar(_)
61            | ImplLongId::ImplImpl(_)
62            | ImplLongId::SelfImpl(_)
63            | ImplLongId::GeneratedImpl(_) => Ok(None),
64        }
65    }
66    pub fn format(&self, db: &dyn Database) -> String {
67        format!("{}::{}", self.impl_id.format(db), self.function.name(db).long(db))
68    }
69}
70impl<'db> DebugWithDb<'db> for ImplGenericFunctionId<'db> {
71    type Db = dyn Database;
72
73    fn fmt(&self, f: &mut std::fmt::Formatter<'_>, db: &'db dyn Database) -> std::fmt::Result {
74        write!(f, "{}", self.format(db))
75    }
76}
77
78/// The ID of a generic function that can be concretized.
79#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, SemanticObject, HeapSize, salsa::SalsaValue)]
80pub enum GenericFunctionId<'db> {
81    /// A generic free function.
82    Free(FreeFunctionId<'db>),
83    /// A generic extern function.
84    Extern(ExternFunctionId<'db>),
85    /// A generic function of an impl.
86    Impl(ImplGenericFunctionId<'db>),
87}
88impl<'db> GenericFunctionId<'db> {
89    pub fn from_generic_with_body(
90        db: &'db dyn Database,
91        val: GenericFunctionWithBodyId<'db>,
92    ) -> Maybe<Self> {
93        Ok(match val {
94            GenericFunctionWithBodyId::Free(id) => GenericFunctionId::Free(id),
95            GenericFunctionWithBodyId::Impl(id) => {
96                let impl_id = ImplLongId::Concrete(id.concrete_impl_id).intern(db);
97                let function = match id.function_body {
98                    ImplFunctionBodyId::Impl(body_id) => {
99                        db.impl_function_trait_function(body_id)?
100                    }
101                    ImplFunctionBodyId::Trait(body_id) => body_id,
102                };
103                GenericFunctionId::Impl(ImplGenericFunctionId { impl_id, function })
104            }
105            GenericFunctionWithBodyId::Trait(id) => {
106                GenericFunctionId::Impl(ImplGenericFunctionId {
107                    impl_id: ImplLongId::SelfImpl(id.concrete_trait(db)).intern(db),
108                    function: id.trait_function(db),
109                })
110            }
111        })
112    }
113    pub fn format(&self, db: &dyn Database) -> String {
114        match self {
115            GenericFunctionId::Free(id) => id.full_path(db),
116            GenericFunctionId::Extern(id) => id.full_path(db),
117            GenericFunctionId::Impl(id) => id.format(db),
118        }
119    }
120    pub fn generic_signature(&self, db: &'db dyn Database) -> Maybe<&'db Signature<'db>> {
121        match *self {
122            GenericFunctionId::Free(id) => db.free_function_signature(id),
123            GenericFunctionId::Extern(id) => db.extern_function_signature(id),
124            GenericFunctionId::Impl(id) => {
125                #[salsa::tracked(returns(ref))]
126                fn impl_function_signature_tracked<'db>(
127                    db: &'db dyn Database,
128                    impl_id: ImplId<'db>,
129                    function: TraitFunctionId<'db>,
130                ) -> Maybe<Signature<'db>> {
131                    let concrete_trait_id = impl_id.concrete_trait(db)?;
132                    let signature = db.concrete_trait_function_signature(
133                        ConcreteTraitGenericFunctionId::new_from_data(
134                            db,
135                            concrete_trait_id,
136                            function,
137                        ),
138                    )?;
139                    GenericSubstitution::from_impl(impl_id).substitute(db, signature.clone())
140                }
141                impl_function_signature_tracked(db, id.impl_id, id.function).maybe_as_ref()
142            }
143        }
144    }
145    pub fn generic_params(&self, db: &'db dyn Database) -> Maybe<&'db [GenericParam<'db>]> {
146        match *self {
147            GenericFunctionId::Free(id) => db.free_function_generic_params(id),
148            GenericFunctionId::Extern(id) => db.extern_function_declaration_generic_params(id),
149            GenericFunctionId::Impl(id) => {
150                #[salsa::tracked(returns(ref))]
151                fn impl_function_generic_params_tracked<'db>(
152                    db: &'db dyn Database,
153                    impl_id: ImplId<'db>,
154                    trait_function: TraitFunctionId<'db>,
155                ) -> Maybe<Vec<GenericParam<'db>>> {
156                    let concrete_trait_id = db.impl_concrete_trait(impl_id)?;
157                    let concrete_id = ConcreteTraitGenericFunctionId::new_from_data(
158                        db,
159                        concrete_trait_id,
160                        trait_function,
161                    );
162                    GenericSubstitution::from_impl(impl_id).substitute(
163                        db,
164                        db.concrete_trait_function_generic_params(concrete_id)?.to_vec(),
165                    )
166                }
167                Ok(impl_function_generic_params_tracked(db, id.impl_id, id.function)
168                    .maybe_as_ref()?)
169            }
170        }
171    }
172    pub fn name(&self, db: &dyn Database) -> String {
173        match self {
174            GenericFunctionId::Free(free_function) => free_function.name(db).to_string(db),
175            GenericFunctionId::Extern(extern_function) => extern_function.name(db).to_string(db),
176            GenericFunctionId::Impl(impl_function) => impl_function.format(db),
177        }
178    }
179    /// Returns the ModuleId of the function's definition if possible.
180    pub fn module_id(&self, db: &'db dyn Database) -> Option<ModuleId<'db>> {
181        match self {
182            GenericFunctionId::Free(free_function) => Some(free_function.parent_module(db)),
183            GenericFunctionId::Extern(extern_function) => Some(extern_function.parent_module(db)),
184            GenericFunctionId::Impl(impl_generic_function_id) => {
185                // Return the module file of the impl containing the function.
186                if let ImplLongId::Concrete(concrete_impl_id) =
187                    impl_generic_function_id.impl_id.long(db)
188                {
189                    Some(concrete_impl_id.impl_def_id(db).parent_module(db))
190                } else {
191                    None
192                }
193            }
194        }
195    }
196    /// Returns whether the function has the `#[must_use]` attribute.
197    pub fn is_must_use(&self, db: &dyn Database) -> Maybe<bool> {
198        match self {
199            GenericFunctionId::Free(id) => id.has_attr(db, MUST_USE_ATTR),
200            GenericFunctionId::Impl(id) => id.function.has_attr(db, MUST_USE_ATTR),
201            GenericFunctionId::Extern(_) => Ok(false),
202        }
203    }
204    /// Returns true if the function does not depend on any generics.
205    pub fn is_fully_concrete(&self, db: &dyn Database) -> bool {
206        match self {
207            GenericFunctionId::Free(_) | GenericFunctionId::Extern(_) => true,
208            GenericFunctionId::Impl(impl_generic_function) => {
209                impl_generic_function.impl_id.is_fully_concrete(db)
210            }
211        }
212    }
213    /// Returns true if the function does not depend on impl or type variables.
214    pub fn is_var_free(&self, db: &dyn Database) -> bool {
215        match self {
216            GenericFunctionId::Free(_) | GenericFunctionId::Extern(_) => true,
217            GenericFunctionId::Impl(impl_generic_function) => {
218                impl_generic_function.impl_id.is_var_free(db)
219            }
220        }
221    }
222    /// Returns the concrete function of this generic function with the given generic args.
223    pub fn concretize(
224        &self,
225        db: &'db dyn Database,
226        generic_args: Vec<semantic::GenericArgumentId<'db>>,
227    ) -> FunctionId<'db> {
228        FunctionLongId { function: ConcreteFunction { generic_function: *self, generic_args } }
229            .intern(db)
230    }
231}
232/// Conversion from ModuleItemId to GenericFunctionId.
233impl<'db> OptionFrom<ModuleItemId<'db>> for GenericFunctionId<'db> {
234    fn option_from(item: ModuleItemId<'db>) -> Option<Self> {
235        match item {
236            ModuleItemId::FreeFunction(id) => Some(GenericFunctionId::Free(id)),
237            ModuleItemId::ExternFunction(id) => Some(GenericFunctionId::Extern(id)),
238            ModuleItemId::Constant(_)
239            | ModuleItemId::Submodule(_)
240            | ModuleItemId::Use(_)
241            | ModuleItemId::Trait(_)
242            | ModuleItemId::Impl(_)
243            | ModuleItemId::Struct(_)
244            | ModuleItemId::Enum(_)
245            | ModuleItemId::TypeAlias(_)
246            | ModuleItemId::ImplAlias(_)
247            | ModuleItemId::ExternType(_)
248            | ModuleItemId::MacroDeclaration(_) => None,
249        }
250    }
251}
252impl<'db> DebugWithDb<'db> for GenericFunctionId<'db> {
253    type Db = dyn Database;
254
255    fn fmt(&self, f: &mut std::fmt::Formatter<'_>, db: &'db dyn Database) -> std::fmt::Result {
256        match self {
257            GenericFunctionId::Free(func) => write!(f, "{:?}", func.debug(db)),
258            GenericFunctionId::Extern(func) => write!(f, "{:?}", func.debug(db)),
259            GenericFunctionId::Impl(func) => write!(f, "{:?}", func.debug(db)),
260        }
261    }
262}
263
264/// Function instance.
265/// For example: `ImplA::foo<A, B>`, or `bar<A>`.
266// TODO(spapini): Make it an enum and add a function pointer variant.
267#[derive(Clone, Debug, Hash, PartialEq, Eq, SemanticObject, salsa::SalsaValue, HeapSize)]
268pub struct FunctionLongId<'db> {
269    pub function: ConcreteFunction<'db>,
270}
271impl<'db> DebugWithDb<'db> for FunctionLongId<'db> {
272    type Db = dyn Database;
273
274    fn fmt(&self, f: &mut std::fmt::Formatter<'_>, db: &dyn Database) -> std::fmt::Result {
275        write!(f, "{:?}", self.function.debug(db))
276    }
277}
278
279define_short_id!(FunctionId, FunctionLongId<'db>);
280semantic_object_for_id!(FunctionId, FunctionLongId<'a>);
281impl<'db> FunctionId<'db> {
282    pub fn get_concrete(&self, db: &'db dyn Database) -> ConcreteFunction<'db> {
283        self.long(db).function.clone()
284    }
285
286    /// Returns the ExternFunctionId if this is an extern function. Otherwise returns none.
287    pub fn try_get_extern_function_id(
288        &self,
289        db: &'db dyn Database,
290    ) -> Option<ExternFunctionId<'db>> {
291        try_extract_matches!(self.get_concrete(db).generic_function, GenericFunctionId::Extern)
292    }
293
294    pub fn name(&self, db: &dyn Database) -> String {
295        format!("{:?}", self.get_concrete(db).generic_function.name(db))
296    }
297
298    pub fn full_path(&self, db: &dyn Database) -> String {
299        self.get_concrete(db).full_path(db)
300    }
301
302    /// Returns true if the function does not depend on any generics.
303    pub fn is_fully_concrete(&self, db: &dyn Database) -> bool {
304        let func = self.get_concrete(db);
305        func.generic_function.is_fully_concrete(db)
306            && func
307                .generic_args
308                .iter()
309                .all(|generic_argument_id| generic_argument_id.is_fully_concrete(db))
310    }
311    /// Returns true if the function does not depend on impl or type variables.
312    pub fn is_var_free(&self, db: &dyn Database) -> bool {
313        let func = self.get_concrete(db);
314        func.generic_function.is_var_free(db)
315            && func
316                .generic_args
317                .iter()
318                .all(|generic_argument_id| generic_argument_id.is_var_free(db))
319    }
320}
321impl<'db> FunctionLongId<'db> {
322    pub fn from_generic(
323        db: &'db dyn Database,
324        generic_function: GenericFunctionId<'db>,
325    ) -> Maybe<Self> {
326        let generic_params = generic_function.generic_params(db)?;
327
328        Ok(FunctionLongId {
329            function: ConcreteFunction {
330                generic_function,
331                generic_args: generic_params_to_args(generic_params, db),
332            },
333        })
334    }
335}
336
337/// A generic function of a concrete impl.
338#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, SemanticObject, salsa::SalsaValue, HeapSize)]
339pub struct ImplGenericFunctionWithBodyId<'db> {
340    pub concrete_impl_id: ConcreteImplId<'db>,
341    pub function_body: ImplFunctionBodyId<'db>,
342}
343
344/// The body of an impl function implementation.
345#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, SemanticObject, salsa::SalsaValue, HeapSize)]
346pub enum ImplFunctionBodyId<'db> {
347    /// A function that was implemented in the impl.
348    Impl(ImplFunctionId<'db>),
349    /// The default implementation of a trait function in the trait.
350    Trait(TraitFunctionId<'db>),
351}
352impl<'db> ImplFunctionBodyId<'db> {
353    pub fn name(&self, db: &'db dyn Database) -> SmolStrId<'db> {
354        match self {
355            Self::Impl(body_id) => body_id.name(db),
356            Self::Trait(body_id) => body_id.name(db),
357        }
358    }
359    pub fn stable_location(&self, db: &'db dyn Database) -> StableLocation<'db> {
360        match self {
361            Self::Impl(body_id) => body_id.stable_location(db),
362            Self::Trait(body_id) => body_id.stable_location(db),
363        }
364    }
365
366    pub fn trait_function(&self, db: &'db dyn Database) -> Maybe<TraitFunctionId<'db>> {
367        match self {
368            Self::Impl(impl_function) => db.impl_function_trait_function(*impl_function),
369            Self::Trait(trait_function) => Ok(*trait_function),
370        }
371    }
372}
373
374/// The ID of a generic function with body that can be concretized.
375#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq, SemanticObject, salsa::SalsaValue, HeapSize)]
376pub enum GenericFunctionWithBodyId<'db> {
377    Free(FreeFunctionId<'db>),
378    Impl(ImplGenericFunctionWithBodyId<'db>),
379    Trait(ConcreteTraitGenericFunctionId<'db>),
380}
381impl<'db> GenericFunctionWithBodyId<'db> {
382    pub fn from_generic(
383        db: &'db dyn Database,
384        other: GenericFunctionId<'db>,
385    ) -> Maybe<Option<Self>> {
386        Ok(Some(match other {
387            GenericFunctionId::Free(id) => GenericFunctionWithBodyId::Free(id),
388            GenericFunctionId::Impl(ImplGenericFunctionId { impl_id, function }) => {
389                let ImplLongId::Concrete(concrete_impl_id) = impl_id.long(db) else {
390                    return Ok(None);
391                };
392                GenericFunctionWithBodyId::Impl(ImplGenericFunctionWithBodyId {
393                    concrete_impl_id: *concrete_impl_id,
394                    function_body: if let Some(impl_function) =
395                        concrete_impl_id.get_impl_function(db, function)?
396                    {
397                        ImplFunctionBodyId::Impl(impl_function)
398                    } else {
399                        ImplFunctionBodyId::Trait(function)
400                    },
401                })
402            }
403            _ => return Ok(None),
404        }))
405    }
406    pub fn name(&self, db: &dyn Database) -> String {
407        match self {
408            GenericFunctionWithBodyId::Free(free) => free.name(db).to_string(db),
409            GenericFunctionWithBodyId::Impl(imp) => {
410                format!(
411                    "{}::{}",
412                    imp.concrete_impl_id.name(db).long(db),
413                    imp.function_body.name(db).long(db)
414                )
415            }
416            GenericFunctionWithBodyId::Trait(trt) => {
417                format!(
418                    "{}::{}",
419                    trt.concrete_trait(db).name(db).long(db),
420                    trt.trait_function(db).name(db).long(db)
421                )
422            }
423        }
424    }
425
426    pub fn full_path(&self, db: &dyn Database) -> String {
427        match self {
428            GenericFunctionWithBodyId::Free(free) => free.full_path(db),
429            GenericFunctionWithBodyId::Impl(imp) => {
430                format!(
431                    "{:?}::{}",
432                    imp.concrete_impl_id.debug(db),
433                    imp.function_body.name(db).long(db)
434                )
435            }
436            GenericFunctionWithBodyId::Trait(trt) => format!(
437                "{}::{}",
438                trt.concrete_trait(db).full_path(db),
439                trt.trait_function(db).name(db).long(db)
440            ),
441        }
442    }
443    pub fn stable_location(&self, db: &'db dyn Database) -> StableLocation<'db> {
444        match self {
445            GenericFunctionWithBodyId::Free(free_function) => free_function.stable_location(db),
446            GenericFunctionWithBodyId::Impl(impl_function) => {
447                impl_function.function_body.stable_location(db)
448            }
449            GenericFunctionWithBodyId::Trait(trait_function) => {
450                trait_function.trait_function(db).stable_location(db)
451            }
452        }
453    }
454}
455
456/// A long Id of a concrete function with body.
457#[derive(Clone, Debug, Hash, PartialEq, Eq, SemanticObject, salsa::SalsaValue, HeapSize)]
458pub struct ConcreteFunctionWithBody<'db> {
459    pub generic_function: GenericFunctionWithBodyId<'db>,
460    pub generic_args: Vec<semantic::GenericArgumentId<'db>>,
461}
462impl<'db> ConcreteFunctionWithBody<'db> {
463    pub fn function_with_body_id(&self, db: &'db dyn Database) -> FunctionWithBodyId<'db> {
464        match self.generic_function {
465            GenericFunctionWithBodyId::Free(id) => FunctionWithBodyId::Free(id),
466            GenericFunctionWithBodyId::Impl(id) => match id.function_body {
467                ImplFunctionBodyId::Impl(id) => FunctionWithBodyId::Impl(id),
468                ImplFunctionBodyId::Trait(id) => FunctionWithBodyId::Trait(id),
469            },
470            GenericFunctionWithBodyId::Trait(id) => {
471                FunctionWithBodyId::Trait(id.trait_function(db))
472            }
473        }
474    }
475    pub fn substitution(&self, db: &'db dyn Database) -> Maybe<GenericSubstitution<'db>> {
476        Ok(match self.generic_function {
477            GenericFunctionWithBodyId::Free(f) => {
478                GenericSubstitution::new(db.free_function_generic_params(f)?, &self.generic_args)
479            }
480            GenericFunctionWithBodyId::Impl(f) => match f.function_body {
481                ImplFunctionBodyId::Impl(body_id) => {
482                    let concrete_impl = f.concrete_impl_id.long(db);
483                    GenericSubstitution::from_impl(
484                        ImplLongId::Concrete(f.concrete_impl_id).intern(db),
485                    )
486                    .concat(GenericSubstitution::new(
487                        &chain!(
488                            db.impl_function_generic_params(body_id)?,
489                            db.impl_def_generic_params(concrete_impl.impl_def_id)?
490                        )
491                        .cloned()
492                        .collect_vec(),
493                        &chain!(&self.generic_args, &concrete_impl.generic_args)
494                            .cloned()
495                            .collect_vec(),
496                    ))
497                }
498                ImplFunctionBodyId::Trait(body_id) => {
499                    let concrete_impl_id = ImplLongId::Concrete(f.concrete_impl_id).intern(db);
500                    let concrete_trait = concrete_impl_id.concrete_trait(db)?.long(db);
501                    GenericSubstitution::from_impl(concrete_impl_id).concat(
502                        GenericSubstitution::new(
503                            &chain!(
504                                db.trait_function_generic_params(body_id)?,
505                                db.trait_generic_params(concrete_trait.trait_id)?
506                            )
507                            .cloned()
508                            .collect_vec(),
509                            &chain!(&self.generic_args, &concrete_trait.generic_args)
510                                .cloned()
511                                .collect_vec(),
512                        ),
513                    )
514                }
515            },
516            GenericFunctionWithBodyId::Trait(f) => {
517                let concrete_trait = f.concrete_trait(db).long(db);
518                GenericSubstitution::new(
519                    &chain!(
520                        db.trait_function_generic_params(f.trait_function(db))?,
521                        db.trait_generic_params(concrete_trait.trait_id)?
522                    )
523                    .cloned()
524                    .collect_vec(),
525                    &chain!(&self.generic_args, &concrete_trait.generic_args)
526                        .cloned()
527                        .collect_vec(),
528                )
529            }
530        })
531    }
532    pub fn from_no_generics_free(
533        db: &dyn Database,
534        free_function_id: FreeFunctionId<'db>,
535    ) -> Option<Self> {
536        require(db.free_function_generic_params(free_function_id).ok()?.is_empty())?;
537        Some(ConcreteFunctionWithBody {
538            generic_function: GenericFunctionWithBodyId::Free(free_function_id),
539            generic_args: vec![],
540        })
541    }
542    pub fn from_generic(
543        db: &'db dyn Database,
544        function_id: FunctionWithBodyId<'db>,
545    ) -> Maybe<Self> {
546        Ok(match function_id {
547            FunctionWithBodyId::Free(free) => {
548                let params = db.free_function_generic_params(free)?;
549                let generic_args = generic_params_to_args(params, db);
550                ConcreteFunctionWithBody {
551                    generic_function: GenericFunctionWithBodyId::Free(free),
552                    generic_args,
553                }
554            }
555            FunctionWithBodyId::Impl(impl_function_id) => {
556                let params = db.impl_function_generic_params(impl_function_id)?;
557                let generic_args = generic_params_to_args(params, db);
558                let impl_def_id = impl_function_id.impl_def_id(db);
559                let impl_def_params = db.impl_def_generic_params(impl_def_id)?;
560                let impl_generic_args = generic_params_to_args(impl_def_params, db);
561                let impl_generic_function = ImplGenericFunctionWithBodyId {
562                    concrete_impl_id: ConcreteImplLongId {
563                        impl_def_id,
564                        generic_args: impl_generic_args,
565                    }
566                    .intern(db),
567                    function_body: ImplFunctionBodyId::Impl(impl_function_id),
568                };
569                ConcreteFunctionWithBody {
570                    generic_function: GenericFunctionWithBodyId::Impl(impl_generic_function),
571                    generic_args,
572                }
573            }
574            FunctionWithBodyId::Trait(trait_function_id) => {
575                let params = db.trait_function_generic_params(trait_function_id)?;
576                let generic_args = generic_params_to_args(params, db);
577                let trait_id = trait_function_id.trait_id(db);
578                let trait_generic_params = db.trait_generic_params(trait_id)?;
579                let trait_generic_args = generic_params_to_args(trait_generic_params, db);
580                let concrete_trait_id = ConcreteTraitLongId {
581                    generic_args: trait_generic_args,
582                    trait_id: trait_function_id.trait_id(db),
583                }
584                .intern(db);
585                let trait_generic_function = ConcreteTraitGenericFunctionId::new_from_data(
586                    db,
587                    concrete_trait_id,
588                    trait_function_id,
589                );
590                ConcreteFunctionWithBody {
591                    generic_function: GenericFunctionWithBodyId::Trait(trait_generic_function),
592                    generic_args,
593                }
594            }
595        })
596    }
597    pub fn concrete(&self, db: &'db dyn Database) -> Maybe<ConcreteFunction<'db>> {
598        Ok(ConcreteFunction {
599            generic_function: GenericFunctionId::from_generic_with_body(db, self.generic_function)?,
600            generic_args: self.generic_args.clone(),
601        })
602    }
603    pub fn function_id(&self, db: &'db dyn Database) -> Maybe<FunctionId<'db>> {
604        Ok(FunctionLongId { function: self.concrete(db)? }.intern(db))
605    }
606    pub fn name(&self, db: &'db dyn Database) -> SmolStrId<'db> {
607        self.function_with_body_id(db).name(db)
608    }
609    pub fn full_path(&self, db: &dyn Database) -> String {
610        format!("{:?}", self.debug(db))
611    }
612}
613
614impl<'db> DebugWithDb<'db> for ConcreteFunctionWithBody<'db> {
615    type Db = dyn Database;
616
617    fn fmt(&self, f: &mut std::fmt::Formatter<'_>, db: &'db dyn Database) -> std::fmt::Result {
618        write!(
619            f,
620            "{}",
621            displayable_concrete(db, &self.generic_function.full_path(db), &self.generic_args)
622        )
623    }
624}
625
626define_short_id!(ConcreteFunctionWithBodyId, ConcreteFunctionWithBody<'db>);
627semantic_object_for_id!(ConcreteFunctionWithBodyId, ConcreteFunctionWithBody<'a>);
628impl<'db> ConcreteFunctionWithBodyId<'db> {
629    pub fn function_with_body_id(&self, db: &'db dyn Database) -> FunctionWithBodyId<'db> {
630        self.long(db).function_with_body_id(db)
631    }
632    pub fn substitution(&self, db: &'db dyn Database) -> Maybe<GenericSubstitution<'db>> {
633        self.long(db).substitution(db)
634    }
635    pub fn from_no_generics_free(
636        db: &'db dyn Database,
637        free_function_id: FreeFunctionId<'db>,
638    ) -> Option<Self> {
639        Some(ConcreteFunctionWithBody::from_no_generics_free(db, free_function_id)?.intern(db))
640    }
641    pub fn from_generic(
642        db: &'db dyn Database,
643        function_id: FunctionWithBodyId<'db>,
644    ) -> Maybe<Self> {
645        Ok(ConcreteFunctionWithBody::from_generic(db, function_id)?.intern(db))
646    }
647    pub fn concrete(&self, db: &'db dyn Database) -> Maybe<ConcreteFunction<'db>> {
648        self.long(db).concrete(db)
649    }
650    pub fn function_id(&self, db: &'db dyn Database) -> Maybe<FunctionId<'db>> {
651        self.long(db).function_id(db)
652    }
653    pub fn generic_function(&self, db: &'db dyn Database) -> GenericFunctionWithBodyId<'db> {
654        self.long(db).generic_function
655    }
656    pub fn name(&self, db: &'db dyn Database) -> SmolStrId<'db> {
657        self.long(db).name(db)
658    }
659    pub fn full_path(&self, db: &dyn Database) -> String {
660        self.long(db).full_path(db)
661    }
662
663    pub fn stable_location(&self, db: &'db dyn Database) -> StableLocation<'db> {
664        self.long(db).generic_function.stable_location(db)
665    }
666
667    pub fn is_panic_destruct_fn(&self, db: &dyn Database) -> Maybe<bool> {
668        let trait_function = match self.generic_function(db) {
669            GenericFunctionWithBodyId::Free(_) => return Ok(false),
670            GenericFunctionWithBodyId::Impl(impl_func) => {
671                impl_func.function_body.trait_function(db)?
672            }
673            GenericFunctionWithBodyId::Trait(trait_func) => trait_func.trait_function(db),
674        };
675        Ok(trait_function == db.core_info().panic_destruct_fn)
676    }
677}
678
679#[derive(Clone, Debug, Hash, PartialEq, Eq, SemanticObject, salsa::SalsaValue, HeapSize)]
680pub struct ConcreteFunction<'db> {
681    pub generic_function: GenericFunctionId<'db>,
682    pub generic_args: Vec<semantic::GenericArgumentId<'db>>,
683}
684impl<'db> ConcreteFunction<'db> {
685    pub fn body(&self, db: &'db dyn Database) -> Maybe<Option<ConcreteFunctionWithBodyId<'db>>> {
686        let Some(generic_function) =
687            GenericFunctionWithBodyId::from_generic(db, self.generic_function)?
688        else {
689            return Ok(None);
690        };
691        Ok(Some(
692            ConcreteFunctionWithBody { generic_function, generic_args: self.generic_args.clone() }
693                .intern(db),
694        ))
695    }
696    pub fn full_path(&self, db: &dyn Database) -> String {
697        format!("{:?}", self.debug(db))
698    }
699}
700impl<'db> DebugWithDb<'db> for ConcreteFunction<'db> {
701    type Db = dyn Database;
702
703    fn fmt(&self, f: &mut std::fmt::Formatter<'_>, db: &'db dyn Database) -> std::fmt::Result {
704        write!(
705            f,
706            "{}",
707            displayable_concrete(db, &self.generic_function.format(db), &self.generic_args)
708        )
709    }
710}
711
712#[derive(Clone, Debug, PartialEq, Eq, DebugWithDb, SemanticObject, salsa::SalsaValue)]
713#[debug_db(dyn Database)]
714pub struct Signature<'db> {
715    pub params: Vec<semantic::Parameter<'db>>,
716    pub return_type: semantic::TypeId<'db>,
717    /// Implicit parameters.
718    pub implicits: Vec<semantic::TypeId<'db>>,
719    #[dont_rewrite]
720    pub panicable: bool,
721    #[dont_rewrite]
722    pub is_const: bool,
723    #[hide_field_debug_with_db]
724    #[dont_rewrite]
725    pub stable_ptr: ast::FunctionSignaturePtr<'db>,
726}
727
728impl<'db> Signature<'db> {
729    pub fn from_ast(
730        diagnostics: &mut SemanticDiagnostics<'db>,
731        db: &'db dyn Database,
732        resolver: &mut Resolver<'db>,
733        declaration_syntax: &ast::FunctionDeclaration<'db>,
734        function_title_id: FunctionTitleId<'db>,
735        environment: &mut Environment<'db>,
736    ) -> Self {
737        let signature_syntax = declaration_syntax.signature(db);
738        let params = function_signature_params(
739            diagnostics,
740            db,
741            resolver,
742            signature_syntax.parameters(db).elements(db),
743            Some(function_title_id),
744            environment,
745        );
746        let return_type =
747            function_signature_return_type(diagnostics, db, resolver, &signature_syntax);
748        for param in &params {
749            add_value_type_based_diagnostics(db, diagnostics, param.ty, param.stable_ptr(db));
750        }
751        if let ast::OptionReturnTypeClause::ReturnTypeClause(syntax) = signature_syntax.ret_ty(db) {
752            add_value_type_based_diagnostics(
753                db,
754                diagnostics,
755                return_type,
756                syntax.ty(db).stable_ptr(db),
757            );
758        }
759        let implicits =
760            function_signature_implicit_parameters(diagnostics, db, resolver, &signature_syntax);
761        let panicable = match signature_syntax.optional_no_panic(db) {
762            ast::OptionTerminalNoPanic::Empty(_) => true,
763            ast::OptionTerminalNoPanic::TerminalNoPanic(_) => false,
764        };
765        let stable_ptr = signature_syntax.stable_ptr(db);
766        let is_const = matches!(
767            declaration_syntax.optional_const(db),
768            ast::OptionTerminalConst::TerminalConst(_)
769        );
770        semantic::Signature { params, return_type, implicits, panicable, stable_ptr, is_const }
771    }
772}
773
774pub fn function_signature_return_type<'db>(
775    diagnostics: &mut SemanticDiagnostics<'db>,
776    db: &'db dyn Database,
777    resolver: &mut Resolver<'db>,
778    sig: &ast::FunctionSignature<'db>,
779) -> semantic::TypeId<'db> {
780    let ty_syntax = match sig.ret_ty(db) {
781        ast::OptionReturnTypeClause::Empty(_) => {
782            return unit_ty(db);
783        }
784        ast::OptionReturnTypeClause::ReturnTypeClause(ret_type_clause) => ret_type_clause.ty(db),
785    };
786    resolve_type(db, diagnostics, resolver, &ty_syntax)
787}
788
789/// Returns the implicit parameters of the given function signature's AST.
790pub fn function_signature_implicit_parameters<'db>(
791    diagnostics: &mut SemanticDiagnostics<'db>,
792    db: &'db dyn Database,
793    resolver: &mut Resolver<'db>,
794    sig: &ast::FunctionSignature<'db>,
795) -> Vec<semantic::TypeId<'db>> {
796    let implicits = match sig.implicits_clause(db) {
797        ast::OptionImplicitsClause::Empty(_) => return vec![],
798        ast::OptionImplicitsClause::ImplicitsClause(implicits_clause) => {
799            implicits_clause.implicits(db)
800        }
801    };
802    let ast_implicits = implicits.elements(db);
803    ast_implicits
804        .map(|implicit| {
805            let stable_ptr = implicit.stable_ptr(db);
806            let ty = resolve_type(db, diagnostics, resolver, &ast::Expr::Path(implicit));
807            add_value_type_based_diagnostics(db, diagnostics, ty, stable_ptr);
808            ty
809        })
810        .collect()
811}
812
813/// Returns the parameters of the given function signature's AST.
814pub fn function_signature_params<'db>(
815    diagnostics: &mut SemanticDiagnostics<'db>,
816    db: &'db dyn Database,
817    resolver: &mut Resolver<'db>,
818    params: impl Iterator<Item = ast::Param<'db>>,
819    function_title_id: Option<FunctionTitleId<'db>>,
820    env: &mut Environment<'db>,
821) -> Vec<semantic::Parameter<'db>> {
822    update_env_with_ast_params(diagnostics, db, resolver, params, function_title_id, env)
823}
824
825/// Query implementation of [FunctionsSemantic::concrete_function_signature].
826#[salsa::tracked(returns(ref))]
827fn concrete_function_signature<'db>(
828    db: &'db dyn Database,
829    function_id: FunctionId<'db>,
830) -> Maybe<Signature<'db>> {
831    let ConcreteFunction { generic_function, generic_args, .. } = &function_id.long(db).function;
832    let generic_params = generic_function.generic_params(db)?;
833    let generic_signature = generic_function.generic_signature(db)?;
834    // TODO(spapini): When trait generics are supported, they need to be substituted
835    //   one by one, not together.
836    // Panic shouldn't occur since ConcreteFunction is assumed to be constructed correctly.
837    GenericSubstitution::new(generic_params, generic_args).substitute(db, generic_signature.clone())
838}
839
840/// Implementation of [FunctionsSemantic::concrete_function_closure_params].
841fn concrete_function_closure_params<'db>(
842    db: &'db dyn Database,
843    function_id: FunctionId<'db>,
844) -> Maybe<OrderedHashMap<semantic::TypeId<'db>, semantic::TypeId<'db>>> {
845    let ConcreteFunction { generic_function, generic_args, .. } =
846        function_id.long(db).function.clone();
847    let generic_params = generic_function.generic_params(db)?;
848    let mut generic_closure_params = db.get_closure_params(generic_function)?;
849    let substitution = GenericSubstitution::new(generic_params, &generic_args);
850    let mut changed_keys = vec![];
851    for (key, value) in generic_closure_params.iter_mut() {
852        *value = substitution.substitute(db, *value)?;
853        let updated_key = substitution.substitute(db, *key)?;
854        if updated_key != *key {
855            changed_keys.push((*key, updated_key));
856        }
857    }
858    for (old_key, new_key) in changed_keys {
859        let v = generic_closure_params.swap_remove(&old_key).unwrap();
860        generic_closure_params.insert(new_key, v);
861    }
862    Ok(generic_closure_params)
863}
864
865/// Query implementation of [FunctionsSemantic::concrete_function_closure_params].
866#[salsa::tracked(returns(clone))]
867fn concrete_function_closure_params_tracked<'db>(
868    db: &'db dyn Database,
869    function_id: FunctionId<'db>,
870) -> Maybe<OrderedHashMap<semantic::TypeId<'db>, semantic::TypeId<'db>>> {
871    concrete_function_closure_params(db, function_id)
872}
873
874/// For a given list of AST parameters, returns the list of semantic parameters along with the
875/// corresponding environment.
876fn update_env_with_ast_params<'db>(
877    diagnostics: &mut SemanticDiagnostics<'db>,
878    db: &'db dyn Database,
879    resolver: &mut Resolver<'db>,
880    ast_params: impl Iterator<Item = ast::Param<'db>>,
881    function_title_id: Option<FunctionTitleId<'db>>,
882    env: &mut Environment<'db>,
883) -> Vec<semantic::Parameter<'db>> {
884    let mut semantic_params = Vec::new();
885    for ast_param in ast_params {
886        let semantic_param = ast_param_to_semantic(diagnostics, db, resolver, &ast_param);
887
888        if env
889            .add_param(db, diagnostics, semantic_param.clone(), &ast_param, function_title_id)
890            .is_ok()
891        {
892            semantic_params.push(semantic_param);
893        }
894    }
895    semantic_params
896}
897
898/// Returns a semantic parameter (and its name) for the given AST parameter.
899fn ast_param_to_semantic<'db>(
900    diagnostics: &mut SemanticDiagnostics<'db>,
901    db: &'db dyn Database,
902    resolver: &mut Resolver<'db>,
903    ast_param: &ast::Param<'db>,
904) -> semantic::Parameter<'db> {
905    let name = ast_param.name(db);
906
907    let id = ParamLongId(resolver.module_id, ast_param.stable_ptr(db)).intern(db);
908
909    let ty = match ast_param.type_clause(db) {
910        ast::OptionTypeClause::Empty(missing) => {
911            resolver.inference().new_type_var(Some(missing.stable_ptr(db).untyped()))
912        }
913        ast::OptionTypeClause::TypeClause(ty_syntax) => {
914            resolve_type(db, diagnostics, resolver, &ty_syntax.ty(db))
915        }
916    };
917
918    let mutability =
919        modifiers::compute_mutability(diagnostics, db, ast_param.modifiers(db).elements(db));
920
921    semantic::Parameter { id, name: name.text(db), ty, mutability, stable_ptr: name.stable_ptr(db) }
922}
923
924// === Function Declaration ===
925
926#[derive(Clone, Debug, PartialEq, Eq, DebugWithDb, salsa::SalsaValue)]
927#[debug_db(dyn Database)]
928pub struct FunctionDeclarationData<'db> {
929    pub diagnostics: Diagnostics<'db, SemanticDiagnostic<'db>>,
930    pub signature: semantic::Signature<'db>,
931    /// The environment induced by the function's signature.
932    pub environment: Environment<'db>,
933    pub attributes: Vec<Attribute<'db>>,
934    pub resolver_data: Arc<ResolverData<'db>>,
935    pub inline_config: InlineConfiguration<'db>,
936    /// Order of implicits to follow by this function.
937    ///
938    /// For example, this can be used to enforce ABI compatibility with Starknet OS.
939    pub implicit_precedence: ImplicitPrecedence<'db>,
940}
941
942#[derive(Debug, PartialEq, Eq, Clone, salsa::SalsaValue)]
943pub enum InlineConfiguration<'db> {
944    /// The user did not specify any inlining preferences.
945    None,
946    Always(ast::AttributePtr<'db>),
947    Should(ast::AttributePtr<'db>),
948    Never(ast::AttributePtr<'db>),
949}
950
951/// If a function with impl generic parameters is marked as '#[inline(always)]', raise a diagnostic.
952pub fn forbid_inline_always_with_impl_generic_param<'db>(
953    diagnostics: &mut SemanticDiagnostics<'db>,
954    generic_params: &[GenericParam<'db>],
955    inline_config: &InlineConfiguration<'db>,
956) {
957    let has_impl_generic_param = generic_params.iter().any(|p| matches!(p, GenericParam::Impl(_)));
958    match &inline_config {
959        InlineConfiguration::Always(stable_ptr) if has_impl_generic_param => {
960            diagnostics.report(
961                stable_ptr.untyped(),
962                SemanticDiagnosticKind::InlineAlwaysWithImplGenericArgNotAllowed,
963            );
964        }
965        _ => {}
966    }
967}
968
969/// Extra information about sorting of implicit arguments of the function.
970///
971/// In most of the user written code, the implicits are not stated explicitly, but instead are
972/// inferred by the compiler. The order on how these implicit arguments are laid out on Sierra level
973/// is unspecified though for the users. Currently, the compiler sorts them alphabetically by name
974/// for reproducibility, but it can equally just randomize the order on each compilation.
975///
976/// Some compilation targets tend to expect that particular functions accept particular implicit
977/// arguments at fixed positions. For example, the Starknet OS has such assumptions. By reading the
978/// implicit precedence information attached to functions, the compiler can now reliably generate
979/// compatible code.
980///
981/// To set, add the `#[implicit_precedence(...)]` attribute to function declaration. Only free or
982/// impl functions can have this information defined. For extern functions, the compiler raises an
983/// error. It is recommended to always create this attribute from compiler plugins, and not force
984/// users to write it manually.
985///
986/// Use [ImplicitPrecedence::UNSPECIFIED] to represent lack of information.
987#[derive(Clone, Debug, Default, Eq, PartialEq, salsa::SalsaValue)]
988pub struct ImplicitPrecedence<'db>(Vec<TypeId<'db>>);
989
990impl<'db> ImplicitPrecedence<'db> {
991    /// A precedence that does not actually prefer any implicit.
992    ///
993    /// When applied to a sequence of implicits, they will just be reordered alphabetically.
994    pub const UNSPECIFIED: Self = Self(Vec::new());
995
996    /// Sort implicits according to this precedence: first the ones with precedence
997    /// (according to it), then the others by their name.
998    pub fn apply(&self, implicits: &mut [TypeId<'db>], db: &dyn Database) {
999        implicits.sort_by_cached_key(|implicit| {
1000            if let Some(idx) = self.0.iter().position(|item| item == implicit) {
1001                return (idx, "".to_string());
1002            }
1003
1004            (self.0.len(), implicit.format(db))
1005        });
1006    }
1007}
1008
1009impl<'db> FromIterator<TypeId<'db>> for ImplicitPrecedence<'db> {
1010    fn from_iter<T: IntoIterator<Item = TypeId<'db>>>(iter: T) -> Self {
1011        Self(Vec::from_iter(iter))
1012    }
1013}
1014
1015/// Implementation of [FunctionsSemantic::get_closure_params].
1016fn get_closure_params<'db>(
1017    db: &'db dyn Database,
1018    generic_function_id: GenericFunctionId<'db>,
1019) -> Maybe<OrderedHashMap<TypeId<'db>, TypeId<'db>>> {
1020    let mut closure_params_map = OrderedHashMap::default();
1021    let generic_params = generic_function_id.generic_params(db)?;
1022
1023    for param in generic_params {
1024        if let GenericParam::Impl(generic_param_impl) = param {
1025            let concrete_trait = generic_param_impl.concrete_trait?;
1026            if fn_traits(db).contains(&concrete_trait.trait_id(db)) {
1027                let [GenericArgumentId::Type(closure_type), GenericArgumentId::Type(params_type)] =
1028                    *concrete_trait.generic_args(db)
1029                else {
1030                    unreachable!(
1031                        "Fn trait must have exactly two generic arguments: closure type and \
1032                         parameter type."
1033                    )
1034                };
1035
1036                closure_params_map.insert(closure_type, params_type);
1037            }
1038        }
1039    }
1040    Ok(closure_params_map)
1041}
1042
1043/// Query implementation of [FunctionsSemantic::get_closure_params].
1044fn get_closure_params_tracked<'db>(
1045    db: &'db dyn Database,
1046    generic_function_id: GenericFunctionId<'db>,
1047) -> Maybe<OrderedHashMap<TypeId<'db>, TypeId<'db>>> {
1048    get_closure_params_helper(db, (), generic_function_id)
1049}
1050
1051#[salsa::tracked(returns(clone))]
1052fn get_closure_params_helper<'db>(
1053    db: &'db dyn Database,
1054    _tracked: Tracked,
1055    generic_function_id: GenericFunctionId<'db>,
1056) -> Maybe<OrderedHashMap<TypeId<'db>, TypeId<'db>>> {
1057    get_closure_params(db, generic_function_id)
1058}
1059
1060/// Trait for functions-related semantic queries.
1061pub trait FunctionsSemantic<'db>: Database {
1062    /// Returns the signature of the given FunctionTitleId. This include free functions, extern
1063    /// functions, etc...
1064    fn function_title_signature(
1065        &'db self,
1066        function_title_id: FunctionTitleId<'db>,
1067    ) -> Maybe<&'db semantic::Signature<'db>> {
1068        match function_title_id {
1069            FunctionTitleId::Free(id) => self.free_function_signature(id),
1070            FunctionTitleId::Extern(id) => self.extern_function_signature(id),
1071            FunctionTitleId::Trait(id) => self.trait_function_signature(id),
1072            FunctionTitleId::Impl(id) => self.impl_function_signature(id),
1073        }
1074    }
1075    /// Returns the generic parameters of the given FunctionTitleId. This include free
1076    /// functions, extern functions, etc...
1077    fn function_title_generic_params(
1078        &'db self,
1079        function_title_id: FunctionTitleId<'db>,
1080    ) -> Maybe<&'db [GenericParam<'db>]> {
1081        match function_title_id {
1082            FunctionTitleId::Free(free_function) => {
1083                self.free_function_generic_params(free_function)
1084            }
1085            FunctionTitleId::Extern(extern_function) => {
1086                self.extern_function_declaration_generic_params(extern_function)
1087            }
1088            FunctionTitleId::Trait(trait_function) => {
1089                self.trait_function_generic_params(trait_function)
1090            }
1091            FunctionTitleId::Impl(impl_function) => {
1092                self.impl_function_generic_params(impl_function)
1093            }
1094        }
1095    }
1096    /// Returns the signature of a concrete function. This include free functions, extern functions,
1097    /// etc...
1098    fn concrete_function_signature(
1099        &'db self,
1100        function_id: FunctionId<'db>,
1101    ) -> Maybe<&'db semantic::Signature<'db>> {
1102        concrete_function_signature(self.as_dyn_database(), function_id).maybe_as_ref()
1103    }
1104    /// Returns a mapping of closure types to their associated parameter types for a concrete
1105    /// function.
1106    fn concrete_function_closure_params(
1107        &'db self,
1108        function_id: FunctionId<'db>,
1109    ) -> Maybe<OrderedHashMap<semantic::TypeId<'db>, semantic::TypeId<'db>>> {
1110        concrete_function_closure_params_tracked(self.as_dyn_database(), function_id)
1111    }
1112    /// Returns a mapping of closure types to their associated parameter types for a generic
1113    /// function.
1114    fn get_closure_params(
1115        &'db self,
1116        generic_function_id: GenericFunctionId<'db>,
1117    ) -> Maybe<OrderedHashMap<TypeId<'db>, TypeId<'db>>> {
1118        get_closure_params_tracked(self.as_dyn_database(), generic_function_id)
1119    }
1120}
1121impl<'db, T: Database + ?Sized> FunctionsSemantic<'db> for T {}
cairo_lang_semantic/items/functions.rs

cairo_lang_semantic/items/
functions.rs
