[swig] Simplify check_lldb_swig_executable_file_exists.

[brucem]

Summary

Remove per-platform variants of this in favor of just having
Windows and Unix. The code that was previously specific to
Linux can be further simplified and used on all non-Windows
platforms that are currently supported as build hosts.

This code only runs when --swigExecutable isn't given on the
command line. cmake always passes that in, so this is never
actually used in current practice.

[zturner]

If it's never used in practice, can you just delete the codepath entirely? I'm a strong proponent of deleting code that nobody cares about. (Of course, if you found this because you do care about it and this codepath didn't work when you tried to use it, that's a different story)

[brucem]

Well, I'm pretty sure ... but I don't know if someone in some configuration or set of build arrangements might use it. It might also be used if we ever make the Makefiles or xcode projects use these scripts.

[zturner]

Eh, just delete it IMO. I don't like leaving code around "just in case". These scripts already need to be practically re-written (due to not using the standard argparse module), the less work we have to do the better. CMake is the only user of this script as far as I know. If it breaks someone they'll chime in presumably

[brucem]

Instead of simplifying, just remove. Expand scope of removal as well.

lldb/trunk/scripts/Python/buildSwigPython.py

 strMsgHdrFiles = "Header files are:"
 strMsgIFaceFiles = "SWIG interface files are"
 strErrMsgProgFail = "Program failure: "
 strMsgFileNewrSwigOpFile = "\'%s\' is newer than \'%s\'\nSWIG file will need to be re-built"
 strMsgFileNotExist = "\'%s\' could not be found\nSWIG file will need to be re-built"
 strErrMsgOsTypeUnknown = "Unable to determine current OS type"
 strMsgNotNeedUpdate = "Everything is up-to-date"
 strMsgSwigNeedRebuild = "SWIG needs to be re-run"
-strErrMsgSwigParamsMissing = "This script was not passed either '--swigExePath \
-or the '--swigExeName' argument. Both are required."
+strErrMsgSwigParamsMissing = "This script was not passed '--swigExecutable' as required."
 strMsgSwigExecute = "SWIG executing the following:\n\'%s'"
 strErrMsgSwigExecute = "SWIG failed: %s"
 strErrMsgPythonExecute = "Python script '%s' failed: %s"
 strMsgSwigNoGenDep = "SWIG ran with no generated dependencies, script exit early"
 strMsgSwigGenDep = "SWIG ran and generated dependencies, script exit early, deleted '%s'"
 strErrMsgFrameWkPyDirNotExist = "Unable to find the LLDB. Framework directory is '%s'"
 strMsgFoundLldbFrameWkDir = "Found '%s'"
 strErrMsgModifyPythonLldbPyFileNotFound = "Unable to find '%s' in '%s'"

 #--
 def do_swig_rebuild(vDictArgs, vstrSwigDepFile, vstrCfgBldDir,
                     vstrSwigOpFile, vstrSwigIpFile):
     dbg = utilsDebug.CDebugFnVerbose("Python script do_swig_rebuild()")
     bOk = True
     strMsg = ""
     bDbg = "-d" in vDictArgs
     bGenDependencies = "-M" in vDictArgs
-    strSwigExePath = vDictArgs["--swigExePath"]
-    strSwigExeName = vDictArgs["--swigExeName"]
+    strSwig = vDictArgs["--swigExecutable"]
     strSrcRoot = vDictArgs["--srcRoot"]
 
-    # Build SWIG path to executable
-    if strSwigExePath != "":
-        strSwig = "%s/%s" % (strSwigExePath, strSwigExeName)
-        strSwig = os.path.normcase(strSwig)
-    else:
-        strSwig = strSwigExeName
-
     strCfg = vstrCfgBldDir
     strOp = vstrSwigOpFile
     strIp = vstrSwigIpFile
     strSi = os.path.normcase("./.")
     strRoot = strSrcRoot + "/include"
     strRoot = os.path.normcase(strRoot)
     strDep = ""
     if bGenDependencies:
Details: This script is to be called by another Python script. It is not
              If environmental variable "LLDB_DISABLE_PYTHON" is defined/exists
              it will cause the script to end early creating nothing.
              If environmental variable "GCC_PREPROCESSOR_DEFINITIONS" is
              defined/exists it will cause the script to end early creating
              nothing.
     Args:     vDictArgs - (R) Map of parameter names to values. Used to for the
                               the SWIG required parameters to create code. Note
                               this container does get amended with more data.
-            -d (optional)   Determines whether or not this script
+            -d (optional)    Determines whether or not this script
                              outputs additional information when running.
