Improve support of the ncurses dependency on NetBSD

[krytarowski]

Summary

Summary of the changes:

• add config.h (CMake and autotools target).
• Handle ncurses with a proper CMake find_package() call
• Handle ncurses panel library with proper find_library()
• Stop hardcoding broken '-lncurses -lpanel' entries
• Handle pkgsrc/NetBSD headers location (<ncurses/ncurses.h>)

[brucem]

Some mostly superficial comments.

I'd like to hear if anyone else has an opinion about using a Config.h generated by cmake & autotools.

I'm also not sure offhand how this would impact the Xcode build that the Apple folks use.

And I didn't see anything that sets autoconf stuff to generate that new config.h.in?

cmake/modules/LLDBConfig.cmake

284

Typo here: ncureses

include/lldb/Config/config.h.cmake

6

This should be LLDB_CONFIG_CONFIG_H rather than just CONFIG_H.

Also, why not use the same #ifndef technique that everything else uses in the header files?

6

Also, other headers in LLDB tend to have capitalized names, so maybe this should be include/lldb/Config/Config.h.cmake.

include/lldb/Config/config.h.in

6

Same as for config.h.cmake.

[labath]

In D12994#254468, @brucem wrote:

I'm also not sure offhand how this would impact the Xcode build that the Apple folks use.

Since the xcode build is only used on Darwin, I think we can hardcode any #defines that are needed in the xcode project.

[krytarowski]

include/lldb/Config/config.h.cmake

6

I was following the clang/llvm approach of exclusing llvm's config.h and subprojects' one.

[krytarowski]

Fix typo.

[krytarowski]

include/lldb/Config/config.h.cmake

6

Please have a look at: https://github.com/llvm-mirror/clang/tree/master/include/clang/Config

[krytarowski]

There is already preliminary NetBSD support merged with trunk, I need this commit (or altered version of it) to build lldb against ncurses on this platform.

Thank you for your time.

[krytarowski]

Closing. We are going for reuse of the NetBSD native curses(8) library.

The reason for it is limit of detecting ncurses on various systems. For example, Ubuntu ships with <curses.h> and linkage from <ncurses.h>, ncurses.h isn't detected by CMake. Detecting <curses.h> on NetBSD is reusing conflicting header from the host curses(8) and pkgsrc's ncurses library.

CMakeLists.txt

if (NOT LLDB_DISABLE_PYTHON)
   add_subdirectory(scripts)
 endif ()
 add_subdirectory(source)
 add_subdirectory(test)
 add_subdirectory(tools)
 add_subdirectory(unittests)
 add_subdirectory(lit)
 
+configure_file(
+    ${LLDB_SOURCE_DIR}/include/lldb/Config/config.h.cmake
+    ${LLDB_BINARY_DIR}/include/lldb/Config/config.h)
+
 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=${CMAKE_CURRENT_BINARY_DIR}/scripts" "--cfgBldDir=${CMAKE_CURRENT_BINARY_DIR}/scripts" "--prefix=${CMAKE_BINARY_DIR}" "--cmakeBuildConfiguration=${CMAKE_CFG_INTDIR}" -m
         DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/scripts/finishSwigWrapperClasses.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 argdumper)
 
     # Ensure we do the python post-build step when building lldb.
     add_dependencies(lldb finish_swig)
 endif ()

cmake/LLDBDependencies.cmake

set( CLANG_USED_LIBS
   )
 
 set(LLDB_SYSTEM_LIBS)
 if (NOT CMAKE_SYSTEM_NAME MATCHES "Windows" AND NOT __ANDROID_NDK__)
   if (NOT LLDB_DISABLE_LIBEDIT)
     list(APPEND LLDB_SYSTEM_LIBS edit)
   endif()
   if (NOT LLDB_DISABLE_CURSES)
-    list(APPEND LLDB_SYSTEM_LIBS panel ncurses)
+    list(APPEND LLDB_SYSTEM_LIBS ${CURSES_LIBRARIES})
     if(LLVM_ENABLE_TERMINFO AND HAVE_TERMINFO)
       list(APPEND LLDB_SYSTEM_LIBS ${TERMINFO_LIBS})
     endif()
   endif()
 endif()
 # On FreeBSD/NetBSD backtrace() is provided by libexecinfo, not libc.
 if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD" OR CMAKE_SYSTEM_NAME MATCHES "NetBSD")
   list(APPEND LLDB_SYSTEM_LIBS execinfo)

cmake/modules/LLDBConfig.cmake

if (CMAKE_SYSTEM_NAME MATCHES "Darwin")
   find_library(CARBON_LIBRARY Carbon)
   find_library(FOUNDATION_LIBRARY Foundation)
   find_library(CORE_FOUNDATION_LIBRARY CoreFoundation)
   find_library(CORE_SERVICES_LIBRARY CoreServices)
   find_library(SECURITY_LIBRARY Security)
   find_library(DEBUG_SYMBOLS_LIBRARY DebugSymbols PATHS "/System/Library/PrivateFrameworks")
 
   add_definitions( -DLIBXML2_DEFINED )
