Unify Darwin and Non-Darwin printing of version output

[beanz]

Summary

This change unifies and simplifies the code paths between the Darwin and non-Darwin code to print the LLDB version information.

It also introduces a new variable in CMake LLDB_VERSION_STRING which can be used to specify custom version information.

With the LLDB_VERSION_STRING variable set to lldb-360.0.0, the -version output is:

./bin/lldb -version

lldb version 4.0.0 (lldb-360.0.0)

clang revision 286264
llvm revision 286265

This behavior is unified across all target platforms.

[tfiala]

Looks good, @beanz!

[labath]

Woohoo.

lldb.xcodeproj/project.pbxproj

2689FFD513353D7A00698AC0 /* Debug */ = {
         CURRENT_PROJECT_VERSION = 360.99.0;
         DYLIB_CURRENT_VERSION = 360.99.0;
         EXECUTABLE_EXTENSION = a;
         FRAMEWORK_SEARCH_PATHS = (
           "$(inherited)",
           "\"$(SYSTEM_LIBRARY_DIR)/PrivateFrameworks\"",
         );
         GCC_INLINES_ARE_PRIVATE_EXTERN = NO;
+        GCC_PREPROCESSOR_DEFINITIONS = (
+          __STDC_CONSTANT_MACROS,
+          __STDC_LIMIT_MACROS,
+          LLDB_CONFIGURATION_DEBUG,
+          "LLDB_VERSION_STRING=\"lldb-${CURRENT_PROJECT_VERSION}\"",
+        );
+        "GCC_PREPROCESSOR_DEFINITIONS[sdk=iphoneos*][arch=*]" = (
+          __STDC_CONSTANT_MACROS,
+          __STDC_LIMIT_MACROS,
+          LLDB_CONFIGURATION_DEBUG,
+          LLDB_DISABLE_PYTHON,
+          NO_XPC_SERVICES,
+          "LLDB_VERSION_STRING=\"lldb-${CURRENT_PROJECT_VERSION}\"",
+        );
         HEADER_SEARCH_PATHS = /usr/include/libxml2;
         LLDB_COMPRESSION_CFLAGS = "";
         "LLDB_COMPRESSION_CFLAGS[sdk=macosx10.11]" = "-DHAVE_LIBCOMPRESSION=1";
         LLDB_COMPRESSION_LDFLAGS = "";
         "LLDB_COMPRESSION_LDFLAGS[sdk=macosx10.11]" = "-weak-lcompression";
         LLDB_ZLIB_CFLAGS = "-DHAVE_LIBZ=1";
         LLDB_ZLIB_LDFLAGS = "-lz";
         MACH_O_TYPE = staticlib;
2689FFD613353D7A00698AC0 /* Release */ = {
         CURRENT_PROJECT_VERSION = 360.99.0;
         DYLIB_CURRENT_VERSION = 360.99.0;
         EXECUTABLE_EXTENSION = a;
         FRAMEWORK_SEARCH_PATHS = (
           "$(inherited)",
           "\"$(SYSTEM_LIBRARY_DIR)/PrivateFrameworks\"",
         );
         GCC_INLINES_ARE_PRIVATE_EXTERN = NO;
+        GCC_PREPROCESSOR_DEFINITIONS = (
+          __STDC_CONSTANT_MACROS,
+          __STDC_LIMIT_MACROS,
+          LLDB_CONFIGURATION_RELEASE,
+          "LLDB_VERSION_STRING=\"lldb-${CURRENT_PROJECT_VERSION}\"",
+        );
+        "GCC_PREPROCESSOR_DEFINITIONS[sdk=iphoneos*][arch=*]" = (
+          __STDC_CONSTANT_MACROS,
+          __STDC_LIMIT_MACROS,
+          LLDB_CONFIGURATION_RELEASE,
+          LLDB_DISABLE_PYTHON,
+          NO_XPC_SERVICES,
+          "LLDB_VERSION_STRING=\"lldb-${CURRENT_PROJECT_VERSION}\"",
+        );
         HEADER_SEARCH_PATHS = /usr/include/libxml2;
         LLDB_COMPRESSION_CFLAGS = "";
         "LLDB_COMPRESSION_CFLAGS[sdk=macosx10.11]" = "-DHAVE_LIBCOMPRESSION=1";
         LLDB_COMPRESSION_LDFLAGS = "";
         "LLDB_COMPRESSION_LDFLAGS[sdk=macosx10.11]" = "-weak-lcompression";
         LLDB_ZLIB_CFLAGS = "-DHAVE_LIBZ=1";
         LLDB_ZLIB_LDFLAGS = "-lz";
         MACH_O_TYPE = staticlib;
2689FFD713353D7A00698AC0 /* BuildAndIntegration */ = {
         CURRENT_PROJECT_VERSION = 360.99.0;
         DYLIB_CURRENT_VERSION = 360.99.0;
         EXECUTABLE_EXTENSION = a;
         FRAMEWORK_SEARCH_PATHS = (
           "$(inherited)",
           "\"$(SYSTEM_LIBRARY_DIR)/PrivateFrameworks\"",
         );
         GCC_INLINES_ARE_PRIVATE_EXTERN = NO;
+        GCC_PREPROCESSOR_DEFINITIONS = (
+          __STDC_CONSTANT_MACROS,
+          __STDC_LIMIT_MACROS,
+          LLDB_CONFIGURATION_BUILD_AND_INTEGRATION,
+          "LLDB_VERSION_STRING=\"lldb-${CURRENT_PROJECT_VERSION}\"",
+        );
+        "GCC_PREPROCESSOR_DEFINITIONS[sdk=iphoneos*][arch=*]" = (
+          __STDC_CONSTANT_MACROS,
+          __STDC_LIMIT_MACROS,
+          LLDB_CONFIGURATION_BUILD_AND_INTEGRATION,
+          LLDB_DISABLE_PYTHON,
+          NO_XPC_SERVICES,
+          "LLDB_VERSION_STRING=\"lldb-${CURRENT_PROJECT_VERSION}\"",
+        );
         HEADER_SEARCH_PATHS = /usr/include/libxml2;
         LLDB_COMPRESSION_CFLAGS = "";
         "LLDB_COMPRESSION_CFLAGS[sdk=macosx10.11]" = "-DHAVE_LIBCOMPRESSION=1";
         LLDB_COMPRESSION_LDFLAGS = "";
         "LLDB_COMPRESSION_LDFLAGS[sdk=macosx10.11]" = "-weak-lcompression";
         LLDB_ZLIB_CFLAGS = "-DHAVE_LIBZ=1";
         LLDB_ZLIB_LDFLAGS = "-lz";
         MACH_O_TYPE = staticlib;
49BB8F3B1611172B00BDD462 /* DebugClang */ = {
         CURRENT_PROJECT_VERSION = 360.99.0;
         DYLIB_CURRENT_VERSION = 360.99.0;
         EXECUTABLE_EXTENSION = a;
         FRAMEWORK_SEARCH_PATHS = (
           "$(inherited)",
           "\"$(SYSTEM_LIBRARY_DIR)/PrivateFrameworks\"",
         );
         GCC_INLINES_ARE_PRIVATE_EXTERN = NO;
+        GCC_PREPROCESSOR_DEFINITIONS = (
+          __STDC_CONSTANT_MACROS,
+          __STDC_LIMIT_MACROS,
+          LLDB_CONFIGURATION_DEBUG,
+          "LLDB_VERSION_STRING=\"lldb-${CURRENT_PROJECT_VERSION}\"",
+        );
+        "GCC_PREPROCESSOR_DEFINITIONS[sdk=iphoneos*][arch=*]" = (
+          __STDC_CONSTANT_MACROS,
+          __STDC_LIMIT_MACROS,
+          LLDB_CONFIGURATION_DEBUG,
+          LLDB_DISABLE_PYTHON,
+          NO_XPC_SERVICES,
+          "LLDB_VERSION_STRING=\"lldb-${CURRENT_PROJECT_VERSION}\"",
+        );
         HEADER_SEARCH_PATHS = /usr/include/libxml2;
         LLDB_COMPRESSION_CFLAGS = "";
         "LLDB_COMPRESSION_CFLAGS[sdk=macosx10.11]" = "-DHAVE_LIBCOMPRESSION=1";
         LLDB_COMPRESSION_LDFLAGS = "";
         "LLDB_COMPRESSION_LDFLAGS[sdk=macosx10.11]" = "-weak-lcompression";
         LLDB_ZLIB_CFLAGS = "-DHAVE_LIBZ=1";
         LLDB_ZLIB_LDFLAGS = "-lz";
         MACH_O_TYPE = staticlib;

source/CMakeLists.txt

include_directories(
   )
 endif ()
 
 
 set(lldbBase_SOURCES
     lldb.cpp
   )
 
-if (CMAKE_SYSTEM_NAME MATCHES "Darwin")
-  set(LLDB_VERS_GENERATED_FILE ${LLDB_BINARY_DIR}/source/LLDB_vers.c)
-  add_custom_command(OUTPUT ${LLDB_VERS_GENERATED_FILE}
-    COMMAND ${LLDB_SOURCE_DIR}/scripts/generate-vers.pl
-            ${LLDB_SOURCE_DIR}/lldb.xcodeproj/project.pbxproj liblldb_core
-            > ${LLDB_VERS_GENERATED_FILE}
-    DEPENDS ${LLDB_SOURCE_DIR}/scripts/generate-vers.pl
-            ${LLDB_SOURCE_DIR}/lldb.xcodeproj/project.pbxproj)
-  set_source_files_properties(${LLDB_VERS_GENERATED_FILE} PROPERTIES GENERATED 1)
-  # Add this to lldbBase since lldb.cpp uses the symbol defined here.
-  list(APPEND lldbBase_SOURCES ${LLDB_VERS_GENERATED_FILE})
-  add_custom_target(lldbGeneratedVersion
-    DEPENDS ${LLDB_VERS_GENERATED_FILE})
-endif()
-
 foreach(file
         "${LLDB_SOURCE_DIR}/.git/logs/HEAD" # Git
         "${LLDB_SOURCE_DIR}/.svn/wc.db"     # SVN 1.7
         "${LLDB_SOURCE_DIR}/.svn/entries"   # SVN 1.6
         )
   if(EXISTS "${file}")
     set(lldb_vc "${file}")
     break()
PROPERTIES GENERATED TRUE
                HEADER_FILE_ONLY TRUE)
 
   # Tell Version.cpp that it needs to build with -DHAVE_SVN_VERSION_INC.
   set_source_files_properties(lldb.cpp
     PROPERTIES COMPILE_DEFINITIONS "HAVE_SVN_VERSION_INC")
   list(APPEND lldbBase_SOURCES ${version_inc})
 endif()
 
+if(LLDB_VERSION_STRING)
+  set_source_files_properties(lldb.cpp
+    PROPERTIES COMPILE_DEFINITIONS "LLDB_VERSION_STRING=\"${LLDB_VERSION_STRING}\"")
+endif()
+
 add_lldb_library(lldbBase
   ${lldbBase_SOURCES}
   )
 
-if (CMAKE_SYSTEM_NAME MATCHES "Darwin")
-  add_dependencies(lldbBase lldbGeneratedVersion)
-endif()
-
 add_subdirectory(Breakpoint)
 add_subdirectory(Commands)
 add_subdirectory(Core)
 add_subdirectory(DataFormatters)
 add_subdirectory(Expression)
 add_subdirectory(Host)
 add_subdirectory(Initialization)
 add_subdirectory(Interpreter)
 add_subdirectory(Plugins)
 add_subdirectory(Symbol)
 add_subdirectory(Target)
 add_subdirectory(Utility)
 
 # Build API last.  Since liblldb needs to link against every other target, it needs
 # those targets to have already been created.
 add_subdirectory(API)

source/lldb.cpp

 //===-- lldb.cpp ------------------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "lldb/lldb-private.h"
 
 using namespace lldb;
 using namespace lldb_private;
 
-#if defined(__APPLE__)
-extern "C" const unsigned char liblldb_coreVersionString[];
-#else
-
 #include "clang/Basic/Version.h"
 
 #ifdef HAVE_SVN_VERSION_INC
 #  include "SVNVersion.inc"
 #endif
 
 static const char *GetLLDBRevision() {
 #ifdef LLDB_REVISION
   return LLDB_REVISION;
 #else
   return NULL;
 #endif
 }
 
 static const char *GetLLDBRepository() {
 #ifdef LLDB_REPOSITORY
   return LLDB_REPOSITORY;
 #else
   return NULL;
 #endif
 }
 
-#endif
 
 const char *lldb_private::GetVersion() {
-#if defined(__APPLE__)
-  static char g_version_string[32];
-  if (g_version_string[0] == '\0') {
-    const char *version_string =
-        ::strstr((const char *)liblldb_coreVersionString, "PROJECT:");
-
-    if (version_string)
-      version_string += sizeof("PROJECT:") - 1;
-    else
-      version_string = "unknown";
-
-    const char *newline_loc = strchr(version_string, '\n');
-
-    size_t version_len = sizeof(g_version_string) - 1;
-
-    if (newline_loc &&
-        (newline_loc - version_string < static_cast<ptrdiff_t>(version_len)))
-      version_len = newline_loc - version_string;
-
-    ::snprintf(g_version_string, version_len + 1, "%s", version_string);
-  }
-
-  return g_version_string;
-#else
   // On platforms other than Darwin, report a version number in the same style
   // as the clang tool.
   static std::string g_version_str;
   if (g_version_str.empty()) {
     g_version_str += "lldb version ";
     g_version_str += CLANG_VERSION_STRING;
     const char *lldb_repo = GetLLDBRepository();
     if (lldb_repo) {
       g_version_str += " (";
       g_version_str += lldb_repo;
     }
 
     const char *lldb_rev = GetLLDBRevision();
     if (lldb_rev) {
       g_version_str += " revision ";
       g_version_str += lldb_rev;
+      g_version_str += ")";
     }
+#ifdef LLDB_VERSION_STRING
+    g_version_str += " (";
+    g_version_str += LLDB_VERSION_STRING;
+    g_version_str += ")";
+#endif
     std::string clang_rev(clang::getClangRevision());
     if (clang_rev.length() > 0) {
-      g_version_str += " clang revision ";
+      g_version_str += "\n  clang revision ";
       g_version_str += clang_rev;
     }
     std::string llvm_rev(clang::getLLVMRevision());
     if (llvm_rev.length() > 0) {
-      g_version_str += " llvm revision ";
+      g_version_str += "\n  llvm revision ";
       g_version_str += llvm_rev;
     }
       
-    if (lldb_repo)
-      g_version_str += ")";
   }
   return g_version_str.c_str();
-#endif
 }