Files
mercury/browser/cterm.m
Zoltan Somogyi 672f77c4ec Add a new compiler option. --inform-ite-instead-of-switch.
Estimated hours taken: 20
Branches: main

Add a new compiler option. --inform-ite-instead-of-switch. If this is enabled,
the compiler will generate informational messages about if-then-elses that
it thinks should be converted to switches for the sake of program reliability.

Act on the output generated by this option.

compiler/simplify.m:
	Implement the new option.

	Fix an old bug that could cause us to generate warnings about code
	that was OK in one duplicated copy but not in another (where a switch
	arm's code is duplicated due to the case being selected for more than
	one cons_id).

compiler/options.m:
	Add the new option.

	Add a way to test for the bug fix in simplify.

doc/user_guide.texi:
	Document the new option.

NEWS:
	Mention the new option.

library/*.m:
mdbcomp/*.m:
browser/*.m:
compiler/*.m:
deep_profiler/*.m:
	Convert if-then-elses to switches at most of the sites suggested by the
	new option. At the remaining sites, switching to switches would have
	nontrivial downsides. This typically happens with the switched-on type
	has many functors, and we treat one or two specially (e.g. cons/2 in
	the cons_id type).

	Perform misc cleanups in the vicinity of the if-then-else to switch
	conversions.

	In a few cases, improve the error messages generated.

compiler/accumulator.m:
compiler/hlds_goal.m:
	(Rename and) move insts for particular kinds of goal from
	accumulator.m to hlds_goal.m, to allow them to be used in other
	modules. Using these insts allowed us to eliminate some if-then-elses
	entirely.

compiler/exprn_aux.m:
	Instead of fixing some if-then-elses, delete the predicates containing
	them, since they aren't used, and (as pointed out by the new option)
	would need considerable other fixing if they were ever needed again.

compiler/lp_rational.m:
	Add prefixes to the names of the function symbols on some types,
	since without those prefixes, it was hard to figure out what type
	the switch corresponding to an old if-then-else was switching on.

tests/invalid/reserve_tag.err_exp:
	Expect a new, improved error message.
2007-11-23 07:36:01 +00:00

138 lines
4.2 KiB
Mathematica

%---------------------------------------------------------------------------%
% vim: ft=mercury ts=4 sw=4 et
%---------------------------------------------------------------------------%
% Copyright (C) 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.
%---------------------------------------------------------------------------%
%
% File: cterm.m.
% Author: zs.
%
% This module provides a mechanism for matching terms from the running program
% against terms specified by debugger commands, which are implemented in C in
% runtime/mercury_trace_term.[ch].
%
%---------------------------------------------------------------------------%
:- module mdb.cterm.
:- interface.
:- import_module bool.
%---------------------------------------------------------------------------%
:- type cterm.
:- type cargs.
% Succeed if and only if the given term matches the given cterm.
%
:- pred match_with_cterm(T::in, cterm::in, bool::out) is cc_multi.
% Implement deconstruct for cterms.
%
:- pred cterm_deconstruct(cterm::in, string::out, cargs::out) is det.
% Decompose a list of arguments into the first element and the rest.
% Fail if the list is empty.
%
:- pred cterm_head_tail(cargs::in, cterm::out, cargs::out) is semidet.
%---------------------------------------------------------------------------%
%---------------------------------------------------------------------------%
:- implementation.
:- import_module deconstruct.
:- import_module list.
:- import_module univ.
%---------------------------------------------------------------------------%
:- pragma foreign_decl(c, "
#include ""mercury_trace_term.h""
").
:- pragma foreign_type(c, cterm, "MR_CTerm", [can_pass_as_mercury_type]).
:- pragma foreign_type(c, cargs, "MR_CArgs", [can_pass_as_mercury_type]).
:- pragma foreign_export("C", match_with_cterm(in, in, out),
"ML_BROWSE_match_with_cterm").
%---------------------------------------------------------------------------%
% Uncomment these and the unsafe_perform_ios below to debug match_with_cterm
% and its callers in the trace directory.
% :- import_module io, unsafe.
% :- pragma promise_pure(match_with_cterm/3).
match_with_cterm(Term, CTerm, Match) :-
deconstruct(Term, include_details_cc, TermFunctor, _, TermArgs),
cterm_deconstruct(CTerm, CTermFunctor, CTermArgs),
% impure unsafe_perform_io(io.write_string("comparing <")),
% impure unsafe_perform_io(io.write_string(TermFunctor)),
% impure unsafe_perform_io(io.write_string("> to <")),
% impure unsafe_perform_io(io.write_string(CTermFunctor)),
% impure unsafe_perform_io(io.write_string(">\n")),
( TermFunctor = CTermFunctor ->
match_with_cterms(TermArgs, CTermArgs, Match)
; CTermFunctor = "_" ->
Match = yes
;
Match = no
).
:- pred match_with_cterms(list(univ)::in, cargs::in, bool::out) is cc_multi.
match_with_cterms(UnivArgs, CArgs, Match) :-
( cterm_head_tail(CArgs, CHead, CTail) ->
(
UnivArgs = [],
Match = no
;
UnivArgs = [UnivHead | UnivTail],
Head = univ_value(UnivHead),
match_with_cterm(Head, CHead, MatchHead),
(
MatchHead = no,
Match = no
;
MatchHead = yes,
match_with_cterms(UnivTail, CTail, Match)
)
)
;
(
UnivArgs = [],
Match = yes
;
UnivArgs = [_ | _],
Match = no
)
).
:- pragma foreign_proc(c,
cterm_deconstruct(Term::in, Functor::out, Args::out),
[will_not_call_mercury, promise_pure],
"
if (Term == NULL) {
MR_fatal_error(""cterm_deconstruct: NULL term"");
}
Functor = Term->MR_term_functor;
Args = Term->MR_term_args;
").
:- pragma foreign_proc(c,
cterm_head_tail(Args::in, Head::out, Tail::out),
[will_not_call_mercury, promise_pure],
"
if (Args == NULL) {
SUCCESS_INDICATOR = MR_FALSE;
} else {
Head = Args->MR_args_head;
Tail = Args->MR_args_tail;
SUCCESS_INDICATOR = MR_TRUE;
}
").