From 0c3b79aa338e41aaa253ea88afc2b5e196b6fbb6 Mon Sep 17 00:00:00 2001
From: Eric Kilmer <eric.d.kilmer@gmail.com>
Date: Fri, 29 Dec 2023 13:35:01 -0500
Subject: [PATCH] Switch from "sleigh" to "ghidra" for include directory (#229)

This breaking change only affects header files from upstream Ghidra repository.

Instead of `#include <sleigh/header.hh>`, it will now be
`#include <ghidra/header.hh>` for headers from upstream.

---------

Co-authored-by: Alex Cameron <asc@tetsuo.sh>
---
 CMakeLists.txt                      |  13 +-
 support/include/sleigh/libsleigh.hh | 212 ++++++++++++++--------------
 2 files changed, 114 insertions(+), 111 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 05bb052..c665e9e 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -30,7 +30,7 @@ include(cmake/project-is-top-level.cmake)
 include(cmake/options.cmake)
 
 #
-# Move headers so we can prefix with "sleigh/"
+# Move headers so we can prefix with "ghidra/"
 #
 set(public_include_header_list
   "${library_root}/action.hh"
@@ -147,13 +147,16 @@ endif()
 # Create custom target so that IDEs know these files are part of the sources
 add_custom_target(sleigh_all_headers SOURCES ${public_include_header_list})
 set(public_headers_dir ${CMAKE_CURRENT_BINARY_DIR}/include)
-file(MAKE_DIRECTORY "${public_headers_dir}/sleigh")
-configure_file(cmake/libconfig.h.in "${public_headers_dir}/sleigh/libconfig.h")
+file(MAKE_DIRECTORY "${public_headers_dir}/ghidra")
 # Copy the public headers into our build directory so that we can control the layout.
-# Ideally, we want to let people '#include <sleigh/{header}>' without installing sleigh
+# Ideally, we want to let people '#include <ghidra/{header}>' without installing sleigh
 foreach(public_header ${public_include_header_list})
-  configure_file("${public_header}" "${public_headers_dir}/sleigh" COPYONLY)
+  configure_file("${public_header}" "${public_headers_dir}/ghidra" COPYONLY)
 endforeach()
+# This project also generates a helper header for managing sleigh versions.
+# We intentionally use the `sleigh` directory for this header because it's
+# not from upstream.
+configure_file(cmake/libconfig.h.in "${public_headers_dir}/sleigh/libconfig.h")
 
 #
 # sla
diff --git a/support/include/sleigh/libsleigh.hh b/support/include/sleigh/libsleigh.hh
index 8efae4d..6d3ddc5 100644
--- a/support/include/sleigh/libsleigh.hh
+++ b/support/include/sleigh/libsleigh.hh
@@ -15,117 +15,117 @@
 #pragma GCC diagnostic ignored "-Wsign-compare"
 #pragma GCC diagnostic ignored "-Wunused-parameter"
 #endif
-#include <sleigh/action.hh>
-#include <sleigh/address.hh>
-#include <sleigh/architecture.hh>
-#include <sleigh/block.hh>
-#include <sleigh/blockaction.hh>
-#include <sleigh/callgraph.hh>
-#include <sleigh/capability.hh>
-#include <sleigh/cast.hh>
-#include <sleigh/codedata.hh>
-#include <sleigh/comment.hh>
-#include <sleigh/comment_ghidra.hh>
-#include <sleigh/condexe.hh>
-#include <sleigh/context.hh>
-#include <sleigh/coreaction.hh>
-#include <sleigh/cover.hh>
-#include <sleigh/cpool.hh>
-#include <sleigh/cpool_ghidra.hh>
-#include <sleigh/crc32.hh>
-#include <sleigh/database.hh>
-#include <sleigh/database_ghidra.hh>
-#include <sleigh/doccore.hh>
-#include <sleigh/docmain.hh>
-#include <sleigh/double.hh>
-#include <sleigh/dynamic.hh>
-#include <sleigh/emulate.hh>
-#include <sleigh/emulateutil.hh>
-#include <sleigh/error.hh>
-#include <sleigh/filemanage.hh>
-#include <sleigh/float.hh>
-#include <sleigh/flow.hh>
-#include <sleigh/fspec.hh>
-#include <sleigh/funcdata.hh>
-#include <sleigh/ghidra_arch.hh>
-#include <sleigh/ghidra_context.hh>
-#include <sleigh/ghidra_process.hh>
-#include <sleigh/ghidra_translate.hh>
-#include <sleigh/globalcontext.hh>
-#include <sleigh/grammar.hh>
-#include <sleigh/graph.hh>
-#include <sleigh/heritage.hh>
-#include <sleigh/ifacedecomp.hh>
-#include <sleigh/ifaceterm.hh>
-#include <sleigh/inject_ghidra.hh>
-#include <sleigh/inject_sleigh.hh>
-#include <sleigh/interface.hh>
-#include <sleigh/jumptable.hh>
-#include <sleigh/libdecomp.hh>
-#include <sleigh/loadimage.hh>
-#include <sleigh/loadimage_ghidra.hh>
-#include <sleigh/loadimage_xml.hh>
-#include <sleigh/memstate.hh>
-#include <sleigh/merge.hh>
-#include <sleigh/op.hh>
-#include <sleigh/opbehavior.hh>
-#include <sleigh/opcodes.hh>
-#include <sleigh/options.hh>
-#include <sleigh/override.hh>
-#include <sleigh/paramid.hh>
-#include <sleigh/partmap.hh>
-#include <sleigh/pcodecompile.hh>
-#include <sleigh/pcodeinject.hh>
-#include <sleigh/pcodeparse.hh>
-#include <sleigh/pcoderaw.hh>
-#include <sleigh/prefersplit.hh>
-#include <sleigh/prettyprint.hh>
-#include <sleigh/printc.hh>
-#include <sleigh/printjava.hh>
-#include <sleigh/printlanguage.hh>
-#include <sleigh/rangemap.hh>
-#include <sleigh/rangeutil.hh>
-#include <sleigh/raw_arch.hh>
-#include <sleigh/ruleaction.hh>
-#include <sleigh/rulecompile.hh>
-#include <sleigh/semantics.hh>
-#include <sleigh/sleigh.hh>
-#include <sleigh/sleigh_arch.hh>
-#include <sleigh/sleighbase.hh>
-#include <sleigh/slgh_compile.hh>
+#include <ghidra/action.hh>
+#include <ghidra/address.hh>
+#include <ghidra/architecture.hh>
+#include <ghidra/block.hh>
+#include <ghidra/blockaction.hh>
+#include <ghidra/callgraph.hh>
+#include <ghidra/capability.hh>
+#include <ghidra/cast.hh>
+#include <ghidra/codedata.hh>
+#include <ghidra/comment.hh>
+#include <ghidra/comment_ghidra.hh>
+#include <ghidra/condexe.hh>
+#include <ghidra/context.hh>
+#include <ghidra/coreaction.hh>
+#include <ghidra/cover.hh>
+#include <ghidra/cpool.hh>
+#include <ghidra/cpool_ghidra.hh>
+#include <ghidra/crc32.hh>
+#include <ghidra/database.hh>
+#include <ghidra/database_ghidra.hh>
+#include <ghidra/doccore.hh>
+#include <ghidra/docmain.hh>
+#include <ghidra/double.hh>
+#include <ghidra/dynamic.hh>
+#include <ghidra/emulate.hh>
+#include <ghidra/emulateutil.hh>
+#include <ghidra/error.hh>
+#include <ghidra/filemanage.hh>
+#include <ghidra/float.hh>
+#include <ghidra/flow.hh>
+#include <ghidra/fspec.hh>
+#include <ghidra/funcdata.hh>
+#include <ghidra/ghidra_arch.hh>
+#include <ghidra/ghidra_context.hh>
+#include <ghidra/ghidra_process.hh>
+#include <ghidra/ghidra_translate.hh>
+#include <ghidra/globalcontext.hh>
+#include <ghidra/grammar.hh>
+#include <ghidra/graph.hh>
+#include <ghidra/heritage.hh>
+#include <ghidra/ifacedecomp.hh>
+#include <ghidra/ifaceterm.hh>
+#include <ghidra/inject_ghidra.hh>
+#include <ghidra/inject_sleigh.hh>
+#include <ghidra/interface.hh>
+#include <ghidra/jumptable.hh>
+#include <ghidra/libdecomp.hh>
+#include <ghidra/loadimage.hh>
+#include <ghidra/loadimage_ghidra.hh>
+#include <ghidra/loadimage_xml.hh>
+#include <ghidra/memstate.hh>
+#include <ghidra/merge.hh>
+#include <ghidra/op.hh>
+#include <ghidra/opbehavior.hh>
+#include <ghidra/opcodes.hh>
+#include <ghidra/options.hh>
+#include <ghidra/override.hh>
+#include <ghidra/paramid.hh>
+#include <ghidra/partmap.hh>
+#include <ghidra/pcodecompile.hh>
+#include <ghidra/pcodeinject.hh>
+#include <ghidra/pcodeparse.hh>
+#include <ghidra/pcoderaw.hh>
+#include <ghidra/prefersplit.hh>
+#include <ghidra/prettyprint.hh>
+#include <ghidra/printc.hh>
+#include <ghidra/printjava.hh>
+#include <ghidra/printlanguage.hh>
+#include <ghidra/rangemap.hh>
+#include <ghidra/rangeutil.hh>
+#include <ghidra/raw_arch.hh>
+#include <ghidra/ruleaction.hh>
+#include <ghidra/rulecompile.hh>
+#include <ghidra/semantics.hh>
+#include <ghidra/sleigh.hh>
+#include <ghidra/sleigh_arch.hh>
+#include <ghidra/sleighbase.hh>
+#include <ghidra/slgh_compile.hh>
 // This is required because slghparse.hh does not have a namespace block
 namespace ghidra {
-#include <sleigh/slghparse.hh>
+#include <ghidra/slghparse.hh>
 } // End namespace ghidra
-#include <sleigh/slghpatexpress.hh>
-#include <sleigh/slghpattern.hh>
-#include <sleigh/slghsymbol.hh>
-#include <sleigh/space.hh>
-#include <sleigh/string_ghidra.hh>
-#include <sleigh/stringmanage.hh>
-#include <sleigh/subflow.hh>
-#include <sleigh/testfunction.hh>
-#include <sleigh/transform.hh>
-#include <sleigh/translate.hh>
-#include <sleigh/type.hh>
-#include <sleigh/typegrp_ghidra.hh>
-#include <sleigh/typeop.hh>
-#include <sleigh/types.h>
-#include <sleigh/unify.hh>
-#include <sleigh/userop.hh>
-#include <sleigh/variable.hh>
-#include <sleigh/varmap.hh>
-#include <sleigh/varnode.hh>
-#include <sleigh/xml.hh>
-#include <sleigh/xml_arch.hh>
-#include <sleigh/unionresolve.hh>
-#include <sleigh/marshal.hh>
+#include <ghidra/slghpatexpress.hh>
+#include <ghidra/slghpattern.hh>
+#include <ghidra/slghsymbol.hh>
+#include <ghidra/space.hh>
+#include <ghidra/string_ghidra.hh>
+#include <ghidra/stringmanage.hh>
+#include <ghidra/subflow.hh>
+#include <ghidra/testfunction.hh>
+#include <ghidra/transform.hh>
+#include <ghidra/translate.hh>
+#include <ghidra/type.hh>
+#include <ghidra/typegrp_ghidra.hh>
+#include <ghidra/typeop.hh>
+#include <ghidra/types.h>
+#include <ghidra/unify.hh>
+#include <ghidra/userop.hh>
+#include <ghidra/variable.hh>
+#include <ghidra/varmap.hh>
+#include <ghidra/varnode.hh>
+#include <ghidra/xml.hh>
+#include <ghidra/xml_arch.hh>
+#include <ghidra/unionresolve.hh>
+#include <ghidra/marshal.hh>
 
 #ifdef sleigh_RELEASE_IS_HEAD
-#include <sleigh/analyzesigs.hh>
-#include <sleigh/modelrules.hh>
-#include <sleigh/signature.hh>
-#include <sleigh/signature_ghidra.hh>
+#include <ghidra/analyzesigs.hh>
+#include <ghidra/modelrules.hh>
+#include <ghidra/signature.hh>
+#include <ghidra/signature_ghidra.hh>
 #endif
 
 #ifndef _MSC_VER