solang 0.3.4

// SPDX-License-Identifier: Apache-2.0

use super::{
    ast::{Diagnostic, Function, Mutability, Namespace, Parameter, StructType, Symbol, Type},
    contracts::is_base,
    diagnostics::Diagnostics,
    function_annotation::function_prototype_annotations,
    tags::resolve_tags,
    ContractDefinition,
};
use crate::sema::ast::ParameterAnnotation;
use crate::sema::function_annotation::unexpected_parameter_annotation;
use crate::sema::namespace::ResolveTypeContext;
use crate::Target;
use solang_parser::pt::{FunctionTy, Identifier};
use solang_parser::{
    doccomment::DocComment,
    pt,
    pt::{CodeLocation, OptionalCodeLocation},
};

/// Resolve function declaration in a contract
pub fn contract_function(
    contract: &ContractDefinition,
    func: &pt::FunctionDefinition,
    tags: &[DocComment],
    annotations: &[&pt::Annotation],
    file_no: usize,
    ns: &mut Namespace,
) -> Option<usize> {
    let mut success = true;
    let contract_no = contract.contract_no;

    // The parser allows constructors to have return values. This is so that we can give a
    // nicer error message than "returns unexpected"
    match func.ty {
        pt::FunctionTy::Function => {
            // Function name cannot be the same as the contract name
            if let Some(n) = &func.name {
                if n.name == ns.contracts[contract_no].id.name {
                    ns.diagnostics.push(Diagnostic::error(
                        func.loc_prototype,
                        "function cannot have same name as the contract".to_string(),
                    ));
                    return None;
                }
            } else {
                ns.diagnostics.push(Diagnostic::error(
                    func.name_loc,
                    "function is missing a name. A function without a name is syntax for 'fallback() external' or 'receive() external' in older versions of the Solidity language, see https://solang.readthedocs.io/en/latest/language/functions.html#fallback-and-receive-function".to_string(),
                ));
                return None;
            }
        }
        pt::FunctionTy::Constructor => {
            if !func.returns.is_empty() {
                ns.diagnostics.push(Diagnostic::error(
                    func.loc_prototype,
                    "constructor cannot have return values".to_string(),
                ));
                return None;
            }
            // Allow setting a name in Polkadot to be used during metadata generation.
            if func.name.is_some() && !ns.target.is_polkadot() {
                ns.diagnostics.push(Diagnostic::error(
                    func.loc_prototype,
                    "constructor cannot have a name".to_string(),
                ));
                return None;
            }
        }
        pt::FunctionTy::Fallback | pt::FunctionTy::Receive => {
            if !func.returns.is_empty() {
                ns.diagnostics.push(Diagnostic::error(
                    func.loc_prototype,
                    format!("{} function cannot have return values", func.ty),
                ));
                success = false;
            }
            if !func.params.is_empty() {
                ns.diagnostics.push(Diagnostic::error(
                    func.loc_prototype,
                    format!("{} function cannot have parameters", func.ty),
                ));
                success = false;
            }
            if func.name.is_some() {
                ns.diagnostics.push(Diagnostic::error(
                    func.loc_prototype,
                    format!("{} function cannot have a name", func.ty),
                ));
                return None;
            }
        }
        pt::FunctionTy::Modifier => {
            if !func.returns.is_empty() {
                ns.diagnostics.push(Diagnostic::error(
                    func.loc_prototype,
                    "constructor cannot have return values".to_string(),
                ));
                return None;
            }
        }
    }

    if let Some(loc) = func.return_not_returns {
        ns.diagnostics.push(Diagnostic::error(
            loc,
            "'return' unexpected. Did you mean 'returns'?".to_string(),
        ));
        success = false;
    }

    let mut mutability: Option<pt::Mutability> = None;
    let mut visibility: Option<pt::Visibility> = None;
    let mut is_virtual: Option<pt::Loc> = None;
    let mut is_override: Option<(pt::Loc, Vec<usize>)> = None;

    for a in &func.attributes {
        match &a {
            pt::FunctionAttribute::Immutable(loc) => {
                ns.diagnostics.push(Diagnostic::error(
                    *loc,
                    "function cannot be declared 'immutable'".to_string(),
                ));
                success = false;
                continue;
            }
            pt::FunctionAttribute::Mutability(m) => {
                if let Some(e) = &mutability {
                    ns.diagnostics.push(Diagnostic::error_with_note(
                        m.loc(),
                        format!("function redeclared '{m}'"),
                        e.loc(),
                        format!("location of previous declaration of '{e}'"),
                    ));
                    success = false;
                    continue;
                }

                if let pt::Mutability::Constant(loc) = m {
                    ns.diagnostics.push(Diagnostic::warning(
                        *loc,
                        "'constant' is deprecated. Use 'view' instead".to_string(),
                    ));

                    mutability = Some(pt::Mutability::View(*loc));
                } else {
                    mutability = Some(m.clone());
                }
            }
            pt::FunctionAttribute::Visibility(v) => {
                if let Some(e) = &visibility {
                    ns.diagnostics.push(Diagnostic::error_with_note(
                        v.loc_opt().unwrap(),
                        format!("function redeclared '{v}'"),
                        e.loc_opt().unwrap(),
                        format!("location of previous declaration of '{e}'"),
                    ));
                    success = false;
                    continue;
                }

                visibility = Some(v.clone());
            }
            pt::FunctionAttribute::Virtual(loc) => {
                if let Some(prev_loc) = &is_virtual {
                    ns.diagnostics.push(Diagnostic::error_with_note(
                        *loc,
                        "function redeclared 'virtual'".to_string(),
                        *prev_loc,
                        "location of previous declaration of 'virtual'".to_string(),
                    ));
                    success = false;
                    continue;
                }

                is_virtual = Some(*loc);
            }
            pt::FunctionAttribute::Override(loc, bases) => {
                if let Some((prev_loc, _)) = &is_override {
                    ns.diagnostics.push(Diagnostic::error_with_note(
                        *loc,
                        "function redeclared 'override'".to_string(),
                        *prev_loc,
                        "location of previous declaration of 'override'".to_string(),
                    ));
                    success = false;
                    continue;
                }

                let mut list = Vec::new();
                let mut diagnostics = Diagnostics::default();

                for name in bases {
                    if let Ok(no) =
                        ns.resolve_contract_with_namespace(file_no, name, &mut diagnostics)
                    {
                        if list.contains(&no) {
                            diagnostics.push(Diagnostic::error(
                                name.loc,
                                format!("function duplicate override '{name}'"),
                            ));
                        } else if !is_base(no, contract_no, ns) {
                            diagnostics.push(Diagnostic::error(
                                name.loc,
                                format!(
                                    "override '{}' is not a base contract of '{}'",
                                    name, ns.contracts[contract_no].id
                                ),
                            ));
                        } else {
                            list.push(no);
                        }
                    }
                }

                ns.diagnostics.extend(diagnostics);

                is_override = Some((*loc, list));
            }
            pt::FunctionAttribute::BaseOrModifier(loc, _) => {
                // We can only fully resolve the base constructors arguments
                // once we have resolved all the constructors, this is not done here yet
                // so we fully resolve these along with the constructor body
                if func.ty != pt::FunctionTy::Constructor && func.ty != pt::FunctionTy::Function {
                    ns.diagnostics.push(Diagnostic::error(
                        *loc,
                        format!(
                            "function modifiers or base contracts are not allowed on {}",
                            func.ty
                        ),
                    ));
                }
            }
            pt::FunctionAttribute::Error(_) => unreachable!(),
        }
    }

    let visibility = match visibility {
        Some(v) => {
            if func.ty == pt::FunctionTy::Modifier {
                ns.diagnostics.push(Diagnostic::error(
                    v.loc_opt().unwrap(),
                    format!("'{v}': modifiers can not have visibility"),
                ));

                pt::Visibility::Internal(v.loc_opt())
            } else if func.ty == pt::FunctionTy::Constructor {
                ns.diagnostics.push(Diagnostic::warning(
                    v.loc_opt().unwrap(),
                    format!("'{v}': visibility for constructors is ignored"),
                ));

                pt::Visibility::Public(v.loc_opt())
            } else {
                v
            }
        }
        None => {
            match func.ty {
                pt::FunctionTy::Constructor => pt::Visibility::Public(None),
                pt::FunctionTy::Modifier => pt::Visibility::Internal(None),
                _ => {
                    ns.diagnostics.push(Diagnostic::error(
                        func.loc_prototype,
                        "no visibility specified".to_string(),
                    ));

                    success = false;
                    // continue processing while assuming it's a public
                    pt::Visibility::Public(None)
                }
            }
        }
    };

    if let Some(m) = &mutability {
        if func.ty == pt::FunctionTy::Modifier {
            ns.diagnostics.push(Diagnostic::error(
                m.loc(),
                "modifier cannot have mutability specifier".to_string(),
            ));
            success = false;
            mutability = None;
        }
    }

    // Reference types can't be passed through the ABI encoder/decoder, so
    // storage parameters/returns are only allowed in internal/private functions
    let storage_allowed = match visibility {
        pt::Visibility::Internal(_) | pt::Visibility::Private(_) => {
            if let Some(pt::Mutability::Payable(loc)) = mutability {
                ns.diagnostics.push(Diagnostic::error(
                    loc,
                    "internal or private function cannot be payable".to_string(),
                ));
                success = false;
            }
            true
        }
        pt::Visibility::Public(_) | pt::Visibility::External(_) => {
            // library function abi is special. Storage vars are allowed
            ns.contracts[contract_no].is_library()
        }
    };

    let mut diagnostics = Diagnostics::default();

    let (params, params_success) = resolve_params(
        &func.params,
        &func.ty,
        storage_allowed,
        file_no,
        Some(contract_no),
        ns,
        &mut diagnostics,
    );

    let (returns, returns_success) = resolve_returns(
        &func.returns,
        storage_allowed,
        file_no,
        Some(contract_no),
        ns,
        &mut diagnostics,
    );

    ns.diagnostics.extend(diagnostics);

    if ns.contracts[contract_no].is_interface() {
        if func.ty == pt::FunctionTy::Constructor {
            ns.diagnostics.push(Diagnostic::error(
                func.loc_prototype,
                "constructor not allowed in an interface".to_string(),
            ));
            success = false;
        } else if func.body.is_some() {
            ns.diagnostics.push(Diagnostic::error(
                func.loc_prototype,
                "function in an interface cannot have a body".to_string(),
            ));
            success = false;
        } else if let pt::Visibility::External(_) = visibility {
            // ok
        } else {
            ns.diagnostics.push(Diagnostic::error(
                func.loc_prototype,
                "functions must be declared 'external' in an interface".to_string(),
            ));
            success = false;
        }
    } else if ns.contracts[contract_no].is_library() {
        if func.ty != pt::FunctionTy::Function && func.ty != pt::FunctionTy::Modifier {
            ns.diagnostics.push(Diagnostic::error(
                func.loc_prototype,
                format!("{} not allowed in a library", func.ty),
            ));
            success = false;
        } else if func.body.is_none() {
            ns.diagnostics.push(Diagnostic::error(
                func.loc_prototype,
                format!("{} in a library must have a body", func.ty),
            ));
            success = false;
        } else if let Some((loc, _)) = is_override {
            ns.diagnostics.push(Diagnostic::error(
                loc,
                format!("{} in a library cannot override", func.ty),
            ));
            success = false;
        } else if let Some(pt::Mutability::Payable(_)) = mutability {
            ns.diagnostics.push(Diagnostic::error(
                func.loc_prototype,
                format!("{} in a library cannot be payable", func.ty),
            ));
            success = false;
        }
    } else if func.ty == pt::FunctionTy::Constructor && is_virtual.is_some() {
        ns.diagnostics.push(Diagnostic::error(
            func.loc_prototype,
            "constructors cannot be declared 'virtual'".to_string(),
        ));
    }

    // all functions in an interface are implicitly virtual
    let is_virtual = if ns.contracts[contract_no].is_interface() {
        if let Some(loc) = is_virtual {
            ns.diagnostics.push(Diagnostic::warning(
                loc,
                "functions in an interface are implicitly virtual".to_string(),
            ));
        }

        true
    } else if ns.contracts[contract_no].is_library() {
        if let Some(loc) = is_virtual {
            ns.diagnostics.push(Diagnostic::error(
                loc,
                "functions in a library cannot be virtual".to_string(),
            ));
        }

        false
    } else {
        is_virtual.is_some()
    };

    if !is_virtual && func.body.is_none() && !ns.contracts[contract_no].is_library() {
        ns.diagnostics.push(Diagnostic::error(
            func.loc_prototype,
            "function with no body missing 'virtual'. This was permitted in older versions of the Solidity language, please update.".to_string(),
        ));
        success = false;
    }

    if let pt::Visibility::Private(_) = visibility {
        if is_virtual {
            ns.diagnostics.push(Diagnostic::error(
                func.loc_prototype,
                "function marked 'virtual' cannot also be 'private'".to_string(),
            ));
            success = false;
        }
    }

    if !success || !returns_success || !params_success {
        return None;
    }

    let name = func.name.clone().unwrap_or_else(|| {
        let name = if ns.target.is_polkadot() && func.ty == pt::FunctionTy::Constructor {
            "new"
        } else {
            ""
        };
        Identifier {
            name: name.to_string(),
            loc: func.name_loc,
        }
    });

    let bases = ns.contract_bases(contract_no);

    let tags = resolve_tags(
        func.loc_prototype.file_no(),
        &func.ty.to_string(),
        tags,
        Some(&params),
        Some(&returns),
        Some(bases),
        ns,
    );

    if matches!(
        visibility,
        pt::Visibility::External(_) | pt::Visibility::Public(_) if params.iter().any(|p| p.ty.is_recursive(ns)))
    {
        ns.diagnostics.push(Diagnostic::error(
            func.loc_prototype,
            "Recursive parameter not allowed for public or external functions.".into(),
        ))
    }

    let mut fdecl = Function::new(
        func.loc_prototype,
        func.loc,
        name,
        Some(contract_no),
        tags,
        func.ty,
        mutability,
        visibility,
        params,
        returns,
        ns,
    );

    fdecl.is_virtual = is_virtual;
    fdecl.is_override = is_override;
    fdecl.has_body = func.body.is_some();

    function_prototype_annotations(&mut fdecl, annotations, ns);

    if func.ty == pt::FunctionTy::Constructor {
        // In the eth solidity only one constructor is allowed
        if ns.target == Target::EVM {
            if let Some(prev_func_no) = ns.contracts[contract_no]
                .functions
                .iter()
                .find(|func_no| ns.functions[**func_no].is_constructor())
            {
                let prev_loc = ns.functions[*prev_func_no].loc_prototype;

                ns.diagnostics.push(Diagnostic::error_with_note(
                    func.loc_prototype,
                    "constructor already defined".to_string(),
                    prev_loc,
                    "location of previous definition".to_string(),
                ));
                return None;
            }
        } else {
            let payable = fdecl.is_payable();

            if let Some(prev_func_no) = ns.contracts[contract_no].functions.iter().find(|func_no| {
                let f = &ns.functions[**func_no];

                f.is_constructor() && f.is_payable() != payable
            }) {
                let prev_loc = ns.functions[*prev_func_no].loc_prototype;

                ns.diagnostics.push(Diagnostic::error_with_note(
                    func.loc_prototype,
                    "all constructors should be defined 'payable' or not".to_string(),
                    prev_loc,
                    "location of previous definition".to_string(),
                ));
                return None;
            }
        }

        match fdecl.mutability {
            Mutability::Pure(loc) => {
                ns.diagnostics.push(Diagnostic::error(
                    loc,
                    "constructor cannot be declared pure".to_string(),
                ));
                return None;
            }
            Mutability::View(loc) => {
                ns.diagnostics.push(Diagnostic::error(
                    loc,
                    "constructor cannot be declared view".to_string(),
                ));
                return None;
            }
            _ => (),
        }

        for prev_func_no in &ns.contracts[contract_no].functions {
            let v = &ns.functions[*prev_func_no];

            if v.is_constructor() && v.signature == fdecl.signature {
                ns.diagnostics.push(Diagnostic::error_with_note(
                    func.loc_prototype,
                    "constructor with this signature already exists".to_string(),
                    v.loc_prototype,
                    "location of previous definition".to_string(),
                ));

                return None;
            }
        }

        let pos = ns.functions.len();

        ns.contracts[contract_no].functions.push(pos);
        ns.functions.push(fdecl);

        Some(pos)
    } else if func.ty == pt::FunctionTy::Receive || func.ty == pt::FunctionTy::Fallback {
        if func.ty == pt::FunctionTy::Receive && ns.target == Target::Solana {
            ns.diagnostics.push(Diagnostic::error(
                func.loc_prototype,
                format!("target {} does not support receive() functions, see https://solang.readthedocs.io/en/latest/language/functions.html#fallback-and-receive-function", ns.target),
            ));
        } else {
            if let Some(prev_func_no) = ns.contracts[contract_no]
                .functions
                .iter()
                .find(|func_no| ns.functions[**func_no].ty == func.ty)
            {
                let prev_loc = ns.functions[*prev_func_no].loc_prototype;

                ns.diagnostics.push(Diagnostic::error_with_note(
                    func.loc_prototype,
                    format!("{} function already defined", func.ty),
                    prev_loc,
                    "location of previous definition".to_string(),
                ));
                return None;
            }

            if let pt::Visibility::External(_) = fdecl.visibility {
                // ok
            } else {
                ns.diagnostics.push(Diagnostic::error(
                    func.loc_prototype,
                    format!("{} function must be declared external", func.ty),
                ));
                return None;
            }

            if fdecl.is_payable() {
                if func.ty == pt::FunctionTy::Fallback {
                    ns.diagnostics.push(Diagnostic::error(
                    func.loc_prototype,
                    format!("{} function must not be declare payable, use 'receive() external payable' instead", func.ty),
                ));
                    return None;
                }
            } else if func.ty == pt::FunctionTy::Receive {
                ns.diagnostics.push(Diagnostic::error(
                    func.loc_prototype,
                    format!("{} function must be declared payable", func.ty),
                ));
                return None;
            }
        }

        let pos = ns.functions.len();

        ns.contracts[contract_no].functions.push(pos);
        ns.functions.push(fdecl);

        Some(pos)
    } else {
        let id = func.name.as_ref().unwrap();

        if let Some(func_no) = ns.contracts[contract_no]
            .all_functions
            .keys()
            .find(|func_no| {
                let func = &ns.functions[**func_no];

                func.signature == fdecl.signature
            })
        {
            ns.diagnostics.push(Diagnostic::error_with_note(
                func.loc_prototype,
                format!("overloaded {} with this signature already exist", func.ty),
                ns.functions[*func_no].loc_prototype,
                "location of previous definition".to_string(),
            ));

            return None;
        }

        let func_no = ns.functions.len();

        ns.functions.push(fdecl);
        ns.contracts[contract_no].functions.push(func_no);

        if let Some(Symbol::Function(ref mut v)) =
            ns.function_symbols
                .get_mut(&(file_no, Some(contract_no), id.name.to_owned()))
        {
            v.push((func.loc_prototype, func_no));
        } else {
            ns.add_symbol(
                file_no,
                Some(contract_no),
                id,
                Symbol::Function(vec![(id.loc, func_no)]),
            );
        }

        Some(func_no)
    }
}

