69 lines
2.9 KiB
C++
69 lines
2.9 KiB
C++
// Copyright (C) 2017-2018 Jonathan Müller <jonathanmueller.dev@gmail.com>
|
|
// This file is subject to the license terms in the LICENSE file
|
|
// found in the top-level directory of this distribution.
|
|
|
|
#ifndef CPPAST_CPP_VARIABLE_HPP_INCLUDED
|
|
#define CPPAST_CPP_VARIABLE_HPP_INCLUDED
|
|
|
|
#include <cppast/cpp_entity.hpp>
|
|
#include <cppast/cpp_forward_declarable.hpp>
|
|
#include <cppast/cpp_storage_class_specifiers.hpp>
|
|
#include <cppast/cpp_variable_base.hpp>
|
|
|
|
namespace cppast
|
|
{
|
|
/// A [cppast::cpp_entity]() modelling a C++ variable.
|
|
/// \notes This is not a member variable,
|
|
/// use [cppast::cpp_member_variable]() for that.
|
|
/// But it can be `static` member variable.
|
|
class cpp_variable final : public cpp_entity,
|
|
public cpp_variable_base,
|
|
public cpp_forward_declarable
|
|
{
|
|
public:
|
|
static cpp_entity_kind kind() noexcept;
|
|
|
|
/// \returns A newly created and registered variable.
|
|
/// \notes The default value may be `nullptr` indicating no default value.
|
|
static std::unique_ptr<cpp_variable> build(const cpp_entity_index& idx, cpp_entity_id id,
|
|
std::string name, std::unique_ptr<cpp_type> type,
|
|
std::unique_ptr<cpp_expression> def,
|
|
cpp_storage_class_specifiers spec,
|
|
bool is_constexpr);
|
|
|
|
/// \returns A newly created variable that is a declaration.
|
|
/// A declaration will not be registered and it does not have the default value.
|
|
static std::unique_ptr<cpp_variable> build_declaration(cpp_entity_id definition_id,
|
|
std::string name,
|
|
std::unique_ptr<cpp_type> type,
|
|
cpp_storage_class_specifiers spec,
|
|
bool is_constexpr);
|
|
|
|
/// \returns The [cppast::cpp_storage_specifiers]() on that variable.
|
|
cpp_storage_class_specifiers storage_class() const noexcept
|
|
{
|
|
return storage_;
|
|
}
|
|
|
|
/// \returns Whether the variable is marked `constexpr`.
|
|
bool is_constexpr() const noexcept
|
|
{
|
|
return is_constexpr_;
|
|
}
|
|
|
|
private:
|
|
cpp_variable(std::string name, std::unique_ptr<cpp_type> type,
|
|
std::unique_ptr<cpp_expression> def, cpp_storage_class_specifiers spec,
|
|
bool is_constexpr)
|
|
: cpp_entity(std::move(name)), cpp_variable_base(std::move(type), std::move(def)),
|
|
storage_(spec), is_constexpr_(is_constexpr)
|
|
{}
|
|
|
|
cpp_entity_kind do_get_entity_kind() const noexcept override;
|
|
|
|
cpp_storage_class_specifiers storage_;
|
|
bool is_constexpr_;
|
|
};
|
|
} // namespace cppast
|
|
|
|
#endif // CPPAST_CPP_VARIABLE_HPP_INCLUDED
|