-  list(APPEND system_libs xml2 ncurses panel)
+  list(APPEND system_libs xml2)
   list(APPEND system_libs ${CARBON_LIBRARY} ${FOUNDATION_LIBRARY}
   ${CORE_FOUNDATION_LIBRARY} ${CORE_SERVICES_LIBRARY} ${SECURITY_LIBRARY}
   ${DEBUG_SYMBOLS_LIBRARY})
 
 else()
 
   if (LIBXML2_FOUND)
     add_definitions( -DLIBXML2_DEFINED )

 
 # Figure out if lldb could use debugserver.  If so, then we'll
 # ensure we build debugserver when we build lldb.
 if ( CMAKE_SYSTEM_NAME MATCHES "Darwin" )
     set(LLDB_CAN_USE_DEBUGSERVER 1)
 else()
     set(LLDB_CAN_USE_DEBUGSERVER 0)
 endif()
+
+if (NOT LLDB_DISABLE_CURSES)
+    set(CURSES_NEED_NCURSES TRUE)
+    find_package(Curses REQUIRED)
+
+    find_library(NCURSES_PANEL_LIBRARY NAMES panel DOC "The ncureses panel library")
+    if (CURSES_FOUND)
+        # Add panels to the library path
+        set (CURSES_LIBRARIES ${CURSES_LIBRARIES} ${NCURSES_PANEL_LIBRARY})
+    endif ()
+
+    list(APPEND system_libs ${CURSES_LIBRARIES})
+    include_directories(${CURSES_INCLUDE_DIR})
+endif ()

include/lldb/Config/config.h.cmake

+/* This generated file is for internal use. Do not include it from headers. */
+
+#ifdef CONFIG_H
+#error config.h can only be included once
+#else
+#define CONFIG_H
+
+/* Define to 1 if you have the <ncurses.h> header file. */
+#cmakedefine CURSES_HAVE_NCURSES_H
+
+/* Define to 1 if you have the <ncurses/ncurses.h> header file. */
+#cmakedefine CURSES_HAVE_NCURSES_NCURSES_H
+
+/* autotools compat */
+#ifdef CURSES_HAVE_NCURSES_H
+#define HAVE_NCURSES_H 1
+#endif
+
+#ifdef CURSES_HAVE_NCURSES_NCURSES_H
+#define HAVE_NCURSES_NCURSES_H 1
+#endif
+
+#endif // CONFIG_H

include/lldb/Config/config.h.in

+/* This generated file is for internal use. Do not include it from headers. */
+
+#ifdef CONFIG_H
+#error config.h can only be included once
+#else
+#define CONFIG_H
+
+/* Define to 1 if you have the <ncurses.h> header file. */
+#undef HAVE_NCURSES_H
+
+/* Define to 1 if you have the <ncurses/ncurses.h> header file. */
+#undef HAVE_NCURSES_NCURSES_H
+
+#endif

source/Core/CMakeLists.txt

add_lldb_library(lldbCore
   ValueObjectList.cpp
   ValueObjectMemory.cpp
   ValueObjectRegister.cpp
   ValueObjectSyntheticFilter.cpp
   ValueObjectVariable.cpp
   VMRange.cpp
   )
 
+include_directories(${CURSES_INCLUDE_DIR})
+target_link_libraries(lldbCore ${CURSES_LIBRARIES})

source/Core/IOHandler.cpp

 //===-- IOHandler.cpp -------------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 
 #include <string>
 
 #include "lldb/Breakpoint/BreakpointLocation.h"
+#include "lldb/Config/config.h"
 #include "lldb/Core/IOHandler.h"
 #include "lldb/Core/Debugger.h"
 #include "lldb/Core/Module.h"
 #include "lldb/Core/State.h"
 #include "lldb/Core/StreamFile.h"
 #include "lldb/Core/ValueObjectRegister.h"
 #ifndef LLDB_DISABLE_LIBEDIT
 #include "lldb/Host/Editline.h"
 #endif
 #include "lldb/Interpreter/CommandCompletions.h"
 #include "lldb/Interpreter/CommandInterpreter.h"
 #include "lldb/Symbol/Block.h"
 #include "lldb/Symbol/Function.h"
 #include "lldb/Symbol/Symbol.h"
 #include "lldb/Target/RegisterContext.h"
 #include "lldb/Target/ThreadPlan.h"
 
 #ifndef LLDB_DISABLE_CURSES
+
+#if defined(HAVE_NCURSES_H)
 #include <ncurses.h>
 #include <panel.h>
+#elif defined(HAVE_NCURSES_NCURSES_H)
+#include <ncurses/ncurses.h>
+#include <ncurses/panel.h>
+#else
+#error No NCURSES header!
+#endif
+
 #endif
 
 using namespace lldb;
 using namespace lldb_private;
 
 IOHandler::IOHandler (Debugger &debugger, IOHandler::Type type) :
     IOHandler (debugger,
                type,