1103: Lower AST::Visibility to HIR::Visibility properly r=CohenArthur a=CohenArthur

Fixes #1093

This should cover every case since the previous code simply created public HIR visibilities.

The PR refactors the HIR::Visibility struct to be tinier and a desugared version of the AST one.

Co-authored-by: Arthur Cohen <arthur.cohen@embecosm.com>
This commit is contained in:
bors[bot] 2022-04-12 10:47:17 +00:00 committed by GitHub
commit a5b38698aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 120 additions and 121 deletions

View File

@ -632,6 +632,8 @@ public:
: public_vis_type (public_vis_type), in_path (std::move (in_path))
{}
PublicVisType get_public_vis_type () const { return public_vis_type; }
// Returns whether visibility is in an error state.
bool is_error () const
{
@ -684,6 +686,7 @@ public:
}
std::string as_string () const;
const SimplePath &get_path () const { return in_path; }
protected:
// Clone function implementation - not currently virtual but may be if
@ -881,6 +884,8 @@ public:
FunctionQualifiers get_qualifiers () { return qualifiers; }
const Visibility &get_visibility () const { return vis; }
protected:
/* Use covariance to implement clone function as returning this object
* rather than base */
@ -938,8 +943,8 @@ public:
std::string as_string () const override;
// TODO: this mutable getter seems really dodgy. Think up better way.
Visibility &get_vis () { return visibility; }
const Visibility &get_vis () const { return visibility; }
Visibility &get_visibility () { return visibility; }
const Visibility &get_visibility () const { return visibility; }
std::vector<Attribute> &get_outer_attrs () { return outer_attrs; }
const std::vector<Attribute> &get_outer_attrs () const { return outer_attrs; }
@ -1893,7 +1898,7 @@ public:
return field_type;
}
Visibility get_visibility () const { return visibility; }
const Visibility &get_visibility () const { return visibility; }
NodeId get_node_id () const { return node_id; }
};
@ -2027,6 +2032,8 @@ public:
NodeId get_node_id () const { return node_id; }
const Visibility &get_visibility () const { return visibility; }
Location get_locus () const { return locus; }
// TODO: this mutable getter seems really dodgy. Think up better way.
@ -3918,6 +3925,8 @@ public:
Identifier get_identifier () const { return item_name; }
const Visibility &get_visibility () const { return visibility; }
bool is_mut () const { return has_mut; }
protected:
@ -4080,6 +4089,8 @@ public:
Location get_locus () const { return locus; }
const Visibility &get_visibility () const { return visibility; }
ExternalFunctionItem (
Identifier item_name,
std::vector<std::unique_ptr<GenericParam>> generic_params,

View File

@ -37,8 +37,7 @@ HIRCompileBase::setup_attributes_on_fndecl (
{
// if its the main fn or pub visibility mark its as DECL_PUBLIC
// please see https://github.com/Rust-GCC/gccrs/pull/137
bool is_pub
= visibility.get_vis_type () != HIR::Visibility::PublicVisType::NONE;
bool is_pub = visibility.get_vis_type () == HIR::Visibility::VisType::PUBLIC;
if (is_main_entry_point || is_pub)
{
TREE_PUBLIC (fndecl) = 1;

View File

@ -84,9 +84,8 @@ CompileTraitItem::visit (HIR::TraitItemFunc &func)
&canonical_path);
rust_assert (ok);
// FIXME
HIR::Visibility vis (HIR::Visibility::PublicVisType::NONE,
AST::SimplePath::create_empty ());
// FIXME: How do we get the proper visibility here?
auto vis = HIR::Visibility (HIR::Visibility::VisType::PUBLIC);
HIR::TraitFunctionDecl &function = func.get_decl ();
tree fndecl
= compile_function (ctx, function.get_function_name (),

View File

@ -19,6 +19,7 @@
#ifndef RUST_AST_LOWER_ENUMITEM
#define RUST_AST_LOWER_ENUMITEM
#include "rust-ast-lower.h"
#include "rust-diagnostics.h"
#include "rust-ast-lower-base.h"
@ -51,7 +52,7 @@ public:
if (item.has_visibility ())
rust_error_at (item.get_locus (),
"visibility qualifier %qs not allowed on enum item",
item.get_vis ().as_string ().c_str ());
item.get_visibility ().as_string ().c_str ());
translated = new HIR::EnumItem (mapping, item.get_identifier (),
item.get_outer_attrs (), item.get_locus ());
@ -73,12 +74,12 @@ public:
if (item.has_visibility ())
rust_error_at (item.get_locus (),
"visibility qualifier %qs not allowed on enum item",
item.get_vis ().as_string ().c_str ());
item.get_visibility ().as_string ().c_str ());
std::vector<HIR::TupleField> fields;
for (auto &field : item.get_tuple_fields ())
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (field.get_visibility ());
HIR::Type *type
= ASTLoweringType::translate (field.get_field_type ().get ());
@ -117,12 +118,12 @@ public:
if (item.has_visibility ())
rust_error_at (item.get_locus (),
"visibility qualifier %qs not allowed on enum item",
item.get_vis ().as_string ().c_str ());
item.get_visibility ().as_string ().c_str ());
std::vector<HIR::StructField> fields;
for (auto &field : item.get_struct_fields ())
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (field.get_visibility ());
HIR::Type *type
= ASTLoweringType::translate (field.get_field_type ().get ());
@ -165,7 +166,7 @@ public:
if (item.has_visibility ())
rust_error_at (item.get_locus (),
"visibility qualifier %qs not allowed on enum item",
item.get_vis ().as_string ().c_str ());
item.get_visibility ().as_string ().c_str ());
HIR::Expr *expr = ASTLoweringExpr::translate (item.get_expr ().get ());
translated

