aboutsummaryrefslogtreecommitdiff
path: root/gdb/python/lib/gdb/dap/evaluate.py
blob: 635a05fcdcd91dd48ccaf9b7b2cae8b7801fac87 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# Copyright 2022, 2023 Free Software Foundation, Inc.

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

import gdb
import gdb.printing

# This is deprecated in 3.9, but required in older versions.
from typing import Optional

from .frames import select_frame
from .server import capability, request, client_bool_capability
from .startup import send_gdb_with_response, in_gdb_thread
from .varref import find_variable, VariableReference


class EvaluateResult(VariableReference):
    def __init__(self, value):
        super().__init__(None, value, "result")


# Helper function to evaluate an expression in a certain frame.
@in_gdb_thread
def _evaluate(expr, frame_id):
    global_context = True
    if frame_id is not None:
        select_frame(frame_id)
        global_context = False
    val = gdb.parse_and_eval(expr, global_context=global_context)
    ref = EvaluateResult(val)
    return ref.to_object()


# Like _evaluate but ensure that the expression cannot cause side
# effects.
@in_gdb_thread
def _eval_for_hover(expr, frame_id):
    with gdb.with_parameter("may-write-registers", "off"):
        with gdb.with_parameter("may-write-memory", "off"):
            with gdb.with_parameter("may-call-functions", "off"):
                return _evaluate(expr, frame_id)


class _SetResult(VariableReference):
    def __init__(self, value):
        super().__init__(None, value, "value")

    def to_object(self):
        result = super().to_object()
        # This is not specified in the setExpression result.
        if "memoryReference" in result:
            del result["memoryReference"]
        return result


# Helper function to perform an assignment.
@in_gdb_thread
def _set_expression(expression, value, frame_id):
    global_context = True
    if frame_id is not None:
        select_frame(frame_id)
        global_context = False
    lhs = gdb.parse_and_eval(expression, global_context=global_context)
    rhs = gdb.parse_and_eval(value, global_context=global_context)
    lhs.assign(rhs)
    return _SetResult(lhs).to_object()


# Helper function to evaluate a gdb command in a certain frame.
@in_gdb_thread
def _repl(command, frame_id):
    if frame_id is not None:
        select_frame(frame_id)
    val = gdb.execute(command, from_tty=True, to_string=True)
    return {
        "result": val,
        "variablesReference": 0,
    }


@request("evaluate")
@capability("supportsEvaluateForHovers")
def eval_request(
    *,
    expression: str,
    frameId: Optional[int] = None,
    context: str = "variables",
    **args,
):
    if context in ("watch", "variables"):
        # These seem to be expression-like.
        return send_gdb_with_response(lambda: _evaluate(expression, frameId))
    elif context == "hover":
        return send_gdb_with_response(lambda: _eval_for_hover(expression, frameId))
    elif context == "repl":
        return send_gdb_with_response(lambda: _repl(expression, frameId))
    else:
        raise Exception('unknown evaluate context "' + context + '"')


@in_gdb_thread
def _variables(ref, start, count):
    var = find_variable(ref)
    children = var.fetch_children(start, count)
    return [x.to_object() for x in children]


@request("variables")
# Note that we ignore the 'filter' field.  That seems to be
# specific to javascript.
def variables(*, variablesReference: int, start: int = 0, count: int = 0, **args):
    # This behavior was clarified here:
    # https://github.com/microsoft/debug-adapter-protocol/pull/394
    if not client_bool_capability("supportsVariablePaging"):
        start = 0
        count = 0
    result = send_gdb_with_response(
        lambda: _variables(variablesReference, start, count)
    )
    return {"variables": result}


@capability("supportsSetExpression")
@request("setExpression")
def set_expression(
    *, expression: str, value: str, frameId: Optional[int] = None, **args
):
    return send_gdb_with_response(lambda: _set_expression(expression, value, frameId))