Files
mercury/compiler/options.m
Zoltan Somogyi 666c4b785e Move toward the proposed structures for representing type class information at
Estimated hours taken: 32
Branches: main

Move toward the proposed structures for representing type class information at
runtime by adding code for generating the structures corresponding to
base_typeclass_infos. The structures corresponding to typeclass_infos will
be added in a later change.

Register the new data structures in a table at runtime.

Add four new mdb developer commands for checking the contents of the new
type class table, as well as the contents of the existing type constructor
table: class_decl, type_ctor, all_class_decls and all_type_ctors.

compiler/rtti.m:
	Add the data types required to represent the new runtime data
	structures that will eventually replace base_typeclass_infos
	inside the compiler.

	Add the required function symbols to the data types representing both
	the new RTTI data structures themselves and those representing
	references to them.

	Make the required changes to the predicates operating on the modified
	data types, and add some required new predicates.

compiler/rtti_out.m:
	Add code to write out the new data structures for the LLDS backend.

	Make some changes in existing predicates to allow them to be used
	in the new code.

compiler/layout_out.m:
	Factor out some code that is now common with rtti_out.m.

compiler/type_class_info.m:
	A new module to generate the new RTTI data structures.

compiler/backend_libs.m:
	Include the new module.

compiler/options.m:
	Add a new option, --new-type-class-rtti, to control whether we
	invoke the top level predicate of type_class_info.m to generate
	the new type class RTTI structures. We still generate and use
	base_typeclass_infos regardless of the value of this option.

compiler/mercury_compile.m:
	Invoke the code of the new module if --new-type-class-rtti is given.

compiler/opt_debug.m:
	Add code to dump descriptions of the new rtti_ids.

compiler/mlds_to_gcc.m:
compiler/rtti_to_mlds.m:
	Handle the new alternatives in the rtti data types, mostly by throwing
	exceptions. The actual code should be written later by Fergus.

compiler/pseudo_type_info.m:
	Module qualify the names of builtin types when generating
	pseudo-typeinfos for them. This makes the naming scheme more regular.

compiler/base_typeclass_info.m:
compiler/notes/type_class_transformation.html:
	Document the impending obsolescence of these files.

compiler/notes/work_in_progress.html:
	List type class RTTI as work in progress.

library/list.m:
	Add a utility predicate for use by compiler/rtti_out.m.

runtime/mercury_typeclass_info.h:
	Make some changes in the C data types representing type class
	information that I discovered to be necessary or advantageous
	in the process of generating values of those types automatically.

	Rename some types to make their names be better documentation.

	Change some arrays of pointers to structures into arrays of structures,
	where the structures at different array indexes are the same size.

	Removing consts that rtti_out.m supplies automatically avoids
	duplicate const errors from the C compiler.

	Add #includes to make the file namespace clean.

	Protect against multiple inclusion.

runtime/mercury_typeclass_info_example.c:
	Remove this file. After the changes to mercury_typeclass_info.h, its
	contents are no longer correct examples of the structures in
	mercury_typeclass_info.h, and since the compiler can now generate
	those structures automatically, hand-written examples no longer serve
	any useful pupose.

runtime/mercury_types.h:
	Add a new type, MR_CodePtr, for use in mercury_typeclass_info.h.
	The compiler predicate tc_rtti_name_type wants single-word names
	for types.

runtime/mercury_imp.h:
	#include mercury_typeclass_info.h.

runtime/mercury_type_tables.[ch]:
	Add functions to register and to look up type class declarations and
	type class instances.

	Add the functions and data structures required to look up all type
	constructors and all type classes. The debugger uses these to support
	the commands that let the programmer check the contents of these
	tables.

	Eventually, we should be able to use the type class tables to test
	whether a vector of types is a member of a given type class.

runtime/mercury_wrapper.c:
runtime/mercury_type_info.[ch]:
	Move the array of type_ctor_rep names from the mercury_wrapper module
	to the mercury_type_info module, and make it always-defined and public;
	the debugger also needs access to it now.

runtime/Mmakefile:
	Add mercury_typeclass_info.h to the list of header files that other
	files depend on.

trace/mercury_trace_internal.c:
	Add four new mdb commands: class_decl, type_ctor, all_class_decls
	and all_type_ctors.

	Make some existing code follow our coding conventions.

doc/user_guide.texi:
doc/mdb_categories:
	Document the four new mdb commands.

doc/reference_manual.texi:
	Document (in a comment) the compiler's reliance on each type in an
	instance declaration containing exactly one type constructor.

tests/debugger/class_decl.{m,inp,exp}:
	A new test case to test the new mdb commands.

tests/debugger/Mmakefile:
tests/debugger/Mercury.options:
	Add the new test case.

tests/debugger/completion.exp:
	Expect the new commands to appear in the command name completion.

tests/debugger/mdb_command_test.inp:
	Test the documentation of the new mdb commands.
	Expect the new commands to appear in the command name completion.
2003-10-23 02:02:45 +00:00

4116 lines
157 KiB
Mathematica

