Module Superbol_free_lib.Common_args

type progress_display =
  1. | Hide
  2. | Show
    (*

    on a single line of stderr, overwritten

    *)
  3. | Log
  4. | Log_stderr
type t = {
  1. platform : Cobol_common.Platform.TYPES.platform;
  2. preproc_options : Cobol_preproc.Options.preproc_options;
  3. parser_options : Cobol_parser.Options.parser_options;
  4. progress_display : progress_display;
  5. pretty_progress : 'a. 'a Pretty.proc;
    (*

    as progress_display

    *)
  6. analysis_overrides : Superbol_project.Analysis.overrides;
    (*

    Only what is explicitly given on the command line, for commands that analyze documents according to the configuration of their project.

    *)
}
val get : unit -> (unit -> t) * Ezcmd.V2.EZCMD.TYPES.arg_list

Progress

val progress_arg : unit -> (unit -> progress_display) * Ezcmd.V2.EZCMD.TYPES.arg_list

progress_arg () is the --progress option (alone in its list), along with a function that tells how to display progress accordingly (by default, it is shown when stderr is a TTY).

val pretty_progress : progress_display -> 'a Pretty.proc

pretty_progress display reports progress as display tells.

val clear_progress : unit -> unit

clear_progress () erases the progress message shown on stderr, if any, so that what is printed next does not mix with it.