/// Resolve free function
pub fn function(
    func: &pt::FunctionDefinition,
    file_no: usize,
    tags: &[DocComment],
    ns: &mut Namespace,
) -> Option<usize> {
    let mut success = true;

    let mut mutability: Option<pt::Mutability> = None;

    for a in &func.attributes {
        match &a {
            pt::FunctionAttribute::Immutable(loc) => {
                ns.diagnostics.push(Diagnostic::error(
                    *loc,
                    "function cannot be declared 'immutable'".to_string(),
                ));
                success = false;
                continue;
            }
            pt::FunctionAttribute::Mutability(m) => {
                if let Some(e) = &mutability {
                    ns.diagnostics.push(Diagnostic::error_with_note(
                        m.loc(),
                        format!("function redeclared '{m}'"),
                        e.loc(),
                        format!("location of previous declaration of '{e}'"),
                    ));
                    success = false;
                    continue;
                }

                if let pt::Mutability::Constant(loc) = m {
                    ns.diagnostics.push(Diagnostic::warning(
                        *loc,
                        "'constant' is deprecated. Use 'view' instead".to_string(),
                    ));

                    mutability = Some(pt::Mutability::View(*loc));
                } else {
                    mutability = Some(m.clone());
                }
            }
            pt::FunctionAttribute::Visibility(v) => {
                ns.diagnostics.push(Diagnostic::error(
                    v.loc_opt().unwrap(),
                    format!("'{v}': only functions in contracts can have a visibility specifier"),
                ));
                success = false;
            }
            pt::FunctionAttribute::Virtual(loc) => {
                ns.diagnostics.push(Diagnostic::error(
                    *loc,
                    String::from("only functions in contracts can be virtual"),
                ));
                success = false;
            }
            pt::FunctionAttribute::Override(loc, _) => {
                ns.diagnostics.push(Diagnostic::error(
                    *loc,
                    String::from("only functions in contracts can override"),
                ));
                success = false;
            }
            pt::FunctionAttribute::BaseOrModifier(loc, _) => {
                // We can only fully resolve the base constructors arguments
                // once we have resolved all the constructors, this is not done here yet
                // so we fully resolve these along with the constructor body
                ns.diagnostics.push(Diagnostic::error(
                    *loc,
                    String::from(
                        "function modifiers or base contracts are only allowed on functions in contracts",
                    ),
                ));
                success = false;
            }
            pt::FunctionAttribute::Error(_) => {
                success = false;
            }
        }
    }

    let mut diagnostics = Diagnostics::default();

    let (params, params_success) = resolve_params(
        &func.params,
        &func.ty,
        true,
        file_no,
        None,
        ns,
        &mut diagnostics,
    );

    let (returns, returns_success) =
        resolve_returns(&func.returns, true, file_no, None, ns, &mut diagnostics);

    ns.diagnostics.extend(diagnostics);

    if func.body.is_none() {
        ns.diagnostics.push(Diagnostic::error(
            func.loc_prototype,
            String::from("missing function body"),
        ));
        success = false;
    }

    if !success || !returns_success || !params_success {
        return None;
    }

    let name = match &func.name {
        Some(s) => s.to_owned(),
        None => {
            ns.diagnostics.push(Diagnostic::error(
                func.loc_prototype,
                String::from("missing function name"),
            ));
            return None;
        }
    };

    let doc = resolve_tags(
        func.loc_prototype.file_no(),
        "function",
        tags,
        Some(&params),
        Some(&returns),
        None,
        ns,
    );

    let mut fdecl = Function::new(
        func.loc_prototype,
        func.loc,
        name,
        None,
        doc,
        func.ty,
        mutability,
        pt::Visibility::Internal(None),
        params,
        returns,
        ns,
    );

    fdecl.has_body = true;

    let id = func.name.as_ref().unwrap();

    if let Some(prev) = ns.functions.iter().find(|f| fdecl.signature == f.signature) {
        ns.diagnostics.push(Diagnostic::error_with_note(
            func.loc_prototype,
            format!("overloaded {} with this signature already exist", func.ty),
            prev.loc_prototype,
            "location of previous definition".to_string(),
        ));

        return None;
    }

    let func_no = ns.functions.len();

    ns.functions.push(fdecl);

    if let Some(Symbol::Function(ref mut v)) =
        ns.function_symbols
            .get_mut(&(file_no, None, id.name.to_owned()))
    {
        v.push((func.loc_prototype, func_no));
    } else {
        ns.add_symbol(file_no, None, id, Symbol::Function(vec![(id.loc, func_no)]));
    }

    Some(func_no)
}

