File Explorer

1// Copyright 2021 the V8 project authors. All rights reserved.2// Use of this source code is governed by a BSD-style license that can be3// found in the LICENSE file.4 5#ifndef INCLUDE_V8_DEBUG_H_6#define INCLUDE_V8_DEBUG_H_7 8#include <stdint.h>9 10#include "v8-script.h"  // NOLINT(build/include_directory)11#include "v8config.h"   // NOLINT(build/include_directory)12 13namespace v8 {14 15class Isolate;16class String;17 18/**19 * A single JavaScript stack frame.20 */21class V8_EXPORT StackFrame {22 public:23  /**24   * Returns the source location, 0-based, for the associated function call.25   */26  Location GetLocation() const;27 28  /**29   * Returns the number, 1-based, of the line for the associate function call.30   * This method will return Message::kNoLineNumberInfo if it is unable to31   * retrieve the line number, or if kLineNumber was not passed as an option32   * when capturing the StackTrace.33   */34  int GetLineNumber() const { return GetLocation().GetLineNumber() + 1; }35 36  /**37   * Returns the 1-based column offset on the line for the associated function38   * call.39   * This method will return Message::kNoColumnInfo if it is unable to retrieve40   * the column number, or if kColumnOffset was not passed as an option when41   * capturing the StackTrace.42   */43  int GetColumn() const { return GetLocation().GetColumnNumber() + 1; }44 45  /**46   * Returns zero based source position (character offset) for the associated47   * function.48   */49  int GetSourcePosition() const;50 51  /**52   * Returns the id of the script for the function for this StackFrame.53   * This method will return Message::kNoScriptIdInfo if it is unable to54   * retrieve the script id, or if kScriptId was not passed as an option when55   * capturing the StackTrace.56   */57  int GetScriptId() const;58 59  /**60   * Returns the name of the resource that contains the script for the61   * function for this StackFrame.62   */63  Local<String> GetScriptName() const;64 65  /**66   * Returns the name of the resource that contains the script for the67   * function for this StackFrame or sourceURL value if the script name68   * is undefined and its source ends with //# sourceURL=... string or69   * deprecated //@ sourceURL=... string.70   */71  Local<String> GetScriptNameOrSourceURL() const;72 73  /**74   * Returns the source of the script for the function for this StackFrame.75   */76  Local<String> GetScriptSource() const;77 78  /**79   * Returns the source mapping URL (if one is present) of the script for80   * the function for this StackFrame.81   */82  Local<String> GetScriptSourceMappingURL() const;83 84  /**85   * Returns the name of the function associated with this stack frame.86   */87  Local<String> GetFunctionName() const;88 89  /**90   * Returns whether or not the associated function is compiled via a call to91   * eval().92   */93  bool IsEval() const;94 95  /**96   * Returns whether or not the associated function is called as a97   * constructor via "new".98   */99  bool IsConstructor() const;100 101  /**102   * Returns whether or not the associated functions is defined in wasm.103   */104  bool IsWasm() const;105 106  /**107   * Returns whether or not the associated function is defined by the user.108   */109  bool IsUserJavaScript() const;110};111 112/**113 * Representation of a JavaScript stack trace. The information collected is a114 * snapshot of the execution stack and the information remains valid after115 * execution continues.116 */117class V8_EXPORT StackTrace {118 public:119  /**120   * Flags that determine what information is placed captured for each121   * StackFrame when grabbing the current stack trace.122   * Note: these options are deprecated and we always collect all available123   * information (kDetailed).124   */125  enum StackTraceOptions {126    kLineNumber = 1,127    kColumnOffset = 1 << 1 | kLineNumber,128    kScriptName = 1 << 2,129    kFunctionName = 1 << 3,130    kIsEval = 1 << 4,131    kIsConstructor = 1 << 5,132    kScriptNameOrSourceURL = 1 << 6,133    kScriptId = 1 << 7,134    kExposeFramesAcrossSecurityOrigins = 1 << 8,135    kOverview = kLineNumber | kColumnOffset | kScriptName | kFunctionName,136    kDetailed = kOverview | kIsEval | kIsConstructor | kScriptNameOrSourceURL137  };138 139  /**140   * Returns the (unique) ID of this stack trace.141   */142  int GetID() const;143 144  /**145   * Returns a StackFrame at a particular index.146   */147  Local<StackFrame> GetFrame(Isolate* isolate, uint32_t index) const;148 149  /**150   * Returns the number of StackFrames.151   */152  int GetFrameCount() const;153 154  /**155   * Grab a snapshot of the current JavaScript execution stack.156   *157   * \param frame_limit The maximum number of stack frames we want to capture.158   * \param options Enumerates the set of things we will capture for each159   *   StackFrame.160   */161  static Local<StackTrace> CurrentStackTrace(162      Isolate* isolate, int frame_limit, StackTraceOptions options = kDetailed);163 164  /**165   * Returns the first valid script name or source URL starting at the top of166   * the JS stack. The returned string is either an empty handle if no script167   * name/url was found or a non-zero-length string.168   *169   * This method is equivalent to calling StackTrace::CurrentStackTrace and170   * walking the resulting frames from the beginning until a non-empty script171   * name/url is found. The difference is that this method won't allocate172   * a stack trace.173   */174  static Local<String> CurrentScriptNameOrSourceURL(Isolate* isolate);175};176 177}  // namespace v8178 179#endif  // INCLUDE_V8_DEBUG_H_180