Files
mercury/compiler/make_hlds_error.m
Zoltan Somogyi cc9912faa8 Don't import anything in packages.
Packages are modules whose only job is to serve as a container for submodules.
Modules like top_level.m, hlds.m, parse_tree.m and ll_backend.m are packages
in this (informal) sense.

Besides the include_module declarations for their submodules, most of the
packages in the compiler used to import some modules, mostly other packages
whose component modules their submodules may need. For example, ll_backend.m
used to import parse_tree.m. This meant that modules in the ll_backend package
did not have to import parse_tree.m before importing modules in the parse_tree
package.

However, this had a price. When we add a new module to the parse_tree package,
parse_tree.int would change, and this would require the recompilation of ALL
the modules in the ll_backend package, even the ones that did NOT import ANY
of the modules in the parse_tree package.

This happened even at one remove. Pretty much all modules in every one
of the backend have to import one or more modules in the hlds package,
and they therefore have import hlds.m. Since hlds.m imported transform_hlds.m,
any addition of a new middle pass to the transform_hlds package required
the recompilation of all backend modules, even in the usual case of the two
having nothing to do with each other.

This diff removes all import_module declarations from the packages,
and replaces them with import_module declarations in the modules that need
them. This includes only a SUBSET of their child modules and of the non-child
modules that import them.
2015-11-13 15:03:20 +11:00

279 lines
12 KiB
Mathematica