/// Resolve the parameters
pub fn resolve_params(
    parameters: &[(pt::Loc, Option<pt::Parameter>)],
    func_ty: &pt::FunctionTy,
    is_internal: bool,
    file_no: usize,
    contract_no: Option<usize>,
    ns: &mut Namespace,
    diagnostics: &mut Diagnostics,
) -> (Vec<Parameter<Type>>, bool) {
    let mut params = Vec::new();
    let mut success = true;

    for (loc, p) in parameters {
        let p = match p {
            Some(p @ pt::Parameter { ref annotation, .. }) => {
                if annotation.is_some()
                    && *func_ty != FunctionTy::Constructor
                    && ns.target == Target::Solana
                {
                    diagnostics.push(Diagnostic::error(
                        annotation.as_ref().unwrap().loc,
                        "parameter annotations are only allowed in constructors".to_string(),
                    ));
                    success = false;
                    continue;
                } else if annotation.is_some() && ns.target != Target::Solana {
                    diagnostics.push(unexpected_parameter_annotation(
                        annotation.as_ref().unwrap().loc,
                    ));
                    success = false;
                    continue;
                }

                p
            }
            None => {
                diagnostics.push(Diagnostic::error(*loc, "missing parameter type".to_owned()));
                success = false;
                continue;
            }
        };

        let mut ty_loc = p.ty.loc();

        match ns.resolve_type(
            file_no,
            contract_no,
            ResolveTypeContext::None,
            &p.ty,
            diagnostics,
        ) {
            Ok(ty) => {
                if !is_internal {
                    if ty.contains_internal_function(ns) {
                        diagnostics.push(Diagnostic::error(
                        p.ty.loc(),
                        "parameter of type 'function internal' not allowed public or external functions".to_string(),
                    ));
                        success = false;
                    }

                    if let Some(ty) = ty.contains_builtins(ns, &StructType::AccountInfo) {
                        let message = format!(
                            "parameter of type '{}' not alowed in public or external functions",
                            ty.to_string(ns)
                        );
                        diagnostics.push(Diagnostic::error(p.ty.loc(), message));
                        success = false
                    }
                }

                let ty = if !ty.can_have_data_location() {
                    if let Some(storage) = &p.storage {
                        diagnostics.push(Diagnostic::error(
                            storage.loc(),
                                format!("data location '{storage}' can only be specified for array, struct or mapping"
                                )
                            ));
                        success = false;
                    }

                    ty
                } else if let Some(pt::StorageLocation::Storage(loc)) = p.storage {
                    if !is_internal {
                        diagnostics.push(Diagnostic::error(
                            loc,
                            "parameter of type 'storage' not allowed public or external functions"
                                .to_string(),
                        ));
                        success = false;
                    }

                    ty_loc.use_end_from(&loc);

                    Type::StorageRef(false, Box::new(ty))
                } else {
                    if ty.contains_mapping(ns) {
                        diagnostics.push(Diagnostic::error(
                            p.ty.loc(),
                            "parameter with mapping type must be of type 'storage'".to_string(),
                        ));
                        success = false;
                    }

                    if !ty.fits_in_memory(ns) {
                        diagnostics.push(Diagnostic::error(
                            p.ty.loc(),
                            String::from("type is too large to fit into memory"),
                        ));
                        success = false;
                    }

                    ty
                };

                let annotation = p.annotation.as_ref().map(|e| ParameterAnnotation {
                    loc: e.loc,
                    id: e.id.clone(),
                });

                params.push(Parameter {
                    loc: *loc,
                    id: p.name.clone(),
                    ty,
                    ty_loc: Some(ty_loc),
                    indexed: false,
                    readonly: false,
                    infinite_size: false,
                    recursive: false,
                    annotation,
                });
            }
            Err(()) => success = false,
        }
    }

    (params, success)
}

