| """ Python SWIG post process script for each language |
| |
| -------------------------------------------------------------------------- |
| File: finishSwigPythonLLDB.py |
| |
| Overview: Python script(s) to post process SWIG Python C++ Script |
| Bridge wrapper code on the Windows/LINUX/OSX platform. |
| The Python scripts are equivalent to the shell script (.sh) |
| files. |
| For the Python script interpreter (external to liblldb) to |
| be able to import and use the lldb module, there must be |
| two files, lldb.py and _lldb.so, that it can find. lldb.py |
| is generated by SWIG at the same time it generates the C++ |
| file. _lldb.so is actually a symlink file that points to |
| the LLDB shared library/framework. |
| The Python script interpreter needs to be able to |
| automatically find these two files. On Darwin systems it |
| searches in the LLDB.framework, as well as in all the normal |
| Python search paths. On non-Darwin systems these files will |
| need to be put some place where Python will find them. |
| This shell script creates the _lldb.so symlink in the |
| appropriate place, and copies the lldb.py (and |
| embedded_interpreter.py) file to the correct directory. |
| |
| Gotchas: Python debug complied pythonXX_d.lib is required for SWIG |
| to build correct LLDBWrapperPython.cpp in order for Visual |
| Studio to compile successfully. The release version of the |
| Python lib will not work (20/12/2013). |
| LLDB (dir) CMakeLists.txt uses windows environmental |
| variables $PYTHON_INCLUDE and $PYTHON_LIB to locate |
| Python files required for the build. |
| |
| Copyright: None. |
| -------------------------------------------------------------------------- |
| |
| """ |
| |
| # Python modules: |
| import os # Provide directory and file handling, determine OS information |
| import sys # System specific parameters and functions |
| import shutil # High-level operations on files and collections of files |
| import ctypes # Invoke Windows API for creating symlinks |
| |
| # Third party modules: |
| |
| # In-house modules: |
| import utilsOsType # Determine the OS type this script is running on |
| import utilsDebug # Debug Python scripts |
| |
| # User facing text: |
| strMsgOsVersion = "The current OS is %s" |
| strMsgPyVersion = "The Python version is %d.%d" |
| strErrMsgProgFail = "Program failure: " |
| strErrMsgLLDBPyFileNotNotFound = "Unable to locate lldb.py at path '%s'" |
| strMsgCopyLLDBPy = "Copying lldb.py from '%s' to '%s'" |
| strErrMsgFrameWkPyDirNotExist = "Unable to find the LLDB.framework directory '%s'" |
| strMsgCreatePyPkgCopyPkgFile = "create_py_pkg: Copied file '%s' to folder '%s'" |
| strMsgCreatePyPkgInitFile = "create_py_pkg: Creating pakage init file '%s'" |
| strMsgCreatePyPkgMkDir = "create_py_pkg: Created folder '%s'" |
| strMsgConfigBuildDir = "Configuration build directory located at '%s'" |
| strMsgFoundLldbFrameWkDir = "Found '%s'" |
| strMsgPyFileLocatedHere = "Python file will be put in '%s'" |
| strMsgFrameWkPyExists = "Python output folder '%s' already exists" |
| strMsgFrameWkPyMkDir = "Python output folder '%s' will be created" |
| strErrMsgCreateFrmWkPyDirFailed = "Unable to create directory '%s' error: %s" |
| strMsgSymlinkExists = "Symlink for '%s' already exists" |
| strMsgSymlinkMk = "Creating symlink for %s (%s -> %s)" |
| strErrMsgCpLldbpy = "copying lldb to lldb package directory" |
| strErrMsgCreatePyPkgMissingSlash = "Parameter 3 fn create_py_pkg() missing slash" |
| strErrMsgMkLinkExecute = "Command mklink failed: %s" |
| strErrMsgMakeSymlink = "creating symbolic link" |
| strErrMsgUnexpected = "Unexpected error: %s" |
| strMsgCopySixPy = "Copying six.py from '%s' to '%s'" |
| strErrMsgCopySixPyFailed = "Unable to copy '%s' to '%s'" |
| |
| |
| #++--------------------------------------------------------------------------- |
| # Details: Create Python packages and Python __init__ files. |
| # Args: vDictArgs - (R) Program input parameters. |
| # vstrFrameworkPythonDir - (R) Python framework directory. |
| # vstrPkgDir - (R) Destination for copied Python files. |
| # vListPkgFiles - (R) List of source Python files. |
| # Returns: Bool - True = function success, False = failure. |
| # Str - Error description on task failure. |
| # Throws: None. |
| #-- |
| |
| |
| def create_py_pkg( |
| vDictArgs, |
| vstrFrameworkPythonDir, |
| vstrPkgDir, |
| vListPkgFiles): |
| dbg = utilsDebug.CDebugFnVerbose("Python script create_py_pkg()") |
| dbg.dump_object("Package file(s):", vListPkgFiles) |
| bDbg = "-d" in vDictArgs |
| |
| bOk = True |
| strMsg = "" |
| |
| if vstrPkgDir.__len__() != 0 and vstrPkgDir[0] != "/": |
| bOk = False |
| strMsg = strErrMsgCreatePyPkgMissingSlash |
| return (bOk, strMsg) |
| |
| strPkgName = vstrPkgDir |
| strPkgName = "lldb" + strPkgName.replace("/", ".") |
| |
| strPkgDir = vstrFrameworkPythonDir |
| strPkgDir += vstrPkgDir |
| strPkgDir = os.path.normcase(strPkgDir) |
| |
| if not(os.path.exists(strPkgDir) and os.path.isdir(strPkgDir)): |
| if bDbg: |
| print((strMsgCreatePyPkgMkDir % strPkgDir)) |
| os.makedirs(strPkgDir) |
| |
| for strPkgFile in vListPkgFiles: |
| if os.path.exists(strPkgFile) and os.path.isfile(strPkgFile): |
| if bDbg: |
| print((strMsgCreatePyPkgCopyPkgFile % (strPkgFile, strPkgDir))) |
| shutil.copy(strPkgFile, strPkgDir) |
| |
| # Create a packet init files if there wasn't one |
| strPkgIniFile = os.path.normpath(os.path.join(strPkgDir, "__init__.py")) |
| if os.path.exists(strPkgIniFile) and os.path.isfile(strPkgIniFile): |
| return (bOk, strMsg) |
| |
| strPyScript = "__all__ = [" |
| strDelimiter = "" |
| for strPkgFile in vListPkgFiles: |
| if os.path.exists(strPkgFile) and os.path.isfile(strPkgFile): |
| strBaseName = os.path.basename(strPkgFile) |
| nPos = strBaseName.find(".") |
| if nPos != -1: |
| strBaseName = strBaseName[0: nPos] |
| strPyScript += "%s\"%s\"" % (strDelimiter, strBaseName) |
| strDelimiter = "," |
| strPyScript += "]\n" |
| strPyScript += "for x in __all__:\n" |
| strPyScript += "\t__import__('%s.' + x)" % strPkgName |
| |
| if bDbg: |
| print((strMsgCreatePyPkgInitFile % strPkgIniFile)) |
| file = open(strPkgIniFile, "w") |
| file.write(strPyScript) |
| file.close() |
| |
| return (bOk, strMsg) |
| |
| |
| #++--------------------------------------------------------------------------- |
| # Details: Retrieve the directory path for Python's dist_packages/ |
| # site_package folder depending on the type of OS platform being |
| # used. |
| # Args: vDictArgs - (R) Program input parameters. |
| # Returns: Bool - True = function success, False = failure. |
| # Str - Python Framework directory path. |
| # strErrMsg - Error description on task failure. |
| # Throws: None. |
| #-- |
| |
| |
| def get_framework_python_dir(vDictArgs): |
| dbg = utilsDebug.CDebugFnVerbose( |
| "Python script get_framework_python_dir()") |
| bOk = True |
| strErrMsg = "" |
| strWkDir = os.path.normpath(vDictArgs["--lldbPythonPath"]) |
| return (bOk, strWkDir, strErrMsg) |
| |
| #----------------------------------------------------------------------------- |
| #----------------------------------------------------------------------------- |
| #----------------------------------------------------------------------------- |
| |
| """ Details: Program main entry point fn. Called by another Python script. |
| |
| -------------------------------------------------------------------------- |
| Details: This script is to be called by another Python script. It is not |
| intended to be called directly i.e from the command line. |
| Args: vDictArgs - (R) Map of parameter names to values. |
| -d (optional) Determines whether or not this script |
| outputs additional information when running. |
| -m (optional) Specify called from Makefile system. If given locate |
| the LLDBWrapPython.cpp in --srcRoot/source folder |
| else in the --targetDir folder. |
| --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 |
| be installed. Where non-Darwin systems want to put |
| the .py and .so files so that Python can find them |
| automatically. Python install directory. |
| --lldbLibDir The name of the directory containing liblldb.so. |
| (optional) "lib" by default. |
| Results: 0 Success |
| -100+ Error from this script to the caller script. |
| -100 Error program failure with optional message. |
| |
| -------------------------------------------------------------------------- |
| |
| """ |
| |
| |
| def main(vDictArgs): |
| dbg = utilsDebug.CDebugFnVerbose("Python script main()") |
| bOk = True |
| strMsg = "" |
| strErrMsgProgFail = "" |
| |
| bDbg = "-d" in vDictArgs |
| |
| eOSType = utilsOsType.determine_os_type() |
| if bDbg: |
| pyVersion = sys.version_info |
| print((strMsgOsVersion % utilsOsType.EnumOsType.name_of(eOSType))) |
| print((strMsgPyVersion % (pyVersion[0], pyVersion[1]))) |
| |
| bOk, strFrameworkPythonDir, strMsg = get_framework_python_dir(vDictArgs) |
| |
| strRoot = os.path.normpath(vDictArgs["--srcRoot"]) |
| if bOk: |
| # lldb |
| listPkgFiles = [ |
| os.path.join( |
| strRoot, |
| "source", |
| "Interpreter", |
| "embedded_interpreter.py")] |
| bOk, strMsg = create_py_pkg( |
| vDictArgs, strFrameworkPythonDir, "", listPkgFiles) |
| |
| if bOk: |
| # lldb/formatters/cpp |
| listPkgFiles = [ |
| os.path.join( |
| strRoot, |
| "examples", |
| "synthetic", |
| "gnu_libstdcpp.py"), |
| os.path.join( |
| strRoot, |
| "examples", |
| "synthetic", |
| "libcxx.py")] |
| bOk, strMsg = create_py_pkg( |
| vDictArgs, strFrameworkPythonDir, "/formatters/cpp", listPkgFiles) |
| |
| if bOk: |
| # Make an empty __init__.py in lldb/runtime as this is required for |
| # Python to recognize lldb.runtime as a valid package (and hence, |
| # lldb.runtime.objc as a valid contained package) |
| listPkgFiles = [] |
| bOk, strMsg = create_py_pkg( |
| vDictArgs, strFrameworkPythonDir, "/runtime", listPkgFiles) |
| |
| if bOk: |
| # lldb/formatters |
| # Having these files copied here ensure that lldb/formatters is a |
| # valid package itself |
| listPkgFiles = [ |
| os.path.join( |
| strRoot, "examples", "summaries", "cocoa", "cache.py"), os.path.join( |
| strRoot, "examples", "summaries", "synth.py"), os.path.join( |
| strRoot, "examples", "summaries", "cocoa", "metrics.py"), os.path.join( |
| strRoot, "examples", "summaries", "cocoa", "attrib_fromdict.py"), os.path.join( |
| strRoot, "examples", "summaries", "cocoa", "Logger.py")] |
| bOk, strMsg = create_py_pkg( |
| vDictArgs, strFrameworkPythonDir, "/formatters", listPkgFiles) |
| |
| if bOk: |
| # lldb/utils |
| listPkgFiles = [ |
| os.path.join( |
| strRoot, |
| "examples", |
| "python", |
| "symbolication.py")] |
| bOk, strMsg = create_py_pkg( |
| vDictArgs, strFrameworkPythonDir, "/utils", listPkgFiles) |
| |
| if bOk and (eOSType == utilsOsType.EnumOsType.Darwin): |
| # lldb/macosx |
| listPkgFiles = [ |
| os.path.join( |
| strRoot, |
| "examples", |
| "python", |
| "crashlog.py"), |
| os.path.join( |
| strRoot, |
| "examples", |
| "darwin", |
| "heap_find", |
| "heap.py")] |
| bOk, strMsg = create_py_pkg( |
| vDictArgs, strFrameworkPythonDir, "/macosx", listPkgFiles) |
| |
| if bOk and (eOSType == utilsOsType.EnumOsType.Darwin): |
| # lldb/diagnose |
| listPkgFiles = [ |
| os.path.join( |
| strRoot, |
| "examples", |
| "python", |
| "diagnose_unwind.py"), |
| os.path.join( |
| strRoot, |
| "examples", |
| "python", |
| "diagnose_nsstring.py")] |
| bOk, strMsg = create_py_pkg( |
| vDictArgs, strFrameworkPythonDir, "/diagnose", listPkgFiles) |
| |
| if bOk: |
| return (0, strMsg) |
| else: |
| strErrMsgProgFail += strMsg |
| return (-100, strErrMsgProgFail) |
| |
| |
| #----------------------------------------------------------------------------- |
| #----------------------------------------------------------------------------- |
| #----------------------------------------------------------------------------- |
| |
| # This script can be called by another Python script by calling the main() |
| # function directly |
| if __name__ == "__main__": |
| print("Script cannot be called directly, called by finishSwigWrapperClasses.py") |