View File

@ -21,6 +21,7 @@
#include "rust-ast-lower-base.h"
#include "rust-ast-lower-type.h"
#include "rust-ast-lower.h"
namespace Rust {
namespace HIR {
@ -39,7 +40,7 @@ public:
void visit (AST::ExternalStaticItem &item) override
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (item.get_visibility ());
HIR::Type *static_type
= ASTLoweringType::translate (item.get_type ().get ());
@ -65,7 +66,7 @@ public:
{
std::vector<std::unique_ptr<HIR::WhereClauseItem> > where_clause_items;
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (function.get_visibility ());
std::vector<std::unique_ptr<HIR::GenericParam> > generic_params;
if (function.has_generics ())

View File

@ -56,7 +56,7 @@ public:
{
std::vector<std::unique_ptr<HIR::WhereClauseItem> > where_clause_items;
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (alias.get_visibility ());
std::vector<std::unique_ptr<HIR::GenericParam> > generic_params;
if (alias.has_generics ())
@ -87,7 +87,7 @@ public:
void visit (AST::ConstantItem &constant) override
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (constant.get_visibility ());
HIR::Type *type = ASTLoweringType::translate (constant.get_type ().get ());
HIR::Expr *expr = ASTLoweringExpr::translate (constant.get_expr ().get ());
@ -120,7 +120,7 @@ public:
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::FunctionQualifiers qualifiers
= lower_qualifiers (function.get_qualifiers ());
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (function.get_visibility ());
// need
std::vector<std::unique_ptr<HIR::GenericParam> > generic_params;
@ -204,7 +204,7 @@ public:
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::FunctionQualifiers qualifiers
= lower_qualifiers (method.get_qualifiers ());
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (method.get_visibility ());
// need
std::vector<std::unique_ptr<HIR::GenericParam> > generic_params;

View File

@ -21,6 +21,7 @@
#include "rust-diagnostics.h"
#include "rust-ast-lower.h"
#include "rust-ast-lower-base.h"
#include "rust-ast-lower-enumitem.h"
#include "rust-ast-lower-type.h"
@ -59,7 +60,7 @@ public:
mappings->get_next_localdef_id (crate_num));
// should be lowered from module.get_vis()
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (module.get_visibility ());
auto items = std::vector<std::unique_ptr<Item>> ();
@ -99,7 +100,7 @@ public:
}
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (alias.get_visibility ());
std::vector<std::unique_ptr<HIR::GenericParam>> generic_params;
if (alias.has_generics ())
@ -146,7 +147,7 @@ public:
}
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (struct_decl.get_visibility ());
std::vector<HIR::TupleField> fields;
for (AST::TupleField &field : struct_decl.get_fields ())
@ -154,7 +155,8 @@ public:
if (field.get_field_type ()->is_marked_for_strip ())
continue;
HIR::Visibility vis = HIR::Visibility::create_public ();
// FIXME: How do we get the visibility from here?
HIR::Visibility vis = translate_visibility (field.get_visibility ());
HIR::Type *type
= ASTLoweringType::translate (field.get_field_type ().get ());
@ -209,7 +211,8 @@ public:
}
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (struct_decl.get_visibility ());
bool is_unit = struct_decl.is_unit_struct ();
std::vector<HIR::StructField> fields;
@ -218,7 +221,7 @@ public:
if (field.get_field_type ()->is_marked_for_strip ())
continue;
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (field.get_visibility ());
HIR::Type *type
= ASTLoweringType::translate (field.get_field_type ().get ());
@ -276,7 +279,7 @@ public:
}
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (enum_decl.get_visibility ());
// bool is_unit = enum_decl.is_zero_variant ();
std::vector<std::unique_ptr<HIR::EnumItem>> items;
@ -326,7 +329,7 @@ public:
std::unique_ptr<HIR::WhereClauseItem> (i));
}
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (union_decl.get_visibility ());
std::vector<HIR::StructField> variants;
for (AST::StructField &variant : union_decl.get_variants ())
@ -334,7 +337,8 @@ public:
if (variant.get_field_type ()->is_marked_for_strip ())
continue;
HIR::Visibility vis = HIR::Visibility::create_public ();
// FIXME: Does visibility apply here?
HIR::Visibility vis = translate_visibility (variant.get_visibility ());
HIR::Type *type
= ASTLoweringType::translate (variant.get_field_type ().get ());
@ -375,7 +379,7 @@ public:
void visit (AST::StaticItem &var) override
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (var.get_visibility ());
HIR::Type *type = ASTLoweringType::translate (var.get_type ().get ());
HIR::Expr *expr = ASTLoweringExpr::translate (var.get_expr ().get ());
@ -401,7 +405,7 @@ public:
void visit (AST::ConstantItem &constant) override
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (constant.get_visibility ());
HIR::Type *type = ASTLoweringType::translate (constant.get_type ().get ());
HIR::Expr *expr = ASTLoweringExpr::translate (constant.get_expr ().get ());
@ -441,7 +445,7 @@ public:
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::FunctionQualifiers qualifiers
= lower_qualifiers (function.get_qualifiers ());
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (function.get_visibility ());
// need
std::vector<std::unique_ptr<HIR::GenericParam>> generic_params;
@ -530,7 +534,7 @@ public:
}
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (impl_block.get_visibility ());
std::vector<std::unique_ptr<HIR::GenericParam>> generic_params;
if (impl_block.has_generics ())
@ -619,7 +623,7 @@ public:
}
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (trait.get_visibility ());
std::vector<std::unique_ptr<HIR::GenericParam>> generic_params;
if (trait.has_generics ())
@ -692,7 +696,7 @@ public:
std::unique_ptr<HIR::WhereClauseItem> (i));
}
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (impl_block.get_visibility ());
std::vector<std::unique_ptr<HIR::GenericParam>> generic_params;
if (impl_block.has_generics ())
@ -774,7 +778,7 @@ public:
void visit (AST::ExternBlock &extern_block) override
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (extern_block.get_visibility ());
std::vector<std::unique_ptr<HIR::ExternalItem>> extern_items;
for (auto &item : extern_block.get_extern_items ())

