From fd279f0e38601c288451354cf5d052c7ce3d9c0f Mon Sep 17 00:00:00 2001
From: Roland Conybeare <rconybeare@gmail.com>
Date: Fri, 15 Mar 2024 19:30:07 -0400
Subject: [PATCH] build: streamline CMAKE_MODULE_PATH interaction

---
 .gitignore                      |  2 +-
 CMakeLists.txt                  |  4 +---
 README.md                       | 36 ++++++++++++++++++++++-----------
 cmake/xo-bootstrap-macros.cmake | 12 +++++++++++
 4 files changed, 38 insertions(+), 16 deletions(-)
 create mode 100644 cmake/xo-bootstrap-macros.cmake

diff --git a/.gitignore b/.gitignore
index f52f1311..53a9c92f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,6 @@
 # lsp keeps state here
 .cache
 # typical build directory
-build
+.build*
 # lsp: symlink to file in build directory (established manually)
 compile_commands.json
diff --git a/CMakeLists.txt b/CMakeLists.txt
index b2e5ca94..5d84942e 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -5,9 +5,7 @@ cmake_minimum_required(VERSION 3.10)
 project(xo_pyreflect VERSION 0.1)
 enable_language(CXX)
 
-# common XO cmake macros (see github.com:Rconybea/xo-cmake)
-include(xo_macros/xo_cxx)
-include(xo_macros/code-coverage)
+include(cmake/xo-bootstrap-macros.cmake)
 
 # ----------------------------------------------------------------
 # unit test setup
diff --git a/README.md b/README.md
index 7be07dd9..078e1a1b 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# python bindings for c++ reflection library (xo-reflect)
+# python bindings for c++ reflection library (xo-pyreflect)
 
 ## Getting Started
 
@@ -22,6 +22,22 @@ $ make install
 ```
 (also see .github/workflows/main.yml)
 
+## Examples
+
+Assumes `xo-pyreflect` installed to `~/local2/lib`
+
+```
+PYTHONPATH=~/local2/lib python
+>>> import xo_pyreflect
+>>> dir(xo_pyreflect)
+['SelfTagging', 'TaggedRcptr', 'TypeDescr', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__']
+>>> xo_pyreflect.TypeDescr.print_reflected_types()
+<type_table_v[0]:>
+```
+(Not _immediately_ interesting:  no reflected types in `pyreflect` itself)
+
+## Development
+
 ### build for unit test coverage
 ```
 $ cd xo-pyreflect
@@ -37,24 +53,20 @@ $ cmake \
 ### LSP (language server) support
 
 LSP looks for compile commands in the root of the source tree;
-while Cmake creates them in the root of its build directory.
+while `cmake` creates them in the root of its build directory.
 
 ```
 $ cd xo-pyreflect
 $ ln -s build/compile_commands.json  # supply compile commands to LSP
 ```
 
-## Examples
+### display cmake variables
 
-Assumes `xo-pyreflect` installed to `~/local2/lib`
+- `-L` list variables
+- `-A` include 'advanced' variables
+- `-H` include help text
 
 ```
-PYTHONPATH=~/local2/lib python
->>> import pyreflect
->>> dir(pyreflect)
-['SelfTagging', 'TaggedRcptr', 'TypeDescr', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__']
->>> pyreflect.TypeDescr.print_reflected_types()
-<type_table_v[0]:>
+$ cd xo-pyprintjson/build
+$ cmake -LAH
 ```
-
-Not _immediately_ interesting:  no reflected types in `pyreflect` itself
diff --git a/cmake/xo-bootstrap-macros.cmake b/cmake/xo-bootstrap-macros.cmake
new file mode 100644
index 00000000..16644435
--- /dev/null
+++ b/cmake/xo-bootstrap-macros.cmake
@@ -0,0 +1,12 @@
+if (("${CMAKE_MODULE_PATH}" STREQUAL "") OR ("${CMAKE_MODULE_PATH}" STREQUAL "prefix"))
+    # default to typical install location for xo-project-macros
+    set(CMAKE_MODULE_PATH ${CMAKE_INSTALL_PREFIX}/share/cmake)
+endif()
+
+message("-- CMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}")
+message("-- CMAKE_MODULE_PATH=${CMAKE_MODULE_PATH}")
+
+# needs to have been installed somewhere on CMAKE_MODULE_PATH,
+# (e.g. from xo-cmake with the same value for CMAKE_INSTALL_PREFIX)
+#
+include(xo_macros/xo-project-macros)