Patrick Kelley 8fd444092b initial
2025-05-07 15:35:15 -04:00

80 lines
3.1 KiB
C++

// Copyright (c) 2020-now by the Zeek Project. See LICENSE for details.
#pragma once
#include <memory>
#include <string>
#include <utility>
#include <hilti/ast/declaration.h>
#include <hilti/ast/declarations/expression.h>
#include <hilti/ast/expression.h>
#include <hilti/ast/type.h>
namespace hilti::declaration {
/**
* AST node for a local variable declaration.
*
* Local variables support a "special" init expression for performance
* optimization: If the init expression is an instance of `expression::Void`,
* the generated C++ code will not default-initialize the variable. That means
* it's not safe to read from it before it has been written to at least once.
* This avoids the overhead of the creating the default value when it's not
* needed, but it disables HILTI's safety property of forcing all runtime
* values to have well-defined content at all times.
*
* TODO: Once we have flow-based optimization, we should be able to figure out
* automatically when it's safe to skip computing the default. We should then
* remove support for explicit `expression::Void` instances.
*
*/
class LocalVariable : public Declaration {
public:
auto type() const { return child<QualifiedType>(0); }
auto init() const { return child<hilti::Expression>(1); }
auto typeArguments() const { return children<hilti::Expression>(2, {}); }
void setType(ASTContext* ctx, QualifiedType* t) { setChild(ctx, 0, t->recreateAsLhs(ctx)); }
void setInit(ASTContext* ctx, hilti::Expression* init) { setChild(ctx, 1, init); }
void setTypeArguments(ASTContext* ctx, Expressions args) {
removeChildren(2, {});
addChildren(ctx, std::move(args));
}
std::string_view displayName() const final { return "local variable"; }
static auto create(ASTContext* ctx, ID id, QualifiedType* type, Expressions args, hilti::Expression* init = nullptr,
Meta meta = {}) {
return ctx->make<LocalVariable>(ctx, node::flatten(type->recreateAsLhs(ctx), init, std::move(args)),
std::move(id), std::move(meta));
}
static auto create(ASTContext* ctx, ID id, QualifiedType* type, hilti::Expression* init, Meta meta = {}) {
return create(ctx, std::move(id), type->recreateAsLhs(ctx), {}, init, std::move(meta));
}
static auto create(ASTContext* ctx, ID id, QualifiedType* type, Meta meta = {}) {
return create(ctx, std::move(id), type->recreateAsLhs(ctx), {}, nullptr, std::move(meta));
}
static auto create(ASTContext* ctx, ID id, hilti::Expression* init, const Meta& meta = {}) {
return create(ctx, std::move(id), QualifiedType::createAuto(ctx, meta), {}, init, meta);
}
static auto create(ASTContext* ctx, ID id, const Meta& meta = {}) {
return create(ctx, std::move(id), QualifiedType::createAuto(ctx, meta), meta);
}
protected:
LocalVariable(ASTContext* ctx, Nodes children, ID id, Meta meta)
: Declaration(ctx, NodeTags, std::move(children), std::move(id), declaration::Linkage::Private,
std::move(meta)) {}
HILTI_NODE_1(declaration::LocalVariable, Declaration, final);
};
} // namespace hilti::declaration