View File

@ -85,7 +85,7 @@ public:
void visit (AST::ConstantItem &constant) override
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (constant.get_visibility ());
HIR::Type *type = ASTLoweringType::translate (constant.get_type ().get ());
HIR::Expr *expr = ASTLoweringExpr::translate (constant.get_expr ().get ());
@ -148,12 +148,12 @@ public:
std::vector<std::unique_ptr<HIR::WhereClauseItem>> where_clause_items;
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (struct_decl.get_visibility ());
std::vector<HIR::TupleField> fields;
for (AST::TupleField &field : struct_decl.get_fields ())
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (field.get_visibility ());
HIR::Type *type
= ASTLoweringType::translate (field.get_field_type ().get ());
@ -199,13 +199,13 @@ public:
std::vector<std::unique_ptr<HIR::WhereClauseItem>> where_clause_items;
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (struct_decl.get_visibility ());
bool is_unit = struct_decl.is_unit_struct ();
std::vector<HIR::StructField> fields;
for (AST::StructField &field : struct_decl.get_fields ())
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (field.get_visibility ());
HIR::Type *type
= ASTLoweringType::translate (field.get_field_type ().get ());
@ -255,12 +255,12 @@ public:
std::vector<std::unique_ptr<HIR::WhereClauseItem>> where_clause_items;
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (union_decl.get_visibility ());
std::vector<HIR::StructField> variants;
for (AST::StructField &variant : union_decl.get_variants ())
{
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (variant.get_visibility ());
HIR::Type *type
= ASTLoweringType::translate (variant.get_field_type ().get ());
@ -308,7 +308,7 @@ public:
std::vector<std::unique_ptr<HIR::WhereClauseItem>> where_clause_items;
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (enum_decl.get_visibility ());
// bool is_unit = enum_decl.is_zero_variant ();
std::vector<std::unique_ptr<HIR::EnumItem>> items;
@ -358,7 +358,7 @@ public:
HIR::WhereClause where_clause (std::move (where_clause_items));
HIR::FunctionQualifiers qualifiers
= lower_qualifiers (function.get_qualifiers ());
HIR::Visibility vis = HIR::Visibility::create_public ();
HIR::Visibility vis = translate_visibility (function.get_visibility ());
// need
std::vector<std::unique_ptr<HIR::GenericParam>> generic_params;

View File

@ -26,6 +26,41 @@
namespace Rust {
namespace HIR {
Visibility
translate_visibility (const AST::Visibility &vis)
{
// FIXME: How do we create a private visibility here? Is it always private if
// the AST vis is an error?
// FIXME: We need to add a `create_private()` static function to the
// AST::Visibility class and use it when the vis is empty in the parser...
if (vis.is_error ())
return Visibility::create_error ();
// FIXME: ... And then use this?
// if (vis.is_private ())
// return Visibility::create_private ();
switch (vis.get_public_vis_type ())
{
case AST::Visibility::NONE:
return Visibility (Visibility::VisType::PUBLIC);
case AST::Visibility::SELF:
return Visibility (Visibility::VisType::PRIVATE);
// Desugar pub(crate) into pub(in crate) and so on
case AST::Visibility::CRATE:
return Visibility (Visibility::PUBLIC,
AST::SimplePath::from_str ("crate"));
case AST::Visibility::SUPER:
return Visibility (Visibility::PUBLIC,
AST::SimplePath::from_str ("super"));
case AST::Visibility::IN_PATH:
return Visibility (Visibility::VisType::PUBLIC, vis.get_path ());
break;
}
return Visibility::create_error ();
}
ASTLowering::ASTLowering (AST::Crate &astCrate) : astCrate (astCrate) {}
ASTLowering::~ASTLowering () {}

View File

@ -32,6 +32,14 @@ namespace HIR {
bool
struct_field_name_exists (std::vector<HIR::StructField> &fields,
HIR::StructField &new_field);
/**
* Lowers a Visibility from the AST into an HIR Visibility, desugaring it in
* the process
*/
Visibility
translate_visibility (const AST::Visibility &vis);
class ASTLowering
{
public:

View File

@ -118,18 +118,12 @@ Crate::as_string () const
std::string
Visibility::as_string () const
{
switch (public_vis_type)
switch (vis_type)
{
case NONE:
return std::string ("pub");
case CRATE:
return std::string ("pub(crate)");
case SELF:
return std::string ("pub(self)");
case SUPER:
return std::string ("pub(super)");
case IN_PATH:
return std::string ("pub(in ") + in_path.as_string () + std::string (")");
case PRIVATE:
return std::string ("private");
case PUBLIC:
return std::string ("pub(in ") + path.as_string () + std::string (")");
default:
gcc_unreachable ();
}

View File

@ -553,91 +553,38 @@ public:
struct Visibility
{
public:
enum PublicVisType
enum VisType
{
NONE,
CRATE,
SELF,
SUPER,
IN_PATH
PRIVATE,
PUBLIC,
ERROR,
};
private:
// if vis is public, one of these
PublicVisType public_vis_type;
// Only assigned if public_vis_type is IN_PATH
AST::SimplePath in_path;
VisType vis_type;
AST::SimplePath path;
// should this store location info?
public:
// Creates a Visibility - TODO make constructor protected or private?
Visibility (PublicVisType public_vis_type, AST::SimplePath in_path)
: public_vis_type (public_vis_type), in_path (std::move (in_path))
Visibility (VisType vis_type,
AST::SimplePath path = AST::SimplePath::create_empty ())
: vis_type (vis_type), path (std::move (path))
{}
// Returns whether visibility is in an error state.
bool is_error () const
{
return public_vis_type == IN_PATH && in_path.is_empty ();
}
bool is_error () const { return vis_type == ERROR; }
// Creates an error visibility.
static Visibility create_error ()
{
return Visibility (IN_PATH, AST::SimplePath::create_empty ());
return Visibility (ERROR, AST::SimplePath::create_empty ());
}
// Unique pointer custom clone function
/*std::unique_ptr<Visibility> clone_visibility() const {
return std::unique_ptr<Visibility>(clone_visibility_impl());
}*/
/* TODO: think of a way to only allow valid Visibility states - polymorphism
* is one idea but may be too resource-intensive. */
// Creates a public visibility with no further features/arguments.
static Visibility create_public ()
{
return Visibility (NONE, AST::SimplePath::create_empty ());
}
// Creates a public visibility with crate-relative paths or whatever.
static Visibility create_crate ()
{
return Visibility (CRATE, AST::SimplePath::create_empty ());
}
// Creates a public visibility with self-relative paths or whatever.
static Visibility create_self ()
{
return Visibility (SELF, AST::SimplePath::create_empty ());
}
// Creates a public visibility with parent module-relative paths or
// whatever.
static Visibility create_super ()
{
return Visibility (SUPER, AST::SimplePath::create_empty ());
}
// Creates a public visibility with a given path or whatever.
static Visibility create_in_path (AST::SimplePath in_path)
{
return Visibility (IN_PATH, std::move (in_path));
}
PublicVisType get_vis_type () const { return public_vis_type; }
VisType get_vis_type () const { return vis_type; }
std::string as_string () const;
protected:
// Clone function implementation - not currently virtual but may be if
// polymorphism used
/*virtual*/ Visibility *clone_visibility_impl () const
{
return new Visibility (*this);
}
};
// Item that supports visibility - abstract base class