Change the way SWIG is found, and fixed a typo in OS detection

[ismailp]

Summary

SWIG is searched under certain paths within python script. CMake can
detect SWIG with find_package(SWIG). This is used iff user checks
LLDB_ENABLE_PYTHON_SCRIPTS_SWIG_API_GENERATION. If
buildSwigWrapperClasses.py does not receive swigExecutable argument,
then script will use its current search implementation.

This patch also fixes a typo in OS detection, where there is one too
many equals in the assignment for Darwin.

[zturner]

I'll take a look at this on Monday. What does this fix exactly? Does it just mean that swig no longer has to be in system PATH because it can be found by CMake?

[ismailp]

On Darwin, if LLDB_ENABLE_PYTHON_SCRIPTS_SWIG_API_GENERATION is enabled, OS detection was failing. This is fixed in scripts/utilsOsType.py:80.

Fixing that didn't help; scripts/buildSwigWrapperClasses.py was not finding SWIG on Darwin. Instead of offloading finding SWIG in path to python, I thought adding find_package(SWIG) would make sense, because user has selected LLDB_ENABLE_PYTHON_SCRIPTS_SWIG_API_GENERATION in CMake.

[emaste]

scripts/utilsOsType.py

74–81 ↗

(On Diff #16278)

This is also broken for FreeBSD. I can take care of that and this Darwin fix in a moment.

[emaste]

Overall seems like a good idea - one thing I don't understand is marked above.

This could be useful for FreeBSD as well, as the swig 2.0 package installs swig as swig2 (or similar), and so swig is not found in the PATH.

scripts/CMakeLists.txt

12

I must be missing something -- I don't see how swigDir is used.

[ismailp]

scripts/CMakeLists.txt

12

CMake is setting that variable. That directory seems like to include skeleton/template/boilerplate files. buildSwigWrapperClasses.py, however, doesn't use it. I thought it might be useful in the future, and kept it. Perhaps it's best to remove it to prevent confusion.

[emaste]

scripts/CMakeLists.txt

12

Yeah, if there are no consumers yet I would leave it out for now. Or, add a comment that it's not yet used but will be soon if that's the case.

[zturner]

I would just leave it out until we have an actual need for it. No reason
to add complexity (however small) that nobody needs.

[ismailp]

Removed swigDir argument from both scripts/CMakeLists.txt, and scripts/buildSwigWrapperClasses.py.

[emaste]

LGTM

[ismailp]

Landed in 222262. Thanks! I can't seem to have Close Revision option, presumably because it wasn't accepted. Please do "Accept Revision" so that it can be closed.

[emaste]

BTW, if you include in the commit message

Differential Revision: http://reviews.llvm.org/D6290

it will auto-close when Phabricator sees the commit.

[ismailp]

Correct! My git-svn failed 3 times, then I checked out lldb svn repo,
and copied message from phabricator instead of original git commit.

[ismailp]

Closing. This has landed in r222262.

scripts/CMakeLists.txt

 set(LLVM_NO_RTTI 1)
 
 file(GLOB SWIG_INPUTS Python/interface/*.i)
 
 if ( LLDB_ENABLE_PYTHON_SCRIPTS_SWIG_API_GENERATION )
+  find_package(SWIG REQUIRED)
   add_custom_command(
     OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/LLDBWrapPython.cpp
     DEPENDS ${LLDB_SOURCE_DIR}/scripts/lldb.swig
     DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/buildSwigWrapperClasses.py
-    DEPENDS ${SWIG_INPUTS}  
-    COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/buildSwigWrapperClasses.py "--srcRoot=${LLDB_SOURCE_DIR}" "--targetDir=${CMAKE_CURRENT_BINARY_DIR}" "--cfgBldDir=${CMAKE_CURRENT_BINARY_DIR}" "--prefix=${CMAKE_BINARY_DIR}" -m    
+    DEPENDS ${SWIG_INPUTS}
+    COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/buildSwigWrapperClasses.py "--srcRoot=${LLDB_SOURCE_DIR}" "--targetDir=${CMAKE_CURRENT_BINARY_DIR}" "--cfgBldDir=${CMAKE_CURRENT_BINARY_DIR}" "--prefix=${CMAKE_BINARY_DIR}" "--swigExecutable=${SWIG_EXECUTABLE}" -m
     COMMENT "Python script building LLDB Python wrapper")  
   set_source_files_properties(${CMAKE_CURRENT_BINARY_DIR}/LLDBWrapPython.cpp PROPERTIES GENERATED 1)
 
   ADD_CUSTOM_TARGET(swig_wrapper ALL echo -n
     DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/LLDBWrapPython.cpp
     )
 
   # Install the LLDB python module on all operating systems (except Windows)

scripts/buildSwigWrapperClasses.py

--cfgBldDir=  (optional) Where the build-swig-Python-LLDB.py program \n\
       SWIG.\n\
   --prefix=   (optional) Is the root directory used to determine where\n\
       third-party modules for scripting languages should\n\
       be installed. Where non-Darwin systems want to put\n\
       the .py and .so files so that Python can find them\n\
       automatically. Python install directory.\n\
   --argsFile= The args are read from a file instead of the\n\
       command line. Other command line args are ignored.\n\
+  --swigExecutable= (optional) Full path of swig executable.\n\
 \n\
 Usage:\n\
   buildSwigWrapperClasses.py --srcRoot=ADirPath --targetDir=ADirPath\n\
-  --cfgBldDir=ADirPath --prefix=ADirPath -m -d\n\
+  --cfgBldDir=ADirPath --prefix=ADirPath --swigExecutable=ADirPath -m -d\n\
 \n\
 "; #TAG_PROGRAM_HELP_INFO
 strHelpInfoExtraWindows = "\
 On the Windows platform the PATH environmental variable needs to be \n\
 extended to include the installed SWIG executable path so it can be \n\
 be found by this Python script. The SWIG executable name is 'swig'."
 strHelpInfoExtraNonWindows = "\
 This Python script looks for the SWIG executable 'swig' in the following \n\

 #         - False = Failure file not found.
 #     Str   - Error message.
 # Throws: None.
 #--
 def check_lldb_swig_executable_file_exists( vDictArgs, veOSType ):
   dbg = utilsDebug.CDebugFnVerbose( "check_lldb_swig_executable_file_exists()" );
   bExeFileFound = False;
   strStatusMsg = "";
+  if "--swigExecutable" in vDictArgs:
+    vDictArgs["--swigExeName"] = os.path.basename(vDictArgs["--swigExecutable"])
+    vDictArgs["--swigExePath"] = os.path.dirname(vDictArgs["--swigExecutable"])
+    bExeFileFound = True
+  else:
     from utilsOsType import EnumOsType;
-
     switch = { EnumOsType.Unknown : check_lldb_swig_executable_file_exists_Unknown,
          EnumOsType.Darwin : check_lldb_swig_executable_file_exists_Darwin,
          EnumOsType.FreeBSD : check_lldb_swig_executable_file_exists_FreeBSD,
          EnumOsType.Linux : check_lldb_swig_executable_file_exists_Linux,
-               EnumOsType.Windows : check_lldb_swig_executable_file_exists_Windows }
+         EnumOsType.Windows : check_lldb_swig_executable_file_exists_Windows }
     bExeFileFound, strStatusMsg = switch[ veOSType ]( vDictArgs );
-  
   return (bExeFileFound, strStatusMsg);
-
 #++---------------------------------------------------------------------------
 # Details:  Validate the arguments passed to the program. This function exits
 #     the program should error with the arguments be found.
 # Args:   vArgv - (R) List of arguments and values.
 # Returns:  Int   - 0 = success, -ve = some failure.
 #     Dict  - Map of arguments names to argument values
 # Throws: None.
 #--
 def validate_arguments( vArgv ):
   dbg = utilsDebug.CDebugFnVerbose( "validate_arguments()" );
   strMsg = "";
   dictArgs = {};
   nResult = 0;
   strListArgs = "hdmM"; # Format "hiox:" = -h -i -o -x <arg>
-  listLongArgs = ["srcRoot=", "targetDir=", "cfgBldDir=", "prefix=", 
-          "argsFile"];
+  listLongArgs = ["srcRoot=", "targetDir=", "cfgBldDir=", "prefix=",
+      "swigExecutable=", "argsFile"];
   dictArgReq = {  "-h": "o",      # o = optional, m = mandatory
           "-d": "o",
           "-m": "o",
           "-M": "o",
           "--srcRoot": "m",
           "--targetDir": "m",
+          "--swigExecutable" : "o",
           "--cfgBldDir": "o",
           "--prefix": "o",
           "--argsFile": "o" };
   strHelpInfo = get_help_information();
   
   # Check for mandatory parameters
   nResult, dictArgs, strMsg = utilsArgsParse.parse( vArgv, strListArgs,
                             listLongArgs,
Args: -h (optional) Print help information on this program.
       --prefix=     Is the root directory used to determine where 
       (optional)    third-party modules for scripting languages should 
               be installed. Where non-Darwin systems want to put 
               the .py and .so files so that Python can find them 
               automatically. Python install directory.
       --argsFile=   The args are read from a file instead of the
               command line. Other command line args are ignored.
   Usage:
-      buildSwigWrapperClasses.py --srcRoot=ADirPath --targetDir=ADirPath 
-      --cfgBldDir=ADirPath --prefix=ADirPath -m -d
+      buildSwigWrapperClasses.py --srcRoot=ADirPath --targetDir=ADirPath
+      --cfgBldDir=ADirPath --prefix=ADirPath --swigExecutable=ADirPath -m -d
 
   Results:  0 Success
         -1 Error - invalid parameters passed.
         -2 Error - incorrect number of mandatory parameters passed.
         -3 Error - unable to locate lldb.swig file.
         -4 Error - unable to determine OS type.
         -5 Error - program called by another Python script not allowed.
         -6 Error - unable to locate the swig executable file.

scripts/utilsArgsParse.py

 #--
 def parse( vArgv, vstrListArgs, vListLongArgs, vDictArgReq, vstrHelpInfo ):
   dictArgs = {};
   dictDummy = {};
   strDummy = "";
       
   # Validate parameters above and error on not recognised
   try:
-    dictOptsNeeded, dictArgsLeftOver = getopt.getopt( vArgv, 
+    dictOptsNeeded, dictArgsLeftOver = getopt.getopt( vArgv,
                               vstrListArgs, 
                               vListLongArgs );
   except getopt.GetoptError:
     strMsg = strMsgErrorInvalidParameters;
     strMsg += str( vArgv );
     return (-1, dictDummy, strMsg);
 
   if len( dictOptsNeeded ) == 0:
def parse( vArgv, vstrListArgs, vListLongArgs, vDictArgReq, vstrHelpInfo ):
   
   # Do we have the exact number of mandatory arguments
   if (countMandatoryOpts > 0) and (countMandatory != countMandatoryOpts):
     strMsg = strMsgErrorNumberParameters % countMandatory;
     strMsg += str( vArgv );
     return (-2, dictDummy, strMsg);
 
   return (0, dictArgs, strDummy);
-