mirror of
https://github.com/Mercury-Language/mercury.git
synced 2025-12-06 07:49:02 +00:00
d465fa53cb
Discussion of these changes can be found on the Mercury developers
mailing list archives from June 2018.
COPYING.LIB:
Add a special linking exception to the LGPL.
*:
Update references to COPYING.LIB.
Clean up some minor errors that have accumulated in copyright
messages.
112 lines
4.6 KiB
C
112 lines
4.6 KiB
C
// vim: ts=4 sw=4 expandtab ft=c
|
|
|
|
// Copyright (C) 1998,2000-2002,2004-2007,2012 The University of Melbourne.
|
|
// Copyright (C) 2016, 2018 The Mercury team.
|
|
// This file is distributed under the terms specified in COPYING.LIB.
|
|
|
|
// This module provides utility functions for the debugger.
|
|
//
|
|
// This header files defines macros for dealing with registers.
|
|
// These macros assume, and enforce, the conventions described
|
|
// in trace/README.
|
|
|
|
#ifndef MERCURY_TRACE_UTIL_H
|
|
#define MERCURY_TRACE_UTIL_H
|
|
|
|
#include "mercury_std.h" // for MR_bool
|
|
#include "mercury_float.h" // for MR_Float
|
|
#include "mercury_types.h" // for MR_Word etc
|
|
#include "mercury_library_types.h" // for MercuryFile
|
|
#include <stdio.h> // for FILE
|
|
#include "mercury_trace.h" // for MR_EventInfo
|
|
|
|
// MR_c_file_to_mercury_file is used to convert MR_mdb_in and MR_mdb_out
|
|
// into Mercury streams suitable for use by the browser.
|
|
|
|
extern void MR_c_file_to_mercury_file(FILE *c_file,
|
|
MercuryFile *mercury_file);
|
|
|
|
// MR_trace_is_natural_number checks whether the given word contains a natural
|
|
// number, i.e. a sequence of digits. If yes, it puts the value of the number
|
|
// in location of type MR_Unsigned and returns MR_TRUE, otherwise it returns
|
|
// MR_FALSE.
|
|
//
|
|
// MR_trace_is_natural_number_pair looks for a pair of natural numbers
|
|
// separated by a '-' character.
|
|
//
|
|
// MR_trace_is_nonneg_int is similar, but puts the value of the number in a
|
|
// location of type int.
|
|
//
|
|
// MR_trace_is_integer is similar, but it also allows an initial minus sign
|
|
// to denote a negative number. It puts the value of the number in a location
|
|
// of type MR_Integer.
|
|
//
|
|
// MR_trace_is_float is similar again, but it also allows an optional
|
|
// fractional part.
|
|
//
|
|
// XXX None of these functions are robust if given numbers too large for their
|
|
// type. MR_trace_is_integer doesn't even work for MININT.
|
|
|
|
extern MR_bool MR_trace_is_natural_number(const char *word,
|
|
MR_Unsigned *value);
|
|
|
|
extern MR_bool MR_trace_is_natural_number_pair(const char *word,
|
|
MR_Unsigned *value1, MR_Unsigned *value2);
|
|
|
|
extern MR_bool MR_trace_is_nonneg_int(const char *word, int *value);
|
|
|
|
extern MR_bool MR_trace_is_integer(const char *word, MR_Integer *value);
|
|
|
|
extern MR_bool MR_trace_is_float(const char *word, MR_Float *value);
|
|
|
|
// These functions print the values of sets of Mercury abstract machine
|
|
// registers. Their main use is low level debugging, including debugging
|
|
// the debugger itself.
|
|
|
|
extern void MR_print_stack_regs(FILE *fp, MR_Word *saved_regs);
|
|
extern void MR_print_heap_regs(FILE *fp, MR_Word *saved_regs);
|
|
extern void MR_print_tabling_regs(FILE *fp, MR_Word *saved_regs);
|
|
extern void MR_print_succip_reg(FILE *fp, MR_Word *saved_regs);
|
|
extern void MR_print_r_regs(FILE *fp, MR_Word *saved_regs);
|
|
extern void MR_print_debug_vars(FILE *fp, MR_EventInfo *event_info);
|
|
|
|
// This function returns MR_TRUE if the layout is for exception.builtin_catch
|
|
// and false otherwise. Because builtin_catch creates a stack frame, but no
|
|
// events, it must be handled specially by some parts of the debugger.
|
|
|
|
extern MR_bool MR_trace_proc_layout_is_builtin_catch(
|
|
const MR_ProcLayout *layout);
|
|
|
|
// Find the stack frame that represents the entry point to the clique
|
|
// of the procedure that the current event is in.
|
|
//
|
|
// If we cannot walk the stack all the way to main, or if there is
|
|
// some other error that prevents us from doing what are asked to do,
|
|
// then return true. If there are no problems, return false, and fill
|
|
// in *selected_level_ptr with a level number that can be given directly
|
|
// to MR_find_nth_ancestor.
|
|
//
|
|
// If which_frame == MR_CLIQUE_ENTRY_FRAME, set *selected_level_ptr
|
|
// to the level of the stack frame of the entry point of that clique.
|
|
// If which_frame == MR_CLIQUE_ENTRY_PARENT_FRAME, set *selected_level_ptr
|
|
// to the level of the parent of that stack frame, i.e. the level of
|
|
// the first stack frame outside the clique (first when looking UP the stack).
|
|
|
|
typedef enum {
|
|
MR_CLIQUE_ENTRY_FRAME, MR_CLIQUE_ENTRY_PARENT_FRAME
|
|
} MR_SelectedStackFrame;
|
|
|
|
extern MR_bool MR_find_clique_entry_mdb(MR_EventInfo *event_info,
|
|
MR_SelectedStackFrame which_frame,
|
|
MR_Level *selected_level_ptr);
|
|
|
|
// MR_trace_call_system_display_error_on_failure executes the given command
|
|
// and displays an error message if the command returned a non-zero exit
|
|
// status, there was a problem executing the command, or no usable shell was
|
|
// available.
|
|
|
|
extern void MR_trace_call_system_display_error_on_failure(FILE *err_stream,
|
|
char *command);
|
|
|
|
#endif // MERCURY_TRACE_UTIL_H
|