gdb/python/lib/gdb/__init__.py - gdb

Global variables defined

Functions defined

Source code

  1. # Copyright (C) 2010-2015 Free Software Foundation, Inc.

  3. # This program is free software; you can redistribute it and/or modify
  4. # it under the terms of the GNU General Public License as published by
  5. # the Free Software Foundation; either version 3 of the License, or
  6. # (at your option) any later version.
  7. #
  8. # This program is distributed in the hope that it will be useful,
  9. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11. # GNU General Public License for more details.
  12. #
  13. # You should have received a copy of the GNU General Public License
  14. # along with this program.  If not, see <http://www.gnu.org/licenses/>.

  16. import traceback
  17. import os
  18. import sys
  19. import _gdb

  21. if sys.version_info[0] > 2:
  22.     # Python 3 moved "reload"
  23.     from imp import reload

  25. from _gdb import *

  27. class _GdbFile (object):
  28.     # These two are needed in Python 3
  29. ‌    encoding = "UTF-8"
  30. ‌    errors = "strict"

  32.     def close(self):
  33.         # Do nothing.
  34.         return None

  36.     def isatty(self):
  37.         return False

  39.     def writelines(self, iterable):
  40.         for line in iterable:
  41.             self.write(line)

  43.     def flush(self):
  44.         flush()

  46. class GdbOutputFile (_GdbFile):
  47.     def write(self, s):
  48.         write(s, stream=STDOUT)

  50. sys.stdout = GdbOutputFile()

  52. class GdbOutputErrorFile (_GdbFile):
  53.     def write(self, s):
  54.         write(s, stream=STDERR)

  56. sys.stderr = GdbOutputErrorFile()

  58. # Default prompt hook does nothing.
  59. ‌prompt_hook = None

  61. # Ensure that sys.argv is set to something.
  62. # We do not use PySys_SetArgvEx because it did not appear until 2.6.6.
  63. sys.argv = ['']

  65. # Initial pretty printers.
  66. ‌pretty_printers = []

  68. # Initial type printers.
  69. ‌type_printers = []
  70. # Initial xmethod matchers.
  71. ‌xmethods = []
  72. # Initial frame filters.
  73. ‌frame_filters = {}

  75. # Convenience variable to GDB's python directory
  76. ‌PYTHONDIR = os.path.dirname(os.path.dirname(__file__))

  78. # Auto-load all functions/commands.

  80. # Packages to auto-load.

  82. ‌packages = [
  83.     'function',
  84.     'command',
  85.     'printer'
  86. ]

  88. # pkgutil.iter_modules is not available prior to Python 2.6.  Instead,
  89. # manually iterate the list, collating the Python files in each module
  90. # path.  Construct the module name, and import.

  92. ‌def auto_load_packages():
  93.     for package in packages:
  94.         location = os.path.join(os.path.dirname(__file__), package)
  95.         if os.path.exists(location):
  96.             py_files = filter(lambda x: x.endswith('.py')
  97.                                         and x != '__init__.py',
  98.                               os.listdir(location))

  100.             for py_file in py_files:
  101.                 # Construct from foo.py, gdb.module.foo
  102.                 modname = "%s.%s.%s" % ( __name__, package, py_file[:-3] )
  103.                 try:
  104.                     if modname in sys.modules:
  105.                         # reload modules with duplicate names
  106.                         reload(__import__(modname))
  107.                     else:
  108.                         __import__(modname)
  109.                 except:
  110.                     sys.stderr.write (traceback.format_exc() + "\n")

  112. auto_load_packages()

  114. ‌def GdbSetPythonDirectory(dir):
  115.     """Update sys.path, reload gdb and auto-load packages."""
  116.     global PYTHONDIR

  118.     try:
  119.         sys.path.remove(PYTHONDIR)
  120.     except ValueError:
  121.         pass
  122.     sys.path.insert(0, dir)

  124.     PYTHONDIR = dir

  126.     # note that reload overwrites the gdb module without deleting existing
  127.     # attributes
  128.     reload(__import__(__name__))
  129.     auto_load_packages()