gdb/python/lib/gdb/command/prompt.py

   1 # Extended prompt.
   2 # Copyright (C) 2011-2025 Free Software Foundation, Inc.
   3
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 """GDB command for working with extended prompts."""
  18
  19 import gdb
  20 import gdb.prompt
  21
  22
  23 class _ExtendedPrompt(gdb.Parameter):
  24     """Set the extended prompt.
  25
  26     Usage: set extended-prompt VALUE
  27
  28     Substitutions are applied to VALUE to compute the real prompt.
  29
  30     The currently defined substitutions are:"""
  31
  32     # Add the prompt library's dynamically generated help to the
  33     # __doc__ string.
  34     __doc__ = __doc__ + "\n" + gdb.prompt.prompt_help()
  35
  36     set_doc = "Set the extended prompt."
  37     show_doc = "Show the extended prompt."
  38
  39     def __init__(self):
  40         super(_ExtendedPrompt, self).__init__(
  41             "extended-prompt", gdb.COMMAND_SUPPORT, gdb.PARAM_STRING_NOESCAPE
  42         )
  43         self.value = ""
  44         self.hook_set = False
  45
  46     def get_show_string(self, pvalue):
  47         if self.value:
  48             return "The extended prompt is: " + self.value
  49         else:
  50             return "The extended prompt is not set."
  51
  52     def get_set_string(self):
  53         if self.hook_set is False:
  54             gdb.prompt_hook = self.before_prompt_hook
  55             self.hook_set = True
  56         return ""
  57
  58     def before_prompt_hook(self, current):
  59         if self.value:
  60             return gdb.prompt.substitute_prompt(self.value)
  61         else:
  62             return None
  63
  64
  65 _ExtendedPrompt()