From 8b0ed2387a52201cd58a7f57e53ac20f5bbe6ddb Mon Sep 17 00:00:00 2001
From: Arthur Cohen <arthur.cohen@embecosm.com>
Date: Wed, 15 Feb 2023 10:52:28 +0100
Subject: [PATCH] gccrs: builtins: Return empty list of tokens instead of
 nullptr

gcc/rust/ChangeLog:

	* expand/rust-macro-builtins.cc (MacroBuiltin::include_handler): Do not
	return nullptr token in expansion of `include!()`

gcc/testsuite/ChangeLog:

	* rust/compile/empty.in: New test.
	* rust/compile/include_empty.rs: New test.
---
 gcc/rust/expand/rust-macro-builtins.cc      | 15 +++++++++++++--
 gcc/testsuite/rust/compile/empty.in         |  1 +
 gcc/testsuite/rust/compile/include_empty.rs |  8 ++++++++
 3 files changed, 22 insertions(+), 2 deletions(-)
 create mode 100644 gcc/testsuite/rust/compile/empty.in
 create mode 100644 gcc/testsuite/rust/compile/include_empty.rs

diff --git a/gcc/rust/expand/rust-macro-builtins.cc b/gcc/rust/expand/rust-macro-builtins.cc
index 3b6f69b..9759492 100644
--- a/gcc/rust/expand/rust-macro-builtins.cc
+++ b/gcc/rust/expand/rust-macro-builtins.cc
@@ -752,8 +752,19 @@ MacroBuiltin::include_handler (Location invoc_locus, AST::MacroInvocData &invoc)
       nodes.push_back (node);
     }
 
-  // FIXME: Do not return an empty token vector here
-  return AST::Fragment (nodes, nullptr);
+  // FIXME: This returns an empty vector of tokens and works fine, but is that
+  // the expected behavior? `include` macros are a bit harder to reason about
+  // since they include tokens. Furthermore, our lexer has no easy way to return
+  // a slice of tokens like the MacroInvocLexer. So it gets even harder to
+  // extrac tokens from here. For now, let's keep it that way and see if it
+  // eventually breaks, but I don't expect it to cause many issues since the
+  // list of tokens is only used when a macro invocation mixes eager
+  // macro invocations and already expanded tokens. Think
+  // `concat!(a!(), 15, b!())`. We need to be able to expand a!(), expand b!(),
+  // and then insert the `15` token in between. In the case of `include!()`, we
+  // only have one argument. So it's either going to be a macro invocation or a
+  // string literal.
+  return AST::Fragment (nodes, std::vector<std::unique_ptr<AST::Token>> ());
 }
 
 AST::Fragment
diff --git a/gcc/testsuite/rust/compile/empty.in b/gcc/testsuite/rust/compile/empty.in
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/gcc/testsuite/rust/compile/empty.in
@@ -0,0 +1 @@
+
diff --git a/gcc/testsuite/rust/compile/include_empty.rs b/gcc/testsuite/rust/compile/include_empty.rs
new file mode 100644
index 0000000..28e940f
--- /dev/null
+++ b/gcc/testsuite/rust/compile/include_empty.rs
@@ -0,0 +1,8 @@
+#[rustc_builtin_macro]
+macro_rules! include {
+    () => {};
+}
+
+include!("empty.in");
+
+fn main() {}
-- 
2.7.4