-            -m (optional)   Specify called from Makefile system. If given locate
+            -m (optional)    Specify called from Makefile system. If given locate
                              the LLDBWrapPython.cpp in --srcRoot/source folder
                              else in the --targetDir folder.
-            -M (optional)   Specify want SWIG to generate a dependency file.
-            --srcRoot       The root of the lldb source tree.
-            --targetDir     Where the lldb framework/shared library gets put.
-            --cfgBldDir     Where the buildSwigPythonLLDB.py program will
-            (optional)      put the lldb.py file it generated from running
+            -M (optional)    Specify want SWIG to generate a dependency file.
+            --srcRoot        The root of the lldb source tree.
+            --targetDir      Where the lldb framework/shared library gets put.
+            --cfgBldDir      Where the buildSwigPythonLLDB.py program will
+            (optional)       put the lldb.py file it generated from running
                              SWIG.
-            --prefix        Is the root directory used to determine where
-            (optional)      third-party modules for scripting languages should
+            --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.
-            --swigExePath   File path the SWIG executable. (Determined and
+            --swigExecutable Full path to the SWIG executable. (Determined and
                              passed by buildSwigWrapperClasses.py to here)
-            --swigExeName   The file name of the SWIG executable. (Determined
-                            and passed by buildSwigWrapperClasses.py to
-                            here)
     Results:    0 Success
                 1 Success, generated dependencies removed
                   LLDBWrapPython.cpp.d.
                 -100+ Error from this script to the caller script.
                 -100 Error program failure with optional message.
                 -200+ - 200 +- the SWIG exit result.
 
     --------------------------------------------------------------------------
 
 """
 def main(vDictArgs):
     dbg = utilsDebug.CDebugFnVerbose("Python script main()")
     bOk = True
     strMsg = ""
 
-    if not("--swigExePath" in vDictArgs) and ("--swigExeName" in vDictArgs):
+    if not "--swigExecutable" in vDictArgs:
         strErrMsgProgFail += strErrMsgSwigParamsMissing
         return (-100, strErrMsgProgFail)
 
     bDebug = "-d" in vDictArgs
 
     strSwigDepFile = ""
     strSwigDepOptions = ""
     bGenDependencies = "-M" in vDictArgs

lldb/trunk/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\
+    --swigExecutable=   Full path of swig executable.\n\
 \n\
 Usage:\n\
     buildSwigWrapperClasses.py --srcRoot=ADirPath --targetDir=ADirPath\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\
def run_swig_for_each_script_supported(vDictArgs):
     if nResult < 0:
         strTmp = strSwigExecuteError % scriptLang
         strTmp += strStatusMsg
         strStatusMsg = strTmp
 
     return (nResult, strStatusMsg)
 
 #++---------------------------------------------------------------------------
-# Details:  Dummy function - system unknown. Function should not be called.
-# Args:     vDictArgs   - (R) Program input parameters.
-# Returns:  Bool    - False = Program logic error.
-#           Str     - Error message.
-# Throws:   None.
-#--
-def check_lldb_swig_executable_file_exists_Unknown(vDictArgs):
-    dbg = utilsDebug.CDebugFnVerbose("check_lldb_swig_executable_file_exists_Unknown()")
-    # Do nothing
-    return (False, strMsgErrorOsTypeUnknown)
-
-#++---------------------------------------------------------------------------
-# Details:  Locate the SWIG executable file in a Windows system. Several hard
-#           coded predetermined possible file path locations are searched.
-#           (This is good candidate for a derived class object)
-# Args:     vDictArgs   - (W) Program input parameters.
-# Returns:  Bool    - True = Success.
-#                   - False = Failure file not found.
-#           Str     - Error message.
-# Throws:   None.
-#--
-def check_lldb_swig_executable_file_exists_Windows(vDictArgs):
-    dbg = utilsDebug.CDebugFnVerbose("check_lldb_swig_executable_file_exists_Windows()")
-
-    # Will always be true as it assumed the path to SWIG executable will be
-    # in the OS system environmental variable %PATH%. Easier this way as the
-    # user may have renamed the directory and or custom path installation.
-    bExeFileFound = True
-    vDictArgs["--swigExePath"] = ""
-    vDictArgs["--swigExeName"] = "swig.exe"
-    return (bExeFileFound, None)
-
-#++---------------------------------------------------------------------------
-# Details:  Locate the SWIG executable file in a Linux system. Several hard
-#           coded predetermined possible file path locations are searched.
-#           (This is good candidate for a derived class object)
-# Args:     vDictArgs   - (W) Program input parameters.
-# Returns:  Bool    - True = Success.
-#                   - False = Failure file not found.
-#           Str     - Error message.
-# Throws:   None.
-#--
-def check_lldb_swig_executable_file_exists_Linux(vDictArgs):
-    dbg = utilsDebug.CDebugFnVerbose("check_lldb_swig_executable_file_exists_Linux()")
-    bExeFileFound = False
-
-    strSwigExe = "swig"
-    strSwigExePath = "/usr/bin"
-    strExe = os.path.normcase("%s/%s" % (strSwigExePath, strSwigExe))
-    if os.path.isfile(strExe) and os.access(strExe, os.X_OK):
-        bExeFileFound = True
-        vDictArgs["--swigExePath"] = os.path.normcase(strSwigExePath)
-        vDictArgs["--swigExeName"] = strSwigExe
-        return (bExeFileFound, None)
-
-    strSwigExePath = "/usr/local/bin"
-    strExe = os.path.normcase("%s/%s" % (strSwigExePath, strSwigExe))
-    if os.path.isfile(strExe) and os.access(strExe, os.X_OK):
-        bExeFileFound = True
-        vDictArgs["--swigExePath"] = os.path.normcase(strSwigExePath)
-        vDictArgs["--swigExeName"] = strSwigExe
-        return (bExeFileFound, None)
-
-    return (bExeFileFound, strSwigExeFileNotFound)
-
-#++---------------------------------------------------------------------------
-# Details:  Locate the SWIG executable file in a OSX system. Several hard
-#           coded predetermined possible file path locations are searched.
-#           (This is good candidate for a derived class object)
-# Args:     vDictArgs   - (W) Program input parameters.
-# Returns:  Bool    - True = Success.
-#                   - False = Failure file not found.
-#           Str     - Error message.
-# Throws:   None.
-#--
-def check_lldb_swig_executable_file_exists_Darwin(vDictArgs):
-    dbg = utilsDebug.CDebugFnVerbose("check_lldb_swig_executable_file_exists_Darwin()")
-    bExeFileFound = False
-    # ToDo: Find the SWIG executable and add the path to the args dictionary
-    #vDictArgs.["--swigExePath"] = "/usr/bin/swig"
-    strStatusMsg = "Sorry function 'check_lldb_swig_executable_file_exists_Darwin()' is not implemented"
-
-    return (bExeFileFound, strStatusMsg)
-
-#++---------------------------------------------------------------------------
-# Details:  Locate the SWIG executable file in a OSX system. Several hard
-#           coded predetermined possible file path locations are searched.
-#           (This is good candidate for a derived class object)
-# Args:     vDictArgs   - (W) Program input parameters.
-# Returns:  Bool    - True = Success.
-#                   - False = Failure file not found.
-#           Str     - Error message.
-# Throws:   None.
-#--
-def check_lldb_swig_executable_file_exists_FreeBSD(vDictArgs):
-    dbg = utilsDebug.CDebugFnVerbose("check_lldb_swig_executable_file_exists_FreeBSD()")
-    bExeFileFound = False
-    # ToDo: Find the SWIG executable and add the path to the args dictionary
-    #vDictArgs.["--swigExePath"] = "/usr/bin/swig"
-    strStatusMsg = "Sorry function 'check_lldb_swig_executable_file_exists_FreeBSD()' is not implemented"
-
-    return (bExeFileFound, strStatusMsg)
-
-#++---------------------------------------------------------------------------
-# Details:  Locate the SWIG executable file. Several hard coded predetermined
-#           possible file path locations are searched.
-# Args:     vDictArgs   - (RW) Program input parameters.
-#           veOSType    - (R) Current OS type enumeration.
-# Returns:  Bool    - True = Success.
-#                   - 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}
-        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):
def main(vArgv):
     global gbSwigGenDepFileFlag
     gbMakeFileFlag = "-m" in dictArgs
     gbSwigGenDepFileFlag = "-M" in dictArgs
 
     bOk, strMsg = check_lldb_swig_file_exists(dictArgs["--srcRoot"], eOSType)
     if bOk == False:
         program_exit(-3, strMsg)
 
-    bOk, strMsg = check_lldb_swig_executable_file_exists(dictArgs, eOSType)
-    if bOk == False:
-        program_exit(-6, strMsg)
-
     nResult, strMsg = run_swig_for_each_script_supported(dictArgs)
 
     program_exit(nResult, strMsg)
 
 #-----------------------------------------------------------------------------
 #-----------------------------------------------------------------------------
 #-----------------------------------------------------------------------------