/// Resolve the return values
pub fn resolve_returns(
    returns: &[(pt::Loc, Option<pt::Parameter>)],
    is_internal: bool,
    file_no: usize,
    contract_no: Option<usize>,
    ns: &mut Namespace,
    diagnostics: &mut Diagnostics,
) -> (Vec<Parameter<Type>>, bool) {
    let mut resolved_returns = Vec::new();
    let mut success = true;

    for (loc, r) in returns {
        let r = match r {
            Some(pt::Parameter {
                annotation: Some(annotation),
                ..
            }) => {
                diagnostics.push(unexpected_parameter_annotation(annotation.loc));
                success = false;
                continue;
            }
            Some(r) => r,
            None => {
                diagnostics.push(Diagnostic::error(*loc, "missing return type".to_owned()));
                success = false;
                continue;
            }
        };

        let mut ty_loc = r.ty.loc();

        match ns.resolve_type(
            file_no,
            contract_no,
            ResolveTypeContext::None,
            &r.ty,
            diagnostics,
        ) {
            Ok(ty) => {
                if !is_internal {
                    if ty.contains_internal_function(ns) {
                        diagnostics.push(Diagnostic::error(
                        r.ty.loc(),
                        "return type 'function internal' not allowed in public or external functions"
                            .to_string(),
                    ));
                        success = false;
                    }

                    if let Some(ty) = ty.contains_builtins(ns, &StructType::AccountInfo) {
                        let message = format!(
                            "return type '{}' not allowed in public or external functions",
                            ty.to_string(ns)
                        );
                        diagnostics.push(Diagnostic::error(r.ty.loc(), message));
                        success = false
                    }
                }
                let ty = if !ty.can_have_data_location() {
                    if let Some(storage) = &r.storage {
                        diagnostics.push(Diagnostic::error(
                            storage.loc(),
                                format!("data location '{storage}' can only be specified for array, struct or mapping"
                                )
                            ));
                        success = false;
                    }

                    ty
                } else {
                    match r.storage {
                        Some(pt::StorageLocation::Storage(loc)) => {
                            if !is_internal {
                                diagnostics.push(Diagnostic::error(
                                    loc,
                                    "return type of type 'storage' not allowed public or external functions"
                                        .to_string(),
                                ));
                                success = false;
                            }

                            ty_loc.use_end_from(&loc);

                            Type::StorageRef(false, Box::new(ty))
                        }
                        _ => {
                            if ty.contains_mapping(ns) {
                                diagnostics.push(Diagnostic::error(
                                    r.ty.loc(),
                                    "return type containing mapping must be of type 'storage'"
                                        .to_string(),
                                ));
                                success = false;
                            }

                            if !ty.fits_in_memory(ns) {
                                diagnostics.push(Diagnostic::error(
                                    r.ty.loc(),
                                    String::from("type is too large to fit into memory"),
                                ));
                                success = false;
                            }

                            ty
                        }
                    }
                };

                resolved_returns.push(Parameter {
                    loc: *loc,
                    id: r.name.clone(),
                    ty,
                    ty_loc: Some(ty_loc),
                    indexed: false,
                    readonly: false,
                    infinite_size: false,
                    recursive: false,
                    annotation: None,
                });
            }
            Err(()) => success = false,
        }
    }

    (resolved_returns, success)
}

