Source/WebGPU/WGSL/AST/FunctionDecl.h

/*
 * Copyright (C) 2022 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "ASTNode.h"
#include "Attribute.h"
#include "CompilationMessage.h"
#include "GlobalDecl.h"
#include "Statements/CompoundStatement.h"
#include "TypeDecl.h"

namespace WGSL::AST {

class Parameter final : public ASTNode {
    WTF_MAKE_FAST_ALLOCATED;
public:
    Parameter(SourceSpan span, StringView name, UniqueRef<TypeDecl>&& type, Attributes&& attributes)
        : ASTNode(span)
        , m_name(WTFMove(name))
        , m_type(WTFMove(type))
        , m_attributes(WTFMove(attributes))
    {
    }

    const StringView& name() const { return m_name; }
    TypeDecl& type() { return m_type; }
    Attributes& attributes() { return m_attributes; }

private:
    StringView m_name;
    UniqueRef<TypeDecl> m_type;
    Attributes m_attributes;
};

class FunctionDecl final : public GlobalDecl {
    WTF_MAKE_FAST_ALLOCATED;
public:
    FunctionDecl(SourceSpan sourceSpan, StringView name, Vector<UniqueRef<Parameter>>&& parameters, std::unique_ptr<TypeDecl>&& returnType, CompoundStatement&& body, Attributes&& attributes, Attributes&& returnAttributes)
        : GlobalDecl(sourceSpan)
        , m_name(name)
        , m_parameters(WTFMove(parameters))
        , m_attributes(WTFMove(attributes))
        , m_returnAttributes(WTFMove(returnAttributes))
        , m_returnType(WTFMove(returnType))
        , m_body(WTFMove(body))
    {
    }

    Kind kind() const override { return Kind::Function; }
    const StringView& name() const { return m_name; }
    Vector<UniqueRef<Parameter>>& parameters() { return m_parameters; }
    Attributes& attributes() { return m_attributes; }
    Attributes& returnAttributes() { return m_returnAttributes; }
    TypeDecl* maybeReturnType() { return m_returnType.get(); }
    CompoundStatement& body() { return m_body; }

private:
    StringView m_name;
    Vector<UniqueRef<Parameter>> m_parameters;
    Attributes m_attributes;
    Attributes m_returnAttributes;
    std::unique_ptr<TypeDecl> m_returnType;
    CompoundStatement m_body;
};

} // namespace WGSL::AST

SPECIALIZE_TYPE_TRAITS_WGSL_GLOBAL_DECL(FunctionDecl, isFunction())