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_CONST_CHECKER_H
      20              : #define RUST_CONST_CHECKER_H
      21              : 
      22              : #include "rust-hir-visitor.h"
      23              : #include "rust-hir-type-check.h"
      24              : #include "rust-stacked-contexts.h"
      25              : #include "rust-name-resolver.h"
      26              : 
      27              : namespace Rust {
      28              : namespace HIR {
      29         4110 : class ConstChecker : public HIRFullVisitor
      30              : {
      31              : public:
      32              :   ConstChecker ();
      33              : 
      34              :   void go (HIR::Crate &crate);
      35              : 
      36              :   /**
      37              :    * Check if an item is a const extern item or not
      38              :    * TODO: Move this to a const compilation context class or an attribute
      39              :    * checking class
      40              :    */
      41              :   static bool is_const_extern_fn (HIR::ExternalFunctionItem &fn);
      42              : 
      43              : private:
      44              :   /**
      45              :    * Check that only const functions are called in const contexts
      46              :    */
      47              :   void check_function_call (HirId fn_id, location_t locus);
      48              : 
      49              :   /* All possible const contexts */
      50              :   enum class ConstGenericCtx
      51              :   {
      52              :     Function,
      53              :     TypeAlias,
      54              :     Struct,
      55              :     Enum,
      56              :     Union,
      57              :     Trait,
      58              :     Impl
      59              :   };
      60              : 
      61              :   /* Get the string representation of a const context */
      62              :   const char *ctx_to_str (ConstGenericCtx ctx);
      63              : 
      64              :   /* Check if a const context allows default values */
      65              :   bool ctx_allows_default (ConstGenericCtx ctx);
      66              : 
      67              :   /**
      68              :    * Check that const generic parameters only contains defaults in allowed
      69              :    * contexts
      70              :    */
      71              :   void check_default_const_generics (
      72              :     std::vector<std::unique_ptr<GenericParam>> &param, ConstGenericCtx context);
      73              : 
      74              :   StackedContexts<HirId> const_context;
      75              :   Resolver::Resolver &resolver;
      76              :   Analysis::Mappings &mappings;
      77              : 
      78              :   virtual void visit (Lifetime &lifetime) override;
      79              :   virtual void visit (LifetimeParam &lifetime_param) override;
      80              :   virtual void visit (PathInExpression &path) override;
      81              :   virtual void visit (TypePathSegment &segment) override;
      82              :   virtual void visit (TypePathSegmentGeneric &segment) override;
      83              :   virtual void visit (TypePathSegmentFunction &segment) override;
      84              :   virtual void visit (TypePath &path) override;
      85              :   virtual void visit (QualifiedPathInExpression &path) override;
      86              :   virtual void visit (QualifiedPathInType &path) override;
      87              :   virtual void visit (LiteralExpr &expr) override;
      88              :   virtual void visit (BorrowExpr &expr) override;
      89              :   virtual void visit (DereferenceExpr &expr) override;
      90              :   virtual void visit (ErrorPropagationExpr &expr) override;
      91              :   virtual void visit (NegationExpr &expr) override;
      92              :   virtual void visit (ArithmeticOrLogicalExpr &expr) override;
      93              :   virtual void visit (ComparisonExpr &expr) override;
      94              :   virtual void visit (LazyBooleanExpr &expr) override;
      95              :   virtual void visit (TypeCastExpr &expr) override;
      96              :   virtual void visit (AssignmentExpr &expr) override;
      97              :   virtual void visit (CompoundAssignmentExpr &expr) override;
      98              :   virtual void visit (GroupedExpr &expr) override;
      99              :   virtual void visit (ArrayElemsValues &elems) override;
     100              :   virtual void visit (ArrayElemsCopied &elems) override;
     101              :   virtual void visit (ArrayExpr &expr) override;
     102              :   virtual void visit (ArrayIndexExpr &expr) override;
     103              :   virtual void visit (TupleExpr &expr) override;
     104              :   virtual void visit (TupleIndexExpr &expr) override;
     105              :   virtual void visit (StructExprStruct &expr) override;
     106              :   virtual void visit (StructExprFieldIdentifier &field) override;
     107              :   virtual void visit (StructExprFieldIdentifierValue &field) override;
     108              :   virtual void visit (StructExprFieldIndexValue &field) override;
     109              :   virtual void visit (StructExprStructFields &expr) override;
     110              :   virtual void visit (StructExprStructBase &expr) override;
     111              :   virtual void visit (CallExpr &expr) override;
     112              :   virtual void visit (MethodCallExpr &expr) override;
     113              :   virtual void visit (FieldAccessExpr &expr) override;
     114              :   virtual void visit (ClosureExpr &expr) override;
     115              :   virtual void visit (BlockExpr &expr) override;
     116              :   virtual void visit (AnonConst &expr) override;
     117              :   virtual void visit (ConstBlock &expr) override;
     118              :   virtual void visit (ContinueExpr &expr) override;
     119              :   virtual void visit (BreakExpr &expr) override;
     120              :   virtual void visit (RangeFromToExpr &expr) override;
     121              :   virtual void visit (RangeFromExpr &expr) override;
     122              :   virtual void visit (RangeToExpr &expr) override;
     123              :   virtual void visit (RangeFullExpr &expr) override;
     124              :   virtual void visit (RangeFromToInclExpr &expr) override;
     125              :   virtual void visit (RangeToInclExpr &expr) override;
     126              :   virtual void visit (ReturnExpr &expr) override;
     127              :   virtual void visit (UnsafeBlockExpr &expr) override;
     128              :   virtual void visit (LoopExpr &expr) override;
     129              :   virtual void visit (WhileLoopExpr &expr) override;
     130              :   virtual void visit (WhileLetLoopExpr &expr) override;
     131              :   virtual void visit (IfExpr &expr) override;
     132              :   virtual void visit (IfExprConseqElse &expr) override;
     133              :   virtual void visit (MatchExpr &expr) override;
     134              :   virtual void visit (AwaitExpr &expr) override;
     135              :   virtual void visit (AsyncBlockExpr &expr) override;
     136              :   virtual void visit (InlineAsm &expr) override;
     137              :   virtual void visit (LlvmInlineAsm &expr) override;
     138              :   virtual void visit (OffsetOf &expr) override;
     139              : 
     140              :   virtual void visit (TypeParam &param) override;
     141              :   virtual void visit (ConstGenericParam &param) override;
     142              :   virtual void visit (LifetimeWhereClauseItem &item) override;
     143              :   virtual void visit (TypeBoundWhereClauseItem &item) override;
     144              :   virtual void visit (Module &module) override;
     145              :   virtual void visit (ExternCrate &crate) override;
     146              :   virtual void visit (UseTreeGlob &use_tree) override;
     147              :   virtual void visit (UseTreeList &use_tree) override;
     148              :   virtual void visit (UseTreeRebind &use_tree) override;
     149              :   virtual void visit (UseDeclaration &use_decl) override;
     150              :   virtual void visit (Function &function) override;
     151              :   virtual void visit (TypeAlias &type_alias) override;
     152              :   virtual void visit (StructStruct &struct_item) override;
     153              :   virtual void visit (TupleStruct &tuple_struct) override;
     154              :   virtual void visit (EnumItem &item) override;
     155              :   virtual void visit (EnumItemTuple &item) override;
     156              :   virtual void visit (EnumItemStruct &item) override;
     157              :   virtual void visit (EnumItemDiscriminant &item) override;
     158              :   virtual void visit (Enum &enum_item) override;
     159              :   virtual void visit (Union &union_item) override;
     160              :   virtual void visit (ConstantItem &const_item) override;
     161              :   virtual void visit (StaticItem &static_item) override;
     162              :   virtual void visit (TraitItemFunc &item) override;
     163              :   virtual void visit (TraitItemConst &item) override;
     164              :   virtual void visit (TraitItemType &item) override;
     165              :   virtual void visit (Trait &trait) override;
     166              :   virtual void visit (ImplBlock &impl) override;
     167              :   virtual void visit (ExternalStaticItem &item) override;
     168              :   virtual void visit (ExternalFunctionItem &item) override;
     169              :   virtual void visit (ExternalTypeItem &item) override;
     170              :   virtual void visit (ExternBlock &block) override;
     171              :   virtual void visit (LiteralPattern &pattern) override;
     172              :   virtual void visit (IdentifierPattern &pattern) override;
     173              :   virtual void visit (WildcardPattern &pattern) override;
     174              :   virtual void visit (RangePatternBoundLiteral &bound) override;
     175              :   virtual void visit (RangePatternBoundPath &bound) override;
     176              :   virtual void visit (RangePatternBoundQualPath &bound) override;
     177              :   virtual void visit (RangePattern &pattern) override;
     178              :   virtual void visit (ReferencePattern &pattern) override;
     179              :   virtual void visit (StructPatternFieldTuplePat &field) override;
     180              :   virtual void visit (StructPatternFieldIdentPat &field) override;
     181              :   virtual void visit (StructPatternFieldIdent &field) override;
     182              :   virtual void visit (StructPattern &pattern) override;
     183              :   virtual void visit (TupleStructItemsNoRest &tuple_items) override;
     184              :   virtual void visit (TupleStructItemsHasRest &tuple_items) override;
     185              :   virtual void visit (TupleStructPattern &pattern) override;
     186              :   virtual void visit (TuplePatternItemsNoRest &tuple_items) override;
     187              :   virtual void visit (TuplePatternItemsHasRest &tuple_items) override;
     188              :   virtual void visit (TuplePattern &pattern) override;
     189              :   virtual void visit (SlicePatternItemsNoRest &items) override;
     190              :   virtual void visit (SlicePatternItemsHasRest &items) override;
     191              :   virtual void visit (SlicePattern &pattern) override;
     192              :   virtual void visit (AltPattern &pattern) override;
     193              :   virtual void visit (EmptyStmt &stmt) override;
     194              :   virtual void visit (LetStmt &stmt) override;
     195              :   virtual void visit (ExprStmt &stmt) override;
     196              :   virtual void visit (TraitBound &bound) override;
     197              :   virtual void visit (ImplTraitType &type) override;
     198              :   virtual void visit (TraitObjectType &type) override;
     199              :   virtual void visit (ParenthesisedType &type) override;
     200              :   virtual void visit (TupleType &type) override;
     201              :   virtual void visit (NeverType &type) override;
     202              :   virtual void visit (RawPointerType &type) override;
     203              :   virtual void visit (ReferenceType &type) override;
     204              :   virtual void visit (ArrayType &type) override;
     205              :   virtual void visit (SliceType &type) override;
     206              :   virtual void visit (InferredType &type) override;
     207              :   virtual void visit (BareFunctionType &type) override;
     208              : };
     209              : 
     210              : } // namespace HIR
     211              : } // namespace Rust
     212              : 
     213              : #endif /* !RUST_CONST_CHECKER_H */