Branch data     Line data    Source code

       1                 :             : // Copyright (C) 2025 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                 :             : #include "rust-derive-debug.h"
      20                 :             : #include "rust-ast.h"
      21                 :             : #include "rust-hir-map.h"
      22                 :             : #include "rust-system.h"
      23                 :             : 
      24                 :             : namespace Rust {
      25                 :             : namespace AST {
      26                 :             : 
      27                 :           6 : DeriveDebug::DeriveDebug (location_t loc)
      28                 :           6 :   : DeriveVisitor (loc), expanded (nullptr)
      29                 :           6 : {}
      30                 :             : 
      31                 :             : std::unique_ptr<Item>
      32                 :           6 : DeriveDebug::go (Item &item)
      33                 :             : {
      34                 :           6 :   item.accept_vis (*this);
      35                 :             : 
      36                 :           6 :   rust_assert (expanded);
      37                 :             : 
      38                 :           6 :   return std::move (expanded);
      39                 :             : }
      40                 :             : 
      41                 :             : std::unique_ptr<AssociatedItem>
      42                 :           6 : DeriveDebug::stub_debug_fn ()
      43                 :             : {
      44                 :           6 :   auto unit_expr = builder.tuple ();
      45                 :           6 :   auto ok_expr
      46                 :           6 :     = ptrify (builder.path_in_expression (LangItem::Kind::RESULT_OK));
      47                 :             : 
      48                 :          12 :   auto stub_return = builder.call (std::move (ok_expr), std::move (unit_expr));
      49                 :             : 
      50                 :             :   // we can't use builder.block() here as it returns a unique_ptr<Expr> and
      51                 :             :   // Function's constructor expects a unique_ptr<BlockExpr>
      52                 :           6 :   auto block = std::unique_ptr<BlockExpr> (
      53                 :           6 :     new BlockExpr ({}, std::move (stub_return), {}, {}, tl::nullopt, loc, loc));
      54                 :             : 
      55                 :           6 :   auto self = builder.self_ref_param ();
      56                 :             : 
      57                 :           6 :   auto return_type
      58                 :           6 :     = ptrify (builder.type_path ({"core", "fmt", "Result"}, true));
      59                 :             : 
      60                 :           6 :   auto mut_fmt_type_inner
      61                 :           6 :     = ptrify (builder.type_path ({"core", "fmt", "Formatter"}, true));
      62                 :             : 
      63                 :           6 :   auto mut_fmt_type
      64                 :           6 :     = builder.reference_type (std::move (mut_fmt_type_inner), true);
      65                 :             : 
      66                 :          12 :   auto fmt = builder.function_param (builder.identifier_pattern ("_fmt"),
      67                 :           6 :                                      std::move (mut_fmt_type));
      68                 :             : 
      69                 :           6 :   auto params = vec (std::move (self), std::move (fmt));
      70                 :             : 
      71                 :          18 :   auto function = builder.function ("fmt", std::move (params),
      72                 :          12 :                                     std::move (return_type), std::move (block));
      73                 :             : 
      74                 :           6 :   return function;
      75                 :           6 : }
      76                 :             : 
      77                 :             : std::unique_ptr<Item>
      78                 :           6 : DeriveDebug::stub_derive_impl (
      79                 :             :   std::string name,
      80                 :             :   const std::vector<std::unique_ptr<GenericParam>> &type_generics)
      81                 :             : {
      82                 :           6 :   auto trait_items = vec (stub_debug_fn ());
      83                 :             : 
      84                 :           6 :   auto debug = builder.type_path ({"core", "fmt", "Debug"}, true);
      85                 :           6 :   auto generics
      86                 :          12 :     = setup_impl_generics (name, type_generics, builder.trait_bound (debug));
      87                 :             : 
      88                 :          12 :   return builder.trait_impl (debug, std::move (generics.self_type),
      89                 :             :                              std::move (trait_items),
      90                 :           6 :                              std::move (generics.impl));
      91                 :           6 : }
      92                 :             : 
      93                 :             : void
      94                 :           2 : DeriveDebug::visit_struct (StructStruct &struct_item)
      95                 :             : {
      96                 :           6 :   expanded = stub_derive_impl (struct_item.get_identifier ().as_string (),
      97                 :           4 :                                struct_item.get_generic_params ());
      98                 :           2 : }
      99                 :             : 
     100                 :             : void
     101                 :           2 : DeriveDebug::visit_tuple (TupleStruct &tuple_item)
     102                 :             : {
     103                 :           6 :   expanded = stub_derive_impl (tuple_item.get_identifier ().as_string (),
     104                 :           4 :                                tuple_item.get_generic_params ());
     105                 :           2 : }
     106                 :             : 
     107                 :             : void
     108                 :           2 : DeriveDebug::visit_enum (Enum &enum_item)
     109                 :             : {
     110                 :           6 :   expanded = stub_derive_impl (enum_item.get_identifier ().as_string (),
     111                 :           4 :                                enum_item.get_generic_params ());
     112                 :           2 : }
     113                 :             : 
     114                 :             : void
     115                 :           0 : DeriveDebug::visit_union (Union &enum_item)
     116                 :             : {
     117                 :           0 :   rust_error_at (loc, "derive(Debug) cannot be derived for unions");
     118                 :           0 : }
     119                 :             : 
     120                 :             : } // namespace AST
     121                 :             : } // namespace Rust