Change SWIG output directory when building LLDB.framework with CMake

[xiaobai]

Summary

Instead of assuming that SWIG generated files (e.g. lldb.py) will live
in scripts, we should set it to $LLDB_PYTHON_TARGET_DIR. This variable is set to
scripts, except when building LLDB.framework when it is set to
LLDB_FRAMEWORK_DIR.

[xiaobai]

I'm not sure who else would be interested in reviewing this. If you know somebody, please add them. :)

[sas]

CMakeLists.txt

149

This path...

scripts/CMakeLists.txt

38

...and this path were not the same before your change. Was that a bug that you're fixing?

[xiaobai]

scripts/CMakeLists.txt

38

Yes. Those paths were actually the same if you were not building the framework, which is why this bug never surfaced. Specifically, ${CMAKE_CURRENT_BINARY_DIR} in scripts/CMakeLists.txt resolves to the same path as ${CMAKE_CURRENT_BINARY_DIR}/scripts in the top level CMakeLists.txt.

The pitfall is the assumption that this path is always the same as ${LLDB_PYTHON_TARGET_DIR}, which it is not if you are trying to build the framework.

[sas]

scripts/CMakeLists.txt

38

Makes sense. This should be good to go then.

CMakeLists.txt

 if (NOT LLDB_DISABLE_PYTHON)
     # Add a Post-Build Event to copy over Python files and create the symlink
     # to liblldb.so for the Python API(hardlink on Windows)
     add_custom_target(finish_swig ALL
         COMMAND
            ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/scripts/finishSwigWrapperClasses.py
                --srcRoot=${LLDB_SOURCE_DIR}
                --targetDir=${LLDB_PYTHON_TARGET_DIR}
-               --cfgBldDir=${CMAKE_CURRENT_BINARY_DIR}/scripts
+               --cfgBldDir=${LLDB_PYTHON_TARGET_DIR}
                --prefix=${CMAKE_BINARY_DIR}
                --cmakeBuildConfiguration=${CMAKE_CFG_INTDIR}
                --lldbLibDir=lib${LLVM_LIBDIR_SUFFIX}
                ${SIX_EXTRA_ARGS}
                ${FINISH_EXTRA_ARGS}
         VERBATIM
         DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/scripts/finishSwigWrapperClasses.py
-        DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/scripts/lldb.py
+        DEPENDS ${LLDB_PYTHON_TARGET_DIR}/lldb.py
         COMMENT "Python script sym-linking LLDB Python API")
     # We depend on liblldb being built before we can do this step.
     add_dependencies(finish_swig liblldb lldb-argdumper)
 
     # If we build the readline module, we depend on that happening
     # first.
     if (TARGET readline)
         add_dependencies(finish_swig readline)

scripts/CMakeLists.txt

set(SWIG_INSTALL_DIR
     ${LLDB_FRAMEWORK_INSTALL_DIR}/${LLDB_FRAMEWORK_RESOURCE_DIR})
 endif()
 
 get_filename_component(CFGBLDDIR ${LLDB_WRAP_PYTHON} DIRECTORY)
 
 find_package(SWIG REQUIRED)
 add_custom_command(
   OUTPUT ${LLDB_WRAP_PYTHON}
-  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/lldb.py
+  OUTPUT ${LLDB_PYTHON_TARGET_DIR}/lldb.py
   DEPENDS ${SWIG_SOURCES}
   DEPENDS ${SWIG_INTERFACES}
   DEPENDS ${SWIG_HEADERS}
   DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/Python/prepare_binding_Python.py
   DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/Python/modify-python-lldb.py
   COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/prepare_bindings.py
       ${framework_arg}
       --srcRoot=${LLDB_SOURCE_DIR}