Add an API function to get a debugger stack trace from an error handle.

runtime/include/dart_debugger_api.h

 // Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
 // for details. 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_DART_DEBUGGER_API_H_
 #define INCLUDE_DART_DEBUGGER_API_H_
 
 #include "include/dart_api.h"
 
 typedef struct _Dart_Breakpoint* Dart_Breakpoint;
@@ skipping 334 matching lines @@
 
 
 /**
  * Returns on which exceptions the debugger pauses.
  *
  * Requires there to be a current isolate.
  */
 DART_EXPORT Dart_ExceptionPauseInfo Dart_GetExceptionPauseInfo();
 
 /**
- * Returns in \trace the the current stack trace, or NULL if the
+ * Returns in \trace the current stack trace, or NULL if the
  * VM is not paused.
  *
  * Requires there to be a current isolate.
  *
  * \return A handle to the True object if no error occurs.
  */
 DART_EXPORT Dart_Handle Dart_GetStackTrace(Dart_StackTrace* trace);
 
 
 /**
+ * Returns in \trace the stack trace associated with the error given in \handle.
+ *
+ * Requires there to be a current isolate.
+ *
+ * \return A handle to the True object if no error occurs.

[siva, 2013/11/12 16:00:43]

why a handle to the True object and not Success like all other API functions.

[rmacnak, 2013/11/12 22:32:40]

It does return Success. Copied from doc for Dart_GetStackTrace, which is also
out of sync. Updated both.

+ */
+DART_EXPORT Dart_Handle Dart_GetStackTraceFromError(Dart_Handle handle,
+                                                    Dart_StackTrace* trace);
+
+
+/**
  * Returns in \length the number of activation frames in the given
  * stack trace.
  *
  * Requires there to be a current isolate.
  *
  * \return A handle to the True object if no error occurs.
  */
 DART_EXPORT Dart_Handle Dart_StackTraceLength(
                             Dart_StackTrace trace,
                             intptr_t* length);
@@ skipping 29 matching lines @@
  *
  * Requires there to be a current isolate.
  *
  * \return A handle to the True object if no error occurs.
  */
 DART_EXPORT Dart_Handle Dart_ActivationFrameInfo(
                             Dart_ActivationFrame activation_frame,
                             Dart_Handle* function_name,
                             Dart_Handle* script_url,
                             intptr_t* line_number,
                             intptr_t* library_id);

[siva, 2013/11/12 16:00:43]

I don't find any use cases of this API function anywhere other than in some
debugger tests, why is this version needed?

[rmacnak, 2013/11/12 22:32:40]

Indeed, even the debugger tests ignore the position info. Removed.

 
 
 /**
+ * Returns information about the given activation frame.
+ * \function_name receives a string handle with the qualified
+ *    function name.
+ * \script_url receives a string handle with the url of the
+ *    source script that contains the frame's function.
+ * \line_number receives the line number in the script.
+ * \col_number receives the line number in the script, or -1 if column
+ *    information is not available
+ *
+ * Any or all of the out parameters above may be NULL.
+ *
+ * Requires there to be a current isolate.
+ *
+ * \return A handle to the True object if no error occurs.

[siva, 2013/11/12 16:00:43]

Ditto comment regarding returning Success.

+ */
+DART_EXPORT Dart_Handle Dart_ActivationFrameInfoWithColumn(
+                            Dart_ActivationFrame activation_frame,
+                            Dart_Handle* function_name,
+                            Dart_Handle* script_url,
+                            intptr_t* line_number,
+                            intptr_t* column_number);

[siva, 2013/11/12 16:00:43]

If we decide to get rid of the other version of ActivationFrameInfo function
then this can be named Dart_ActivationFrameInfo

[rmacnak, 2013/11/12 22:32:40]

Done.

+
+
+/**
  * Returns code location of the given activation frame.
  *
  * \function_name receives a string handle with the qualified
  *    function name.
  * \function receives a handle to the function.
  * \location.script_url receives a string handle with the url of
  *    the source script that contains the frame's function.
  *    Receives a null handle if there is no textual location
  *    that corresponds to the frame, e.g. for implicitly
  *    generated constructors.
@@ skipping 246 matching lines @@
  * \param request A REST-like string, which uses '/' to separate
  *     parameters. The first parameter is always the status type.
  *
  * \return The requested status as a JSON formatted string, with the
  *     contents defined by the status plug-in. The caller is responsible
  *     for freeing this string.
  */
 DART_EXPORT char* Dart_GetVmStatus(const char* request);
 
 #endif  // INCLUDE_DART_DEBUGGER_API_H_