[lldb][scripts] Fix bugs in framework fix script

[chelcassanova]

The script used to fix up LLDB's header for use in the macOS framework contained 2 bugs that this commit addreses:

1. The output contents were appended to the output file multiple times instead of only being written once.
2. The script was not considering LLDB includes that were not from the SB API.

This commit addresses and fixes both of these bugs and updates the corresponding test to match.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Chelsea Cassanova (chelcassanova)

Changes

The script used to fix up LLDB's header for use in the macOS framework contained 2 bugs that this commit addreses:

1. The output contents were appended to the output file multiple times instead of only being written once.
2. The script was not considering LLDB includes that were not from the SB API.

This commit addresses and fixes both of these bugs and updates the corresponding test to match.

---

Full diff: https://github.com/llvm/llvm-project/pull/145961.diff

3 Files Affected:

• (modified) lldb/scripts/framework-header-fix.py (+2-2)
• (modified) lldb/test/Shell/Scripts/Inputs/Main/SBAddress.h (+1)
• (modified) lldb/test/Shell/Scripts/TestFrameworkFixScript.test (+1)

diff --git a/lldb/scripts/framework-header-fix.py b/lldb/scripts/framework-header-fix.py
index 9528fdb7e30bd..883c56d3dddc3 100755
--- a/lldb/scripts/framework-header-fix.py
+++ b/lldb/scripts/framework-header-fix.py
@@ -20,7 +20,7 @@
 
 # Main header regexes
 INCLUDE_FILENAME_REGEX = re.compile(
-    r'#include "lldb/API/(?P<include_filename>.*){0,1}"'
+    r'#include "lldb/(API/){0,1}(?P<include_filename>.*){0,1}"'
 )
 
 # RPC header regexes
@@ -70,7 +70,7 @@ def modify_main_includes(input_file_path, output_file_path):
                     r"#include <LLDB/" + match.group("include_filename") + ">",
                     file_buffer,
                 )
-                output_file.write(file_buffer)
+            output_file.write(file_buffer)
 
 
 def remove_guards(output_file_path, unifdef_path, unifdef_guards):
diff --git a/lldb/test/Shell/Scripts/Inputs/Main/SBAddress.h b/lldb/test/Shell/Scripts/Inputs/Main/SBAddress.h
index fecc69687cd74..a15dd9d2a942e 100644
--- a/lldb/test/Shell/Scripts/Inputs/Main/SBAddress.h
+++ b/lldb/test/Shell/Scripts/Inputs/Main/SBAddress.h
@@ -6,6 +6,7 @@
 // e.g. #include "lldb/API/SBDefines.h" -> #include <LLDB/SBDefines.h>
 #include "lldb/API/SBDefines.h"
 #include "lldb/API/SBModule.h"
+#include "lldb/lldb-types.h"
 
 // Any include guards specified at the command line must be removed.
 #ifndef SWIG
diff --git a/lldb/test/Shell/Scripts/TestFrameworkFixScript.test b/lldb/test/Shell/Scripts/TestFrameworkFixScript.test
index e90c3bdfc5adb..5c48b796efda4 100644
--- a/lldb/test/Shell/Scripts/TestFrameworkFixScript.test
+++ b/lldb/test/Shell/Scripts/TestFrameworkFixScript.test
@@ -9,3 +9,4 @@ RUN: cat %t/Outputs/SBAddress.h | FileCheck %s
 # e.g. #include "lldb/API/SBDefines.h" -> #include <LLDB/SBDefines.h>
 CHECK: #include <LLDB/SBDefines.h>
 CHECK: #include <LLDB/SBModule.h>
+CHECK: #include <LLDB/lldb-types.h>

[bulbazord]

I'm not an expert on regex but would it make sense to use ? here instead of {0,1}?

[chelcassanova]

Such that we have r'#include "lldb/(API/)?(?P<include_filename>.*){0,1}"' instead of r'#include "lldb/(API/){0,1}(?P<include_filename>.*){0,1}"'. I just tried it and the test still works, updating the patch.

[chelcassanova]

Could be worth updating all other instances of {0,1}