.vim/bundle/ale/doc/ale-prolog.txt

   1 ===============================================================================
   2 ALE Prolog Integration                                     *ale-prolog-options*
   3
   4
   5 ===============================================================================
   6 swipl                                                        *ale-prolog-swipl*
   7
   8                                           *ale-options.prolog_swipl_executable*
   9                                                 *g:ale_prolog_swipl_executable*
  10                                                 *b:ale_prolog_swipl_executable*
  11 prolog_swipl_executable
  12 g:ale_prolog_swipl_executable
  13   Type: |String|
  14   Default: `'swipl'`
  15
  16   The executable that will be run for the `swipl` linter.
  17
  18                                                 *ale-options.prolog_swipl_load*
  19                                                       *g:ale_prolog_swipl_load*
  20                                                       *b:ale_prolog_swipl_load*
  21 prolog_swipl_load
  22 g:ale_prolog_swipl_load
  23   Type: |String|
  24   Default: `'current_prolog_flag(argv, [File]), load_files(File, [sandboxed(true)]), halt.'`
  25
  26   The prolog goals that will be passed to |g:ale_prolog_swipl_executable| with `-g` option.
  27
  28   It does:
  29   1. Takes the first command argument (current file path)
  30   2. Checks (syntactic / semantic) problems and output to stderr
  31
  32   NOTE: `sandboxed(true)` prohibits executing some directives such as 'initialization main'.
  33
  34                                              *ale-options.prolog_swipl_timeout*
  35                                                    *g:ale_prolog_swipl_timeout*
  36                                                    *b:ale_prolog_swipl_timeout*
  37 prolog_swipl_timeout
  38 g:ale_prolog_swipl_timeout
  39   Type: |Number|
  40   Default: `3`
  41
  42   Timeout seconds to detect long-running linter.
  43   It is done by setting SIGALRM.
  44   See |g:ale_prolog_swipl_alarm| and |g:ale_prolog_swipl_alarm_handler|.
  45
  46                                                *ale-options.prolog_swipl_alarm*
  47                                                      *g:ale_prolog_swipl_alarm*
  48                                                      *b:ale_prolog_swipl_alarm*
  49 prolog_swipl_alarm
  50 g:ale_prolog_swipl_alarm
  51   Type: |String|
  52   Default: `'alarm(%t, (%h), _, [])'`
  53
  54   The prolog goals to be expected to set SIGALRM.
  55   `%t` is replaced by |g:ale_prolog_swipl_timeout|.
  56   `%h` is replaced by |g:ale_prolog_swipl_alarm_handler|.
  57
  58                                        *ale-options.prolog_swipl_alarm_handler*
  59                                              *g:ale_prolog_swipl_alarm_handler*
  60                                              *b:ale_prolog_swipl_alarm_handler*
  61 prolog_swipl_alarm_handler
  62 g:ale_prolog_swipl_alarm_handler
  63   Type: |String|
  64   Default: `'writeln(user_error, "ERROR: Exceeded %t seconds, Please change g:prolog_swipl_timeout to modify the limit."), halt(1)'`
  65
  66   The prolog goals to be expected that will be run on SIGALRM.
  67   `%t` is replaced by |g:ale_prolog_swipl_timeout|.
  68
  69
  70 ===============================================================================
  71   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: