v8-debug.h

Go to the documentation of this file.

// Copyright 2021 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
 
#ifndef INCLUDE_V8_DEBUG_H_
#define INCLUDE_V8_DEBUG_H_
 
#include <stdint.h>
 
#include <span>
 
#include "v8-script.h"  // NOLINT(build/include_directory)
#include "v8config.h"   // NOLINT(build/include_directory)
 
namespace v8 {
 
class Isolate;
class String;
 
class V8_EXPORT StackFrame {
 public:
  Location GetLocation() const;
 
  int GetLineNumber() const { return GetLocation().GetLineNumber() + 1; }
 
  int GetColumn() const { return GetLocation().GetColumnNumber() + 1; }
 
  int GetSourcePosition() const;
 
  int GetScriptId() const;
 
  Local<String> GetScriptName() const;
 
  Local<String> GetScriptNameOrSourceURL() const;
 
  Local<String> GetScriptSource() const;
 
  Local<String> GetScriptSourceMappingURL() const;
 
  Local<String> GetFunctionName() const;
 
  bool IsEval() const;
 
  bool IsConstructor() const;
 
  bool IsWasm() const;
 
  bool IsUserJavaScript() const;
 
  bool IsScriptOpaque() const;
};
 
class V8_EXPORT StackTrace {
 public:
  enum StackTraceOptions {
    kLineNumber = 1,
    kColumnOffset = 1 << 1 | kLineNumber,
    kScriptName = 1 << 2,
    kFunctionName = 1 << 3,
    kIsEval = 1 << 4,
    kIsConstructor = 1 << 5,
    kScriptNameOrSourceURL = 1 << 6,
    kScriptId = 1 << 7,
    kExposeFramesAcrossSecurityOrigins = 1 << 8,
    kOverview = kLineNumber | kColumnOffset | kScriptName | kFunctionName,
    kDetailed = kOverview | kIsEval | kIsConstructor | kScriptNameOrSourceURL
  };
 
  struct ScriptIdAndContext {
    int id;
    v8::Local<v8::Context> context;
  };
 
  struct ScriptData {
    int id;
    v8::Local<v8::Function> function;
    v8::Local<v8::Context> context;
  };
 
  int GetID() const;
 
  Local<StackFrame> GetFrame(Isolate* isolate, uint32_t index) const;
 
  int GetFrameCount() const;
 
  static Local<StackTrace> CurrentStackTrace(
      Isolate* isolate, int frame_limit, StackTraceOptions options = kDetailed);
 
  static Local<String> CurrentScriptNameOrSourceURL(Isolate* isolate);
 
  static int CurrentScriptId(Isolate* isolate);
 
  V8_DEPRECATE_SOON("Use CurrentScriptData instead")
  static std::span<v8::StackTrace::ScriptIdAndContext>
  CurrentScriptIdsAndContexts(Isolate* isolate,
                              std::span<ScriptIdAndContext> frame_data);
 
  static std::span<v8::StackTrace::ScriptData> CurrentScriptData(
      Isolate* isolate, std::span<ScriptData> frame_data);
};
 
}  // namespace v8
 
#endif  // INCLUDE_V8_DEBUG_H_