Line data    Source code

       1              : // Copyright (C) 2020-2026 Free Software Foundation, Inc.
       2              : 
       3              : // This file is part of GCC.
       4              : 
       5              : // GCC is free software; you can redistribute it and/or modify it under
       6              : // the terms of the GNU General Public License as published by the Free
       7              : // Software Foundation; either version 3, or (at your option) any later
       8              : // version.
       9              : 
      10              : // GCC is distributed in the hope that it will be useful, but WITHOUT ANY
      11              : // WARRANTY; without even the implied warranty of MERCHANTABILITY or
      12              : // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
      13              : // for more details.
      14              : 
      15              : // You should have received a copy of the GNU General Public License
      16              : // along with GCC; see the file COPYING3.  If not see
      17              : // <http://www.gnu.org/licenses/>.
      18              : 
      19              : #ifndef RUST_AST_LOWER_BASE
      20              : #define RUST_AST_LOWER_BASE
      21              : 
      22              : #include "rust-ast.h"
      23              : #include "rust-builtin-ast-nodes.h"
      24              : #include "rust-expr.h"
      25              : #include "rust-system.h"
      26              : #include "rust-ast-full.h"
      27              : #include "rust-ast-visitor.h"
      28              : #include "rust-hir-map.h"
      29              : #include "rust-hir-full.h"
      30              : #include "rust-attributes.h"
      31              : 
      32              : namespace Rust {
      33              : namespace HIR {
      34              : 
      35              : // proxy class so we can do attribute checking on items and trait items
      36              : class ItemWrapper
      37              : {
      38              : public:
      39        30039 :   ItemWrapper (const HIR::Item &item)
      40        30039 :     : mappings (item.get_mappings ()), locus (item.get_locus ()),
      41        30039 :       outer_attrs (item.get_outer_attrs ())
      42              :   {}
      43              : 
      44         3321 :   ItemWrapper (const HIR::TraitItem &item)
      45         3321 :     : mappings (item.get_mappings ()), locus (item.get_trait_locus ()),
      46         3321 :       outer_attrs (item.get_outer_attrs ())
      47         3321 :   {}
      48              : 
      49         3191 :   const Analysis::NodeMapping &get_mappings () const { return mappings; }
      50              :   location_t get_locus () const { return locus; }
      51        33360 :   const AST::AttrVec &get_outer_attrs () const { return outer_attrs; }
      52              : 
      53              : private:
      54              :   const Analysis::NodeMapping &mappings;
      55              :   location_t locus;
      56              :   const AST::AttrVec &outer_attrs;
      57              : };
      58              : 
      59              : // base class to allow derivatives to overload as needed
      60              : class ASTLoweringBase : public AST::ASTVisitor
      61              : {
      62              : public:
      63       312146 :   virtual ~ASTLoweringBase () {}
      64              : 
      65              :   // Special casing nodes that should never reach the HIR lowering stage
      66              :   virtual void visit (AST::MacroInvocation &) override final;
      67              :   virtual void visit (AST::ErrorPropagationExpr &) override final;
      68              :   virtual void visit (AST::ForLoopExpr &) override final;
      69              :   virtual void visit (AST::TryExpr &) override final;
      70              :   virtual void visit (AST::WhileLetLoopExpr &) override final;
      71              : 
      72              :   // visitor impl
      73              :   // rust-ast.h
      74              :   //  virtual void visit(AttrInput& attr_input);
      75              :   //  virtual void visit(TokenTree& token_tree);
      76              :   //  virtual void visit(MacroMatch& macro_match);
      77              :   virtual void visit (AST::Token &tok) override;
      78              :   virtual void visit (AST::DelimTokenTree &delim_tok_tree) override;
      79              :   virtual void visit (AST::AttrInputMetaItemContainer &input) override;
      80              :   //  virtual void visit(MetaItem& meta_item) override;
      81              :   //  void vsit(Stmt& stmt) override;
      82              :   //  virtual void visit(Expr& expr) override;
      83              :   virtual void visit (AST::IdentifierExpr &ident_expr) override;
      84              :   //  virtual void visit(Pattern& pattern) override;
      85              :   //  virtual void visit(Type& type) override;
      86              :   //  virtual void visit(TypeParamBound& type_param_bound) override;
      87              :   virtual void visit (AST::Lifetime &lifetime) override;
      88              :   //  virtual void visit(GenericParam& generic_param) override;
      89              :   virtual void visit (AST::LifetimeParam &lifetime_param) override;
      90              :   virtual void visit (AST::ConstGenericParam &const_param) override;
      91              :   //  virtual void visit(TraitItem& trait_item) override;
      92              :   //  virtual void visit(InherentImplItem& inherent_impl_item) override;
      93              :   //  virtual void visit(TraitImplItem& trait_impl_item) override;
      94              : 
      95              :   // rust-path.h
      96              :   virtual void visit (AST::PathInExpression &path) override;
      97              :   virtual void visit (AST::TypePathSegment &segment) override;
      98              :   virtual void visit (AST::TypePathSegmentGeneric &segment) override;
      99              :   virtual void visit (AST::TypePathSegmentFunction &segment) override;
     100              :   virtual void visit (AST::TypePath &path) override;
     101              :   virtual void visit (AST::QualifiedPathInExpression &path) override;
     102              :   virtual void visit (AST::QualifiedPathInType &path) override;
     103              : 
     104              :   // rust-expr.h
     105              :   virtual void visit (AST::LiteralExpr &expr) override;
     106              :   virtual void visit (AST::AttrInputLiteral &attr_input) override;
     107              :   virtual void visit (AST::AttrInputMacro &attr_input) override;
     108              :   virtual void visit (AST::MetaItemLitExpr &meta_item) override;
     109              :   virtual void visit (AST::MetaItemPathExpr &meta_item) override;
     110              :   virtual void visit (AST::BorrowExpr &expr) override;
     111              :   virtual void visit (AST::DereferenceExpr &expr) override;
     112              :   virtual void visit (AST::NegationExpr &expr) override;
     113              :   virtual void visit (AST::ArithmeticOrLogicalExpr &expr) override;
     114              :   virtual void visit (AST::ComparisonExpr &expr) override;
     115              :   virtual void visit (AST::LazyBooleanExpr &expr) override;
     116              :   virtual void visit (AST::TypeCastExpr &expr) override;
     117              :   virtual void visit (AST::AssignmentExpr &expr) override;
     118              :   virtual void visit (AST::CompoundAssignmentExpr &expr) override;
     119              :   virtual void visit (AST::GroupedExpr &expr) override;
     120              :   //  virtual void visit(ArrayElems& elems) override;
     121              :   virtual void visit (AST::ArrayElemsValues &elems) override;
     122              :   virtual void visit (AST::ArrayElemsCopied &elems) override;
     123              :   virtual void visit (AST::ArrayExpr &expr) override;
     124              :   virtual void visit (AST::ArrayIndexExpr &expr) override;
     125              :   virtual void visit (AST::TupleExpr &expr) override;
     126              :   virtual void visit (AST::TupleIndexExpr &expr) override;
     127              :   virtual void visit (AST::StructExprStruct &expr) override;
     128              :   //  virtual void visit(StructExprField& field) override;
     129              :   virtual void visit (AST::StructExprFieldIdentifier &field) override;
     130              :   virtual void visit (AST::StructExprFieldIdentifierValue &field) override;
     131              :   virtual void visit (AST::StructExprFieldIndexValue &field) override;
     132              :   virtual void visit (AST::StructExprStructFields &expr) override;
     133              :   virtual void visit (AST::StructExprStructBase &expr) override;
     134              :   virtual void visit (AST::CallExpr &expr) override;
     135              :   virtual void visit (AST::MethodCallExpr &expr) override;
     136              :   virtual void visit (AST::FieldAccessExpr &expr) override;
     137              :   virtual void visit (AST::ClosureExprInner &expr) override;
     138              :   virtual void visit (AST::BlockExpr &expr) override;
     139              :   virtual void visit (AST::AnonConst &expr) override;
     140              :   virtual void visit (AST::ConstBlock &expr) override;
     141              :   virtual void visit (AST::ClosureExprInnerTyped &expr) override;
     142              :   virtual void visit (AST::ContinueExpr &expr) override;
     143              :   virtual void visit (AST::BreakExpr &expr) override;
     144              :   virtual void visit (AST::RangeFromToExpr &expr) override;
     145              :   virtual void visit (AST::RangeFromExpr &expr) override;
     146              :   virtual void visit (AST::RangeToExpr &expr) override;
     147              :   virtual void visit (AST::RangeFullExpr &expr) override;
     148              :   virtual void visit (AST::RangeFromToInclExpr &expr) override;
     149              :   virtual void visit (AST::RangeToInclExpr &expr) override;
     150              :   virtual void visit (AST::BoxExpr &expr) override;
     151              :   virtual void visit (AST::ReturnExpr &expr) override;
     152              :   virtual void visit (AST::UnsafeBlockExpr &expr) override;
     153              :   virtual void visit (AST::LoopExpr &expr) override;
     154              :   virtual void visit (AST::WhileLoopExpr &expr) override;
     155              :   virtual void visit (AST::IfExpr &expr) override;
     156              :   virtual void visit (AST::IfExprConseqElse &expr) override;
     157              :   virtual void visit (AST::IfLetExpr &expr) override;
     158              :   virtual void visit (AST::IfLetExprConseqElse &expr) override;
     159              :   virtual void visit (AST::InlineAsm &expr) override;
     160              :   virtual void visit (AST::LlvmInlineAsm &expr) override;
     161              :   //  virtual void visit(MatchCase& match_case) override;
     162              :   // virtual void visit (AST::MatchCaseBlockExpr &match_case) override;
     163              :   // virtual void visit (AST::MatchCaseExpr &match_case) override;
     164              :   virtual void visit (AST::MatchExpr &expr) override;
     165              :   virtual void visit (AST::AwaitExpr &expr) override;
     166              :   virtual void visit (AST::AsyncBlockExpr &expr) override;
     167              : 
     168              :   // rust-item.h
     169              :   virtual void visit (AST::TypeParam &param) override;
     170              :   //  virtual void visit(WhereClauseItem& item) override;
     171              :   virtual void visit (AST::LifetimeWhereClauseItem &item) override;
     172              :   virtual void visit (AST::TypeBoundWhereClauseItem &item) override;
     173              :   virtual void visit (AST::Module &module) override;
     174              :   virtual void visit (AST::ExternCrate &crate) override;
     175              :   //  virtual void visit(UseTree& use_tree) override;
     176              :   virtual void visit (AST::UseTreeGlob &use_tree) override;
     177              :   virtual void visit (AST::UseTreeList &use_tree) override;
     178              :   virtual void visit (AST::UseTreeRebind &use_tree) override;
     179              :   virtual void visit (AST::UseDeclaration &use_decl) override;
     180              :   virtual void visit (AST::Function &function) override;
     181              :   virtual void visit (AST::TypeAlias &type_alias) override;
     182              :   virtual void visit (AST::StructStruct &struct_item) override;
     183              :   virtual void visit (AST::TupleStruct &tuple_struct) override;
     184              :   virtual void visit (AST::EnumItem &item) override;
     185              :   virtual void visit (AST::EnumItemTuple &item) override;
     186              :   virtual void visit (AST::EnumItemStruct &item) override;
     187              :   virtual void visit (AST::EnumItemDiscriminant &item) override;
     188              :   virtual void visit (AST::Enum &enum_item) override;
     189              :   virtual void visit (AST::Union &union_item) override;
     190              :   virtual void visit (AST::ConstantItem &const_item) override;
     191              :   virtual void visit (AST::StaticItem &static_item) override;
     192              :   virtual void visit (AST::TraitItemType &item) override;
     193              :   virtual void visit (AST::Trait &trait) override;
     194              :   virtual void visit (AST::InherentImpl &impl) override;
     195              :   virtual void visit (AST::TraitImpl &impl) override;
     196              :   //  virtual void visit(ExternalItem& item) override;
     197              :   virtual void visit (AST::ExternalTypeItem &item) override;
     198              :   virtual void visit (AST::ExternalStaticItem &item) override;
     199              :   virtual void visit (AST::ExternBlock &block) override;
     200              : 
     201              :   // rust-macro.h
     202              :   virtual void visit (AST::MacroMatchFragment &match) override;
     203              :   virtual void visit (AST::MacroMatchRepetition &match) override;
     204              :   virtual void visit (AST::MacroMatcher &matcher) override;
     205              :   virtual void visit (AST::MacroRulesDefinition &rules_def) override;
     206              :   virtual void visit (AST::MetaItemPath &meta_item) override;
     207              :   virtual void visit (AST::MetaItemSeq &meta_item) override;
     208              :   virtual void visit (AST::MetaWord &meta_item) override;
     209              :   virtual void visit (AST::MetaNameValueStr &meta_item) override;
     210              :   virtual void visit (AST::MetaListPaths &meta_item) override;
     211              :   virtual void visit (AST::MetaListNameValueStr &meta_item) override;
     212              : 
     213              :   // rust-pattern.h
     214              :   virtual void visit (AST::LiteralPattern &pattern) override;
     215              :   virtual void visit (AST::IdentifierPattern &pattern) override;
     216              :   virtual void visit (AST::WildcardPattern &pattern) override;
     217              :   virtual void visit (AST::RestPattern &pattern) override;
     218              :   //  virtual void visit(RangePatternBound& bound) override;
     219              :   virtual void visit (AST::RangePatternBoundLiteral &bound) override;
     220              :   virtual void visit (AST::RangePatternBoundPath &bound) override;
     221              :   virtual void visit (AST::RangePatternBoundQualPath &bound) override;
     222              :   virtual void visit (AST::RangePattern &pattern) override;
     223              :   virtual void visit (AST::ReferencePattern &pattern) override;
     224              :   //  virtual void visit(StructPatternField& field) override;
     225              :   virtual void visit (AST::StructPatternFieldTuplePat &field) override;
     226              :   virtual void visit (AST::StructPatternFieldIdentPat &field) override;
     227              :   virtual void visit (AST::StructPatternFieldIdent &field) override;
     228              :   virtual void visit (AST::StructPattern &pattern) override;
     229              :   //  virtual void visit(TupleStructItems& tuple_items) override;
     230              :   virtual void visit (AST::TupleStructItemsNoRest &tuple_items) override;
     231              :   virtual void visit (AST::TupleStructItemsHasRest &tuple_items) override;
     232              :   virtual void visit (AST::TupleStructPattern &pattern) override;
     233              :   //  virtual void visit(TuplePatternItems& tuple_items) override;
     234              :   virtual void visit (AST::TuplePatternItemsNoRest &tuple_items) override;
     235              :   virtual void visit (AST::TuplePatternItemsHasRest &tuple_items) override;
     236              :   virtual void visit (AST::TuplePattern &pattern) override;
     237              :   virtual void visit (AST::GroupedPattern &pattern) override;
     238              :   virtual void visit (AST::SlicePatternItemsNoRest &items) override;
     239              :   virtual void visit (AST::SlicePatternItemsHasRest &items) override;
     240              :   virtual void visit (AST::SlicePattern &pattern) override;
     241              :   virtual void visit (AST::AltPattern &pattern) override;
     242              : 
     243              :   // rust-stmt.h
     244              :   virtual void visit (AST::EmptyStmt &stmt) override;
     245              :   virtual void visit (AST::LetStmt &stmt) override;
     246              :   virtual void visit (AST::ExprStmt &stmt) override;
     247              : 
     248              :   // rust-type.h
     249              :   virtual void visit (AST::TraitBound &bound) override;
     250              :   virtual void visit (AST::ImplTraitType &type) override;
     251              :   virtual void visit (AST::TraitObjectType &type) override;
     252              :   virtual void visit (AST::ParenthesisedType &type) override;
     253              :   virtual void visit (AST::ImplTraitTypeOneBound &type) override;
     254              :   virtual void visit (AST::TraitObjectTypeOneBound &type) override;
     255              :   virtual void visit (AST::TupleType &type) override;
     256              :   virtual void visit (AST::NeverType &type) override;
     257              :   virtual void visit (AST::RawPointerType &type) override;
     258              :   virtual void visit (AST::ReferenceType &type) override;
     259              :   virtual void visit (AST::ArrayType &type) override;
     260              :   virtual void visit (AST::SliceType &type) override;
     261              :   virtual void visit (AST::InferredType &type) override;
     262              :   virtual void visit (AST::BareFunctionType &type) override;
     263              :   virtual void visit (AST::FunctionParam &param) override;
     264              :   virtual void visit (AST::VariadicParam &param) override;
     265              :   virtual void visit (AST::SelfParam &param) override;
     266              : 
     267              :   virtual void visit (AST::FormatArgs &fmt) override;
     268              :   virtual void visit (AST::OffsetOf &offset_of) override;
     269              : 
     270              : protected:
     271       383629 :   ASTLoweringBase ()
     272       767258 :     : mappings (Analysis::Mappings::get ()),
     273       383629 :       attr_mappings (Analysis::BuiltinAttributeMappings::get ())
     274       383629 :   {}
     275              : 
     276              :   Analysis::Mappings &mappings;
     277              :   Analysis::BuiltinAttributeMappings *attr_mappings;
     278              : 
     279              :   HIR::Lifetime lower_lifetime (AST::Lifetime &lifetime,
     280              :                                 bool default_to_static_lifetime = false);
     281              : 
     282              :   HIR::LoopLabel lower_loop_label (AST::LoopLabel &loop_label);
     283              : 
     284              :   std::vector<std::unique_ptr<HIR::GenericParam> > lower_generic_params (
     285              :     std::vector<std::unique_ptr<AST::GenericParam> > &params);
     286              : 
     287              :   HIR::PathExprSegment lower_path_expr_seg (AST::PathExprSegment &s);
     288              : 
     289              :   HIR::GenericArgs lower_generic_args (AST::GenericArgs &args);
     290              : 
     291              :   HIR::GenericArgsBinding lower_binding (AST::GenericArgsBinding &binding);
     292              : 
     293              :   HIR::SelfParam lower_self (AST::Param &self);
     294              : 
     295              :   HIR::Type *lower_type_no_bounds (AST::TypeNoBounds &type);
     296              : 
     297              :   HIR::TypeParamBound *lower_bound (AST::TypeParamBound &bound);
     298              : 
     299              :   HIR::QualifiedPathType
     300              :   lower_qual_path_type (AST::QualifiedPathType &qual_path_type);
     301              : 
     302              :   HIR::FunctionQualifiers
     303              :   lower_qualifiers (const AST::FunctionQualifiers &qualifiers);
     304              : 
     305              :   void handle_outer_attributes (const ItemWrapper &item);
     306              : 
     307              :   void handle_lang_item_attribute (const ItemWrapper &item,
     308              :                                    const AST::Attribute &attr);
     309              : 
     310              :   void handle_doc_item_attribute (const ItemWrapper &item,
     311              :                                   const AST::Attribute &attr);
     312              : 
     313              :   bool is_known_attribute (const std::string &attribute_path) const;
     314              : 
     315              :   bool
     316              :   attribute_handled_in_another_pass (const std::string &attribute_path) const;
     317              : 
     318              :   std::unique_ptr<TuplePatternItems>
     319              :   lower_tuple_pattern_multiple (AST::TuplePatternItemsNoRest &pattern);
     320              : 
     321              :   std::unique_ptr<TuplePatternItems>
     322              :   lower_tuple_pattern_ranged (AST::TuplePatternItemsHasRest &pattern);
     323              : 
     324              :   std::unique_ptr<SlicePatternItems>
     325              :   lower_slice_pattern_no_rest (AST::SlicePatternItemsNoRest &pattern);
     326              : 
     327              :   std::unique_ptr<SlicePatternItems>
     328              :   lower_slice_pattern_has_rest (AST::SlicePatternItemsHasRest &pattern);
     329              : 
     330              :   std::unique_ptr<HIR::RangePatternBound>
     331              :   lower_range_pattern_bound (AST::RangePatternBound &bound);
     332              : 
     333              :   HIR::Literal lower_literal (const AST::Literal &literal);
     334              : 
     335              :   HIR::ExternBlock *lower_extern_block (AST::ExternBlock &extern_block);
     336              : 
     337              :   HIR::ClosureParam lower_closure_param (AST::ClosureParam &param);
     338              : 
     339              :   /* Lower a macro definition if it should be exported */
     340              :   void lower_macro_definition (AST::MacroRulesDefinition &def);
     341              : };
     342              : 
     343              : } // namespace HIR
     344              : } // namespace Rust
     345              : 
     346              : #endif // RUST_AST_LOWER_BASE