Files
mercury/library/ops.m
Fergus Henderson b5ae12b829 Add support for nested modules.
Estimated hours taken: 50

Add support for nested modules.

- module names may themselves be module-qualified
- modules may contain `:- include_module' declarations
  which name sub-modules
- a sub-module has access to all the declarations in the
  parent module (including its implementation section).

This support is not yet complete; see the BUGS and LIMITATIONS below.

LIMITATIONS
- source file names must match module names
	(just as they did previously)
- mmc doesn't allow path names on the command line any more
	(e.g. `mmc --make-int ../library/foo.m').
- import_module declarations must use the fully-qualified module name
- module qualifiers must use the fully-qualified module name
- no support for root-qualified module names
	(e.g. `:parent:child' instead of `parent:child').
- modules may not be physically nested (only logical nesting, via
  `include_module').

BUGS
- doesn't check that the parent module is imported/used before allowing
	import/use of its sub-modules.
- doesn't check that there is an include_module declaration in the
	parent for each module claiming to be a child of that parent
- privacy of private modules is not enforced

-------------------

NEWS:
	Mention that we support nested modules.

library/ops.m:
library/nc_builtin.nl:
library/sp_builtin.nl:
compiler/mercury_to_mercury.m:
	Add `include_module' as a new prefix operator.
	Change the associativity of `:' from xfy to yfx
	(since this made parsing module qualifiers slightly easier).

compiler/prog_data.m:
	Add new `include_module' declaration.
	Change the `module_name' and `module_specifier' types
	from strings to sym_names, so that module names can
	themselves be module qualified.

compiler/modules.m:
	Add predicates module_name_to_file_name/2 and
	file_name_to_module_name/2.
	Lots of changes to handle parent module dependencies,
	to create parent interface (`.int0') files, to read them in,
	to output correct dependencies information for them to the
	`.d' and `.dep' files, etc.
	Rewrite a lot of the code to improve the readability
	(add comments, use subroutines, better variable names).
	Also fix a couple of bugs:
	- generate_dependencies was using the transitive implementation
	  dependencies rather than the transitive interface dependencies
	  to compute the `.int3' dependencies when writing `.d' files
	  (this bug was introduced during crs's changes to support
	  `.trans_opt' files)
	- when creating the `.int' file, it was reading in the
	  interfaces for modules imported in the implementation section,
	  not just those in the interface section.
	  This meant that the compiler missed a lot of errors.

library/graph.m:
library/lexer.m:
library/term.m:
library/term_io.m:
library/varset.m:
compiler/*.m:
	Add `:- import_module' declarations to the interface needed
	by declarations in the interface.  (The previous version
	of the compiler did not detect these missing interface imports,
	due to the above-mentioned bug in modules.m.)

compiler/mercury_compile.m:
compiler/intermod.m:
	Change mercury_compile__maybe_grab_optfiles and
	intermod__grab_optfiles so that they grab the opt files for
	parent modules as well as the ones for imported modules.

compiler/mercury_compile.m:
	Minor changes to handle parent module dependencies.
	(Also improve the wording of the warning about trans-opt
	dependencies.)

compiler/make_hlds.m:
compiler/module_qual.m:
	Ignore `:- include_module' declarations.

compiler/module_qual.m:
	A couple of small changes to handle nested module names.

compiler/prog_out.m:
compiler/prog_util.m:
	Add new predicates string_to_sym_name/3 (prog_util.m) and
	sym_name_to_string/{2,3} (prog_out.m).

compiler/*.m:
	Replace many occurrences of `string' with `module_name'.
	Change code that prints out module names or converts
	them to strings or filenames to handle the fact that
	module names are now sym_names intead of strings.
	Also change a few places (e.g. in intermod.m, hlds_module.m)
	where the code assumed that any qualified symbol was
	fully-qualified.

compiler/prog_io.m:
compiler/prog_io_goal.m:
	Move sym_name_and_args/3, parse_qualified_term/4 and
	parse_qualified_term/5 preds from prog_io_goal.m to prog_io.m,
	since they are very similar to the parse_symbol_name/2 predicate
	already in prog_io.m.  Rewrite these predicates, both
	to improve maintainability, and to handle the newly
	allowed syntax (module-qualified module names).
	Rename parse_qualified_term/5 as `parse_implicit_qualified_term'.

compiler/prog_io.m:
	Rewrite the handling of `:- module' and `:- end_module'
	declarations, so that it can handle nested modules.
	Add code to parse `include_module' declarations.

compiler/prog_util.m:
compiler/*.m:
	Add new predicates mercury_public_builtin_module/1 and
	mercury_private_builtin_module/1 in prog_util.m.
	Change most of the hard-coded occurrences of "mercury_builtin"
	to call mercury_private_builtin_module/1 or
	mercury_public_builtin_module/1 or both.

compiler/llds_out.m:
	Add llds_out__sym_name_mangle/2, for mangling module names.

compiler/special_pred.m:
compiler/mode_util.m:
compiler/clause_to_proc.m:
compiler/prog_io_goal.m:
compiler/lambda.m:
compiler/polymorphism.m:
	Move the predicates in_mode/1, out_mode/1, and uo_mode/1
	from special_pred.m to mode_util.m, and change various
	hard-coded definitions to instead call these predicates.

compiler/polymorphism.m:
	Ensure that the type names `type_info' and `typeclass_info' are
	module-qualified in the generated code.  This avoids a problem
	where the code generated by polymorphism.m was not considered
	type-correct, due to the type `type_info' not matching
	`mercury_builtin:type_info'.

compiler/check_typeclass.m:
	Simplify the code for check_instance_pred and
	get_matching_instance_pred_ids.

compiler/mercury_compile.m:
compiler/modules.m:
	Disallow directory names in command-line arguments.

compiler/options.m:
compiler/handle_options.m:
compiler/mercury_compile.m:
compiler/modules.m:
	Add a `--make-private-interface' option.
	The private interface file `<module>.int0' contains
	all the declarations in the module; it is used for
	compiling sub-modules.

scripts/Mmake.rules:
scripts/Mmake.vars.in:
	Add support for creating `.int0' and `.date0' files
	by invoking mmc with `--make-private-interface'.

doc/user_guide.texi:
	Document `--make-private-interface' and the `.int0'
	and `.date0' file extensions.

doc/reference_manual.texi:
	Document nested modules.

util/mdemangle.c:
profiler/demangle.m:
	Demangle names with multiple module qualifiers.

tests/general/Mmakefile:
tests/general/string_format_test.m:
tests/general/string_format_test.exp:
tests/general/string__format_test.m:
tests/general/string__format_test.exp:
tests/general/.cvsignore:
	Change the `:- module string__format_test' declaration in
	`string__format_test.m' to `:- module string_format_test',
	because with the original declaration the `__' was taken
	as a module qualifier, which lead to an error message.
	Hence rename the file accordingly, to avoid the warning
	about file name not matching module name.

tests/invalid/Mmakefile:
tests/invalid/missing_interface_import.m:
tests/invalid/missing_interface_import.err_exp:
	Regression test to check that the compiler reports
	errors for missing `import_module' in the interface section.

tests/invalid/*.err_exp:
tests/warnings/unused_args_test.exp:
tests/warnings/unused_import.exp:
	Update the expected diagnostics output for the test cases to
	reflect a few minor changes to the warning messages.

tests/hard_coded/Mmakefile:
tests/hard_coded/parent.m:
tests/hard_coded/parent.child.m:
tests/hard_coded/parent.exp:
tests/hard_coded/parent2.m:
tests/hard_coded/parent2.child.m:
tests/hard_coded/parent2.exp:
	Two simple tests case for the use of nested modules with
	separate compilation.
1998-03-03 17:26:11 +00:00

231 lines
11 KiB
Mathematica

%---------------------------------------------------------------------------%
% Copyright (C) 1995-1998 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: ops.m.
% main author: fjh.
% stability: low.
%
% Here's where we maintain the table of current operators.
%
% XXX In the current implementation the table is fixed and cannot be
% modified at run-time.
%
%-----------------------------------------------------------------------------%
:- module ops.
:- interface.
:- type ops__specifier
---> fx ; fy ; xf ; yf ; xfx ; yfx ; xfy ; fxx ; fxy ; fyx.
:- type ops__assoc
---> x ; y.
:- type ops__class
---> infix(ops__assoc, ops__assoc)
; prefix(ops__assoc)
; binary_prefix(ops__assoc, ops__assoc)
; postfix(ops__assoc).
:- type ops__table.
:- type ops__priority == int.
% create an ops_table with the standard Mercury operators.
:- pred ops__init_op_table(ops__table).
:- mode ops__init_op_table(uo) is det.
% check whether a string is the name of an infix operator,
% and if it is, return its precedence and associativity.
:- pred ops__lookup_infix_op(ops__table, string, int, ops__assoc, ops__assoc).
:- mode ops__lookup_infix_op(in, in, out, out, out) is semidet.
% check whether a string is the name of a prefix operator,
% and if it is, return its precedence and associativity.
:- pred ops__lookup_prefix_op(ops__table, string, int, ops__assoc).
:- mode ops__lookup_prefix_op(in, in, out, out) is semidet.
% check whether a string is the name of a binary prefix operator,
% and if it is, return its precedence and associativity.
:- pred ops__lookup_binary_prefix_op(ops__table, string,
int, ops__assoc, ops__assoc).
:- mode ops__lookup_binary_prefix_op(in, in, out, out, out) is semidet.
% check whether a string is the name of a postfix operator,
% and if it is, return its precedence and associativity.
:- pred ops__lookup_postfix_op(ops__table, string, int, ops__assoc).
:- mode ops__lookup_postfix_op(in, in, out, out) is semidet.
% check whether a string is the name of an operator
:- pred ops__lookup_op(ops__table, string).
:- mode ops__lookup_op(in, in) is semidet.
% convert an ops__specifer (e.g. `xfy') to an ops__class
% (e.g. `infix(x, y)').
:- pred ops__op_specifier_to_class(ops__specifier, ops__class).
:- mode ops__op_specifier_to_class(in, out) is det.
% :- mode ops__op_specifier_to_class(out, in) is semidet.
% Returns the highest priority number (the lowest is zero).
% Note that due to Prolog tradition, the priority numbers
% are backwards: higher numbers mean lower priority
% and lower numbers mean higher priority. Sorry...
:- pred ops__max_priority(ops__priority).
:- mode ops__max_priority(out) is det.
%-----------------------------------------------------------------------------%
:- implementation.
:- type ops__table ---> ops__table. % XXX
:- type ops__category ---> before ; after.
ops__op_specifier_to_class(fx, prefix(x)).
ops__op_specifier_to_class(fy, prefix(y)).
ops__op_specifier_to_class(xf, postfix(x)).
ops__op_specifier_to_class(yf, postfix(y)).
ops__op_specifier_to_class(xfx, infix(x,x)).
ops__op_specifier_to_class(yfx, infix(y,x)).
ops__op_specifier_to_class(xfy, infix(x,y)).
ops__op_specifier_to_class(fxx, binary_prefix(x,x)).
ops__op_specifier_to_class(fyx, binary_prefix(y,x)).
ops__op_specifier_to_class(fxy, binary_prefix(x,y)).
ops__lookup_infix_op(_OpTable, Name, Priority, LeftAssoc, RightAssoc) :-
ops__op_table(Name, after, Specifier, Priority), !,
ops__op_specifier_to_class(Specifier,
infix(LeftAssoc, RightAssoc)).
ops__lookup_prefix_op(_OpTable, Name, Priority, LeftAssoc) :-
ops__op_table(Name, before, Specifier, Priority), !,
ops__op_specifier_to_class(Specifier, prefix(LeftAssoc)).
ops__lookup_binary_prefix_op(_OpTable, Name, Priority, LeftAssoc, RightAssoc) :-
ops__op_table(Name, before, Specifier, Priority), !,
ops__op_specifier_to_class(Specifier,
binary_prefix(LeftAssoc, RightAssoc)).
ops__lookup_postfix_op(_OpTable, Name, Priority, LeftAssoc) :-
ops__op_table(Name, after, Specifier, Priority), !,
ops__op_specifier_to_class(Specifier, postfix(LeftAssoc)).
ops__lookup_op(_OpTable, Name) :-
ops__op_table(Name, _, _, _).
:- pred ops__op_table(string, ops__category, ops__specifier, ops__priority).
:- mode ops__op_table(in, in, out, out) is semidet.
:- mode ops__op_table(in, out, out, out) is nondet.
ops__op_table("*", after, yfx, 400). % standard ISO Prolog
ops__op_table("**", after, xfy, 200). % standard ISO Prolog
ops__op_table("+", after, yfx, 500). % standard ISO Prolog
ops__op_table("+", before, fx, 500). % traditional Prolog (not ISO)
ops__op_table(",", after, xfy, 1000). % standard ISO Prolog
ops__op_table("&", after, xfy, 1025). % Mercury extension
ops__op_table("-", after, yfx, 500). % standard ISO Prolog
ops__op_table("-", before, fx, 200). % standard ISO Prolog
ops__op_table("--->", after, xfy, 1179). % Mercury extension
ops__op_table("-->", after, xfx, 1200). % standard ISO Prolog
ops__op_table("->", after, xfy, 1050). % standard ISO Prolog
ops__op_table(".", after, xfy, 600). % traditional Prolog (not ISO)
ops__op_table("/", after, yfx, 400). % standard ISO Prolog
ops__op_table("//", after, yfx, 400). % standard ISO Prolog
ops__op_table("/\\", after, yfx, 500). % standard ISO Prolog
ops__op_table(":", after, yfx, 600). % `xfy' in ISO Prolog
ops__op_table(":-", after, xfx, 1200). % standard ISO Prolog
ops__op_table(":-", before, fx, 1200). % standard ISO Prolog
ops__op_table("::", after, xfx, 1175). % Mercury extension
ops__op_table(";", after, xfy, 1100). % standard ISO Prolog
ops__op_table("<", after, xfx, 700). % standard ISO Prolog
ops__op_table("<<", after, yfx, 400). % standard ISO Prolog
ops__op_table("<=", after, xfy, 920). % Mercury/NU-Prolog extension
ops__op_table("<=>", after, xfy, 920). % Mercury/NU-Prolog extension
ops__op_table("=", after, xfx, 700). % standard ISO Prolog
ops__op_table("=..", after, xfx, 700). % standard ISO Prolog
ops__op_table("=:=", after, xfx, 700). % standard ISO Prolog (*)
ops__op_table("=<", after, xfx, 700). % standard ISO Prolog
ops__op_table("==", after, xfx, 700). % standard ISO Prolog (*)
ops__op_table("=>", after, xfy, 920). % Mercury/NU-Prolog extension
ops__op_table("=\\=", after, xfx, 700). % standard ISO Prolog (*)
ops__op_table(">", after, xfx, 700). % standard ISO Prolog
ops__op_table(">=", after, xfx, 700). % standard ISO Prolog
ops__op_table(">>", after, yfx, 400). % standard ISO Prolog
ops__op_table("?-", before, fx, 1200). % standard ISO Prolog (*)
ops__op_table("@<", after, xfx, 700). % standard ISO Prolog
ops__op_table("@=<", after, xfx, 700). % standard ISO Prolog
ops__op_table("@>", after, xfx, 700). % standard ISO Prolog
ops__op_table("@>=", after, xfx, 700). % standard ISO Prolog
ops__op_table("\\", before, fx, 200). % standard ISO Prolog
ops__op_table("\\+", before, fy, 900). % standard ISO Prolog
ops__op_table("\\/", after, yfx, 500). % standard ISO Prolog
ops__op_table("\\=", after, xfx, 700). % standard ISO Prolog
ops__op_table("\\==", after, xfx, 700). % standard ISO Prolog (*)
ops__op_table("^", after, xfy, 200). % standard ISO Prolog
ops__op_table("all", before, fxy, 950). % Mercury/NU-Prolog extension
ops__op_table("and", after, xfy, 720). % NU-Prolog extension
ops__op_table("div", after, yfx, 400). % standard ISO Prolog
ops__op_table("else", after, xfy, 1170). % Mercury/NU-Prolog extension
ops__op_table("end_module", before, fx, 1199). % Mercury extension
ops__op_table("export_adt", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("export_cons", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("export_module", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("export_op", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("export_pred", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("export_sym", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("export_type", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("func", before, fx, 800). % Mercury extension
ops__op_table("if", before, fx, 1160). % Mercury/NU-Prolog extension
ops__op_table("import_adt", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("import_cons", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("import_module", before, fx, 1199). % Mercury extension
ops__op_table("include_module", before, fx, 1199). % Mercury extension
ops__op_table("import_op", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("import_pred", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("import_sym", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("import_type", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("impure", before, fy, 800). % Mercury extension
ops__op_table("inst", before, fx, 1199). % Mercury extension
ops__op_table("instance", before, fx, 1199). % Mercury extension
ops__op_table("is", after, xfx, 701). % ISO Prolog says prec 700
ops__op_table("lambda", before, fxy, 950). % Mercury extension
ops__op_table("mod", after, xfx, 400). % Standard ISO Prolog
ops__op_table("mode", before, fx, 1199). % Mercury extension
ops__op_table("module", before, fx, 1199). % Mercury extension
ops__op_table("not", before, fy, 900). % Mercury/NU-Prolog extension
ops__op_table("or", after, xfy, 740). % NU-Prolog extension
ops__op_table("pragma", before, fx, 1199). % Mercury extension
ops__op_table("pred", before, fx, 800). % Mercury/NU-Prolog extension
ops__op_table("rem", after, xfx, 400). % Standard ISO Prolog
ops__op_table("rule", before, fx, 1199). % NU-Prolog extension
ops__op_table("semipure", before, fy, 800). % Mercury extension
ops__op_table("some", before, fxy, 950). % Mercury/NU-Prolog extension
ops__op_table("then", after, xfx, 1150). % Mercury/NU-Prolog extension
ops__op_table("type", before, fx, 1180). % Mercury extension
ops__op_table("typeclass", before, fx, 1199). % Mercury extension
ops__op_table("use_adt", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("use_cons", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("use_module", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("use_op", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("use_pred", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("use_sym", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("use_type", before, fx, 1199). % Mercury extension (NYI)
ops__op_table("when", after, xfx, 900). % NU-Prolog extension (*)
ops__op_table("where", after, xfx, 1175). % NU-Prolog extension (*)
ops__op_table("~", before, fy, 900). % Goedel (*)
ops__op_table("~=", after, xfx, 700). % NU-Prolog (*)
% (*) means that the operator is not useful in Mercury
% and is provided only for compatibility.
% (NYI) means that the operator is reserved for some Not Yet Implemented
% future purpose
ops__init_op_table(ops__table).
ops__max_priority(1200).
%-----------------------------------------------------------------------------%