%-----------------------------------------------------------------------------%
% Copyright (C) 1994-2003 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: options.m.
% Main author: fjh.
% This defines the stuff necessary so that getopt.m
% can parse the command-line options.
% IMPORTANT NOTE: any changes to the options should be
% reflected in both the help message produced below,
% and in the Mercury User's Guide (../doc/user_guide.texi).
%-----------------------------------------------------------------------------%
:- module libs__options.
:- interface.
:- import_module char, io, getopt.
:- pred short_option(char::in, option::out) is semidet.
:- pred long_option(string::in, option::out) is semidet.
:- pred option_defaults(option::out, option_data::out) is nondet.
:- pred special_handler(option::in, special_data::in, option_table::in,
maybe_option_table::out) is semidet.
% special_handler(Option, ValueForThatOption, OptionTableIn,
% MaybeOptionTableOut).
% This predicate is invoked whenever getopt finds an option
% (long or short) designated as special, with special_data holding
% the argument of the option (if any). The predicate can change the
% option table in arbitrary ways in the course of handling the option,
% or it can return an error message.
% The canonical examples of special options are -O options in compilers,
% which set many other options at once.
% The MaybeOptionTableOut may either be ok(OptionTableOut), or it may
% be error(ErrorString).
:- pred options_help(io__state::di, io__state::uo) is det.
:- type option_table == option_table(option).
:- type maybe_option_table == maybe_option_table(option).
% Add a directory to search for Mercury libraries. This
% adds `--search-directory', `--c-include-directory',
% `--library-directory' and `--init-file-directory' options.
:- func option_table_add_mercury_library_directory(option_table,
string) = option_table.
% Quote an argument to a shell command.
:- func quote_arg(string) = string.
% NOTE: ALL OPTIONS SHOULD BE DOCUMENTED!
%
% Officially supported options should be documented both in the
% help message output by options_help/2, and also in the
% "invocation" chapter of doc/user_guide.texi.
%
% Options which are not officially supported (e.g. those used
% internally by the Mercury implementation, those which are not
% sufficiently useful to be worth mentioning in the User Guide,
% or options for experimental features that are not yet stable
% enough to be officially supported should still be documented.
% The documentation can go either next to the option definition
% here, or as commented-out code in the appropriate subroutine
% of options_help/2.
:- type option
% Warning options
---> inhibit_warnings
; inhibit_accumulator_warnings
; halt_at_warn
; halt_at_syntax_errors
; warn_singleton_vars
; warn_overlapping_scopes
; warn_det_decls_too_lax
; warn_inferred_erroneous
; warn_nothing_exported
; warn_unused_args
; warn_interface_imports
; warn_missing_opt_files
; warn_missing_trans_opt_files
; warn_missing_trans_opt_deps
; warn_non_stratification
; warn_simple_code
; warn_duplicate_calls
; warn_missing_module_name
; warn_wrong_module_name
; warn_smart_recompilation
; warn_undefined_options_variables
; warn_non_tail_recursion
; warn_target_code
; warn_up_to_date
; warn_stubs
; warn_dead_procs
% Verbosity options
; verbose
; very_verbose
; verbose_errors
; verbose_recompilation
; find_all_recompilation_reasons
; verbose_make
; verbose_commands
; output_compile_error_lines
; statistics
; debug_types
; debug_modes
; debug_det
; debug_opt
; debug_opt_pred_id
; debug_pd % pd = partial deduction/deforestation
; debug_rl_gen
; debug_rl_opt
; debug_il_asm % il_asm = IL generation via asm
; debug_liveness
; debug_stack_opt
; debug_make
% Output options
; make_short_interface
; make_interface
; make_private_interface
; make_optimization_interface
; make_transitive_opt_interface
; generate_source_file_mapping
; generate_dependencies
; generate_module_order
; convert_to_mercury
; typecheck_only
; errorcheck_only
; target_code_only
; compile_only
; compile_to_shared_lib
; aditi_only
; output_grade_string
; output_link_command
; output_shared_lib_link_command
% Auxiliary output options
; smart_recompilation
% This option is used to control output
% of version numbers in interface files.
% It is implied by --smart-recompilation,
% and cannot be set explicitly by the user.
; generate_item_version_numbers
; generate_mmc_make_module_dependencies
; assume_gmake
; trace
; trace_optimized
; trace_table_io
; trace_table_io_only_retry
; trace_table_io_states
; trace_table_io_require
; trace_table_io_all
; delay_death
; suppress_trace
; stack_trace_higher_order
; generate_bytecode
; line_numbers
; auto_comments
; show_dependency_graph
; dump_hlds
; dump_hlds_pred_id
; dump_hlds_alias
; dump_hlds_options
; dump_mlds
; verbose_dump_mlds
; generate_schemas
; dump_rl
; dump_rl_bytecode
; sign_assembly
; separate_assemblies
% Language semantics options
; reorder_conj
; reorder_disj
; fully_strict
; strict_sequential
; allow_stubs
; infer_types
; infer_modes
; infer_det
; infer_all
; type_inference_iteration_limit
; mode_inference_iteration_limit
% Compilation Model options
; grade
% Target selection options
; target
; il % target il
; il_only % target il + target_code_only
; compile_to_c % target c + target_code_only
; java % target java
; java_only % target java + target_code_only
% Compilation model options for optional features:
% (a) Debugging
% For documentation of the stack_trace, require_tracing,
% and decl_debug options, see the documentation for
% MR_STACK_TRACE, MR_REQUIRE_TRACING, and MR_DECL_DEBUG
% in runtime/mercury_conf_param.h.
% The debug option just means both stack_trace and
% require_tracing.
; debug
; stack_trace
; require_tracing
; decl_debug
% (b) Profiling
; profiling % profile_time + profile_calls
; time_profiling % profile_time + profile_calls
; memory_profiling % profime_mem + profile_calls
; deep_profiling % profile_deep
; profile_calls
; profile_time
; profile_memory
; profile_deep
; use_activation_counts
% use_activation_counts is used to determine
% which mechanism for cycle detection should be
% used for deep profiling. Actually, we only
% want to use the `yes' value, but we keep
% support for the `no' value for benchmarks
% for the paper.
; use_zeroing_for_ho_cycles
; use_lots_of_ho_specialization
% We should always handle tail recursion
% specially in deep profiling; the option is
% only for benchmarks for the paper.
; deep_profile_tail_recursion
; record_term_sizes_as_words
; record_term_sizes_as_cells
% (c) Miscellaneous
; gc
; parallel
; use_trail
; use_minimal_model
; type_layout
% Data representation compilation model options
; reserve_tag
; tags
; num_tag_bits
; num_reserved_addresses
; num_reserved_objects
; bits_per_word
; bytes_per_word
% The undocumented conf_low_tag_bits option
% is used by the `mmc' script to pass the
% default value for num_tag_bits
% assuming --tags low.
% The reason that `mmc' doesn't just
% pass a default value for --num-tag-bits
% is that we want to be able to give an
% error message if the user specifies
% `--tags high' and doesn't specify
% `--num-tag-bits'.
; conf_low_tag_bits
; unboxed_float
; unboxed_enums
; unboxed_no_tag_types
; sync_term_size % in words
% LLDS back-end compilation model options
; gcc_non_local_gotos
; gcc_global_registers
; asm_labels
; pic_reg
% MLDS back-end compilation model options
; highlevel_code
; highlevel_data
; gcc_nested_functions
; det_copy_out
; nondet_copy_out
; put_commit_in_own_func
; put_nondet_env_on_heap
% IL back-end compilation model options
; verifiable_code
; il_refany_fields
; il_funcptr_types
; il_byref_tailcalls % Currently this is not really a
% compilation model option,
% i.e. it doesn't affect the ABI.
% In future it might become one,
% though -- we should return
% multiple values in value types,
% rather than using byrefs.
% Also it's nicer to keep it with
% the other IL back-end options here.
% Options for internal use only
% (the values of these options are implied by the
% settings of other options)
% The foreign programming languages that this
% backend can interface to.
; backend_foreign_languages
% Stack layout information required to do
% a stack trace.
; basic_stack_layout
% Stack layout information required to do
% accurate GC.
; agc_stack_layout
% Stack layout information required to do
% procedure identification.
; procid_stack_layout
% Stack layout information required to do
% execution tracing.
; trace_stack_layout
% Use an alternate calculation of liveness
% where the typeinfo for a type variable
% must live at any point in the body of the
% procedure at which a live variable's type
% includes that type variable.
%
% Although this option governs whether the
% body of a procedure uses this liveness
% calculation, it is not the only consideration
% we have to take into account when deciding on
% the interface of any procedure whose address
% may be taken. We must include typeinfos
% describing the types of all arguments in the
% interface of a procedure if either this
% option is set *or* the procedure's address
% may be taken, otherwise, the layout structure
% we include in closures using that procedure
% may not have all the information required
% to reconstruct the types of all the values
% inside the closure.
%
% The only place in the compiler that should
% look at this option is the predicate
% body_should_use_typeinfo_liveness in
% hlds_pred.m; everything else, including
% the predicates deciding interface typeinfo
% liveness, should go through there.
; body_typeinfo_liveness
% Options for internal use only
% (setting these options to non-default values can result in
% programs that do not link, or programs that dump core)
% Generate unify and compare preds. For
% measurement only. Code generated with
% this set to `no' is unlikely to
% actually work.
; special_preds
% Generate type_ctor_info structures.
% For measurement only -- if you turn this
% off, then you're unlikely to be able
% to link.
; type_ctor_info
% Generate type_ctor_layout structures.
% For measurement only -- if you turn this
% off, then you're unlikely to be able
% to link.
; type_ctor_layout
% Generate type_ctor_functors structures.
% For measurement only -- if you turn this
% off, then you're unlikely to be able
% to link.
; type_ctor_functors
% XXX temporary option: enables the generation
% of new style static data structures for
% runtime information about type classes.
% These are not yet used. When we add code to
% generate the matching dynamic data structures
% and switch over to use them, we won't need
% this option anymore.
; new_type_class_rtti
% Generate line number information in the RTTI
% when debugging is enabled. For measurement
% only -- if you turn this off, then the
% debugger may dereference garbage pointers.
; rtti_line_numbers
% Code generation options
; low_level_debug
; trad_passes
; polymorphism
; reclaim_heap_on_failure
; reclaim_heap_on_semidet_failure
; reclaim_heap_on_nondet_failure
; have_delay_slot
; num_real_r_regs
; num_real_f_regs
; num_real_r_temps
; num_real_f_temps
; pic
; max_jump_table_size
; compare_specialization
; fact_table_max_array_size
% maximum number of elements in a single
% fact table data array
; fact_table_hash_percent_full
% how full the fact table hash tables should
% be allowed to get, given as an integer
% percentage.
; gcc_local_labels
; prefer_switch
; opt_no_return_calls
% Optimization Options
; opt_level
; opt_space % default is to optimize time
; intermodule_optimization
; intermodule_analysis
; read_opt_files_transitively
; automatic_intermodule_optimization
; use_opt_files
; use_trans_opt_files
; transitive_optimization
; split_c_files
% - HLDS
; inlining
; inline_simple
; inline_builtins
; inline_single_use
; inline_compound_threshold
; inline_simple_threshold
; inline_vars_threshold
; intermod_inline_simple_threshold
; common_struct
; common_goal
; constraint_propagation
; local_constraint_propagation
; optimize_unused_args
; intermod_unused_args
; optimize_higher_order
; higher_order_size_limit
; higher_order_arg_limit
; unneeded_code
; unneeded_code_copy_limit
; type_specialization
; user_guided_type_specialization
; introduce_accumulators
; optimize_constructor_last_call
; optimize_duplicate_calls
; constant_propagation
; excess_assign
; optimize_saved_vars_const
; optimize_saved_vars_cell
; optimize_saved_vars_cell_loop
; optimize_saved_vars_cell_full_path
; optimize_saved_vars_cell_on_stack
; optimize_saved_vars_cell_candidate_headvars
; optimize_saved_vars_cell_cv_store_cost
; optimize_saved_vars_cell_cv_load_cost
; optimize_saved_vars_cell_fv_store_cost
; optimize_saved_vars_cell_fv_load_cost
; optimize_saved_vars_cell_op_ratio
; optimize_saved_vars_cell_node_ratio
; optimize_saved_vars_cell_all_path_node_ratio
; optimize_saved_vars_cell_include_all_candidates
; optimize_saved_vars
; loop_invariants
; delay_construct
; follow_code
; prev_code
; optimize_dead_procs
; deforestation
; deforestation_depth_limit
; deforestation_cost_factor
; deforestation_vars_threshold
; deforestation_size_threshold
; termination
; check_termination
; verbose_check_termination
; termination_single_args
; termination_norm
; termination_error_limit
; termination_path_limit
% - HLDS->LLDS
; smart_indexing
; dense_switch_req_density
; lookup_switch_req_density
; dense_switch_size
; lookup_switch_size
; string_switch_size
; tag_switch_size
; try_switch_size
; binary_switch_size
; static_ground_terms
; middle_rec
; simple_neg
; allow_hijacks
% - MLDS
; optimize_tailcalls
; optimize_initializations
; eliminate_local_vars
% - LLDS
; common_data
; optimize % also used for MLDS->MLDS optimizations
; optimize_peep
; optimize_jumps
; optimize_fulljumps
; pessimize_tailcalls
; checked_nondet_tailcalls
; use_local_vars
; local_var_access_threshold
; optimize_labels
; optimize_dups
%%% unused: ; optimize_copyprop
; optimize_frames
; optimize_delay_slot
; optimize_reassign
; optimize_repeat
% - RL
; optimize_rl
; optimize_rl_cse
; optimize_rl_invariants
; optimize_rl_index
; detect_rl_streams
% - C
; use_macro_for_redo_fail
; emit_c_loops
; procs_per_c_function
; everything_in_one_c_function
% - IL
% (none yet)
% Target code compilation options
; target_debug
% C
; cc
; cflags
; quoted_cflag
; c_include_directory
; c_optimize
; ansi_c
; inline_alloc
% auto-configured C compilation options.
; cflags_for_warnings
; cflags_for_optimization
; cflags_for_ansi
; cflags_for_regs
; cflags_for_gotos
; cflags_for_threads
; cflags_for_debug
; cflags_for_pic
; c_flag_to_name_object_file
; object_file_extension
; pic_object_file_extension
; link_with_pic_object_file_extension
% Java
; java_compiler
; java_flags
; quoted_java_flag
; java_classpath
; java_object_file_extension
% IL
; il_assembler
; ilasm_flags
; quoted_ilasm_flag
; dotnet_library_version
; support_ms_clr
; support_rotor_clr
% Managed C++
; mcpp_compiler
; mcpp_flags
; quoted_mcpp_flag
% C#
; csharp_compiler
; csharp_flags
; quoted_csharp_flag
% Link options
; output_file_name
; ld_flags
; quoted_ld_flag
; ld_libflags
; quoted_ld_libflag
; link_library_directories
; runtime_link_library_directories
; link_libraries
; link_objects
; mercury_library_directories
; mercury_library_directory_special
; mercury_libraries
; mercury_library_special
; mercury_standard_library_directory
; mercury_standard_library_directory_special
; init_file_directories
; init_files
; trace_init_files
; linkage
; linkage_special
; mercury_linkage
; mercury_linkage_special
; strip
; demangle
; main
; allow_undefined
; use_readline
; runtime_flags
; extra_initialization_functions
% auto-configured options.
; shared_library_extension
; library_extension
; executable_file_extension
; link_executable_command
; link_shared_lib_command
; create_archive_command
; create_archive_command_output_flag
; create_archive_command_flags
; ranlib_command
; mkinit_command
; demangle_command
; trace_libs
; thread_libs
; shared_libs
; math_lib
; readline_libs
; linker_opt_separator
; linker_thread_flags
; shlib_linker_thread_flags
; linker_static_flags
; linker_strip_flag
; linker_link_lib_flag
; linker_link_lib_suffix
; shlib_linker_link_lib_flag
; shlib_linker_link_lib_suffix
; linker_debug_flags
; shlib_linker_debug_flags
; linker_trace_flags
; shlib_linker_trace_flags
; linker_path_flag
; linker_rpath_flag
; linker_rpath_separator
; shlib_linker_rpath_flag
; shlib_linker_rpath_separator
; linker_allow_undefined_flag
; linker_error_undefined_flag
% Build system options
; make
; keep_going
; rebuild
; invoked_by_mmc_make
; extra_init_command
; pre_link_command
; install_prefix
; use_symlinks
; mercury_configuration_directory
; mercury_configuration_directory_special
; install_command
; libgrades
; options_files
; config_file
; options_search_directories
; use_subdirs
; use_grade_subdirs
% Miscellaneous Options
; search_directories
; intermod_directories
; use_search_directories_for_intermod
; filenames_from_stdin
; aditi % XXX this should be in the
% "Auxiliary output options"
% section
; aditi_user
; help
; fullarch
; compiler_sufficiently_recent
% This option is used to test that the compiler
% is sufficiently recent when no other test
% can easily be constructed in configure.in.
.
:- implementation.
:- import_module libs__handle_options.
:- import_module string, bool, int, map, std_util, assoc_list, require, list.
:- import_module dir.
:- type option_category
---> warning_option
; verbosity_option
; output_option
; aux_output_option
; language_semantics_option
; compilation_model_option
; internal_use_option
; code_gen_option
; special_optimization_option
; optimization_option
; target_code_compilation_option
; link_option
; build_system_option
; miscellaneous_option.
option_defaults(Option, Default) :-
option_defaults_2(_Category, OptionsList),
list__member(Option - Default, OptionsList).
:- pred option_defaults_2(option_category, list(pair(option, option_data))).
:- mode option_defaults_2(in, out) is det.
:- mode option_defaults_2(out, out) is multidet.
option_defaults_2(warning_option, [
% Warning Options
inhibit_warnings - bool_special,
inhibit_accumulator_warnings - bool(no),
halt_at_warn - bool(no),
halt_at_syntax_errors - bool(no),
%
% IMPORTANT NOTE:
% if you add any new warning options, or if you change
% the default for an existing warning option to `yes',
% then you will need to modify the handling of inhibit_warnings
%
warn_singleton_vars - bool(yes),
warn_overlapping_scopes - bool(yes),
warn_det_decls_too_lax - bool(yes),
warn_inferred_erroneous - bool(yes),
warn_nothing_exported - bool(yes),
warn_unused_args - bool(no),
warn_interface_imports - bool(yes),
warn_non_stratification - bool(no),
warn_missing_opt_files - bool(yes),
warn_missing_trans_opt_files - bool(no),
warn_missing_trans_opt_deps - bool(yes),
warn_simple_code - bool(yes),
warn_duplicate_calls - bool(no),
warn_missing_module_name - bool(yes),
warn_wrong_module_name - bool(yes),
warn_smart_recompilation - bool(yes),
warn_undefined_options_variables - bool(yes),
warn_non_tail_recursion - bool(no),
warn_target_code - bool(yes),
warn_up_to_date - bool(yes),
warn_stubs - bool(yes),
warn_dead_procs - bool(no)
]).
option_defaults_2(verbosity_option, [
% Verbosity Options
verbose - bool(no),
very_verbose - bool(no),
verbose_errors - bool(no),
verbose_recompilation - bool(no),
find_all_recompilation_reasons -
bool(no),
verbose_make - bool(yes),
verbose_commands - bool(no),
output_compile_error_lines - int(15),
statistics - bool(no),
debug_types - bool(no),
debug_modes - bool(no),
debug_det - bool(no),
debug_opt - bool(no),
debug_opt_pred_id - int(-1),
debug_pd - bool(no),
debug_rl_gen - bool(no),
debug_rl_opt - bool(no),
debug_il_asm - bool(no),
debug_liveness - int(-1),
debug_stack_opt - int(-1),
debug_make - bool(no)
]).
option_defaults_2(output_option, [
% Output Options (mutually exclusive)
generate_source_file_mapping - bool(no),
generate_dependencies - bool(no),
generate_module_order - bool(no),
make_short_interface - bool(no),
make_interface - bool(no),
make_private_interface - bool(no),
make_optimization_interface - bool(no),
make_transitive_opt_interface - bool(no),
convert_to_mercury - bool(no),
typecheck_only - bool(no),
errorcheck_only - bool(no),
target_code_only - bool(no),
compile_only - bool(no),
compile_to_shared_lib - bool(no),
aditi_only - bool(no),
output_grade_string - bool(no),
output_link_command - bool(no),
output_shared_lib_link_command - bool(no)
]).
option_defaults_2(aux_output_option, [
% Auxiliary Output Options
smart_recompilation - bool(no),
generate_item_version_numbers - bool(no),
generate_mmc_make_module_dependencies - bool(no),
assume_gmake - bool(yes),
trace - string("default"),
trace_optimized - bool(no),
trace_table_io - bool(no),
trace_table_io_only_retry - bool(no),
trace_table_io_states - bool(no),
trace_table_io_require - bool(no),
trace_table_io_all - bool(no),
suppress_trace - string(""),
delay_death - bool(yes),
stack_trace_higher_order - bool(no),
generate_bytecode - bool(no),
line_numbers - bool(yes),
auto_comments - bool(no),
show_dependency_graph - bool(no),
dump_hlds - accumulating([]),
dump_hlds_pred_id - int(-1),
dump_hlds_alias - string(""),
dump_hlds_options - string(""),
dump_mlds - accumulating([]),
verbose_dump_mlds - accumulating([]),
dump_rl - bool(no),
dump_rl_bytecode - bool(no),
sign_assembly - bool(no),
% XXX should default to no but currently broken
separate_assemblies - bool(yes),
generate_schemas - bool(no)
]).
option_defaults_2(language_semantics_option, [
strict_sequential - special,
reorder_conj - bool(yes),
reorder_disj - bool(yes),
fully_strict - bool(yes),
allow_stubs - bool(no),
infer_types - bool(no),
infer_modes - bool(no),
infer_det - bool(yes),
infer_all - bool_special,
type_inference_iteration_limit - int(60),
mode_inference_iteration_limit - int(30)
]).
option_defaults_2(compilation_model_option, [
%
% Compilation model options (ones that affect binary
% compatibility).
%
grade - string_special,
% the `mmc' script will pass the
% default grade determined
% at configuration time
% Target selection compilation model options
target - string("c"),
il - special,
il_only - special,
compile_to_c - special,
java - special,
java_only - special,
% Optional feature compilation model options:
% (a) Debuggging
debug - bool_special,
stack_trace - bool(no),
require_tracing - bool(no),
decl_debug - bool(no),
% (b) Profiling
profiling - bool_special,
time_profiling - special,
memory_profiling - special,
deep_profiling - special,
profile_calls - bool(no),
profile_time - bool(no),
profile_memory - bool(no),
profile_deep - bool(no),
use_activation_counts - bool(no),
use_zeroing_for_ho_cycles
- bool(yes),
use_lots_of_ho_specialization
- bool(no),
deep_profile_tail_recursion
- bool(yes),
record_term_sizes_as_words - bool(no),
record_term_sizes_as_cells - bool(no),
% (c) Miscellaneous optional features
gc - string("boehm"),
parallel - bool(no),
use_trail - bool(no),
use_minimal_model - bool(no),
type_layout - bool(yes),
% Data representation compilation model options
reserve_tag - bool(no),
pic_reg - bool(no),
tags - string("low"),
num_tag_bits - int(-1),
% -1 is a special value which means
% use the value of conf_low_tag_bits
% instead
num_reserved_addresses - int(0),
num_reserved_objects - int(0),
bits_per_word - int(32),
% A good default for the current
% generation of architectures.
bytes_per_word - int(4),
% A good default for the current
% generation of architectures.
conf_low_tag_bits - int(2),
% the `mmc' script will override the
% above default with a value determined
% at configuration time
sync_term_size - int(8),
% 8 is the size on linux (at the time
% of writing) - will usually be over-
% ridden by a value from configure.
unboxed_float - bool(no),
unboxed_enums - bool(yes),
unboxed_no_tag_types - bool(yes),
% LLDS back-end compilation model options
gcc_non_local_gotos - bool(yes),
gcc_global_registers - bool(yes),
asm_labels - bool(yes),
% MLDS back-end compilation model options
highlevel_code - bool(no),
highlevel_data - bool(no),
gcc_nested_functions - bool(no),
det_copy_out - bool(no),
nondet_copy_out - bool(no),
put_commit_in_own_func - bool(no),
put_nondet_env_on_heap - bool(no),
% IL back-end compilation model options
verifiable_code - bool(no),
il_funcptr_types - bool(no),
il_refany_fields - bool(no),
il_byref_tailcalls - bool(no)
]).
option_defaults_2(internal_use_option, [
% Options for internal use only
backend_foreign_languages- accumulating([]),
% The backend_foreign_languages option
% depends on the target and is set in
% handle_options.
basic_stack_layout - bool(no),
agc_stack_layout - bool(no),
procid_stack_layout - bool(no),
trace_stack_layout - bool(no),
body_typeinfo_liveness - bool(no),
special_preds - bool(yes),
type_ctor_info - bool(yes),
type_ctor_layout - bool(yes),
type_ctor_functors - bool(yes),
rtti_line_numbers - bool(yes),
new_type_class_rtti - bool(no)
]).
option_defaults_2(code_gen_option, [
% Code Generation Options
low_level_debug - bool(no),
trad_passes - bool(yes),
polymorphism - bool(yes),
reclaim_heap_on_failure - bool_special,
reclaim_heap_on_semidet_failure - bool(yes),
reclaim_heap_on_nondet_failure - bool(yes),
have_delay_slot - bool(no),
% the `mmc' script may override the
% above default if configure says
% the machine has branch delay slots
num_real_r_regs - int(5),
num_real_f_regs - int(0),
num_real_r_temps - int(5),
num_real_f_temps - int(0),
% the `mmc' script will override the
% above defaults with values determined
% at configuration time
pic - bool(no),
max_jump_table_size - int(0),
% 0 indicates any size.
compare_specialization - int(-1),
% -1 asks handle_options.m to give
% the value, which may be grade
% dependent.
fact_table_max_array_size - int(1024),
fact_table_hash_percent_full - int(90),
gcc_local_labels - bool(no),
prefer_switch - bool(yes),
opt_no_return_calls - bool(yes)
]).
option_defaults_2(special_optimization_option, [
% Special optimization options.
% These ones are not affected by `-O<n>'.
opt_level - int_special,
opt_space - special,
intermodule_optimization - bool(no),
intermodule_analysis - bool(no),
read_opt_files_transitively - bool(yes),
automatic_intermodule_optimization - bool(yes),
use_opt_files - bool(no),
use_trans_opt_files - bool(no),
transitive_optimization - bool(no),
check_termination - bool(no),
verbose_check_termination - bool(no),
termination - bool(no),
termination_single_args - int(0),
termination_norm - string("total"),
termination_error_limit - int(3),
termination_path_limit - int(256),
split_c_files - bool(no)
]).
option_defaults_2(optimization_option, [
% Optimization options
%
% IMPORTANT: the default here should be all optimizations OFF.
% Optimizations should be enabled by the appropriate
% optimization level in the opt_level table.
%
% HLDS
inlining - bool_special,
inline_simple - bool(no),
inline_builtins - bool(yes),
inline_single_use - bool(no),
inline_compound_threshold - int(0),
inline_simple_threshold - int(5), % has no effect until
% --inline-simple is enabled
inline_vars_threshold - int(100),
intermod_inline_simple_threshold - % has no effect until
int(5), % --intermodule-optimization
common_struct - bool(no),
common_goal - bool(yes),
% common_goal is not really an optimization, since
% it affects the semantics
constraint_propagation - bool(no),
local_constraint_propagation - bool(no),
optimize_duplicate_calls - bool(no),
constant_propagation - bool(no),
excess_assign - bool(no),
loop_invariants - bool(no),
optimize_saved_vars_const - bool(no),
optimize_saved_vars_cell - bool(no),
optimize_saved_vars_cell_loop - bool(yes),
optimize_saved_vars_cell_full_path - bool(yes),
optimize_saved_vars_cell_on_stack - bool(yes),
optimize_saved_vars_cell_candidate_headvars - bool(yes),
optimize_saved_vars_cell_cv_store_cost - int(3),
optimize_saved_vars_cell_cv_load_cost - int(1),
optimize_saved_vars_cell_fv_store_cost - int(1),
optimize_saved_vars_cell_fv_load_cost - int(1),
optimize_saved_vars_cell_op_ratio - int(100),
optimize_saved_vars_cell_node_ratio - int(100),
optimize_saved_vars_cell_all_path_node_ratio - int(100),
optimize_saved_vars_cell_include_all_candidates - bool(yes),
optimize_saved_vars - bool_special,
delay_construct - bool(no),
prev_code - bool(no),
follow_code - bool(no),
optimize_unused_args - bool(no),
intermod_unused_args - bool(no),
optimize_higher_order - bool(no),
higher_order_size_limit - int(20),
higher_order_arg_limit - int(10),
unneeded_code - bool(no),
unneeded_code_copy_limit- int(10),
type_specialization - bool(no),
user_guided_type_specialization - bool(no),
introduce_accumulators - bool(no),
optimize_constructor_last_call - bool(no),
optimize_dead_procs - bool(no),
deforestation - bool(no),
deforestation_depth_limit - int(4),
deforestation_cost_factor - int(1000),
deforestation_vars_threshold - int(200),
deforestation_size_threshold - int(15),
% HLDS -> LLDS
smart_indexing - bool(no),
dense_switch_req_density - int(25),
% Minimum density before using a dense switch
lookup_switch_req_density - int(25),
% Minimum density before using a lookup switch
dense_switch_size - int(4),
lookup_switch_size - int(4),
string_switch_size - int(8),
tag_switch_size - int(3),
try_switch_size - int(3),
binary_switch_size - int(4),
static_ground_terms - bool(no),
middle_rec - bool(no),
simple_neg - bool(no),
allow_hijacks - bool(yes),
% MLDS
optimize_tailcalls - bool(no),
optimize_initializations - bool(no),
eliminate_local_vars - bool(no),
% LLDS
common_data - bool(no),
optimize - bool(no),
optimize_peep - bool(no),
optimize_jumps - bool(no),
optimize_fulljumps - bool(no),
pessimize_tailcalls - bool(no),
checked_nondet_tailcalls - bool(no),
use_local_vars - bool(no),
local_var_access_threshold - int(2),
optimize_labels - bool(no),
optimize_dups - bool(no),
%%% optimize_copyprop - bool(no),
optimize_frames - bool(no),
optimize_delay_slot - bool(no),
optimize_reassign - bool(no),
optimize_repeat - int(0),
% LLDS -> C
use_macro_for_redo_fail - bool(no),
emit_c_loops - bool(no),
procs_per_c_function - int(1),
everything_in_one_c_function - special,
% RL
optimize_rl - bool(no),
optimize_rl_cse - bool(no),
optimize_rl_invariants - bool(no),
optimize_rl_index - bool(no),
detect_rl_streams - bool(no)
]).
option_defaults_2(target_code_compilation_option, [
% Target code compilation options
target_debug - bool(no),
% C
% the `mmc' script will override the
% following default with a value
% determined at configuration time.
cc - string("gcc"),
% the `mmc' script will override the
% following default with a value
% determined at configuration time
c_include_directory - accumulating([]),
c_optimize - bool(no),
ansi_c - bool(yes),
inline_alloc - bool(no),
cflags - accumulating([]),
quoted_cflag - string_special,
% the `mmc' script will override the
% following defaults with values
% determined at configuration time
cflags_for_warnings - string(""),
cflags_for_optimization - string("-O"),
cflags_for_ansi - string(""),
cflags_for_regs - string(""),
cflags_for_gotos - string(""),
cflags_for_threads - string(""),
cflags_for_debug - string("-g"),
cflags_for_pic - string(""),
c_flag_to_name_object_file - string("-o "),
object_file_extension - string(".o"),
pic_object_file_extension - string(".o"),
link_with_pic_object_file_extension - string(".o"),
% Java
java_compiler - string("javac"),
java_flags - accumulating([]),
quoted_java_flag - string_special,
java_classpath - accumulating([]),
java_object_file_extension - string(".class"),
% IL
il_assembler - string("ilasm"),
ilasm_flags - accumulating([]),
quoted_ilasm_flag - string_special,
% We default to the version of the library that came
% with Beta2.
dotnet_library_version - string("1.0.3300.0"),
support_ms_clr - bool(yes),
support_rotor_clr - bool(no),
% Managed C++
mcpp_compiler - string("cl"),
mcpp_flags - accumulating([]),
quoted_mcpp_flag - string_special,
% C#
csharp_compiler - string("csc"),
csharp_flags - accumulating([]),
quoted_csharp_flag - string_special
]).
option_defaults_2(link_option, [
% Link Options
output_file_name - string(""),
% if the output_file_name is an empty
% string, we use the name of the first
% module on the command line
ld_flags - accumulating([]),
quoted_ld_flag - string_special,
ld_libflags - accumulating([]),
quoted_ld_libflag - string_special,
link_library_directories - accumulating([]),
runtime_link_library_directories - accumulating([]),
link_libraries - accumulating([]),
link_objects - accumulating([]),
mercury_library_directory_special -
string_special,
mercury_library_directories - accumulating([]),
mercury_library_special - string_special,
mercury_libraries - accumulating([]),
% The Mercury.config file will set the
% default standard library directory.
mercury_standard_library_directory - maybe_string(no),
mercury_standard_library_directory_special - maybe_string_special,
init_file_directories - accumulating([]),
init_files - accumulating([]),
trace_init_files - accumulating([]),
linkage - string("shared"),
linkage_special - string_special,
mercury_linkage - string("shared"),
mercury_linkage_special - string_special,
demangle - bool(yes),
strip - bool(yes),
main - bool(yes),
allow_undefined - bool(no),
use_readline - bool(yes),
runtime_flags - accumulating([]),
extra_initialization_functions - bool(no),
% the `mmc' script will override the
% following defaults with a value
% determined at configuration time
shared_library_extension - string(".so"),
library_extension - string(".a"),
executable_file_extension - string(""),
link_executable_command - string("gcc"),
link_shared_lib_command - string("gcc -shared"),
create_archive_command - string("ar"),
create_archive_command_output_flag -
string(""),
create_archive_command_flags - accumulating([]), % "cr"
ranlib_command - string(""),
mkinit_command - string("mkinit"),
demangle_command - string("mdemangle"),
trace_libs - string(""),
thread_libs - string(""),
shared_libs - string(""),
math_lib - string(""),
readline_libs - string(""),
linker_opt_separator - string(""),
linker_debug_flags - string("-g"),
shlib_linker_debug_flags - string("-g"),
linker_trace_flags - string("-g"),
shlib_linker_trace_flags - string("-g"),
linker_thread_flags - string(""),
shlib_linker_thread_flags - string(""),
linker_static_flags - string("-static"),
linker_strip_flag - string("-s"),
linker_link_lib_flag - string("-l"),
linker_link_lib_suffix - string(""),
shlib_linker_link_lib_flag - string("-l"),
shlib_linker_link_lib_suffix - string(""),
linker_path_flag - string("-L"),
linker_rpath_flag - string("-Wl,-rpath"),
linker_rpath_separator - string(" -Wl,-rpath"),
shlib_linker_rpath_flag - string("-Wl,-rpath"),
shlib_linker_rpath_separator - string(" -Wl,-rpath"),
linker_allow_undefined_flag - string(""),
linker_error_undefined_flag - string("-Wl,-no-undefined")
]).
option_defaults_2(build_system_option, [
% Build System Options
make - bool(no),
keep_going - bool(no),
rebuild - bool(no),
invoked_by_mmc_make - bool(no),
pre_link_command - maybe_string(no),
extra_init_command - maybe_string(no),
install_prefix - string("/usr/local/"),
use_symlinks - bool(yes),
% If `--mercury-stdlib-dir' is set, `--mercury-config-dir'
% must also be set. This invariant is maintained by the
% `special' variants of the options.
mercury_configuration_directory_special - string_special,
mercury_configuration_directory - maybe_string(no),
install_command - string("cp"),
libgrades - accumulating([]),
options_files - accumulating(["Mercury.options"]),
% yes("") means unset.
config_file - maybe_string(yes("")),
options_search_directories - accumulating(["."]),
use_subdirs - bool(no),
use_grade_subdirs - bool(no),
search_directories - accumulating(["."]),
intermod_directories - accumulating([]),
use_search_directories_for_intermod
- bool(yes)
]).
option_defaults_2(miscellaneous_option, [
% Miscellaneous Options
filenames_from_stdin - bool(no),
aditi - bool(no),
aditi_user - string(""),
help - bool(no),
fullarch - string(""),
compiler_sufficiently_recent
- bool(no)
]).
% please keep this in alphabetic order
short_option('c', compile_only).
short_option('C', target_code_only).
short_option('d', dump_hlds).
short_option('D', dump_hlds_alias).
short_option('e', errorcheck_only).
short_option('E', verbose_errors).
short_option('f', generate_source_file_mapping).
short_option('h', help).
short_option('H', highlevel_code).
short_option('i', make_interface).
short_option('I', search_directories).
short_option('k', keep_going).
short_option('l', link_libraries).
short_option('L', link_library_directories).
short_option('m', make).
short_option('M', generate_dependencies).
short_option('n', line_numbers).
short_option('N', debug_modes).
short_option('o', output_file_name).
short_option('O', opt_level).
short_option('p', profiling).
short_option('P', convert_to_mercury).
short_option('r', rebuild).
short_option('R', runtime_link_library_directories).
short_option('s', grade).
short_option('S', statistics).
short_option('T', debug_types).
short_option('t', typecheck_only).
short_option('v', verbose).
short_option('V', very_verbose).
short_option('w', inhibit_warnings).
short_option('?', help).
% warning options
long_option("inhibit-warnings", inhibit_warnings).
long_option("inhibit-accumulator-warnings", inhibit_accumulator_warnings).
long_option("halt-at-warn", halt_at_warn).
long_option("halt-at-syntax-errors", halt_at_syntax_errors).
long_option("warn-singleton-variables", warn_singleton_vars).
long_option("warn-overlapping-scopes", warn_overlapping_scopes).
long_option("warn-det-decls-too-lax", warn_det_decls_too_lax).
long_option("warn-inferred-erroneous", warn_inferred_erroneous).
long_option("warn-nothing-exported", warn_nothing_exported).
long_option("warn-unused-args", warn_unused_args).
long_option("warn-interface-imports", warn_interface_imports).
long_option("warn-non-stratification", warn_non_stratification).
long_option("warn-missing-opt-files", warn_missing_opt_files).
long_option("warn-missing-trans-opt-files", warn_missing_trans_opt_files).
long_option("warn-missing-trans-opt-deps", warn_missing_trans_opt_deps).
long_option("warn-simple-code", warn_simple_code).
long_option("warn-duplicate-calls", warn_duplicate_calls).
long_option("warn-missing-module-name", warn_missing_module_name).
long_option("warn-wrong-module-name", warn_wrong_module_name).
long_option("warn-smart-recompilation", warn_smart_recompilation).
long_option("warn-undefined-options-variables",
warn_undefined_options_variables).
long_option("warn-non-tail-recursion", warn_non_tail_recursion).
long_option("warn-target-code", warn_target_code).
long_option("warn-up-to-date", warn_up_to_date).
long_option("warn-stubs", warn_stubs).
long_option("warn-dead-procs", warn_dead_procs).
% verbosity options
long_option("verbose", verbose).
long_option("very-verbose", very_verbose).
long_option("verbose-error-messages", verbose_errors).
long_option("verbose-recompilation", verbose_recompilation).
long_option("find-all-recompilation-reasons",
find_all_recompilation_reasons).
long_option("verbose-make", verbose_make).
long_option("verbose-commands", verbose_commands).
long_option("output-compile-error-lines", output_compile_error_lines).
long_option("statistics", statistics).
long_option("debug-types", debug_types).
long_option("debug-modes", debug_modes).
long_option("debug-determinism", debug_det).
long_option("debug-det", debug_det).
long_option("debug-opt", debug_opt).
long_option("debug-opt-pred-id", debug_opt_pred_id).
long_option("debug-pd", debug_pd).
long_option("debug-rl-gen", debug_rl_gen).
long_option("debug-rl-opt", debug_rl_opt).
% debug-il-asm does very low-level printf style debugging of
% IL assember. Each instruction is written on stdout before it
% is executed. It is a temporary measure until the IL debugging
% system built into .NET improves.
long_option("debug-il-asm", debug_il_asm).
long_option("debug-liveness", debug_liveness).
long_option("debug-stack-opt", debug_stack_opt).
long_option("debug-make", debug_make).
% output options (mutually exclusive)
long_option("generate-source-file-mapping",
generate_source_file_mapping).
long_option("generate-dependencies", generate_dependencies).
long_option("generate-module-order", generate_module_order).
long_option("make-short-interface", make_short_interface).
long_option("make-short-int", make_short_interface).
long_option("make-interface", make_interface).
long_option("make-int", make_interface).
long_option("make-private-interface", make_private_interface).
long_option("make-priv-int", make_private_interface).
long_option("make-optimization-interface",
make_optimization_interface).
long_option("make-optimisation-interface",
make_optimization_interface).
long_option("make-opt-int", make_optimization_interface).
long_option("make-transitive-optimization-interface",
make_transitive_opt_interface).
long_option("make-transitive-optimisation-interface",
make_transitive_opt_interface).
long_option("make-trans-opt", make_transitive_opt_interface).
long_option("convert-to-mercury", convert_to_mercury).
long_option("convert-to-Mercury", convert_to_mercury).
long_option("pretty-print", convert_to_mercury).
long_option("typecheck-only", typecheck_only).
long_option("errorcheck-only", errorcheck_only).
long_option("target-code-only", target_code_only).
long_option("compile-only", compile_only).
long_option("compile-to-shared-lib", compile_to_shared_lib).
long_option("aditi-only", aditi_only).
long_option("output-grade-string", output_grade_string).
long_option("output-link-command", output_link_command).
long_option("output-shared-lib-link-command",
output_shared_lib_link_command).
% aux output options
long_option("smart-recompilation", smart_recompilation).
long_option("assume-gmake", assume_gmake).
long_option("generate-mmc-make-module-dependencies",
generate_mmc_make_module_dependencies).
long_option("generate-mmc-deps", generate_mmc_make_module_dependencies).
long_option("trace", trace).
long_option("trace-optimised", trace_optimized).
long_option("trace-optimized", trace_optimized).
long_option("trace-table-io", trace_table_io).
long_option("trace-table-io-only-retry", trace_table_io_only_retry).
long_option("trace-table-io-states", trace_table_io_states).
long_option("trace-table-io-require", trace_table_io_require).
long_option("trace-table-io-all", trace_table_io_all).
long_option("suppress-trace", suppress_trace).
long_option("delay-death", delay_death).
long_option("stack-trace-higher-order", stack_trace_higher_order).
long_option("generate-bytecode", generate_bytecode).
long_option("line-numbers", line_numbers).
long_option("auto-comments", auto_comments).
long_option("show-dependency-graph", show_dependency_graph).
long_option("dump-hlds", dump_hlds).
long_option("hlds-dump", dump_hlds).
long_option("dump-hlds-pred-id", dump_hlds_pred_id).
long_option("dump-hlds-alias", dump_hlds_alias).
long_option("dump-hlds-options", dump_hlds_options).
long_option("dump-mlds", dump_mlds).
long_option("mlds-dump", dump_mlds).
long_option("verbose-dump-mlds", verbose_dump_mlds).
long_option("verbose-mlds-dump", verbose_dump_mlds).
long_option("dump-rl", dump_rl).
long_option("dump-rl-bytecode", dump_rl_bytecode).
long_option("sign-assembly", sign_assembly).
long_option("separate-assemblies", separate_assemblies).
long_option("generate-schemas", generate_schemas).
% language semantics options
long_option("reorder-conj", reorder_conj).
long_option("reorder-disj", reorder_disj).
long_option("fully-strict", fully_strict).
long_option("strict-sequential", strict_sequential).
long_option("allow-stubs", allow_stubs).
long_option("infer-all", infer_all).
long_option("infer-types", infer_types).
long_option("infer-modes", infer_modes).
long_option("infer-determinism", infer_det).
long_option("infer-det", infer_det).
long_option("type-inference-iteration-limit",
type_inference_iteration_limit).
long_option("mode-inference-iteration-limit",
mode_inference_iteration_limit).
% compilation model options
long_option("grade", grade).
% target selection options
long_option("target", target).
long_option("il", il).
long_option("il-only", il_only).
long_option("IL-only", il_only).
long_option("compile-to-c", compile_to_c).
long_option("compile-to-C", compile_to_c).
long_option("java", java).
long_option("Java", java).
long_option("java-only", java_only).
long_option("Java-only", java_only).
% Optional features compilation model options:
% (a) debugging
long_option("debug", debug).
% The following options are not allowed, because they're
% not very useful and would probably only confuse people.
% long_option("stack-trace", stack_trace).
% long_option("require-tracing", require_tracing).
long_option("decl-debug", decl_debug).
% (b) profiling
long_option("profiling", profiling).
long_option("time-profiling", time_profiling).
long_option("memory-profiling", memory_profiling).
long_option("deep-profiling", deep_profiling).
long_option("profile-calls", profile_calls).
long_option("profile-time", profile_time).
long_option("profile-memory", profile_memory).
long_option("profile-deep", profile_deep).
long_option("use-activation-counts", use_activation_counts).
long_option("use-zeroing-for-ho-cycles",
use_zeroing_for_ho_cycles).
long_option("use-lots-of-ho-specialization",
use_lots_of_ho_specialization).
long_option("deep-profile-tail-recursion",
deep_profile_tail_recursion).
long_option("record-term-sizes-as-words", record_term_sizes_as_words).
long_option("record-term-sizes-as-cells", record_term_sizes_as_cells).
% (c) miscellanous optional features
long_option("gc", gc).
long_option("garbage-collection", gc).
long_option("parallel", parallel).
long_option("use-trail", use_trail).
long_option("type-layout", type_layout).
% Data represention options
long_option("reserve-tag", reserve_tag).
long_option("use-minimal-model", use_minimal_model).
long_option("pic", pic).
long_option("pic-reg", pic_reg).
long_option("tags", tags).
long_option("num-tag-bits", num_tag_bits).
long_option("num-reserved-addresses", num_reserved_addresses).
long_option("num-reserved-objects", num_reserved_objects).
long_option("bits-per-word", bits_per_word).
long_option("bytes-per-word", bytes_per_word).
long_option("conf-low-tag-bits", conf_low_tag_bits).
long_option("unboxed-float", unboxed_float).
long_option("unboxed-enums", unboxed_enums).
long_option("unboxed-no-tag-types", unboxed_no_tag_types).
long_option("highlevel-data", highlevel_data).
long_option("high-level-data", highlevel_data).
% LLDS back-end compilation model options
long_option("gcc-non-local-gotos", gcc_non_local_gotos).
long_option("gcc-global-registers", gcc_global_registers).
long_option("asm-labels", asm_labels).
% MLDS back-end compilation model options
long_option("highlevel-code", highlevel_code).
long_option("high-level-code", highlevel_code).
long_option("highlevel-C", highlevel_code).
long_option("highlevel-c", highlevel_code).
long_option("high-level-C", highlevel_code).
long_option("high-level-c", highlevel_code).
long_option("gcc-nested-functions", gcc_nested_functions).
long_option("det-copy-out", det_copy_out).
long_option("nondet-copy-out", nondet_copy_out).
long_option("put-commit-in-own-func", put_commit_in_own_func).
long_option("put-nondet-env-on-heap", put_nondet_env_on_heap).
% IL back-end compilation model options
long_option("verifiable-code", verifiable_code).
long_option("verifiable", verifiable_code).
long_option("il-funcptr-types", il_funcptr_types).
long_option("IL-funcptr-types", il_funcptr_types).
long_option("il-refany-fields", il_refany_fields).
long_option("IL-refany-fields", il_refany_fields).
long_option("il-byref-tailcalls", il_byref_tailcalls).
long_option("IL-byref-tailcalls", il_byref_tailcalls).
% internal use options
long_option("backend-foreign-languages",
backend_foreign_languages).
long_option("agc-stack-layout", agc_stack_layout).
long_option("basic-stack-layout", basic_stack_layout).
long_option("procid-stack-layout", procid_stack_layout).
long_option("trace-stack-layout", trace_stack_layout).
long_option("body-typeinfo-liveness", body_typeinfo_liveness).
long_option("special-preds", special_preds).
long_option("type-ctor-info", type_ctor_info).
long_option("type-ctor-layout", type_ctor_layout).
long_option("type-ctor-functors", type_ctor_functors).
long_option("new-type-class-rtti", new_type_class_rtti).
long_option("rtti-line-numbers", rtti_line_numbers).
% code generation options
long_option("low-level-debug", low_level_debug).
long_option("polymorphism", polymorphism).
long_option("trad-passes", trad_passes).
long_option("reclaim-heap-on-failure", reclaim_heap_on_failure).
long_option("reclaim-heap-on-semidet-failure",
reclaim_heap_on_semidet_failure).
long_option("reclaim-heap-on-nondet-failure",
reclaim_heap_on_nondet_failure).
long_option("branch-delay-slot", have_delay_slot).
long_option("have-delay-slot", have_delay_slot).
long_option("num-real-r-regs", num_real_r_regs).
long_option("num-real-f-regs", num_real_f_regs).
long_option("num-real-r-temps", num_real_r_temps).
long_option("num-real-f-temps", num_real_f_temps).
long_option("num-real-temps", num_real_r_temps). % obsolete
long_option("max-jump-table-size", max_jump_table_size).
long_option("compare-specialization", compare_specialization).
long_option("fact-table-max-array-size",fact_table_max_array_size).
long_option("fact-table-hash-percent-full",
fact_table_hash_percent_full).
long_option("gcc-local-labels", gcc_local_labels).
long_option("prefer-switch", prefer_switch).
long_option("opt-no-return-calls", opt_no_return_calls).
% optimization options
long_option("opt-level", opt_level).
long_option("optimization-level", opt_level).
long_option("optimisation-level", opt_level).
long_option("opt-space", opt_space).
long_option("optimize-space", opt_space).
long_option("optimise-space", opt_space).
long_option("intermodule-optimization", intermodule_optimization).
long_option("intermodule-optimisation", intermodule_optimization).
long_option("intermodule-analysis", intermodule_analysis).
long_option("read-opt-files-transitively", read_opt_files_transitively).
long_option("automatic-intermodule-optimization",
automatic_intermodule_optimization).
long_option("automatic-intermodule-optimisation",
automatic_intermodule_optimization).
long_option("use-opt-files", use_opt_files).
long_option("use-trans-opt-files", use_trans_opt_files).
long_option("transitive-intermodule-optimization",
transitive_optimization).
long_option("transitive-intermodule-optimisation",
transitive_optimization).
long_option("trans-intermod-opt", transitive_optimization).
% HLDS->HLDS optimizations
long_option("inlining", inlining).
long_option("inline-simple", inline_simple).
long_option("inline-builtins", inline_builtins).
long_option("inline-single-use", inline_single_use).
long_option("inline-compound-threshold", inline_compound_threshold).
long_option("inline-simple-threshold", inline_simple_threshold).
long_option("intermod-inline-simple-threshold",
intermod_inline_simple_threshold).
long_option("inline-vars-threshold", inline_vars_threshold).
long_option("common-struct", common_struct).
long_option("common-goal", common_goal).
long_option("excess-assign", excess_assign).
long_option("optimize-duplicate-calls", optimize_duplicate_calls).
long_option("optimise-duplicate-calls", optimize_duplicate_calls).
long_option("optimise-constant-propagation", constant_propagation).
long_option("optimize-constant-propagation", constant_propagation).
long_option("optimize-saved-vars", optimize_saved_vars).
long_option("optimise-saved-vars", optimize_saved_vars).
long_option("loop-invariants", loop_invariants).
long_option("optimize-saved-vars-const", optimize_saved_vars_const).
long_option("optimise-saved-vars-const", optimize_saved_vars_const).
long_option("optimize-saved-vars-cell", optimize_saved_vars_cell).
long_option("optimise-saved-vars-cell", optimize_saved_vars_cell).
long_option("osv-loop", optimize_saved_vars_cell_loop).
long_option("osv-full-path", optimize_saved_vars_cell_full_path).
long_option("osv-on-stack", optimize_saved_vars_cell_on_stack).
long_option("osv-cand-head", optimize_saved_vars_cell_candidate_headvars).
long_option("osv-cvstore-cost", optimize_saved_vars_cell_cv_store_cost).
long_option("osv-cvload-cost", optimize_saved_vars_cell_cv_load_cost).
long_option("osv-fvstore-cost", optimize_saved_vars_cell_fv_store_cost).
long_option("osv-fvload-cost", optimize_saved_vars_cell_fv_load_cost).
long_option("osv-op-ratio", optimize_saved_vars_cell_op_ratio).
long_option("osv-node-ratio", optimize_saved_vars_cell_node_ratio).
long_option("osv-allpath-node-ratio", optimize_saved_vars_cell_all_path_node_ratio).
long_option("osv-all-cand", optimize_saved_vars_cell_include_all_candidates).
long_option("delay-construct", delay_construct).
long_option("delay-constructs", delay_construct).
long_option("prev-code", prev_code).
long_option("follow-code", follow_code).
long_option("constraint-propagation", constraint_propagation).
long_option("local-constraint-propagation", local_constraint_propagation).
long_option("optimize-unused-args", optimize_unused_args).
long_option("optimise-unused-args", optimize_unused_args).
long_option("intermod-unused-args", intermod_unused_args).
long_option("optimize-higher-order", optimize_higher_order).
long_option("optimise-higher-order", optimize_higher_order).
long_option("higher-order-size-limit", higher_order_size_limit).
long_option("higher-order-arg-limit", higher_order_arg_limit).
long_option("unneeded-code", unneeded_code).
long_option("unneeded-code-copy-limit", unneeded_code_copy_limit).
long_option("type-specialization", type_specialization).
long_option("type-specialisation", type_specialization).
long_option("user-guided-type-specialization",
user_guided_type_specialization).
long_option("user-guided-type-specialisation",
user_guided_type_specialization).
% This option is for use in configure.in to test for
% some bug-fixes for type-specialization which are needed
% to compile the library. It's not documented, and should
% eventually be removed.
long_option("fixed-user-guided-type-specialization",
user_guided_type_specialization).
long_option("introduce-accumulators", introduce_accumulators).
long_option("optimise-constructor-last-call", optimize_constructor_last_call).
long_option("optimize-constructor-last-call", optimize_constructor_last_call).
long_option("optimize-dead-procs", optimize_dead_procs).
long_option("optimise-dead-procs", optimize_dead_procs).
long_option("deforestation", deforestation).
long_option("deforestation-depth-limit", deforestation_depth_limit).
long_option("deforestation-cost-factor", deforestation_cost_factor).
long_option("deforestation-vars-threshold", deforestation_vars_threshold).
long_option("deforestation-size-threshold", deforestation_size_threshold).
long_option("enable-termination", termination).
long_option("enable-term", termination).
long_option("check-termination", check_termination).
long_option("check-term", check_termination).
long_option("chk-term", check_termination).
long_option("verbose-check-termination",verbose_check_termination).
long_option("verb-check-term", verbose_check_termination).
long_option("verb-chk-term", verbose_check_termination).
long_option("termination-single-argument-analysis",
termination_single_args).
long_option("term-single-arg", termination_single_args).
long_option("termination-norm", termination_norm).
long_option("term-norm", termination_norm).
long_option("termination-error-limit", termination_error_limit).
long_option("term-err-limit", termination_error_limit).
long_option("termination-path-limit", termination_path_limit).
long_option("term-path-limit", termination_path_limit).
% HLDS->LLDS optimizations
long_option("smart-indexing", smart_indexing).
long_option("dense-switch-req-density", dense_switch_req_density).
long_option("lookup-switch-req-density",lookup_switch_req_density).
long_option("dense-switch-size", dense_switch_size).
long_option("lookup-switch-size", lookup_switch_size).
long_option("string-switch-size", string_switch_size).
long_option("tag-switch-size", tag_switch_size).
long_option("try-switch-size", try_switch_size).
long_option("binary-switch-size", binary_switch_size).
long_option("static-ground-terms", static_ground_terms).
long_option("middle-rec", middle_rec).
long_option("simple-neg", simple_neg).
long_option("allow-hijacks", allow_hijacks).
% MLDS optimizations
% Option `optimize' is used for both MLDS and LLDS optimizations, but since
% you can't use both at the same time it doesn't really matter.
long_option("mlds-optimize", optimize).
long_option("mlds-optimise", optimize).
long_option("optimize-tailcalls", optimize_tailcalls).
long_option("optimise-tailcalls", optimize_tailcalls).
long_option("optimize-initializations", optimize_initializations).
long_option("optimise-initializations", optimize_initializations).
long_option("eliminate-local-vars", eliminate_local_vars).
% LLDS optimizations
long_option("common-data", common_data).
long_option("llds-optimize", optimize).
long_option("llds-optimise", optimize).
long_option("optimize-peep", optimize_peep).
long_option("optimise-peep", optimize_peep).
long_option("optimize-jumps", optimize_jumps).
long_option("optimise-jumps", optimize_jumps).
long_option("optimize-fulljumps", optimize_fulljumps).
long_option("optimise-fulljumps", optimize_fulljumps).
long_option("pessimize-tailcalls", pessimize_tailcalls).
long_option("checked-nondet-tailcalls", checked_nondet_tailcalls).
long_option("use-local-vars", use_local_vars).
long_option("local-var-access-threshold", local_var_access_threshold).
long_option("optimize-labels", optimize_labels).
long_option("optimise-labels", optimize_labels).
long_option("optimize-dups", optimize_dups).
long_option("optimise-dups", optimize_dups).
%%% long_option("optimize-copyprop", optimize_copyprop).
%%% long_option("optimise-copyprop", optimize_copyprop).
long_option("optimize-frames", optimize_frames).
long_option("optimise-frames", optimize_frames).
long_option("optimize-delay-slot", optimize_delay_slot).
long_option("optimise-delay-slot", optimize_delay_slot).
long_option("optimize-reassign", optimize_reassign).
long_option("optimise-reassign", optimize_reassign).
long_option("optimize-repeat", optimize_repeat).
long_option("optimise-repeat", optimize_repeat).
% RL optimizations
long_option("optimize-rl", optimize_rl).
long_option("optimise-rl", optimize_rl).
long_option("optimize-rl-cse", optimize_rl_cse).
long_option("optimise-rl-cse", optimize_rl_cse).
long_option("optimize-rl-invariants", optimize_rl_invariants).
long_option("optimise-rl-invariants", optimize_rl_invariants).
long_option("optimize-rl-index", optimize_rl_index).
long_option("optimise-rl-index", optimize_rl_index).
long_option("detect-rl-streams", detect_rl_streams).
% LLDS->C optimizations
long_option("use-macro-for-redo-fail", use_macro_for_redo_fail).
long_option("emit-c-loops", emit_c_loops).
long_option("procs-per-c-function", procs_per_c_function).
long_option("procs-per-C-function", procs_per_c_function).
long_option("everything-in-one-c-function", everything_in_one_c_function).
long_option("everything-in-one-C-function", everything_in_one_c_function).
long_option("split-c-files", split_c_files).
long_option("split-C-files", split_c_files).
long_option("inline-alloc", inline_alloc).
% Target code compilation options
long_option("target-debug", target_debug).
long_option("cc", cc).
long_option("c-optimise", c_optimize).
long_option("c-optimize", c_optimize).
% XXX we should consider the relationship between c_debug and
% target_debug more carefully. Perhaps target_debug could imply
% C debug if the target is C. However for the moment they are
% just synonyms.
long_option("c-debug", target_debug).
long_option("c-include-directory", c_include_directory).
long_option("ansi-c", ansi_c).
long_option("cflags", cflags).
long_option("cflag", quoted_cflag).
long_option("cflags-for-warnings", cflags_for_warnings).
long_option("cflags-for-optimization", cflags_for_optimization).
long_option("cflags-for-ansi", cflags_for_ansi).
long_option("cflags-for-regs", cflags_for_regs).
long_option("cflags-for-gotos", cflags_for_gotos).
long_option("cflags-for-threads", cflags_for_threads).
long_option("cflags-for-debug", cflags_for_debug).
long_option("cflags-for-pic", cflags_for_pic).
long_option("c-flag-to-name-object-file", c_flag_to_name_object_file).
long_option("object-file-extension", object_file_extension).
long_option("pic-object-file-extension", pic_object_file_extension).
long_option("link-with-pic-object-file-extension",
link_with_pic_object_file_extension).
long_option("java-compiler", java_compiler).
long_option("javac", java_compiler).
long_option("java-flags", java_flags).
long_option("java-flag", quoted_java_flag).
% XXX we should consider the relationship between java_debug and
% target_debug more carefully. Perhaps target_debug could imply
% Java debug if the target is Java. However for the moment they are
% just synonyms.
long_option("java-debug", target_debug).
long_option("java-classpath", java_classpath).
long_option("java-object-file-extension", java_object_file_extension).
long_option("il-assembler", il_assembler).
long_option("ilasm-flags", ilasm_flags).
long_option("ilasm-flag", quoted_ilasm_flag).
long_option("dotnet-library-version", dotnet_library_version).
long_option("support-ms-clr", support_ms_clr).
long_option("support-rotor-clr", support_rotor_clr).
long_option("mcpp-compiler", mcpp_compiler).
long_option("mcpp-flags", mcpp_flags).
long_option("mcpp-flag", quoted_mcpp_flag).
long_option("csharp-compiler", csharp_compiler).
long_option("csharp-flags", csharp_flags).
long_option("csharp-flag", quoted_csharp_flag).
% link options
long_option("output-file", output_file_name).
long_option("ld-flags", ld_flags).
long_option("ld-flag", quoted_ld_flag).
long_option("ld-libflags", ld_libflags).
long_option("ld-libflag", quoted_ld_libflag).
long_option("library-directory", link_library_directories).
long_option("runtime-library-directory", runtime_link_library_directories).
long_option("library", link_libraries).
long_option("link-object", link_objects).
long_option("mercury-library", mercury_library_special).
long_option("ml", mercury_library_special).
long_option("mercury-library-directory", mercury_library_directory_special).
long_option("mld", mercury_library_directory_special).
long_option("mercury-standard-library-directory",
mercury_standard_library_directory_special).
long_option("mercury-stdlib-dir",
mercury_standard_library_directory_special).
long_option("init-file-directory", init_file_directories).
long_option("init-file", init_files).
long_option("trace-init-file", trace_init_files).
long_option("linkage", linkage_special).
long_option("mercury-linkage", mercury_linkage_special).
long_option("demangle", demangle).
long_option("strip", strip).
long_option("main", main).
long_option("allow-undefined", allow_undefined).
long_option("use-readline", use_readline).
long_option("runtime-flags", runtime_flags).
long_option("extra-initialization-functions",
extra_initialization_functions).
long_option("extra-inits", extra_initialization_functions).
long_option("shared-library-extension", shared_library_extension).
long_option("library-extension", library_extension).
long_option("executable-file-extension", executable_file_extension).
long_option("create-archive-command", create_archive_command).
long_option("create-archive-command-output-flag",
create_archive_command_output_flag).
long_option("create-archive-command-flags", create_archive_command_flags).
long_option("link-executable-command", link_executable_command).
long_option("link-shared-lib-command", link_shared_lib_command).
long_option("ranlib-command", ranlib_command).
long_option("mkinit-command", mkinit_command).
long_option("demangle-command", demangle_command).
long_option("trace-libs", trace_libs).
long_option("thread-libs", thread_libs).
long_option("shared-libs", shared_libs).
long_option("math-lib", math_lib).
long_option("readline-libs", readline_libs).
long_option("linker-opt-separator", linker_opt_separator).
long_option("linker-debug-flags", linker_debug_flags).
long_option("shlib-linker-debug-flags", shlib_linker_debug_flags).
long_option("linker-trace-flags", linker_trace_flags).
long_option("shlib-linker-trace-flags", shlib_linker_trace_flags).
long_option("linker-thread-flags", linker_thread_flags).
long_option("shlib-linker-thread-flags", shlib_linker_thread_flags).
long_option("linker-static-flags", linker_static_flags).
long_option("linker-strip-flag", linker_strip_flag).
long_option("linker-link-lib-flag", linker_link_lib_flag).
long_option("linker-link-lib-suffix", linker_link_lib_suffix).
long_option("shlib-linker-link-lib-flag", shlib_linker_link_lib_flag).
long_option("shlib-linker-link-lib-suffix", shlib_linker_link_lib_suffix).
long_option("linker-path-flag", linker_path_flag).
long_option("linker-rpath-flag", linker_rpath_flag).
long_option("linker-rpath-separator", linker_rpath_separator).
long_option("shlib-linker-rpath-flag", shlib_linker_rpath_flag).
long_option("shlib-linker-rpath-separator", shlib_linker_rpath_separator).
long_option("linker-allow-undefined-flag", linker_allow_undefined_flag).
long_option("linker-error-undefined-flag", linker_error_undefined_flag).
% build system options
long_option("make", make).
long_option("keep-going", keep_going).
long_option("rebuild", rebuild).
long_option("invoked-by-mmc-make", invoked_by_mmc_make).
long_option("pre-link-command", pre_link_command).
long_option("extra-init-command", extra_init_command).
long_option("mercury-configuration-directory",
mercury_configuration_directory_special).
long_option("mercury-config-dir",
mercury_configuration_directory_special).
long_option("install-prefix", install_prefix).
long_option("install-command", install_command).
long_option("use-symlinks", use_symlinks).
long_option("library-grade", libgrades).
long_option("libgrade", libgrades).
long_option("options-file", options_files).
long_option("config-file", config_file).
long_option("options-search-directory", options_search_directories).
long_option("use-subdirs", use_subdirs).
long_option("use-grade-subdirs", use_grade_subdirs).
long_option("search-directory", search_directories).
long_option("intermod-directory", intermod_directories).
long_option("use-search-directories-for-intermod",
use_search_directories_for_intermod).
% misc options
long_option("help", help).
long_option("filenames-from-stdin", filenames_from_stdin).
long_option("aditi", aditi).
long_option("aditi-user", aditi_user).
long_option("fullarch", fullarch).
long_option("bug-intermod-2002-06-13", compiler_sufficiently_recent).
long_option("bug-foreign_import-2002-08-06", compiler_sufficiently_recent).
long_option("install-opt-files-2002-08-30", compiler_sufficiently_recent).
long_option("read-config-file-2003-03-01", compiler_sufficiently_recent).
%-----------------------------------------------------------------------------%
special_handler(grade, string(Grade), OptionTable0, Result) :-
( convert_grade_option(Grade, OptionTable0, OptionTable) ->
Result = ok(OptionTable)
;
string__append_list(["invalid grade `", Grade, "'"], Msg),
Result = error(Msg)
).
special_handler(il, none, OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, target, string("il"), OptionTable).
special_handler(il_only, none, OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, target, string("il"), OptionTable1),
map__set(OptionTable1, target_code_only, bool(yes), OptionTable).
special_handler(compile_to_c, none, OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, target, string("c"), OptionTable1),
map__set(OptionTable1, target_code_only, bool(yes), OptionTable).
special_handler(java, none, OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, target, string("java"), OptionTable).
special_handler(java_only, none, OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, target, string("java"), OptionTable1),
map__set(OptionTable1, target_code_only, bool(yes), OptionTable).
special_handler(profiling, bool(Value), OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, profile_time, bool(Value), OptionTable1),
map__set(OptionTable1, profile_calls, bool(Value), OptionTable2),
map__set(OptionTable2, profile_memory, bool(no), OptionTable3),
map__set(OptionTable3, profile_deep, bool(no), OptionTable).
special_handler(time_profiling, none, OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, profile_time, bool(yes), OptionTable1),
map__set(OptionTable1, profile_calls, bool(yes), OptionTable2),
map__set(OptionTable2, profile_memory, bool(no), OptionTable3),
map__set(OptionTable3, profile_deep, bool(no), OptionTable).
special_handler(memory_profiling, none, OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, profile_time, bool(no), OptionTable1),
map__set(OptionTable1, profile_calls, bool(yes), OptionTable2),
map__set(OptionTable2, profile_memory, bool(yes), OptionTable3),
map__set(OptionTable3, profile_deep, bool(no), OptionTable).
special_handler(deep_profiling, none, OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, profile_time, bool(no), OptionTable1),
map__set(OptionTable1, profile_calls, bool(no), OptionTable2),
map__set(OptionTable2, profile_memory, bool(no), OptionTable3),
map__set(OptionTable3, profile_deep, bool(yes), OptionTable).
special_handler(debug, bool(Value), OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, stack_trace, bool(Value), OptionTable1),
map__set(OptionTable1, require_tracing, bool(Value), OptionTable).
special_handler(inlining, bool(Value), OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, inline_simple, bool(Value), OptionTable1),
map__set(OptionTable1, inline_builtins, bool(Value), OptionTable2),
map__set(OptionTable2, inline_single_use, bool(Value), OptionTable3),
(
Value = yes,
map__set(OptionTable3, inline_compound_threshold,
int(10), OptionTable)
;
Value = no,
map__set(OptionTable3, inline_compound_threshold,
int(0), OptionTable)
).
special_handler(everything_in_one_c_function, none, OptionTable0,
ok(OptionTable)) :-
map__set(OptionTable0, procs_per_c_function, int(0),
OptionTable).
special_handler(reclaim_heap_on_failure, bool(Value), OptionTable0,
ok(OptionTable)) :-
map__set(OptionTable0, reclaim_heap_on_semidet_failure, bool(Value),
OptionTable1),
map__set(OptionTable1, reclaim_heap_on_nondet_failure, bool(Value),
OptionTable).
special_handler(strict_sequential, none, OptionTable0, ok(OptionTable)) :-
override_options([
reorder_conj - bool(no),
reorder_disj - bool(no),
fully_strict - bool(yes)
], OptionTable0, OptionTable).
special_handler(inhibit_warnings, bool(Inhibit), OptionTable0, ok(OptionTable))
:-
bool__not(Inhibit, Enable),
override_options([
inhibit_accumulator_warnings - bool(Inhibit),
warn_singleton_vars - bool(Enable),
warn_overlapping_scopes - bool(Enable),
warn_det_decls_too_lax - bool(Enable),
warn_inferred_erroneous - bool(Enable),
warn_nothing_exported - bool(Enable),
warn_interface_imports - bool(Enable),
warn_missing_opt_files - bool(Enable),
warn_missing_trans_opt_files - bool(Enable),
warn_missing_trans_opt_deps - bool(Enable),
warn_simple_code - bool(Enable),
warn_missing_module_name - bool(Enable),
warn_wrong_module_name - bool(Enable),
warn_smart_recompilation - bool(Enable),
warn_undefined_options_variables - bool(Enable),
warn_target_code - bool(Enable),
warn_up_to_date - bool(Enable),
warn_stubs - bool(Enable),
warn_dead_procs - bool(Enable)
], OptionTable0, OptionTable).
special_handler(infer_all, bool(Infer), OptionTable0, ok(OptionTable)) :-
override_options([
infer_types - bool(Infer),
infer_modes - bool(Infer),
infer_det - bool(Infer)
], OptionTable0, OptionTable).
special_handler(opt_space, none, OptionTable0, ok(OptionTable)) :-
opt_space(OptionSettingsList),
override_options(OptionSettingsList, OptionTable0, OptionTable).
special_handler(opt_level, int(N0), OptionTable0, ok(OptionTable)) :-
( N0 > 6 ->
N = 6
; N0 < -1 ->
N = -1
;
N = N0
),
set_opt_level(N, OptionTable0, OptionTable).
special_handler(optimize_saved_vars, bool(Optimize),
OptionTable0, ok(OptionTable)) :-
map__set(OptionTable0, optimize_saved_vars_const, bool(Optimize),
OptionTable1),
map__set(OptionTable1, optimize_saved_vars_cell, bool(Optimize),
OptionTable).
special_handler(mercury_library_directory_special, string(Dir),
OptionTable0, ok(OptionTable)) :-
OptionTable = option_table_add_mercury_library_directory(
OptionTable0, Dir).
special_handler(mercury_library_special, string(Lib),
OptionTable0, ok(OptionTable)) :-
OptionTable =
list__foldl(append_to_accumulating_option, [
link_libraries - Lib,
mercury_libraries - Lib,
init_files - (Lib ++ ".init")
], OptionTable0).
special_handler(mercury_standard_library_directory_special,
maybe_string(MaybeStdLibDir), OptionTable0, ok(OptionTable)) :-
OptionTable =
map__set(map__set(OptionTable0,
mercury_standard_library_directory,
maybe_string(MaybeStdLibDir)),
mercury_configuration_directory,
maybe_string(MaybeStdLibDir)).
special_handler(mercury_configuration_directory_special,
string(ConfDir), OptionTable0, ok(OptionTable)) :-
OptionTable = map__set(OptionTable0, mercury_configuration_directory,
maybe_string(yes(ConfDir))).
special_handler(quoted_cflag, string(Flag),
OptionTable0, ok(OptionTable)) :-
handle_quoted_flag(cflags, Flag, OptionTable0, OptionTable).
special_handler(quoted_java_flag, string(Flag),
OptionTable0, ok(OptionTable)) :-
handle_quoted_flag(java_flags, Flag, OptionTable0, OptionTable).
special_handler(quoted_ilasm_flag, string(Flag),
OptionTable0, ok(OptionTable)) :-
handle_quoted_flag(ilasm_flags, Flag, OptionTable0, OptionTable).
special_handler(quoted_mcpp_flag, string(Flag),
OptionTable0, ok(OptionTable)) :-
handle_quoted_flag(mcpp_flags, Flag, OptionTable0, OptionTable).
special_handler(quoted_csharp_flag, string(Flag),
OptionTable0, ok(OptionTable)) :-
handle_quoted_flag(csharp_flags, Flag, OptionTable0, OptionTable).
special_handler(quoted_ld_flag, string(Flag),
OptionTable0, ok(OptionTable)) :-
handle_quoted_flag(ld_flags, Flag, OptionTable0, OptionTable).
special_handler(quoted_ld_libflag, string(Flag),
OptionTable0, ok(OptionTable)) :-
handle_quoted_flag(ld_libflags, Flag, OptionTable0, OptionTable).
special_handler(linkage_special, string(Flag), OptionTable0, Result) :-
( ( Flag = "shared" ; Flag = "static" ) ->
Result = ok(
(OptionTable0 ^ elem(mercury_linkage) := string(Flag))
^ elem(linkage) := string(Flag))
;
Result = error(
"argument of `--linkage' should be either ""shared"" or ""static"".")
).
special_handler(mercury_linkage_special, string(Flag),
OptionTable0, Result) :-
( ( Flag = "shared" ; Flag = "static" ) ->
Result = ok(
OptionTable0 ^ elem(mercury_linkage) := string(Flag))
;
Result = error(
"argument of `--mercury-linkage' should be either ""shared"" or ""static"".")
).
%-----------------------------------------------------------------------------%
option_table_add_mercury_library_directory(OptionTable0, Dir) =
% The link_library_directories for Mercury libraries are grade
% dependent, so they need to be handled in handle_options.m
% when we know the grade.
list__foldl(append_to_accumulating_option, [
search_directories - dir__make_path_name(Dir, "ints"),
c_include_directory - dir__make_path_name(Dir, "inc"),
init_file_directories - dir__make_path_name(Dir, "modules"),
mercury_library_directories - Dir
], OptionTable0).
:- func append_to_accumulating_option(pair(option, string),
option_table) = option_table.
append_to_accumulating_option(Option - Value, OptionTable0) =
OptionTable0 ^ elem(Option) :=
accumulating(
getopt__lookup_accumulating_option(OptionTable0, Option)
++ [Value]).
:- pred set_opt_level(int, option_table, option_table).
:- mode set_opt_level(in, in, out) is det.
set_opt_level(N, OptionTable0, OptionTable) :-
%
% first reset all optimizations to their default
% (the default should be all optimizations off)
%
option_defaults_2(optimization_option, OptimizationDefaults),
override_options(OptimizationDefaults, OptionTable0, OptionTable1),
%
% next enable the optimization levels from 0 up to N.
%
enable_opt_levels(0, N, OptionTable1, OptionTable).
:- pred enable_opt_levels(int, int, option_table, option_table).
:- mode enable_opt_levels(in, in, in, out) is det.
enable_opt_levels(N0, N, OptionTable0, OptionTable) :-
( N0 > N ->
OptionTable = OptionTable0
; opt_level(N0, OptionTable0, OptionSettingsList) ->
override_options(OptionSettingsList, OptionTable0,
OptionTable1),
N1 = N0 + 1,
enable_opt_levels(N1, N, OptionTable1, OptionTable)
;
error("Unknown optimization level")
).
:- pred override_options(list(pair(option, option_data)),
option_table, option_table).
:- mode override_options(in, in, out) is det.
override_options([], OptionTable, OptionTable).
override_options([Option - Value | Settings], OptionTable0, OptionTable) :-
map__set(OptionTable0, Option, Value, OptionTable1),
override_options(Settings, OptionTable1, OptionTable).
%-----------------------------------------------------------------------------%
:- pred opt_space(list(pair(option, option_data))::out) is det.
opt_space([
unneeded_code_copy_limit - int(1),
optimize_dead_procs - bool(yes),
optimize_labels - bool(yes),
optimize_dups - bool(yes),
optimize_fulljumps - bool(no),
optimize_reassign - bool(yes),
inline_alloc - bool(no),
use_macro_for_redo_fail - bool(no),
loop_invariants - bool(no)
]).
%-----------------------------------------------------------------------------%
:- pred opt_level(int::in, option_table::in,
list(pair(option, option_data))::out) is semidet.
% Optimization level -1:
% Generate totally unoptimized code; turns off ALL optimizations that
% can be turned off, including HLDS->HLDS, HLDS->LLDS, LLDS->LLDS, LLDS->C,
% and C->object optimizations.
% (However, there are some optimizations that can't be disabled.)
% Optimization level 0: aim to minimize overall compilation time.
% XXX I just guessed. We should run lots of experiments.
opt_level(0, _, [
common_data - bool(yes),
optimize - bool(yes),
optimize_repeat - int(1),
optimize_peep - bool(yes),
static_ground_terms - bool(yes),
smart_indexing - bool(yes),
optimize_jumps - bool(yes),
optimize_labels - bool(yes),
excess_assign - bool(yes) % ???
]).
% Optimization level 1: apply optimizations which are cheap and
% have a good payoff while still keeping compilation time small
opt_level(1, OptionTable, [
c_optimize - bool(yes), % XXX we want `gcc -O1'
optimize_frames - bool(yes),
optimize_delay_slot - bool(DelaySlot),
middle_rec - bool(yes),
emit_c_loops - bool(yes),
optimize_tailcalls - bool(yes)
% dups?
]) :-
getopt__lookup_bool_option(OptionTable, have_delay_slot, DelaySlot).
% Optimization level 2: apply optimizations which have a good
% payoff relative to their cost; but include optimizations
% which are more costly than with -O1
opt_level(2, _, [
optimize_fulljumps - bool(yes),
optimize_repeat - int(3),
optimize_dups - bool(yes),
optimize_dead_procs - bool(yes),
follow_code - bool(yes),
inline_simple - bool(yes),
inline_single_use - bool(yes),
inline_compound_threshold - int(10),
common_struct - bool(yes),
user_guided_type_specialization
- bool(yes),
% XXX While inst `array' is defined as `ground', we
% can't optimize duplicate calls (we might combine
% calls to `array.init').
% optimize_duplicate_calls - bool(yes),
simple_neg - bool(yes),
optimize_rl - bool(yes),
optimize_rl_index - bool(yes),
detect_rl_streams - bool(yes),
optimize_initializations - bool(yes)
]).
% Optimization level 3: apply optimizations which usually have a good
% payoff even if they increase compilation time quite a bit
opt_level(3, _, [
%%% optimize_copyprop - bool(yes),
optimize_saved_vars_const - bool(yes),
optimize_unused_args - bool(yes),
optimize_higher_order - bool(yes),
deforestation - bool(yes),
local_constraint_propagation - bool(yes),
constant_propagation - bool(yes),
optimize_reassign - bool(yes),
% Disabled until a bug in extras/trailed_update/var.m is resolved.
%introduce_accumulators - bool(yes),
optimize_repeat - int(4)
]).
% Optimization level 4: apply optimizations which may have some
% payoff even if they increase compilation time quite a bit
% Currently this enables the use of local variables
% and increases the inlining thresholds
opt_level(4, _, [
use_local_vars - bool(yes),
inline_simple_threshold - int(8),
inline_compound_threshold - int(20),
higher_order_size_limit - int(30)
]).
% Optimization level 5: apply optimizations which may have some
% payoff even if they increase compilation time a lot
% Currently this enables the search for construction unifications that can be
% delayed past failing computations, allows more passes of the low-level
% optimizations, and increases the inlining thresholds still further.
% We also enable eliminate_local_vars only at this level,
% because that pass is implemented pretty inefficiently.
opt_level(5, _, [
optimize_repeat - int(5),
delay_construct - bool(yes),
inline_compound_threshold - int(100),
higher_order_size_limit - int(40),
eliminate_local_vars - bool(yes),
loop_invariants - bool(yes)
]).
% Optimization level 6: apply optimizations which may have any
% payoff even if they increase compilation time to completely
% unreasonable levels
% Currently this sets `everything_in_one_c_function', which causes
% the compiler to put everything in the one C function and treat
% calls to predicates in the same module as local.
% We also enable inlining of GC_malloc(), redo(), and fail().
opt_level(6, _, [
procs_per_c_function - int(0), % everything in one C function
inline_alloc - bool(yes),
use_macro_for_redo_fail - bool(yes)
]).
% The following optimization options are not enabled at any level:
%
% checked_nondet_tailcalls:
% This is deliberate, because the transformation
% might make code run slower.
%
% constraint_propagation:
% I think this is deliberate, because the transformation
% might make code run slower?
%
% prev_code:
% Not useful?
%
% unneeded_code:
% type_specialization:
% optimize_rl_invariant:
% XXX why not?
%
% introduce_accumulators:
% XXX Disabled until a bug in extras/trailed_update/var.m
% is resolved.
%
% optimize_rl_cse:
% optimize_constructor_last_call:
% Not implemented yet.
%-----------------------------------------------------------------------------%
:- pred handle_quoted_flag(option::in, string::in, option_table::in,
option_table::out) is det.
handle_quoted_flag(Option, Flag, Table,
append_to_accumulating_option(Option - quote_arg(Flag), Table)).
quote_arg(Arg0) = Arg :-
% XXX Instead of using dir__use_windows_paths, this should really
% test whether we are using a Unix or Windows shell.
( dir__use_windows_paths ->
ArgList = quote_arg_windows(string__to_char_list(Arg0)),
(
ArgList = []
->
Arg = """"""
;
Arg = string__from_char_list(ArgList)
)
;
ArgList = quote_arg_unix(string__to_char_list(Arg0)),
(
ArgList = []
->
Arg = """"""
;
list__member(Char, ArgList),
\+ ( char__is_alnum_or_underscore(Char)
; Char = ('-')
; Char = ('/')
; Char = ('.')
; Char = (',')
; Char = (':')
)
->
Arg = """" ++ string__from_char_list(ArgList) ++ """"
;
Arg = string__from_char_list(ArgList)
)
).
:- func quote_arg_windows(list(char)) = list(char).
quote_arg_windows([]) = [].
quote_arg_windows([Char | Chars0]) = Chars :-
Chars1 = quote_arg_windows(Chars0),
( quote_char_windows(Char) ->
% We want whitespace characters within an argument to not be
% treated as whitespace when splitting the command line
% into words.
% Newlines and tabs within a word don't really make
% sense, so just convert them to spaces.
QuoteChar = ( char__is_whitespace(Char) -> ' ' ; Char ),
Chars = [('\\'), QuoteChar | Chars1]
;
Chars = [Char | Chars1]
).
:- pred quote_char_windows(char::in) is semidet.
quote_char_windows(' ').
quote_char_windows('\n').
quote_char_windows('\t').
quote_char_windows('"').
quote_char_windows('%').
:- func quote_arg_unix(list(char)) = list(char).
quote_arg_unix([]) = [].
quote_arg_unix([Char | Chars0]) = Chars :-
Chars1 = quote_arg_unix(Chars0),
( quote_char_unix(Char) ->
Chars = [('\\'), Char | Chars1]
;
Chars = [Char | Chars1]
).
:- pred quote_char_unix(char::in) is semidet.
quote_char_unix('\\').
quote_char_unix('"').
quote_char_unix('`').
quote_char_unix('$').
%-----------------------------------------------------------------------------%
options_help -->
io__write_string("\t-?, -h, --help\n"),
io__write_string("\t\tPrint this usage message.\n"),
options_help_warning,
options_help_verbosity,
options_help_output,
options_help_aux_output,
options_help_semantics,
options_help_termination,
options_help_compilation_model,
options_help_code_generation,
options_help_optimization,
options_help_hlds_hlds_optimization,
options_help_hlds_llds_optimization,
options_help_llds_llds_optimization,
options_help_mlds_mlds_optimization,
options_help_rl_rl_optimization,
options_help_output_optimization,
options_help_target_code_compilation,
options_help_link,
options_help_build_system,
options_help_misc.
:- pred options_help_warning(io__state::di, io__state::uo) is det.
options_help_warning -->
io__write_string("\nWarning Options:\n"),
write_tabbed_lines([
"-w, --inhibit-warnings",
"\tDisable all warning messages.",
"--halt-at-warn",
"\tThis option causes the compiler to treat all ",
"\twarnings as if they were errors. This means that",
"\tif any warning is issued, the compiler will not",
"\tgenerate code --- instead, it will return a",
"\tnon-zero exit status.",
"--halt-at-syntax-errors",
"\tThis option causes the compiler to halt immediately",
"\tafter syntax checking and not do any semantic checking",
"\tif it finds any syntax errors in the program.",
"--inhibit-accumulator-warnings",
"\tDon't warn about argument order rearrangement caused",
"\tby --introduce-accumulators.",
"--no-warn-singleton-variables",
"\tDon't warn about variables which only occur once.",
"--no-warn-overlapping-scopes",
"\tDon't warn about variables which occur in overlapping scopes.",
"--no-warn-det-decls-too-lax",
"\tDon't warn about determinism declarations",
"\twhich could have been stricter.",
"--no-warn-inferred-erroneous",
"\tDon't warn about procedures whose determinism is inferred",
"\terroneous but whose determinism declarations are laxer.",
"--no-warn-nothing-exported",
"\tDon't warn about modules which export nothing.",
"--warn-unused-args",
"\tWarn about predicate arguments which are not used.",
"--warn-interface-imports",
"\tWarn about modules imported in the interface, but",
"\twhich are not used in the interface.",
"--no-warn-missing-opt-files",
"\tDisable warnings about `.opt' files which cannot be opened.",
"--warn-missing-trans-opt-files",
"\tEnable warnings about `.trans_opt' files which cannot",
"\tbe opened.",
"--no-warn-missing-trans-opt-deps",
"\tDisable warnings produced when the information required",
"\tto allow `.trans_opt' files to be read when creating other",
"\t`.trans_opt' files has been lost. The information can be",
"\trecreated by running `mmake <mainmodule>.depend'",
"--warn-non-stratification",
"\tWarn about possible non-stratification in the module.",
"\tNon-stratification occurs when a predicate/function can call",
"\titself negatively through some path along its call graph.",
"--no-warn-simple-code",
"\tDisable warnings about constructs which are so",
"\tsimple that they are likely to be programming errors.",
"--warn-duplicate-calls",
"\tWarn about multiple calls to a predicate with the",
"\tsame input arguments.",
"--no-warn-missing-module-name",
"\tDisable warnings for modules that do no start with",
"\ta `:- module' declaration.",
"--no-warn-wrong-module-name",
"\tDisable warnings for modules whose `:- module'",
"\tdeclaration does not match the module's file name.",
"--no-warn-smart-recompilation",
"\tDisable warnings from the smart recompilation system.",
"--no-warn-undefined-options-variables",
"\tWarn about references to undefined variables in",
"\toptions files with `--make'.",
"--warn-non-tail-recursion",
"\tWarn about any directly recursive calls that are not tail calls.",
"\tThis requires --high-level-code.",
"--no-warn-up-to-date",
"\tDon't warn if targets specified on the command line",
"\twith `--make' are already up to date.",
"--no-warn-stubs",
"\tDisable warnings about procedures for which there are no",
"\tclauses. Note that this option only has any effect if",
"\tthe `--allow-stubs' option (described in the ""Language",
"\tSemantics Options"" section below) is enabled.",
"--warn-dead-procs",
"\tWarn about procedures which are never called.",
"--no-warn-target-code",
"\tDisable warnings from the compiler used to process the",
"\ttarget code (e.g. gcc)."
]).
:- pred options_help_verbosity(io__state::di, io__state::uo) is det.
options_help_verbosity -->
io__write_string("\nVerbosity Options:\n"),
write_tabbed_lines([
"-v, --verbose",
"\tOutput progress messages at each stage in the compilation.",
"-V, --very-verbose",
"\tOutput very verbose progress messages.",
"-E, --verbose-error-messages",
"\tExplain error messages. Asks the compiler to give you a more",
"\tdetailed explanation of any errors it finds in your program.",
"--no-verbose-make",
"\tDisable messages about the progress of builds using",
"\tthe `--make' option.",
"--output-compile-error-lines <n>",
"\tWith `--make', output the first <n> lines of the `.err'",
"\tfile after compiling a module (default: 15).",
"--verbose-commands",
"\tOutput each external command before it is run.",
"\tNote that some commands will only be printed",
"\tprinted with `--verbose'.",
"--verbose-recompilation",
"\tWhen using `--smart-recompilation', output messages",
"\texplaining why a module needs to be recompiled.",
"--find-all-recompilation-reasons",
"\tFind all the reasons why a module needs to be recompiled,",
"\tnot just the first. Implies `--verbose-recompilation'.",
"-S, --statistics",
"\tOutput messages about the compiler's time/space usage.",
"\tAt the moment this option implies `--no-trad-passes', so you get",
"\tinformation at the boundaries between phases of the compiler.",
"-T, --debug-types",
"\tOutput detailed debugging traces of the type checking.",
"-N, --debug-modes",
"\tOutput detailed debugging traces of the mode checking.",
"--debug-det, --debug-determinism",
"\tOutput detailed debugging traces of determinism analysis.",
"--debug-opt",
"\tOutput detailed debugging traces of the optimization process.",
"--debug-opt-pred-id <n>",
"\tOutput detailed debugging traces of the optimization process",
"\tonly for the predicate/function with the specified pred id.",
"--debug-pd",
"\tOutput detailed debugging traces of the partial",
"\tdeduction and deforestation process.",
"--debug-rl-gen",
"\tOutput detailed debugging traces of Aditi-RL code generation.",
"--debug-rl-opt",
"\tOutput detailed debugging traces of Aditi-RL optimization.",
"--debug-liveness <pred_id>",
"\tOutput detailed debugging traces of the liveness analysis",
"\tof the predicate with the given predicate id.",
"--debug-make",
"\tOutput detailed debugging traces of the `--make' option."
]).
:- pred options_help_output(io__state::di, io__state::uo) is det.
options_help_output -->
io__write_string("\nOutput Options:\n"),
write_tabbed_lines([
"These options are mutually exclusive.",
"Only the first one specified will apply.",
"If none of these options are specified, the default action",
"is to link the named modules to produce an executable.\n",
"-f, --generate-source-file-mapping",
"\tOutput the module name to file name mapping for the list",
"\tof source files given as non-option arguments to mmc",
"\tto `Mercury.modules'. This must be done before",
"\t`mmc --generate-dependencies' if there are any modules",
"\tfor which the file name does not match the module name.",
"\tIf there are no such modules the mapping need not be",
"\tgenerated.",
"-M, --generate-dependencies",
"\tOutput `Make'-style dependencies for the module",
"\tand all of its dependencies to `<module>.dep'.",
"--generate-module-order",
"\tOutput the strongly connected components of the module",
"\tdependency graph in top-down order to `<module>.order'.",
"\tImplies --generate-dependencies.",
"-i, --make-int, --make-interface",
"\tWrite the module interface to `<module>.int',",
"\tand write the short interface to `<module>.int2'",
"\tThis option should only be used by mmake.",
"--make-priv-int, --make-private-interface",
"\tWrite the private interface to `<module>.int0'.",
"\tThis option should only be used by mmake.",
"--make-short-int, --make-short-interface",
"\tWrite the unqualified short interface to `<module>.int3'.",
"\tThis option should only be used by mmake.",
"--make-opt-int, --make-optimization-interface",
"\tWrite inter-module optimization information to",
"\t`<module>.opt'.",
"\tThis option should only be used by mmake.",
"--make-trans-opt",
"--make-transitive-optimization-interface",
"\tOutput transitive optimization information",
"\tinto the `<module>.trans_opt' file.",
"\tThis option should only be used by mmake.",
"-P, --convert-to-mercury",
"\tConvert to Mercury. Output to file `<module>.ugly'",
"\tThis option acts as a Mercury ugly-printer.",
"-t, --typecheck-only",
"\tJust check that the code is syntactically correct and",
"\ttype-correct. Don't check modes or determinism,",
"\tand don't generate any code.",
"-e, --errorcheck-only",
"\tCheck the module for errors, but do not generate any code.",
"-C, --target-code-only",
"\tGenerate target code (i.e. C code in `<module>.c',",
"\tassembler code in `<module>.s' or `<module>.pic_s',",
"\tIL code in `<module>.il', or Java code in",
"\t`<module>.java'), but not object code.",
"-c, --compile-only",
"\tGenerate C code in `<module>.c' and object code in `<module>.o'",
"\tbut do not attempt to link the named modules.",
% --compile-to-shared-lib is intended only for use
% by the debugger's interactive query facility,
% so it isn't documented.
"--aditi-only",
"\tWrite Aditi-RL bytecode to `<module>.rlo' and",
"\tdo not compile to C.",
"--output-grade-string",
"\tCompute the grade of the library to link with based on",
"\tthe command line options, and print it to the standard",
"\toutput.",
"--output-link-command",
"\tPrint the command used to link executables to the",
"\tstandard output.",
"--output-shared-lib-link-command",
"\tPrint the command used to link shared libraries to the",
"\tstandard output."
]).
:- pred options_help_aux_output(io__state::di, io__state::uo) is det.
options_help_aux_output -->
io__write_string("\nAuxiliary Output Options:\n"),
write_tabbed_lines([
"--smart-recompilation",
"\tWhen compiling, write program dependency information",
"\tto be used to avoid unnecessary recompilations if an",
"\timported module's interface changes in a way which does",
"\tnot invalidate the compiled code. `--smart-recompilation'",
"\tdoes not yet work with `--intermodule-optimization'.",
"--no-assume-gmake",
"\tWhen generating `.dep' files, generate Makefile",
"\tfragments that use only the features of standard make;",
"\tdo not assume the availability of GNU Make extensions.",
"\tWhen generating `.dep' files, generate dependencies",
"\tfor use by `mmc --make' in addition to the dependencies",
"\tused by mmake.",
"--generate-mmc-deps",
"--generate-mmc-make-module-dependencies",
"\tGenerate dependencies for use by `mmc --make' even",
"\twhen using Mmake. This is recommended when building a",
"\tlibrary for installation.",
% "--trace decl" is not documented, because it is for backwards
% compatibility only. It is now equivalent to `--trace rep'.
% "--trace {minimum, shallow, deep, decl, rep, default}",
"--trace {minimum, shallow, deep, rep, default}",
"\tGenerate code that includes the specified level",
"\tof execution tracing.",
"\tSee the Debugging chapter of the Mercury User's Guide",
"\tfor details.",
% "--suppress-trace <suppress-items>,",
% "\tSuppress the named aspects of the execution tracing system.",
"--trace-optimized",
"\tDo not disable optimizations that can change the trace.",
% I/O tabling is deliberately not documented. It is mean to be switched on,
% with consistent parameters, in debugging grades, and to be consistently
% switched off in non-debugging grades. Inconsistent use of the options
% governing I/O tabling can yield core dumps from the debugger, so these
% options are for implementors only.
% "--trace-table-io",
% "\tEnable the tabling of I/O actions, to allow the debugger",
% "\tto execute retry commands across I/O actions.",
% "--trace-table-io-only-retry",
% "\tSet up I/O tabling to support only retries across I/O",
% "\tactions, not the printing of actions or declarative",
% "\tdebugging. This reduces the size of the I/O action table.",
% "--trace-table-io-states",
% "\tWhen tabling I/O actions, table the io__state arguments",
% "\ttogether with the others. This should be required iff",
% "\tvalues of type io__state actually contain information.",
% "--trace-table-io-require",
% "\tRequire the tabling of I/O actions, i.e. generate an error",
% "\tif an I/O primitive does not have the tabled_for_io",
% "\tannotation.",
% "--trace-table-io-all",
% "\tTable all I/O actions even in the absence of annotations.",
% "\tIf a primitive has no annotation specifying the type of",
% "\ttabling required, deduce it from the values of the other",
% "\tannotations.",
"--no-delay-death",
"\tWhen the trace level is `deep', the compiler normally",
"\tpreserves the values of variables as long as possible, even",
"\tbeyond the point of their last use, in order to make them",
"\taccessible from as many debugger events as possible.",
"\tHowever, it will not do this if this option is given.",
"--stack-trace-higher-order",
"\tEnable stack traces through predicates and functions with",
"\thigher-order arguments, even if stack tracing is not",
"\tsupported in general.",
"--generate-bytecode",
"\tOutput a bytecode form of the module for use",
"\tby an experimental debugger.",
"-n-, --no-line-numbers",
"\tDo not put source line numbers in the generated code.",
"\tThe generated code may be in C (the usual case),",
"\tor in Mercury (with the option --convert-to-mercury).",
"--auto-comments",
"\tOutput comments in the `<module>.c' file.",
"\t(The code may be easier to understand if you also",
"\tuse the `--no-llds-optimize' option.)",
"--show-dependency-graph",
"\tWrite out the dependency graph to `<module>.dependency_graph'.",
"-d <n>, --dump-hlds <stage number or name>",
"\tDump the HLDS (high level intermediate representation) after",
"\tthe specified stage to `<module>.hlds_dump.<num>-<name>'.",
"\tStage numbers range from 1-99.",
"\tMultiple dump options accumulate.",
"--dump-hlds-pred-id <n>",
"\tDump the HLDS only of the predicate/function with the given",
"\tpred id.",
% This option is for developers only
% "-D, --dump-hlds-alias <dump-alias>",
% "\tWith `--dump-hlds', include extra detail in the dump.",
% "\tEach dump alias is shorthand for a set of option letters.",
% "\tThe list of aliases is in handle_options.m",
"--dump-hlds-options <options>",
"\tWith `--dump-hlds', include extra detail in the dump.",
"\tEach type of detail is included in the dump if its",
"\tcorresponding letter occurs in the option argument",
"\t(see the Mercury User's Guide for details).",
"--dump-mlds <stage number or name>",
"\tDump the MLDS (medium level intermediate representation)",
"\tafter the specified stage, as C code,",
"\tto`<module>.c_dump.<num>-<name>',",
"\tand `<module>.h_dump.<num>-<name>'.",
"\tStage numbers range from 1-99.",
"\tMultiple dump options accumulate.",
"--verbose-dump-mlds <stage number or name>",
"\tDump the internal compiler representation of the MLDS, after",
"\tthe specified stage, to `<module>.mlds_dump.<num>-<name>'.",
"--dump-rl",
"\tOutput a human readable form of the compiler's internal",
"\trepresentation of the generated Aditi-RL code to",
"\t`<module>.rl_dump'.",
"--dump-rl-bytecode",
"\tOutput a human readable representation of the generated",
"\tAditi-RL bytecodes to `<module>.rla'.",
"\tAditi-RL bytecodes are directly executed by the Aditi system.",
"--generate-schemas",
"\tOutput schema strings for Aditi base relations",
"\tto `<module>.base_schema' and for Aditi derived",
"\trelations to `<module>.derived_schema'.",
"\tA schema string is a representation of the types",
"\tof a relation.",
"--sign-assembly",
"\tSign the current assembly with the Mercury strong name.",
"\tTo use assemblies created with this command all the Mercury",
"\tmodules must be compiled with this option enabled.",
"\tThis option is specific to the IL backend, and is likely",
"\tto be deprecated at a later date."
/* XXX currently broken.
"--separate-assemblies",
"\tPlace sub-modules in separate assemblies.",
"\tThis option is specific to the IL backend."
*/
]).
:- pred options_help_semantics(io__state::di, io__state::uo) is det.
options_help_semantics -->
io__write_string("\nLanguage semantics options:\n"),
io__write_string("(See the Mercury language reference manual for detailed explanations.)\n"),
write_tabbed_lines([
"--no-reorder-conj",
"\tExecute conjunctions left-to-right except where the modes imply",
"\tthat reordering is unavoidable.",
"--no-reorder-disj",
"\tExecute disjunctions strictly left-to-right.",
"--fully-strict",
"\tDon't optimize away loops or calls to error/1.",
"--allow-stubs",
"\tAllow procedures to have no clauses. Any calls to",
"\tsuch procedures will raise an exception at run-time.",
"\tThis option is sometimes useful during program development.",
"\t(See also the documentation for the `--warn-stubs' option",
"\tin the ""Warning Options"" section.)",
"--infer-all",
"\tAbbreviation for `--infer-types --infer-modes --infer-det'.",
"--infer-types",
"\tIf there is no type declaration for a predicate or function,",
"\ttry to infer the type, rather than just reporting an error.",
"--infer-modes",
"\tIf there is no mode declaration for a predicate,",
"\ttry to infer the modes, rather than just reporting an error.",
"--no-infer-det, --no-infer-determinism",
"\tIf there is no determinism declaration for a procedure,",
"\tdon't try to infer the determinism, just report an error.",
"--type-inference-iteration-limit <n>",
"\tPerform at most <n> passes of type inference (default: 60).",
"--mode-inference-iteration-limit <n>",
"\tPerform at most <n> passes of mode inference (default: 30)."
]).
:- pred options_help_termination(io__state::di, io__state::uo) is det.
options_help_termination -->
io__write_string("\nTermination Analysis Options:\n"),
write_tabbed_lines([
"--enable-term, --enable-termination",
"\tAnalyse each predicate to discover if it terminates.",
"--chk-term, --check-term, --check-termination",
"\tEnable termination analysis, and emit warnings for some",
"\tpredicates or functions that cannot be proved to terminate. In",
"\tmany cases where the compiler is unable to prove termination",
"\tthe problem is either a lack of information about the",
"\ttermination properties of other predicates, or because language",
"\tconstructs (such as higher order calls) were used which could",
"\tnot be analysed. In these cases the compiler does not emit a",
"\twarning of non-termination, as it is likely to be spurious.",
"--verb-chk-term, --verb-check-term, --verbose-check-termination",
"\tEnable termination analysis, and emit warnings for all",
"\tpredicates or functions that cannot be proved to terminate.",
"--term-single-arg <n>, --termination-single-argument-analysis <n>",
"\tWhen performing termination analysis, try analyzing",
"\trecursion on single arguments in strongly connected",
"\tcomponents of the call graph that have up to <n> procedures.",
"\tSetting this limit to zero disables single argument analysis.",
"--termination-norm {simple, total, num-data-elems}",
"\tThe norm defines how termination analysis measures the size",
"\tof a memory cell. The `simple' norm says that size is always",
"\tone. The `total' norm says that it is the number of words",
"\tin the cell. The `num-data-elems' norm says that it is the",
"\tnumber of words in the cell that contain something other",
"\tthan pointers to cells of the same type.",
"--term-err-limit <n>, --termination-error-limit <n>",
"\tPrint at most <n> reasons for any single termination error",
"\t(default: 3).",
"--term-path-limit <n>, --termination-path-limit <n>",
"\tPerform termination analysis only on predicates",
"\twith at most <n> paths (default: 256)."
]).
:- pred options_help_compilation_model(io__state::di, io__state::uo) is det.
options_help_compilation_model -->
io__write_string("\nCompilation model options:\n"),
write_tabbed_lines([
"The following compilation options affect the generated",
"code in such a way that the entire program must be",
"compiled with the same setting of these options,",
"and it must be linked to a version of the Mercury",
"library which has been compiled with the same setting.",
"",
"-s <grade>, --grade <grade>",
"\tSelect the compilation model. The <grade> should be one of",
"\tthe base grades `none', `reg', `jump', `asm_jump', `fast', ",
"\t`asm_fast', `hl', `hlc', `il', or `java',",
% The hl, hl_nest, and hlc_nest are not yet documented, because
% the --high-level-data option is not yet supported for C,
% and the --gcc-nested-functions option is not yet documented.
% The ilc grade is not documented because it is not useful;
% it has been superceded by the il grade.
"\tor one of those with one or more of the grade modifiers",
"\t`.gc', `.mps', `.prof', `.memprof', `.profdeep', `.tr',",
"\t`rt', `.debug', `.par' and/or `.pic_reg' appended.",
"\tDepending on your particular installation, only a subset",
"\tof these possible grades will have been installed.",
"\tAttempting to use a grade which has not been installed",
"\twill result in an error at link time."
]),
io__write_string("\n Target selection compilation model options:\n"),
write_tabbed_lines([
"--target c\t\t\t(grades: none, reg, jump, fast,",
"\t\t\t\t\tasm_jump, asm_fast, hl, hlc)",
"--target asm\t\t\t(grades: hlc)",
"--target il\t\t\t(grades: il)",
"--target java\t\t\t(grades: java)",
"\tSpecify the target language: C, assembler, IL or Java.",
"\tThe default is C. ""IL"" (also known as ""CIL"" or ""MSIL"")",
"\tis the Intermediate Language for the .NET Common Language",
"\tRuntime.",
"\tTargets other than C imply `--high-level-code' (see below).",
"\tAs an exception to the usual rule for options in this section,",
"\twhere different option settings normally correspond to different",
"\tABIs, code generated using `--target asm' is binary compatible",
"\twith code generated using `--target c --high-level code', so",
"\tthese both use grade `hlc'.",
"--il",
"\tAn abbreviation for `--target il'.",
"--il-only",
"\tAn abbreviation for `--target il --target-code-only'.",
"\tGenerate IL code in `<module>.il', but do not generate",
"\tobject code.",
"--dotnet-library-version <version-number>",
"\tThe version number for the mscorlib assembly distributed",
"\twith the Microsoft .NET SDK.",
"--no-support-ms-clr",
"\tDon't use MS CLR specific workarounds in the generated code.",
"--support-rotor-clr",
"\tUse specific workarounds for the ROTOR CLR in the generated",
"\tcode.",
"--java",
"\tAn abbreviation for `--target java'.",
"--java-only",
"\tAn abbreviation for `--target java --target-code-only'.",
"\tGenerate Java code in `<module>.java', but do not generate",
"\tobject code.",
"--compile-to-c",
"\tAn abbreviation for `--target c --target-code-only'.",
"\tGenerate C code in `<module>.c', but do not generate object",
"\tcode."
]),
io__write_string("\n Optional feature compilation model options:\n"),
io__write_string(" Debugging\n"),
write_tabbed_lines([
"--debug\t\t\t\t(grade modifier: `.debug')",
"\tEnable Mercury-level debugging.",
"\tSee the Debugging chapter of the Mercury User's Guide",
"\tfor details.",
"\tThis option is not yet supported for the `--high-level-code'",
"\tback-ends."
% The --decl-debug option is not documented because the .decldebug grade
% is not installed by default, and because the .decldebug grade is not
% usefully different from the .debug grade.
% "--decl-debug\t\t\t\t(grade modifier: `.decldebug')",
% "\tEnable full support for declarative debugging.",
% "\tThis ensures that .",
% "\tSee the Debugging chapter of the Mercury User's Guide",
% "\tfor details.",
% "\tThis option is not yet supported for the `--high-level-code'",
% "\tback-ends."
]),
io__write_string(" Profiling\n"),
write_tabbed_lines([
"-p, --profiling, --time-profiling",
"\t\t\t\t(grade modifier: `.prof')",
"\tEnable time and call profiling. Insert profiling hooks in the",
"\tgenerated code, and also output some profiling",
"\tinformation (the static call graph) to the file",
"\t`<module>.prof'.",
"\tThis option is not supported for the IL or Java back-ends.",
"--memory-profiling\t\t(grade modifier: `.memprof')",
"\tEnable memory and call profiling.",
"\tThis option is not supported for the IL or Java back-ends.",
"--deep-profiling\t\t(grade modifier: `.profdeep')",
"\tEnable deep profiling.",
"\tThis option is not supported for the high-level C, IL",
"\tor Java back-ends."
/*****************
XXX The following options are not documented,
because they are currently not useful.
The idea was for you to be able to use --profile-calls
and --profile-time separately, but that doesn't work
because compiling with --profile-time instead of
--profile-calls results in different code addresses,
so you can't combine the data from versions of
your program compiled with different options.
"--profile-calls\t\t(grade modifier: `.profcalls')",
"\tSimilar to `--profiling', except that only gathers",
"\tcall counts, not timing information.",
"\tUseful on systems where time profiling is not supported,",
"\tbut not as useful as `--memory-profiling'.",
"--profile-time\t\t(grade modifier: `.proftime')",
"\tSimilar to `--profiling', except that it only gathers",
"\ttiming information, not call counts.",
"--profile-memory\t\t(grade modifier: `.profmem')",
"\tSimilar to `--memory-profiling', except that it only gathers",
"\tmemory usage information, not call counts.",
% "--record-term-sizes-as-words\t\t(grade modifier: `.tsw')",
% "\tAugment each heap cells with its size in words.",
% "--record-term-sizes-as-cells\t\t(grade modifier: `.tsc')",
% "\tAugment each heap cells with its size in cells.",
********************/
]),
io__write_string(" Miscellaneous optional features\n"),
write_tabbed_lines([
"--gc {none, conservative, boehm, mps, accurate}",
"--garbage-collection {none, conservative, boehm, mps, accurate}",
"\t\t\t\t(`.gc' grades use `--gc boehm',",
"\t\t\t\t`.mps' grades use `--gc mps',",
"\t\t\t\tother grades use `--gc none'.)",
"\tSpecify which method of garbage collection to use",
"\t(default: boehm).",
"\t`conservative' or `boehm' is Hans Boehm et al's conservative",
"\tcollector.",
"\t`accurate' is our own type-accurate copying GC;",
"\tit requires `--high-level-code'.",
"\t`mps' is a different conservative collector, based on",
"\tRavenbrook Limited's MPS (Memory Pool System) kit.",
"\tThis option is ignored for the IL and Java back-ends,",
"\twhich always use the garbage collector of the underlying",
"\tIL or Java implementation.",
"--use-trail\t\t\t(grade modifier: `.tr')",
"\tEnable use of a trail.",
"\tThis is necessary for interfacing with constraint solvers,",
"\tor for backtrackable destructive update.",
"\tThis option is not yet supported for the IL or Java back-ends."
]),
io__write_string("\n LLDS back-end compilation model options:\n"),
write_tabbed_lines([
"--gcc-global-registers\t\t(grades: reg, fast, asm_fast)",
"--no-gcc-global-registers\t(grades: none, jump, asm_jump)",
"\tSpecify whether or not to use GNU C's",
"\tglobal register variables extension.",
"\tThis option is ignored if the `--high-level-code' option is",
"\tenabled.",
"--gcc-non-local-gotos\t\t(grades: jump, fast, asm_jump, asm_fast)",
"--no-gcc-non-local-gotos\t(grades: none, reg)",
"\tSpecify whether or not to use GNU C's",
"\t""labels as values"" extension.",
"\tThis option is ignored if the `--high-level-code' option is",
"\tenabled.",
"--asm-labels\t\t\t(grades: asm_jump, asm_fast)",
"--no-asm-labels\t\t\t(grades: none, reg, jump, fast)",
"\tSpecify whether or not to use GNU C's",
"\tasm extensions for inline assembler labels.",
"\tThis option is ignored if the `--high-level-code' option is",
"\tenabled.",
"--pic-reg\t\t\t(grade modifier: `.pic_reg')",
"[For Unix with intel x86 architecture only]",
"\tSelect a register usage convention that is compatible,",
"\twith position-independent code (gcc's `-fpic' option).",
"\tThis is necessary when using shared libraries on Intel x86",
"\tsystems running Unix. On other systems it has no effect."
]),
io__write_string("\n MLDS back-end compilation model options:\n"),
write_tabbed_lines([
% These grades (hl_nest, and hlc_nest) are not yet documented,
% because the --gcc-nested-functions option is not yet documented.
% "-H, --high-level-code\t\t\t(grades: hl_nest, hlc_nest)",
% The ilc grade is not documented because it is not useful;
% it has been superceded by the il grade.
"-H, --high-level-code\t\t\t(grades: hl, hlc, il, java)",
"\tUse an alternative back-end that generates high-level code",
"\trather than the very low-level code that is generated by our",
"\toriginal back-end.",
% The hl_nest grade is not yet documented,
% because the --gcc-nested-functions option is not yet documented.
% because it is not yet supported
% "--high-level-data\t\t\t(grades: hl, hl_nest, il, java)",
"--high-level-data\t\t\t(grades: hl, il, java)",
"\tUse an alternative higher-level data representation.",
% "--high-level\t\t\t(grades: hl, hl_nest, il, java)",
"--high-level\t\t\t(grades: hl, il, java)",
"\tAn abbreviation for `--high-level-code --high-level-data'."
% The --gcc-nested-functions option is not yet documented,
% because it doesn't pass our test suite, and it is
% probably not very useful.
% "--gcc-nested-functions\t\t(grades: hl_nest, hlc_nest)",
% "\tSpecify whether or not to use GNU C's nested functions extension.",
% "\tThis option is ignored if the `--high-level-code' option is not enabled.",
% The --det-copy-out option is not yet documented,
% because it is not yet tested much and probably not very useful,
% except for Java, where it is the default.
% "--det-copy-out",
% "\tSpecify whether to handle output arguments for det/semidet",
% "\tprocedures using return-by-value rather than pass-by-reference.",
% "\tThis option is ignored if the `--high-level-code' option is not enabled.",
% The --nondet-copy-out option is not yet documented,
% because it is probably not very useful except for IL and Java,
% where it is the default.
% "--nondet-copy-out\t\t(grades: il, ilc)",
% "\tSpecify whether to handle output arguments for nondet",
% "\tprocedures using pass-by-value rather than pass-by-reference.",
% "\tThis option is ignored if the `--high-level-code' option is not enabled.",
% The --put-commit-in-own-func option is not documented because
% it is enabled automatically (by handle_options) in the situations
% where it is needed; the user should never need to set it.
% "--put-commit-in-own-func",
% "\tPut each commit in its own C function.",
% "\tThis option only affects the MLDS back-ends.",
% "\tIt is needed for the high-level C back-end,",
% "\twhere commits are implemented via setjmp()/longjmp(),",
% "\tsince longjmp() may clobber any non-volatile local vars",
% "\tin the function that called setjmp().",
% The --put-nondet-env-on-heap option is not documented because
% it is enabled automatically (by handle_options) in the situations
% where it is needed; the user should never need to set it.
% "--put-nondet-env-on-heap",
% "\tAllocate the environment structures used for",
% "\tnondeterministic Mercury procedures on the heap,",
% "\trather than on the stack.",
%
% ]),
% io__write_string("\n IL back-end compilation model options:\n"),
% write_tabbed_lines([
%
% The --verifiable-code option is not yet documented because it is not yet fully
% implemented.
% "--verifiable, --verifiable-code\t\t\t",
% "\tEnsure that the generated IL code is verifiable.",
%
% The --il-refany-fields option is not documented because currently there
% are no IL implementations for which it is useful.
% "--il-refany-fields",
% "\tGenerate IL code that assumes that the CLI implementation",
% "\tsupports value types with fields of type `refany'.",
% "\tUsing this option could in theory allow more efficient",
% "\tverifiable IL code for nondeterministic Mercury procedures,",
% "\tif the CLI implementation supported it."
% "\tHowever, the current Microsoft CLR does not support it."
%
% The --il-byref-tailcalls option is not documented because currently there
% are no IL implementations for which it is useful.
% "--il-byref-tailcalls",
% "\tGenerate IL code that assumes that the CLI verifier",
% "\tsupports tail calls with byref arguments."
%
% The --il-funcptr-types option is not documented because it is not yet
% implemented.
% "--il-funcptr-types",
% "\tGenerate IL code that assumes that the IL assembler",
% "\tsupports function pointer types."
% "\tThe ECMA CLI specification allows function pointer types,"
% "\tbut some CLR implementations, e.g. the old Beta 2 version of"
% "\tthe Microsoft CLR implementation, do not support them."
]),
io__write_string("\n Developer compilation model options:\n"),
io__write_string("\n Data representation\n"),
write_tabbed_lines([
"--tags {none, low, high} (This option is not for general use.)",
"\tSpecify whether to use the low bits or the high bits of ",
"\teach word as tag bits (default: low).",
% "\t\t`--tags none' implies `--num-tag-bits 0'.",
"--num-tag-bits <n> (This option is not for general use.)",
"\tUse <n> tag bits.",
"--num-reserved-addresses <n> (This option is not for general use.)",
"\tTreat the integer values from 0 up to <n> - 1 as reserved",
"\taddresses that can be used to represent nullary constructors",
"\t(constants) of discriminated union types.",
"--num-reserved-objects <n> (This option is not for general use.)",
"\tAllocate up to <n> global objects per type,",
"\tfor representing nullary constructors",
"\t(constants) of discriminated union types.",
"--reserve-tag\t\t\t(grade modifier: `.rt')",
"\tReserve a tag in the data representation of the generated ",
"\tcode. This tag is intended to be used to give an explicit",
"\trepresentation to free variables.",
"\tThis is necessary for a seamless Herbrand constraint solver -",
"\tfor use with HAL.",
% The --conf-low-tag-bits option is reserved for use
% by the `mmc' script; it is deliberately not documented.
% The --bits-per-word option is intended for use
% by the `mmc' script; it is deliberately not documented.
% The --bytes-per-word option is intended for use
% by the `mmc' script; it is deliberately not documented.
"--unboxed-float",
"(This option is not for general use.)",
"\tDon't box floating point numbers.",
"\tThis assumes that a Mercury float will fit in a word.",
"\tThe C code needs to be compiled with `-UBOXED_FLOAT'.",
"\tIt may also need to be compiled with",
"\t`-DUSE_SINGLE_PREC_FLOAT', if double precision",
"\tfloats don't fit into a word."
% This is a developer only option.
% "--no-unboxed-enums",
% "(This option is not for general use.)",
% "\tBox enumerations. This option is disabled by default.",
% This is a developer only option.
% "--no-unboxed-no-tag-types",
% "(This option is not for general use.)",
% "\tBox no-tag types. This option is disabled by default."
]),
io__write_string("\n Developer optional features\n"),
write_tabbed_lines([
"--use-minimal-model",
"(This option is not for general use.)",
"\tEnable the use of minimal model tabling.",
"--no-type-layout",
"(This option is not for general use.)",
"\tDon't output type_ctor_layout structures or references",
"\tto them. (The C code also needs to be compiled with",
"\t`-DNO_TYPE_LAYOUT')."
% This is a developer only option.
% "--basic-stack-layout",
% "(This option is not for general use.)",
% "\tGenerate the simple stack_layout structures required",
% "\tfor stack traces.",
% This is a developer only option.
% "--agc-stack-layout",
% "(This option is not for general use.)",
% "\tGenerate the stack_layout structures required for",
% "\taccurate garbage collection.",
% This is a developer only option.
% "--procid-stack-layout",
% "(This option is not for general use.)",
% "\tGenerate the stack_layout structures required for",
% "\tlooking up procedure identification information.",
% This is a developer only option.
% "--trace-stack-layout",
% "(This option is not for general use.)",
% "\tGenerate the stack_layout structures required for",
% "\texecution tracing.",
% This is a developer only option.
% "--body-typeinfo-liveness",
% "(This option is not for general use.)",
% For documentation, see the comment in the type declaration.
]).
:- pred options_help_code_generation(io__state::di, io__state::uo) is det.
options_help_code_generation -->
io__write_string("\nCode generation options:\n"),
write_tabbed_lines([
"--low-level-debug",
"\tEnables various low-level debugging stuff, that was in",
"\tthe distant past used to debug the low-level code generation.",
"\tYou don't want to use this option unless you are hacking",
"\tthe Mercury compiler itself (and probably not even then).",
"\tCauses the generated code to become VERY big and VERY",
"\tinefficient. Slows down compilation a LOT.",
"--pic",
"\tGenerate position-independent code.",
"\tThis option is only used by the `--target asm' back-end.",
"\tThe generated assembler code will be written to",
"\t`<module>.pic_s' rather than to `<module>.s'.",
"--no-trad-passes",
"\tThe default `--trad-passes' completely processes each predicate",
"\tbefore going on to the next predicate.",
"\tThis option tells the compiler",
"\tto complete each phase of code generation on all predicates",
"\tbefore going on the next phase on all predicates.",
% "\t--no-polymorphism",
% "\t\tDon't handle polymorphic types.",
% "\t\t(Generates slightly more efficient code, but stops",
% "\t\tpolymorphism from working except in special cases.)",
"--no-reclaim-heap-on-nondet-failure",
"\tDon't reclaim heap on backtracking in nondet code.",
"--no-reclaim-heap-on-semidet-failure",
"\tDon't reclaim heap on backtracking in semidet code.",
"--no-reclaim-heap-on-failure",
"\tCombines the effect of the two options above.",
"--max-jump-table-size",
"\tThe maximum number of entries a jump table can have.",
"\tThe special value 0 indicates the table size is unlimited.",
"\tThis option can be useful to avoid exceeding fixed limits",
"\timposed by some C compilers.",
"--fact-table-max-array-size <n>",
"\tSpecify the maximum number of elements in a single",
"\t`:- pragma fact_table' data array (default: 1024).",
"--fact-table-hash-percent-full <percentage>",
"\tSpecify how full the `:- pragma fact_table' hash tables",
"\tshould be allowed to get. Given as an integer percentage",
"\t(valid range: 1 to 100, default: 90)."
% This option is not yet documented because the `--gcc-nested-functions' option
% is not documented.
% "--gcc-local-labels",
% "\tThis option has no effect unless both the `--high-level-code' option",
% "\tand the `--gcc-nested-functions' options are enabled.",
% "\tIf this option is enabled, the Mercury compiler will generate",
% "\tC code that uses GNU C's local labels extension to allow",
% "\tGNU C nested functions to exit into their containing function",
% "\tvia a `goto'.",
% "\tIf this option is not enabled, the default behaviour is to",
% "\tuse the standard ANSI/ISO C setjmp() and longjmp() functions."
% This option is not yet documented because it is not yet useful -- currently
% we don't take advantage of GNU C's computed gotos extension.
% "--no-prefer-switch",
% "\tGenerate code using computed gotos rather than switches.",
% "\tThis makes the generated code less readable, but potentially",
% "\tslightly more efficient.",
% "\tThis option has no effect unless the `--high-level-code' option",
% "\tis enabled. It also has no effect if the `--target' option is",
% "\tset to `il'.",
% This optimization is for implementors only. Turning this option on provides
% the fairest possible test of --optimize-saved-vars-cell.
% "--no-opt-no-return-calls",
% "\tDo not optimize the stack usage of calls that cannot return.",
]),
io__write_string("\n Code generation target options:\n"),
write_tabbed_lines([
"--branch-delay-slot \t(This option is not for general use.)",
"\tAssume that branch instructions have a delay slot.",
"--num-real-r-regs <n> \t(This option is not for general use.)",
"\tAssume registers r1 up to r<n> are real general purpose",
"\tregisters.",
"--num-real-f-regs <n> \t(This option is not for general use.)",
"\tAssume registers f1 up to f<n> are real floating point",
"\tregisters.",
"--num-real-r-temps <n> \t(This option is not for general use.)",
"\tAssume that <n> non-float temporaries will fit into",
"\treal machine registers.",
"--num-real-f-temps <n> \t(This option is not for general use.)",
"\tAssume that <n> float temporaries will fit into",
"\treal machine registers."
]).
:- pred options_help_optimization(io__state::di, io__state::uo) is det.
options_help_optimization -->
io__write_string("\nOptimization Options:\n"),
write_tabbed_lines([
"-O <n>, --opt-level <n>, --optimization-level <n>",
"\tSet optimization level to <n>.",
"\tOptimization level -1 means no optimization",
"\twhile optimization level 6 means full optimization.",
% "\t\tFor a full description of each optimization level,",
% "\t\tsee the Mercury User's Guide.",
"--opt-space, --optimize-space",
"\tTurn on optimizations that reduce code size",
"\tand turn off optimizations that significantly",
"\tincrease code size.",
"--intermodule-optimization",
"\tPerform inlining and higher-order specialization of",
"\tthe code for predicates imported from other modules.",
"\tThis option must be set throughout the compilation process.",
"--trans-intermod-opt",
"--transitive-intermodule-optimization",
"\tImport the transitive intermodule optimization data.",
"\tThis data is imported from `<module>.trans_opt' files.",
"--no-read-opt-files-transitively",
"\tOnly read the inter-module optimization information",
"\tfor directly imported modules, not the transitive",
"\tclosure of the imports.",
/* Developer only option
** Used in tests/invalid/Mercury.options
"--no-automatic-intermodule-optimization",
"\tDon't automatically enable intermodule optimization for"
"\tthose backends which require it.",
*/
"--use-opt-files",
"\tPerform inter-module optimization using any",
"\t`.opt' files which are already built,",
"\te.g. those for the standard library, but do",
"\tnot build any others.",
"--use-trans-opt-files",
"\tPerform inter-module optimization using any",
"\t`.trans_opt' files which are already built,",
"\te.g. those for the standard library, but do",
"\tnot build any others.",
"--intermodule-analysis",
"\tPerform analyses such as termination analysis and",
"\tunused argument elimination across module boundaries.",
"\tThis option is not yet fully implemented.",
"--split-c-files",
"\tGenerate each C function in its own C file,",
"\tso that the linker will optimize away unused code.",
"\tThis option significantly increases compilation time,",
"\tlink time, and intermediate disk space requirements,",
"\tbut in return reduces the size of the final",
"\texecutable, typically by about 10-20%.",
"\tThis option is only useful with `--procs-per-c-function 1',",
"\tso this option automatically sets `--procs-per-c-function 1'.",
"\tThe `--high-level-code' back-end does not support",
"\t`--split-c-files'."
]).
:- pred options_help_hlds_hlds_optimization(io__state::di, io__state::uo)
is det.
options_help_hlds_hlds_optimization -->
io__write_string("\n High-level (HLDS -> HLDS) optimizations:\n"),
write_tabbed_lines([
"--no-inlining",
"\tDisable all forms of inlining.",
"--no-inline-simple",
"\tDisable the inlining of simple procedures.",
"--no-inline-builtins",
"\tGenerate builtins (e.g. arithmetic operators) as calls to",
"\tout of line procedures. This is done by default when,",
"\tdebugging, as without this option the execution of",
"\tbuiltins is not traced.",
"--no-inline-single-use",
"\tDisable the inlining of procedures called only once.",
"--inline-compound-threshold <threshold>",
"\tInline a procedure if its size (measured roughly",
"\tin terms of the number of connectives in its internal form),",
"\tmultiplied by the number of times it is called,",
"\tis below the given threshold.",
"--inline-simple-threshold <threshold>",
"\tInline a procedure if its size is less than the",
"\tgiven threshold.",
"--intermod-inline-simple-threshold",
"\tSimilar to `--inline-simple-threshold', except used to",
"\tdetermine which predicates should be included in",
"\t`.opt' files. Note that changing this between writing",
"\tthe `.opt' file and compiling to C may cause link errors,",
"\tand too high a value may result in reduced performance.",
"--inline-vars-threshold <threshold>",
"\tDon't inline a call if it would result in a procedure",
"\tcontaining more than <threshold> variables. Procedures",
"\tcontaining large numbers of variables can cause",
"\tslow compilation.",
"--no-common-struct",
"\tDisable optimization of common term structures.",
"--no-common-goal",
"\tDisable optimization of common goals.",
"\tAt the moment this optimization",
"\tdetects only common deconstruction unifications.",
"\tDisabling this optimization reduces the class of predicates",
"\tthat the compiler considers to be deterministic.",
"--constraint-propagation",
"\tEnable the constraint propagation transformation,",
"\twhich attempts to transform the code so that goals",
"\twhich can fail are executed as early as possible.",
"--local-constraint-propagation",
"\tEnable the constraint propagation transformation,",
"\tbut only rearrange goals within each procedure.",
"\tSpecialized versions of procedures will not be created.",
"--prev-code",
"\tMigrate into the start of branched goals.",
"--no-follow-code",
"\tDon't migrate into the end of branched goals.",
"--excess-assign",
"\tRemove excess assignment unifications.",
"--optimize-duplicate-calls",
"\tOptimize away multiple calls to a predicate",
"\twith the same input arguments.",
"--loop-invariants",
"\tHoist loop invariants out of loops.",
"--delay-constructs",
"\tReorder goals to move construction unifications after",
"\tprimitive goals that can fail.",
% "--optimize-saved-vars-const",
% "\tMinimize the number of variables saved across calls by",
% "\tintroducing duplicate copies of variables bound to",
% "\tconstants in each interval between flushes where they",
% "\tare needed.",
% "--optimize-saved-vars-cell",
% "\tMinimize the number of variables saved across calls by",
% "\ttrying to use saved variables pointing to cells to reach",
% "\tthe variables stored in those cells.",
"--optimize-saved-vars",
"\tMinimize the number of variables saved across calls.",
"--optimize-unused-args",
"\tRemove unused predicate arguments.",
"\tThis will cause the compiler to generate more",
"\tefficient code for many polymorphic predicates.",
"--intermod-unused-args",
"\tPerform unused argument removal across module boundaries.",
"\tThis option implies `--optimize-unused-args' and",
"\t`--intermodule-optimization'.",
"--optimize-higher-order",
"\tEnable specialization of higher-order predicates.",
"--type-specialization",
"\tEnable specialization of polymorphic predicates where the",
"\tpolymorphic types are known.",
"--user-guided-type-specialization",
"\tEnable specialization of polymorphic predicates for which",
"\tthere are `:- pragma type_spec' declarations.",
"--higher-order-size-limit",
"\tSet the maximum goal size of specialized versions created by",
"\t`--optimize-higher-order' and `--type-specialization'.",
"\tGoal size is measured as the number of calls, unifications",
"\tand branched goals.",
"--higher-order-arg-limit",
"\tSet the maximum size of higher-order arguments to",
"\tbe specialized by `--optimize-higher-order' and",
"\t`--type-specialization'.",
"--unneeded-code",
"\tRemove goals from computation paths where their outputs are",
"\tnot needed, provided the semantics options allow the deletion",
"\tor movement of the goal.",
"--unneeded-code-copy-limit",
"\tGives the maximum number of places to which a goal may be copied",
"\twhen removing it from computation paths on which its outputs are",
"\tnot needed. A value of zero forbids goal movement and allows",
"\tonly goal deletion; a value of one prevents any increase in the",
"\tsize of the code.",
"--introduce-accumulators",
"\tAttempt to introduce accumulating variables into",
"\tprocedures, so as to make them tail recursive.",
"--optimize-constructor-last-call",
"\tEnable the optimization of ""last"" calls that are followed by",
"\tconstructor application.",
"--deforestation",
"\tEnable deforestation. Deforestation is a program",
"\ttransformation whose aim is to avoid the construction of",
"\tintermediate data structures and to avoid repeated traversals",
"\tover data structures within a conjunction.",
"--deforestation-depth-limit <limit>",
"\tSpecify a depth limit to prevent infinite loops in the",
"\tdeforestation algorithm.",
"\tA value of -1 specifies no depth limit. The default is 4.",
"--deforestation-vars-threshold <threshold>",
"\tSpecify a rough limit on the number of variables",
"\tin a procedure created by deforestation.",
"\tA value of -1 specifies no limit. The default is 200.",
"--deforestation-size-threshold <threshold>",
"\tSpecify a rough limit on the size of a goal",
"\tto be optimized by deforestation.",
"\tA value of -1 specifies no limit. The default is 15."
]).
:- pred options_help_hlds_llds_optimization(io__state::di, io__state::uo) is det.
options_help_hlds_llds_optimization -->
io__write_string("\n Medium-level (HLDS -> LLDS) optimizations:\n"),
write_tabbed_lines([
"--no-smart-indexing",
"\tGenerate switches as a simple if-then-else chains;",
"\tdisable string hashing and integer table-lookup indexing.",
"--dense-switch-req-density <percentage>",
"\tThe jump table generated for an atomic switch",
"\tmust have at least this percentage of full slots (default: 25).",
"--lookup-switch-req-density <percentage>",
"\tThe jump table generated for an atomic switch",
"\tin which all the outputs are constant terms",
"\tmust have at least this percentage of full slots (default: 25).",
"--dense-switch-size <n>",
"\tThe jump table generated for an atomic switch",
"\tmust have at least this many entries (default: 4).",
"--lookup-switch-size <n>",
"\tThe lookup table generated for an atomic switch",
"\tmust have at least this many entries (default: 4).",
"--string-switch-size <n>",
"\tThe hash table generated for a string switch",
"\tmust have at least this many entries (default: 8).",
"--tag-switch-size <n>",
"\tThe number of alternatives in a tag switch",
"\tmust be at least this number (default: 3).",
"--try-switch-size <n>",
"\tThe number of alternatives in a try/retry chain switch",
"\tmust be at least this number (default: 3).",
"--binary-switch-size <n>",
"\tThe number of alternatives in a binary search switch",
"\tmust be at least this number (default: 4).",
"--no-static-ground-terms",
"\tDisable the optimization of constructing constant ground terms",
"\tat compile time and storing them as static constants.",
"\tNote that auxiliary data structures created by the compiler",
"\tfor purposes such as debugging will still be created as",
"\tstatic constants.",
"--no-middle-rec",
"\tDisable the middle recursion optimization.",
"--no-simple-neg",
"\tDon't generate simplified code for simple negations."
% "--no-allow-hijacks",
% "\tDo not generate code in which a procedure hijacks",
% "\ta nondet stack frame that possibly belongs to",
% "\tanother procedure invocation".
]).
:- pred options_help_llds_llds_optimization(io__state::di, io__state::uo) is det.
options_help_llds_llds_optimization -->
io__write_string("\n Low-level (LLDS -> LLDS) optimizations:\n"),
write_tabbed_lines([
"--no-common-data",
"\tDisable optimization of common data structures.",
"--no-llds-optimize",
"\tDisable the low-level optimization passes.",
"--optimize-dead-procs",
"\tEnable dead predicate elimination.",
"--no-optimize-peep",
"\tDisable local peephole optimizations.",
"--no-optimize-jumps",
"\tDisable elimination of jumps to jumps.",
"--no-optimize-fulljumps",
"\tDisable elimination of jumps to ordinary code.",
"--pessimize-tailcalls",
"\tDisable the optimization of tailcalls.",
"--checked-nondet-tailcalls",
"\tConvert nondet calls into tail calls whenever possible, even",
"\twhen this requires a runtime check. This option tries to",
"\tminimize stack consumption, possibly at the expense of speed.",
"--use-local-vars",
"\tDisable the transformation to use local variables in C code",
"\tblocks wherever possible.",
"--no-optimize-labels",
"\tDisable elimination of dead labels and code.",
"--optimize-dups",
"\tEnable elimination of duplicate code.",
%%% "--optimize-copyprop",
%%% "\tEnable the copy propagation optimization.",
"--no-optimize-frames",
"\tDisable stack frame optimizations.",
"--no-optimize-delay-slot",
"\tDisable branch delay slot optimizations.",
"--optimize-reassign",
"\tOptimize away assignments to locations that already hold",
"\tthe assigned value.",
"--optimize-repeat <n>",
"\tIterate most optimizations at most <n> times (default: 3)."
]).
:- pred options_help_mlds_mlds_optimization(io__state::di, io__state::uo) is det.
options_help_mlds_mlds_optimization -->
io__write_string("\n MLDS -> MLDS optimizations:\n"),
write_tabbed_lines([
"--no-mlds-optimize",
"\tDisable the MLDS->MLDS optimization passes.",
"--no-optimize-tailcalls",
"\tTreat tailcalls as ordinary calls, rather than optimizing",
"\tby turning self-tailcalls into loops.",
"--no-optimize-initializations",
"\tLeave initializations of local variables as",
"\tassignment statements, rather than converting such",
"\tassignment statements into initializers.",
"--eliminate-local-vars",
"\tEliminate local variables with known values, where possible,",
"\tby replacing occurrences of such variables with their values."
]).
:- pred options_help_rl_rl_optimization(io__state::di, io__state::uo) is det.
options_help_rl_rl_optimization -->
io__write_string("\n Aditi-RL optimizations:\n"),
write_tabbed_lines([
"--optimize-rl",
"\tEnable the optimizations of Aditi-RL procedures",
"\tdescribed below.",
"\t--optimize-rl-invariants",
"\tOptimize loop invariants in Aditi-RL procedures.",
"\t--optimize-rl-index",
"\tUse indexing to optimize access to relations in Aditi-RL",
"\tprocedures.",
"\t--detect-rl-streams",
"\tDetect cases where intermediate results in Aditi-RL",
"\tprocedures do not need to be materialised."
/*
% This option is not yet used.
"--optimize-rl-cse",
"\tOptimize common subexpressions in Aditi-RL procedures.",
*/
]).
:- pred options_help_output_optimization(io__state::di, io__state::uo) is det.
options_help_output_optimization -->
io__write_string("\n Output-level (LLDS -> C) optimizations:\n"),
write_tabbed_lines([
"--use-macro-for-redo-fail",
"\tEmit the fail or redo macro instead of a branch",
"\tto the fail or redo code in the runtime system.",
"\tThis produces slightly bigger but slightly faster code.",
"--no-emit-c-loops",
"\tUse only gotos, don't emit C loop constructs.",
"--procs-per-c-function <n>",
"\tPut the code for up to <n> Mercury",
"\tprocedures in a single C function. The default",
"\tvalue of <n> is one. Increasing <n> can produce",
"\tslightly more efficient code, but makes compilation slower.",
"--everything-in-one-c-function",
"\tThis option has the effect of putting the code for all",
"\tthe Mercury procedures in a single C function,",
"\twhich produces the most efficient code but tends to",
"\tseverely stress the C compiler on large modules."
]).
:- pred options_help_target_code_compilation(io__state::di,
io__state::uo) is det.
options_help_target_code_compilation -->
io__write_string("\n Target code compilation:\n"),
write_tabbed_lines([
"\tNote that if you are using Mmake, you need to pass these",
"\toptions to the target code compiler (e.g. `mgnuc')",
"\trather than to `mmc'.",
"--target-debug",
"\tEnable debugging of the generated target code.",
"\tIf the target language is C, this has the same effect as",
"\t`--c-debug' (see below).",
"\tIf the target language is IL, this causes the compiler to",
"\tpass `/debug' to the IL assembler.)",
"--cc <compiler-name>",
"\tSpecify which C compiler to use.",
"--no-c-optimize",
"\tDon't enable the C compiler's optimizations.",
"--no-ansi-c",
"\tDon't specify to the C compiler that the ANSI dialect",
"\tof C should be used. Use the full contents of system",
"\theaders, rather than the ANSI subset.",
"--c-debug",
"\tEnable debugging of the generated C code.",
"\t(This has the same effect as `--cflags ""-g""'",
"\tand disables stripping of the executable.)",
"--c-include-directory <dir>",
"\tAppend <dir> to the list of directories to be searched for",
"\tC header files. Note that if you want to override",
"\tthis list, rather than append to it, then you can set the",
"\t`MERCURY_MC_ALL_C_INCL_DIRS' environment variable to a",
"\tsequence of `--c-include-directory' options.",
"--inline-alloc",
"\tInline calls to GC_malloc().",
"\tThis can improve performance a fair bit,",
"\tbut may significantly increase code size.",
"\tThis option has no effect if `--gc boehm'",
"\tis not set or if the C compiler is not GNU C.",
"--cflags <options>, --cflag <option>",
"\tSpecify options to be passed to the C compiler.",
"\t`--cflag' should be used for single words which need",
"\tto be quoted when passed to the shell.",
% The --cflags-for-regs, --cflags-for-gotos,
% --cflags-for-threads, --cflags-for-pic,
% --cflags-for-warnings, --cflags-for-ansi,
% --cflags-for-optimization, --c-flag-to-name-object-file,
% --object-file-extension, --pic-object-file-extension
% and --link-with-pic-object-file-extension
% options are reserved for use by the `mmc' script;
% they are deliberately not documented.
"--javac <javac>",
"--java-compiler <javac>",
"\tSpecify which Java compiler to use. The default is `javac'.",
"--java-flags <options>, --java-flag <option>",
"\tSpecify options to be passed to the Java compiler.",
"\t`--java-flag' should be used for single words which need",
"\tto be quoted when passed to the shell.",
"--java-classpath <path>",
"\tSet the classpath for the Java compiler.",
"--java-object-file-extension <ext>",
"\tSpecify an extension for Java object (bytecode) files",
"\tBy default this is `.class'.",
"--il-assembler <ilasm>",
"\tSpecify the name of the .NET IL Assembler command.",
"--ilasm-flags <options>, --ilasm-flag <options>",
"\tSpecify options to be passed to the IL assembler.",
"\t`--ilasm-flag' should be used for single words which need",
"\tto be quoted when passed to the shell.",
"--mcpp-compiler <cl>",
"\tSpecify the name of the Microsoft Managed C++ Compiler.",
"--mcpp-flags <options>, --mcpp-flag <option>",
"\tSpecify options to be passed to the Managed C++ compiler.",
"\t`--mcpp-flag' should be used for single words which need",
"\tto be quoted when passed to the shell.",
"--csharp-compiler <csc>",
"\tSpecify the name of the C# Compiler. The default is `csc'.",
"--csharp-flags <options>, --csharp-flag <option>",
"\tSpecify options to be passed to the C# compiler.",
"\t`--csharp-flag' should be used for single words which need",
"\tto be quoted when passed to the shell."
]).
:- pred options_help_link(io__state::di, io__state::uo) is det.
options_help_link -->
io__write_string("\nLink Options:\n"),
write_tabbed_lines([
"-o <filename>, --output-file <filename>",
"\tSpecify the name of the final executable.",
"\t(The default executable name is the same as the name",
"\tof the first module on the command line.)",
"\tThis option is ignored by `mmc --make'.",
"--ld-flags <options>, --ld-flags <option>",
"\tSpecify options to be passed to the linker command",
"\tinvoked by ml to link an executable.",
"\tUse `ml --print-link-command' to find out which",
"\tcommand is used.",
"\t`--ld-flag' should be used for single words which need",
"\tto be quoted when passed to the shell.",
"--ld-libflags <options>, --ld-libflag <option>",
"\tSpecify options to be passed to the linker command",
"\tinvoked by ml to link a shared library.",
"\tUse `ml --print-shared-lib-link-command' to find out",
"\twhich command is used.",
"\t`--ld-libflags' should be used for single words which need",
"\tto be quoted when passed to the shell.",
"-L <directory>, --library-directory <directory>",
"\tAppend <directory> to the list of directories in which",
"\tto search for libraries.",
"-R <directory>, --runtime-library-directory <directory>",
"\tAppend <directory> to the list of directories in which",
"\tto search for shared libraries at runtime.",
"-l <library>, --library <library>",
"\tLink with the specified library.",
"--link-object <object-file>",
"\tLink with the specified object file.",
"--mld <directory>, --mercury-library-directory <directory>",
"\tAppend <directory> to the list of directories to",
"\tbe searched for Mercury libraries. This will add",
"\t`--search-directory', `--library-directory',",
"\t`--init-file-directory' and `--c-include-directory'",
"\toptions as needed.",
"--mercury-standard-library-directory <directory>",
"--mercury-stdlib-dir <directory>",
"\tSearch <directory> for the Mercury standard library.",
"\tImplies `--mercury-library-directory <directory>'",
"\tand `--mercury-configuration-directory <directory>'.",
"--no-mercury-standard-library-directory",
"--no-mercury-stdlib-dir",
"\tDon't use the Mercury standard library.",
"\tImplies `--no-mercury-configuration-directory'.",
"--ml <library>, --mercury-library <library>",
"\tLink with the specified Mercury library.",
"--linkage {shared|static}",
"\tSpecify whether to use shared or static linking for",
"\texecutables. Shared libraries are always linked",
"\twith `--linkage shared'.",
"--mercury-linkage {shared|static}",
"\tSpecify whether to use shared or static linking when",
"\tlinking an executable with Mercury libraries.",
"\tShared libraries are always linked with",
"\t`--mercury-linkage shared'.",
"--init-file-directory <directory>",
"\tAppend <directory> to the list of directories to",
"\tbe searched for `.init' files by c2init.",
"--init-file <init-file>",
"\tAppend <init-file> to the list of `.init' files to",
"\tbe passed to c2init.",
"--trace-init-file <init-file>",
"\tAppend <init-file> to the list of `.init' files to",
"\tbe passed to c2init when tracing is enabled.",
"--no-strip",
"\tDon't strip executables.",
"--no-demangle",
"\tDon't pipe link errors through the Mercury demangler.",
"--no-main",
"\tDon't generate a C main() function. The user's code must",
"\tprovide a main() function.",
"--allow-undefined",
"\tAllow undefined symbols in shared libraries.",
"--no-use-readline",
"\tDisable use of the readline library in the debugger.",
"--runtime-flags <flags>",
"\tSpecify flags to pass to the Mercury runtime.",
"--extra-initialization-functions, --extra-inits",
"\tSearch `.c' files for extra initialization functions.",
"\t(This may be necessary if the C files contain",
"\thand-coded C code with `INIT' comments, rather than",
"\tcontaining only C code that was automatically generated",
"\tby the Mercury compiler.)"
% The --shared-library-extension,
% --library-extension, --executable-file-extension
% --create-archive-command, --create-archive-command-flags
% --create-archive-command-output-flag, --ranlib-command
% --link-executable-command, --link-shared-lib-command,
% --mkinit-command, --demangle-command, --trace-libs,
% --thread-libs, --shared-libs, --math-lib, --readline-libs,
% --linker-opt-separator,
% --linker-debug-flags, --shlib-linker-debug-flags,
% --linker-trace-flags, --shlib-linker-trace-flags,
% --linker-thread-flags, --shlib-linker-thread-flags,
% --linker-static-flags, --linker-strip-flag,
% --linker-link-lib-flag, --linker-link-lib-suffix,
% --shlib-linker-link-lib-flag, --shlib-linker-link-lib-suffix,
% --linker-path-flag, --linker-link-with-lib-flag,
% --linker-rpath-flag, --linker-rpath-separator,
% --shlib-linker-link-with-lib-flag,
% --shlib-linker-rpath-flag, --shlib-linker-rpath-separator,
% --linker-allow-undefined-flag and
% --linker-error-undefined-flag,
% options are reserved for use by the `Mercury.config' file;
% they are deliberately not documented.
]).
:- pred options_help_build_system(io__state::di, io__state::uo) is det.
options_help_build_system -->
io__write_string("\nBuild System Options:\n"),
write_tabbed_lines([
% `--invoked-by-mmc-make' is for internal use by the
% compiler. `mmc --make' passes it as the first argument
% when compiling a module.
"-m, --make",
"\tTreat the non-option arguments to `mmc' as files to",
"\tmake, rather than source files. Create the specified",
"\tfiles, if they are not already up-to-date.",
"\tNote that this option also enables `--use-subdirs'.",
"-r, --rebuild",
"\tSame as `--make', but always rebuild the target files",
"\teven if they are up to date.",
"-k, --keep-going",
"\tWith `--make', keep going as far as",
"\tpossible even if an error is detected.",
"--pre-link-command <command>",
"\tSpecify a command to run before linking with `mmc --make'.",
"\tThis can be used to compile C source files which rely on",
"\theader files generated by the Mercury compiler.",
"\tThe command will be passed the names of all of the source",
"\tfiles in the program or library, with the source file",
"\tcontaining the main module given first.",
"--extra-init-command <command>",
"\tSpecify a command to produce extra entries in the `.init'",
"\tfile for a library.",
"\tThe command will be passed the names of all of the source",
"\tfiles in the program or library, with the source file",
"\tcontaining the main module given first.",
"--install-prefix <dir>",
"\tThe directory under which to install Mercury libraries.",
% --use-symlinks is only used by Mercury.config.
% It controls whether the build system should attempt
% to use symlinks.
"--install-command <command>",
"\tSpecify the command to use to install the files in",
"\tMercury libraries. The given command will be invoked as",
"\t`<command> <source> <target>' to install each file",
"\tin a Mercury library. The default command is `cp'.",
"--libgrade <grade>",
"\tAdd <grade> to the list of compilation grades in",
"\twhich a library to be installed should be built.",
"--options-file <file>",
"\tAdd <file> to the list of options files to be processed.",
"\tIf <file> is `-', an options file will be read from the",
"\tstandard input. By default the file `Mercury.options'",
"\tin the current directory will be read.",
"--options-search-directory <dir>",
"\tAdd <dir> to the list of directories to be searched for",
"\toptions files.",
"--mercury-configuration-directory <directory>",
"--mercury-config-dir <directory>",
"\tSearch <directory> for Mercury system's configuration files.",
"--config-file <file>",
"\tRead the Mercury compiler's configuration information",
"\tfrom <file>. If the `--config-file' option is not set,",
"\ta default configuration will be used, unless",
"\t`--no-mercury-stdlib-dir' is passed to mmc.",
"\tThe configuration file is just an options file.",
"-I <dir>, --search-directory <dir>",
"\tAppend <dir> to the list of directories to be searched for",
"\timported modules.",
"--intermod-directory <dir>",
"\tAdd <dir> to the list of directories to be",
"\tsearched for `.opt' files.",
"--no-use-search-directories-for-intermod",
"\tDon't add arguments to `--search-directory' to the list",
"\tof directories to search for `.opt' files - use only the",
"\tdirectories given by `--intermod-directory'.",
"--use-subdirs",
"\tGenerate intermediate files in a `Mercury' subdirectory,",
"\trather than generating them in the current directory.",
"--use-grade-subdirs",
"\tGenerate intermediate files in a `Mercury' subdirectory,",
"\tlaid out so that multiple grades can be built simultaneously.",
"\tExecutables and libraries will be symlinked or copied into",
"\tthe current directory.",
"\t`--use-grade-subdirs' does not work with Mmake (it does",
"\twork with `mmc --make')."
]).
:- pred options_help_misc(io__state::di, io__state::uo) is det.
options_help_misc -->
io__write_string("\nMiscellaneous Options:\n"),
write_tabbed_lines([
"--filenames-from-stdin",
"\tRead then compile a newline terminated module name or",
"\tfile name from the standard input. Repeat this until EOF",
"\tis reached. (This allows a program or user to interactively",
"\tcompile several modules without the overhead of process",
"\tcreation for each one.)",
"--aditi",
"\tEnable Aditi compilation. You need to enable this",
"\toption if you are making use of the Aditi deductive",
"\tdatabase interface.",
"--aditi-user",
"\tSpecify the Aditi login of the owner of the predicates",
"\tin any Aditi RL files produced. The owner field is",
"\tused along with module, name and arity to identify",
"\tpredicates, and is also used for security checks.",
"\tDefaults to the value of the `USER' environment",
"\tvariable. If `$USER' is not set, `--aditi-user'",
"\tdefaults to the string ""guest""."
% The `--fullarch' option is reserved for
% use by the `Mercury.config' file.
]).
:- pred write_tabbed_lines(list(string), io__state, io__state).
:- mode write_tabbed_lines(in, di, uo) is det.
write_tabbed_lines([]) --> [].
write_tabbed_lines([Str|Strs]) -->
io__write_char('\t'),
io__write_string(Str),
io__write_char('\n'),
write_tabbed_lines(Strs).
:- end_module options.
%-----------------------------------------------------------------------------%