Merge pull request #6181 from adrian-prantl/macro-test

Add an LLDB test for Swift macros.

Author: adrian-prantl

lldb/packages/Python/lldbsuite/test/make/Makefile.rules

@@ -304,6 +304,12 @@ SWIFT_BRIDGING_PCH :=
 SWIFT_HFLAGS :=
 endif
 
+ifeq "$(OS)" "Linux"
+SWIFT_HOSTDIR = $(shell dirname $(SWIFTC))/../lib/swift/linux
+else
+SWIFT_HOSTDIR = $(shell dirname $(SWIFTC))/../lib/swift/host
+endif
+
 # Use this one if you want to build one part of the result without debug information:
 ifeq "$(OS)" "Darwin"
 	CFLAGS_NO_DEBUG = -O0 $(ARCHFLAG) $(ARCH) $(FRAMEWORK_INCLUDES) $(ARCH_CFLAGS) $(CFLAGS_EXTRAS) -isysroot "$(SDKROOT)"

lldb/test/API/lang/swift/macro/MacroImpl.swift

@@ -0,0 +1,16 @@
+import SwiftSyntax
+import SwiftSyntaxBuilder
+import SwiftSyntaxMacros
+
+public struct StringifyMacro: ExpressionMacro {
+  public static func expansion(
+    of macro: some FreestandingMacroExpansionSyntax,
+    in context: some MacroExpansionContext
+  ) -> ExprSyntax {
+    guard let argument = macro.argumentList.first?.expression else {
+      fatalError("boom")
+    }
+
+    return "(\(argument), \(StringLiteralExprSyntax(content: argument.description)))"
+  }
+}

lldb/test/API/lang/swift/macro/Makefile

@@ -0,0 +1,21 @@
+SWIFT_SOURCES := main.swift
+SWIFTFLAGS_EXTRAS = -enable-experimental-feature Macros \
+	            -load-plugin-library $(BUILDDIR)/libMacroImpl.dylib
+
+all: libMacroImpl.dylib $(EXE)
+
+include Makefile.rules
+
+libMacroImpl.dylib:
+	$(MAKE) MAKE_DSYM=$(MAKE_DSYM) CC=$(CC) SWIFTC=$(SWIFTC) \
+		ARCH=$(ARCH) DSYMUTIL=$(DSYMUTIL) \
+		VPATH=$(SRCDIR) -I $(SRCDIR) \
+		-f $(THIS_FILE_DIR)/Makefile.rules \
+		DYLIB_SWIFT_SOURCES=MacroImpl.swift \
+		DYLIB_NAME=MacroImpl \
+		DYLIB_ONLY=YES \
+		SWIFTFLAGS_EXTRAS="-I$(SWIFT_HOSTDIR)" \
+		LD_EXTRAS="-L$(SWIFT_HOSTDIR)" \
+		SWIFT_SOURCES= \
+		all
+

lldb/test/API/lang/swift/macro/TestSwiftMacro.py

@@ -0,0 +1,35 @@
+import lldb
+from lldbsuite.test.decorators import *
+import lldbsuite.test.lldbtest as lldbtest
+import lldbsuite.test.lldbutil as lldbutil
+import unittest2
+
+
+class TestSwiftMacro(lldbtest.TestBase):
+
+    @swiftTest
+    # At the time of writing swift/test/Macros/macro_expand.swift is also disabled.
+    @expectedFailureAll(oslist=['linux'])
+    def test(self):
+        """Test Swift macros"""
+        self.build()
+        target, process, thread, bkpt = lldbutil.run_to_source_breakpoint(
+            self, 'break here', lldb.SBFileSpec('main.swift'))
+
+        thread.StepOver()
+        thread.StepInto()
+        # This is the expanded macro source, we should be able to step into it.
+        self.expect('reg read pc', substrs=[
+            '[inlined] stringify at',
+            '13testStringify'
+        ])
+
+        # Macros are not supported in the expression evaluator.
+        self.expect('expression -- #stringify(1)', error=True,
+                    substrs=["external macro implementation",
+                              'MacroImpl.StringifyMacro',
+                              "could not be found"])
+
+        # Make sure we can set a symbolic breakpoint on a macro.
+        b = target.BreakpointCreateByName("stringify")
+        self.assertGreaterEqual(b.GetNumLocations(), 1)

lldb/test/API/lang/swift/macro/main.swift

@@ -0,0 +1,9 @@
+@freestanding(expression) macro stringify<T>(_ value: T) -> (T, String) = #externalMacro(module: "MacroImpl", type: "StringifyMacro")
+
+func testStringify(a: Int, b: Int) {
+  print("break here")
+  let s = #stringify(a + b)
+  print(s.1)
+}
+
+testStringify(a: 23, b: 42)