ScriptedFrameInterface.h

Go to the documentation of this file.

//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#ifndef LLDB_INTERPRETER_INTERFACES_SCRIPTEDFRAMEINTERFACE_H
#define LLDB_INTERPRETER_INTERFACES_SCRIPTEDFRAMEINTERFACE_H
 
#include "ScriptedInterface.h"
#include "lldb/Core/StructuredDataImpl.h"
#include "lldb/Symbol/SymbolContext.h"
#include "lldb/lldb-private.h"
#include <optional>
#include <string>
 
namespace lldb_private {
class ScriptedFrameInterface : virtual public ScriptedInterface {
public:
  virtual llvm::Expected<StructuredData::GenericSP>
  CreatePluginObject(llvm::StringRef class_name, ExecutionContext &exe_ctx,
                     StructuredData::DictionarySP args_sp,
                     StructuredData::Generic *script_obj = nullptr) = 0;
 
  virtual lldb::user_id_t GetID() { return LLDB_INVALID_FRAME_ID; }
 
  virtual lldb::addr_t GetPC() { return LLDB_INVALID_ADDRESS; }
 
  virtual lldb::addr_t GetCFA() { return LLDB_INVALID_ADDRESS; }
 
  virtual std::optional<SymbolContext> GetSymbolContext() {
    return std::nullopt;
  }
 
  virtual std::optional<std::string> GetFunctionName() { return std::nullopt; }
 
  virtual std::optional<std::string> GetDisplayFunctionName() {
    return std::nullopt;
  }
 
  virtual bool IsInlined() { return false; }
 
  virtual bool IsArtificial() { return false; }
 
  virtual bool IsHidden() { return false; }
 
  virtual StructuredData::DictionarySP GetRegisterInfo() { return {}; }
 
  virtual std::optional<std::string> GetRegisterContext() {
    return std::nullopt;
  }
 
  virtual lldb::ValueObjectListSP GetVariables() { return nullptr; }
 
  /// Report which kind of variable \a valobj is presented as, for instance
  /// \a eValueTypeVariableLocal to have it listed among the frame's locals.
  ///
  /// A ValueObject the ScriptedFrame built itself should have
  /// \a eValueTypeSyntheticFlag set in the ValueType it reports. LLDB uses that
  /// flag to skip the scope rules it applies to a declared variable, which a
  /// made-up ValueObject cannot satisfy: it has no storage to locate, so an
  /// in-scope-only listing drops it. A variable the frame is only forwarding
  /// should leave the flag clear, so those rules still apply to it.
  ///
  /// If this returns std::nullopt, LLDB keeps the ValueType the ValueObject
  /// already reports and adds the synthetic flag to it.
  virtual std::optional<lldb::ValueType>
  GetValueTypeForVariable(lldb::ValueObjectSP valobj) {
    return std::nullopt;
  }
 
  virtual lldb::ValueObjectSP
  GetValueObjectForVariableExpression(llvm::StringRef expr, uint32_t options,
                                      Status &error) {
    return nullptr;
  }
 
  virtual llvm::Expected<ScriptedMetadata>
  GetThreadPlanMetadataForStepType(lldb::StepType step_type) {
    return llvm::createStringError(
        "the current interpreter doesn't support scripted stepping");
  }
};
} // namespace lldb_private
 
#endif // LLDB_INTERPRETER_INTERFACES_SCRIPTEDFRAMEINTERFACE_H