#[test]
fn signatures() {
    use super::*;

    let mut ns = Namespace::new(Target::EVM);

    ns.contracts.push(ast::Contract::new(
        &pt::Identifier {
            name: "bar".to_string(),
            loc: pt::Loc::Implicit,
        },
        pt::ContractTy::Contract(pt::Loc::Implicit),
        Vec::new(),
        pt::Loc::Implicit,
    ));

    let fdecl = Function::new(
        pt::Loc::Implicit,
        pt::Loc::Implicit,
        pt::Identifier {
            name: "foo".to_owned(),
            loc: pt::Loc::Implicit,
        },
        None,
        vec![],
        pt::FunctionTy::Function,
        None,
        pt::Visibility::Public(None),
        vec![
            Parameter {
                loc: pt::Loc::Implicit,
                id: None,
                ty: Type::Uint(8),
                ty_loc: None,
                indexed: false,
                readonly: false,
                infinite_size: false,
                recursive: false,
                annotation: None,
            },
            Parameter {
                loc: pt::Loc::Implicit,
                id: None,
                ty: Type::Address(false),
                ty_loc: None,
                indexed: false,
                readonly: false,
                infinite_size: false,
                recursive: false,
                annotation: None,
            },
        ],
        Vec::new(),
        &ns,
    );

    assert_eq!(fdecl.signature, "foo(uint8,address)");
}