mirror of
https://github.com/Mercury-Language/mercury.git
synced 2025-12-17 23:05:21 +00:00
6de3b102ba
Estimated hours taken: 20 Branches: main Add support for deconstructing by functor number rather than name, for use by write_binary. library/deconstruct.m: runtime/mercury_deconstruct.h: runtime/mercury_deconstruct.c: runtime/mercury_ml_expand_body.h: runtime/mercury_ml_deconstruct_body.h: Add predicates deconstruct.functor_number and deconstruct.deconstruct.du, which returns a functor number suitable for use by construct.construct rather than a functor name. library/construct.m: library/term.m: browser/term_rep.m: extras/quickcheck/qcheck.m: tests/valid/agc_unbound_typevars.m: tests/valid/agc_unbound_typevars2.m: Add a function get_functor_lex, which returns the lexicographic functor number given an ordinal functor number. Add equivalence types to make it clearer which ordering is being used by which functor numbers. Remove a C-ism: num_functors now fails rather than returning -1 for types without functors. NEWS: Document the new predicates and functions. runtime/mercury_type_info.h: runtime/mercury_builtin_types.c: runtime/mercury_mcpp.h: compiler/rtti.m: compiler/rtti_out.m: compiler/type_ctor_info.m: compiler/rtti_to_mlds.m: compiler/opt_debug.m: Add a field to MR_TypeCtorInfo which contains a mapping from an ordinal functor number to a lexicographic functor number which can be passed to construct.construct. Bump MR_RTTI_VERSION. tests/hard_coded/expand.m: tests/hard_coded/expand.exp: tests/hard_coded/expand.exp2: tests/hard_coded/construct_test.m: tests/hard_coded/construct_test.exp: tests/hard_coded/construct_test_exist.m: tests/hard_coded/construct_test_exist.exp: Test cases.
153 lines
5.2 KiB
C
153 lines
5.2 KiB
C
/*
|
|
** vim:ts=4 sw=4 expandtab
|
|
*/
|
|
|
|
/*
|
|
** Copyright (C) 2002, 2005, 2007 The University of Melbourne.
|
|
** This file may only be copied under the terms of the GNU Library General
|
|
** Public License - see the file COPYING.LIB in the Mercury distribution.
|
|
*/
|
|
|
|
/*
|
|
** mercury_deconstruct.h
|
|
**
|
|
** This file declares utility functions for deconstructing terms,
|
|
** for use by the standard library and the debugger.
|
|
*/
|
|
|
|
#ifndef MERCURY_DECONSTRUCT_H
|
|
#define MERCURY_DECONSTRUCT_H
|
|
|
|
#include "mercury_imp.h"
|
|
#include <stdio.h>
|
|
|
|
typedef struct {
|
|
int num_extra_args;
|
|
MR_Word *arg_values;
|
|
MR_TypeInfo *arg_type_infos;
|
|
MR_bool can_free_arg_type_infos;
|
|
} MR_Expand_Args_Fields;
|
|
|
|
typedef struct {
|
|
int arity;
|
|
int functor_number;
|
|
MR_ConstString functor;
|
|
MR_Expand_Args_Fields args;
|
|
} MR_Expand_Functor_Args_Info;
|
|
|
|
typedef struct {
|
|
int arity;
|
|
int functor_number;
|
|
MR_ConstString functor;
|
|
MR_Expand_Args_Fields args;
|
|
MR_bool limit_reached;
|
|
} MR_Expand_Functor_Args_Limit_Info;
|
|
|
|
typedef struct {
|
|
int arity;
|
|
int functor_number;
|
|
MR_ConstString functor_only;
|
|
} MR_Expand_Functor_Only_Info;
|
|
|
|
typedef struct {
|
|
int arity;
|
|
MR_Expand_Args_Fields args_only;
|
|
} MR_Expand_Args_Only_Info;
|
|
|
|
typedef struct {
|
|
int arity;
|
|
MR_bool chosen_index_exists;
|
|
MR_Word *chosen_value_ptr;
|
|
MR_TypeInfo chosen_type_info;
|
|
} MR_Expand_Chosen_Arg_Only_Info;
|
|
|
|
/*
|
|
** MR_NONCANON_ABORT asks that deconstructions of noncanonical types should
|
|
** cause a runtime abort.
|
|
**
|
|
** MR_NONCANON_ALLOW asks that deconstructions of noncanonical types should
|
|
** return a constant that indicates this fact.
|
|
**
|
|
** MR_NONCANON_CC asks that deconstruction of noncanonical types should
|
|
** deconstruct the term as if it were canonical. Since by definition,
|
|
** noncanonical types may have more than one representation for the same value,
|
|
** this requires the caller to be in a committed choice context.
|
|
*/
|
|
|
|
typedef enum {
|
|
MR_NONCANON_ABORT,
|
|
MR_NONCANON_ALLOW,
|
|
MR_NONCANON_CC
|
|
} MR_noncanon_handling;
|
|
|
|
extern void MR_expand_functor_args(MR_TypeInfo type_info,
|
|
MR_Word *data_word_ptr, MR_noncanon_handling noncanon,
|
|
MR_Expand_Functor_Args_Info *expand_info);
|
|
|
|
extern void MR_expand_functor_args_limit(MR_TypeInfo type_info,
|
|
MR_Word *data_word_ptr, MR_noncanon_handling noncanon,
|
|
int max_arity,
|
|
MR_Expand_Functor_Args_Limit_Info *expand_info);
|
|
|
|
extern void MR_expand_functor_only(MR_TypeInfo type_info,
|
|
MR_Word *data_word_ptr, MR_noncanon_handling noncanon,
|
|
MR_Expand_Functor_Only_Info *expand_info);
|
|
|
|
extern void MR_expand_args_only(MR_TypeInfo type_info,
|
|
MR_Word *data_word_ptr, MR_noncanon_handling noncanon,
|
|
MR_Expand_Args_Only_Info *expand_info);
|
|
|
|
extern void MR_expand_chosen_arg_only(MR_TypeInfo type_info,
|
|
MR_Word *data_word_ptr, MR_noncanon_handling noncanon,
|
|
int chosen, MR_Expand_Chosen_Arg_Only_Info *expand_info);
|
|
|
|
extern void MR_expand_named_arg_only(MR_TypeInfo type_info,
|
|
MR_Word *data_word_ptr, MR_noncanon_handling noncanon,
|
|
MR_ConstString chosen_name,
|
|
MR_Expand_Chosen_Arg_Only_Info *expand_info);
|
|
|
|
/*
|
|
** MR_arg() takes the address of a term, its type, and an
|
|
** argument position (the first argument being at position 1).
|
|
** If the given term has an argument at that position, MR_arg
|
|
** returns MR_TRUE and fills in the locations pointed to by the
|
|
** argument_ptr and arg_type_info_ptr arguments with the value
|
|
** and type of the argument at the selected position.
|
|
** If it doesn't, it fails (i.e. returns MR_FALSE).
|
|
**
|
|
** You need to wrap MR_{save/restore}_transient_hp() around
|
|
** calls to this function.
|
|
*/
|
|
|
|
extern MR_bool MR_arg(MR_TypeInfo type_info, MR_Word *term, int arg_index,
|
|
MR_TypeInfo *arg_type_info_ptr, MR_Word **argument_ptr,
|
|
MR_noncanon_handling noncanon);
|
|
|
|
/*
|
|
** MR_named_arg() is just like MR_arg, except the argument
|
|
** is selected by name, not by position.
|
|
**
|
|
** You need to wrap MR_{save/restore}_transient_hp() around
|
|
** calls to this function.
|
|
*/
|
|
|
|
extern MR_bool MR_named_arg(MR_TypeInfo type_info, MR_Word *term,
|
|
MR_ConstString arg_name, MR_TypeInfo *arg_type_info_ptr,
|
|
MR_Word **argument_ptr, MR_noncanon_handling noncanon);
|
|
|
|
/*
|
|
** MR_named_arg_num() takes the address of a term, its type,
|
|
** and an argument name. If the given term has an argument
|
|
** with the given name, it succeeds and returns the argument
|
|
** number (counted starting from 0) of the argument. If it
|
|
** doesn't, it fails (i.e. returns MR_FALSE).
|
|
**
|
|
** You need to wrap MR_{save/restore}_transient_hp() around
|
|
** calls to this function.
|
|
*/
|
|
|
|
extern MR_bool MR_named_arg_num(MR_TypeInfo type_info, MR_Word *term_ptr,
|
|
const char *arg_name, int *arg_num_ptr);
|
|
|
|
#endif /* MERCURY_DECONSTRUCT_H */
|