]>
git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/python/lib/gdb/prompt.py
1 # Extended prompt utilities.
2 # Copyright (C) 2011-2024 Free Software Foundation, Inc.
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.
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.
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/>.
17 """ Extended prompt library functions."""
23 def _prompt_pwd(ignore
):
24 "The current working directory."
28 def _prompt_object_attr(func
, what
, attr
, nattr
):
29 """Internal worker for fetching GDB attributes."""
35 return "<no %s>" % what
36 if hasattr(obj
, attr
):
37 result
= getattr(obj
, attr
)
42 return "<no attribute %s on current %s>" % (attr
, what
)
45 def _prompt_frame(attr
):
46 "The selected frame; an argument names a frame parameter."
47 return _prompt_object_attr(gdb
.selected_frame
, "frame", attr
, "name")
50 def _prompt_thread(attr
):
51 "The selected thread; an argument names a thread parameter."
52 return _prompt_object_attr(gdb
.selected_thread
, "thread", attr
, "num")
55 def _prompt_version(attr
):
60 def _prompt_esc(attr
):
80 def _prompt_param(attr
):
81 "A parameter's value; the argument names the parameter."
82 return gdb
.parameter(attr
)
85 def _prompt_noprint_begin(attr
):
86 "Begins a sequence of non-printing characters."
90 def _prompt_noprint_end(attr
):
91 "Ends a sequence of non-printing characters."
95 prompt_substitutions
= {
100 "v": _prompt_version
,
105 "[": _prompt_noprint_begin
,
106 "]": _prompt_noprint_end
,
111 """Generate help dynamically from the __doc__ strings of attribute
115 keys
= sorted(prompt_substitutions
.keys())
117 result
+= " \\%s\t%s\n" % (key
, prompt_substitutions
[key
].__doc
__)
119 A substitution can be used in a simple form, like "\\f".
120 An argument can also be passed to it, like "\\f{name}".
121 The meaning of the argument depends on the particular substitution."""
125 def substitute_prompt(prompt
):
126 "Perform substitutions on PROMPT."
132 if prompt
[i
] == "\\":
138 if cmdch
in prompt_substitutions
:
139 cmd
= prompt_substitutions
[cmdch
]
141 if i
+ 1 < plen
and prompt
[i
+ 1] == "{":
143 while j
< plen
and prompt
[j
] != "}":
145 # Just ignore formatting errors.
146 if j
>= plen
or prompt
[j
] != "}":
149 arg
= prompt
[i
+ 2 : j
]
153 result
+= str(cmd(arg
))
155 # Unrecognized escapes are turned into the escaped