%-----------------------------------------------------------------------------%
% vim: ft=mercury ts=4 sw=4 et
%-----------------------------------------------------------------------------%
% Copyright (C) 1993-2006, 2008 The University of Melbourne.
% This file may only be copied under the terms of the GNU General
% Public License - see the file COPYING in the Mercury distribution.
%-----------------------------------------------------------------------------%
%
% File: make_hlds_error.m.
%
% Utility predicates for writing out warning and error messages when
% building the HLDS. Error messages specific to a given submodule of
% make_hlds.m are in that specific submodule; this submodule is for error
% messages that are needed by more than one submodule.
%
%-----------------------------------------------------------------------------%
:- module hlds.make_hlds.make_hlds_error.
:- interface.
:- import_module mdbcomp.sym_name.
:- import_module parse_tree.
:- import_module parse_tree.error_util.
:- import_module parse_tree.prog_data.
:- import_module list.
%-----------------------------------------------------------------------------%
:- pred multiple_def_error(maybe_opt_imported::in, sym_name::in, int::in,
string::in, prog_context::in, prog_context::in, list(format_component)::in,
list(error_spec)::in, list(error_spec)::out) is det.
:- pred undefined_pred_or_func_error(sym_name::in, int::in, prog_context::in,
list(format_component)::in,
list(error_spec)::in, list(error_spec)::out) is det.
% Similar to undeclared_mode_error, but gives less information.
% XXX perhaps we should get rid of this, and change the callers to
% instead call undeclared_mode_error.
%
:- pred undefined_mode_error(sym_name::in, int::in, prog_context::in,
list(format_component)::in,
list(error_spec)::in, list(error_spec)::out) is det.
:- pred maybe_undefined_pred_error(module_info::in, sym_name::in, int::in,
pred_or_func::in, pred_status::in, maybe_class_method::in,
prog_context::in, list(format_component)::in,
list(error_spec)::in, list(error_spec)::out) is det.
% Emit an error reporting that something should not have occurred in
% a module interface.
%
:- pred error_is_exported(prog_context::in, format_components::in,
list(error_spec)::in, list(error_spec)::out) is det.
%----------------------------------------------------------------------------%
%----------------------------------------------------------------------------%
:- implementation.
:- import_module check_hlds.
:- import_module check_hlds.mode_errors.
:- import_module hlds.hlds_error_util.
:- import_module hlds.hlds_module.
:- import_module hlds.pred_table.
:- import_module libs.
:- import_module libs.globals.
:- import_module libs.options.
:- import_module parse_tree.parse_tree_out_info.
:- import_module parse_tree.parse_tree_out_pred_decl.
:- import_module parse_tree.prog_mode.
:- import_module parse_tree.prog_out.
:- import_module parse_tree.prog_util.
:- import_module bool.
:- import_module set.
:- import_module varset.
%-----------------------------------------------------------------------------%
multiple_def_error(IsOptImported, Name, Arity, DefType, Context, OrigContext,
ExtraPieces, !Specs) :-
(
IsOptImported = is_opt_imported
% We don't take care not to read the same declaration from multiple
% sources with inter-module optimization, so ignore multiple definition
% errors in the items read for inter-module optimization.
;
IsOptImported = is_not_opt_imported,
Pieces1 = [words("Error:"), fixed(DefType),
sym_name_and_arity(Name / Arity), words("multiply defined."), nl],
Pieces2 = [words("Here is the previous definition of"),
fixed(DefType), sym_name_and_arity(Name / Arity), suffix("."), nl],
Msg1 = simple_msg(Context, [always(Pieces1)]),
Msg2 = error_msg(yes(OrigContext), treat_as_first, 0,
[always(Pieces2)]),
(
ExtraPieces = [],
ExtraMsgs = []
;
ExtraPieces = [_ | _],
ExtraMsgs = [simple_msg(Context, [always(ExtraPieces)])]
),
Spec = error_spec(severity_error, phase_parse_tree_to_hlds,
[Msg1, Msg2] ++ ExtraMsgs),
!:Specs = [Spec | !.Specs]
).
undefined_pred_or_func_error(Name, Arity, Context, DescPieces, !Specs) :-
Pieces = [words("Error:") | DescPieces] ++ [words("for"),
sym_name_and_arity(Name / Arity),
words("without corresponding"), decl("pred"), words("or"),
decl("func"), words("declaration.")],
Msg = simple_msg(Context, [always(Pieces)]),
Spec = error_spec(severity_error, phase_parse_tree_to_hlds, [Msg]),
!:Specs = [Spec | !.Specs].
undefined_mode_error(Name, Arity, Context, DescPieces, !Specs) :-
Pieces = [words("Error:") | DescPieces] ++ [words("for"),
sym_name_and_arity(Name / Arity),
words("specifies non-existent mode.")],
Msg = simple_msg(Context, [always(Pieces)]),
Spec = error_spec(severity_error, phase_parse_tree_to_hlds, [Msg]),
!:Specs = [Spec | !.Specs].
% Similar to undefined_mode_error, but gives more information.
% XXX the documentation here should be somewhat less circular.
%
:- func undeclared_mode_error(list(mer_mode), prog_varset,
pred_id, pred_info, module_info, prog_context) = error_spec.
undeclared_mode_error(ModeList, VarSet, PredId, PredInfo, ModuleInfo, Context)
= Spec :-
PredIdPieces = describe_one_pred_name(ModuleInfo,
should_not_module_qualify, PredId),
strip_builtin_qualifiers_from_mode_list(ModeList, StrippedModeList),
PredOrFunc = pred_info_is_pred_or_func(PredInfo),
Name = pred_info_name(PredInfo),
MaybeDet = no,
SubDeclStr = mercury_mode_subdecl_to_string(output_debug, PredOrFunc,
varset.coerce(VarSet), unqualified(Name), StrippedModeList, MaybeDet),
MainPieces = [words("In clause for")] ++ PredIdPieces ++ [suffix(":"), nl,
words("error: mode annotation specifies undeclared mode"),
quote(SubDeclStr), suffix("."), nl],
ProcIds = pred_info_all_procids(PredInfo),
(
ProcIds = [],
VerbosePieces = [words("(There are no declared modes for this"),
p_or_f(PredOrFunc), suffix(".)"), nl]
;
ProcIds = [_ | _],
VerbosePieces = [words("The declared modes for this"),
p_or_f(PredOrFunc), words("are the following:"),
nl_indent_delta(1)] ++
component_list_to_line_pieces(
list.map(mode_decl_for_pred_info_to_pieces(PredInfo), ProcIds),
[]) ++
[nl_indent_delta(-1)]
),
Msg = simple_msg(Context,
[always(MainPieces), verbose_only(verbose_always, VerbosePieces)]),
Spec = error_spec(severity_error, phase_parse_tree_to_hlds, [Msg]).
:- func mode_decl_for_pred_info_to_pieces(pred_info, proc_id)
= list(format_component).
mode_decl_for_pred_info_to_pieces(PredInfo, ProcId) =
[words(":- mode"), words(mode_decl_to_string(ProcId, PredInfo)),
suffix(".")].
%----------------------------------------------------------------------------%
maybe_undefined_pred_error(ModuleInfo, Name, Arity, PredOrFunc, Status,
IsClassMethod, Context, DescPieces, !Specs) :-
% This is not considered an unconditional error anymore:
% if there is no `:- pred' or `:- func' declaration,
% and the declaration is local, and not a type class method,
% and the `--infer-types' option was specified,
% then we just add an implicit declaration for that predicate or
% function, marking it as one whose type will be inferred.
DefinedInThisModule = pred_status_defined_in_this_module(Status),
IsExported = pred_status_is_exported(Status),
module_info_get_globals(ModuleInfo, Globals),
globals.lookup_bool_option(Globals, infer_types, InferTypes),
( if
DefinedInThisModule = yes,
IsExported = no,
IsClassMethod = is_not_a_class_method,
InferTypes = yes
then
true
else
PredOrFuncStr = pred_or_func_to_str(PredOrFunc),
MainPieces = [words("Error:") | DescPieces] ++ [words("for"),
simple_call(simple_call_id(PredOrFunc, Name, Arity)), nl,
words("without corresponding"),
decl(PredOrFuncStr), words("declaration."), nl],
MainMsg = simple_msg(Context, [always(MainPieces)]),
module_info_get_predicate_table(ModuleInfo, PredicateTable),
predicate_table_lookup_pf_sym(PredicateTable,
is_fully_qualified, PredOrFunc, Name, AllArityPredIds),
gather_porf_arities(ModuleInfo, AllArityPredIds, PredOrFunc,
PorFArities),
set.delete(Arity, PorFArities, OtherArities),
% The sorting is to make the error message easier to read.
% There should not be any duplicates among OtherArities, but better
% safe than sorry ...
set.to_sorted_list(OtherArities, OtherAritiesList),
FullPredOrFuncStr = pred_or_func_to_full_str(PredOrFunc),
(
OtherAritiesList = [],
Spec = error_spec(severity_error, phase_parse_tree_to_hlds,
[MainMsg])
;
(
OtherAritiesList = [OtherArity],
OtherAritiesPieces = [words("However, a"),
words(FullPredOrFuncStr), words("of that name"),
words("does exist with arity"), int_fixed(OtherArity),
suffix("."), nl]
;
OtherAritiesList = [_, _ | _],
OtherAritiesPieces = [words("However,"),
words(FullPredOrFuncStr), suffix("s"),
words("of that name do exist with arities") |
component_list_to_pieces(
list.map(wrap_int_fixed, OtherAritiesList))] ++
[suffix("."), nl]
),
OtherAritiesMsg = simple_msg(Context,
[always(OtherAritiesPieces)]),
Spec = error_spec(severity_error, phase_parse_tree_to_hlds,
[MainMsg, OtherAritiesMsg])
),
!:Specs = [Spec | !.Specs]
).
% Given a list of pred ids, find out which of them represent
% procedures which have the right pred_or_func field (WantedPorF),
% and return their original arities.
%
:- pred gather_porf_arities(module_info::in, list(pred_id)::in,
pred_or_func::in, set(int)::out) is det.
gather_porf_arities(_ModuleInfo, [], _WantedPorF, set.init).
gather_porf_arities(ModuleInfo, [PredId | PredIds], WantedPorF,
!:PorFArities) :-
gather_porf_arities(ModuleInfo, PredIds, WantedPorF, !:PorFArities),
module_info_pred_info(ModuleInfo, PredId, PredInfo),
PorF = pred_info_is_pred_or_func(PredInfo),
( if PorF = WantedPorF then
pred_info_get_orig_arity(PredInfo, OrigArity),
adjust_func_arity(PorF, OrigArity, Arity),
set.insert(Arity, !PorFArities)
else
true
).
:- func wrap_int_fixed(int) = format_component.
wrap_int_fixed(N) = int_fixed(N).
%----------------------------------------------------------------------------%
error_is_exported(Context, ItemPieces, !Specs) :-
Pieces = [words("Error:")] ++ ItemPieces ++
[words("in module interface."), nl],
Msg = simple_msg(Context, [always(Pieces)]),
Spec = error_spec(severity_error, phase_parse_tree_to_hlds, [Msg]),
!:Specs = [Spec | !.Specs].
%----------------------------------------------------------------------------%
:- end_module hlds.make_hlds.make_hlds_error.
%----------------------------------------------------------------------------%