src/Pure/PIDE/command_span.ML
author wenzelm
Thu, 07 Aug 2025 22:42:21 +0200
changeset 82968 b2b88d5b01b6
parent 82931 fa8067dc6787
permissions -rw-r--r--
update to jdk-21.0.8; enforce rebuild of Isabelle/ML and Isabelle/Scala;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
57905
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
     1
(*  Title:      Pure/PIDE/command_span.ML
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
     3
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
     4
Syntactic representation of command spans.
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
     5
*)
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
     6
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
     7
signature COMMAND_SPAN =
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
     8
sig
72754
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
     9
  val extensions: string list -> Path.T -> Path.T list
57905
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    10
  datatype kind = Command_Span of string * Position.T | Ignored_Span | Malformed_Span
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    11
  datatype span = Span of kind * Token.T list
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    12
  val kind: span -> kind
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    13
  val content: span -> Token.T list
82931
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    14
  val range: span -> Position.range
68183
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    15
  val symbol_length: span -> int option
82679
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    16
  val eof: span
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    17
  val is_eof: span -> bool
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    18
  val stopper: span Scan.stopper
68183
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    19
  val adjust_offsets_kind: (int -> int option) -> kind -> kind
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    20
  val adjust_offsets: (int -> int option) -> span -> span
82931
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    21
  val command_ranges: span list -> Position.range list
57905
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    22
end;
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    23
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    24
structure Command_Span: COMMAND_SPAN =
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    25
struct
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    26
72754
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    27
(* loaded files *)
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    28
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    29
fun extensions exts path = map (fn ext => Path.ext ext path) exts;
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    30
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    31
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    32
(* span *)
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    33
57905
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    34
datatype kind = Command_Span of string * Position.T | Ignored_Span | Malformed_Span;
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    35
datatype span = Span of kind * Token.T list;
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    36
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    37
fun kind (Span (k, _)) = k;
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    38
fun content (Span (_, toks)) = toks;
82931
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    39
val range = Token.range_of o content;
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    40
val symbol_length = Position.distance_of o range;
68177
6e40f5d43936 clarified signature;
wenzelm
parents: 59689
diff changeset
    41
72754
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    42
82679
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    43
(* stopper *)
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    44
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    45
val eof = Span (Command_Span ("", Position.none), []);
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    46
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    47
fun is_eof (Span (Command_Span ("", _), _)) = true
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    48
  | is_eof _ = false;
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    49
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    50
val stopper = Scan.stopper (K eof) is_eof;
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    51
1dd29afaddda more generic parsing of command spans;
wenzelm
parents: 72754
diff changeset
    52
72754
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    53
(* presentation positions *)
1456c5747416 clarified modules;
wenzelm
parents: 68183
diff changeset
    54
68183
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    55
fun adjust_offsets_kind adjust k =
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    56
  (case k of
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    57
    Command_Span (name, pos) => Command_Span (name, Position.adjust_offsets adjust pos)
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    58
  | _ => k);
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    59
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    60
fun adjust_offsets adjust (Span (k, toks)) =
6560324b1e4d adjust position according to offset of command/exec id;
wenzelm
parents: 68177
diff changeset
    61
  Span (adjust_offsets_kind adjust k, map (Token.adjust_offsets adjust) toks);
68177
6e40f5d43936 clarified signature;
wenzelm
parents: 59689
diff changeset
    62
82931
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    63
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    64
(* command ranges, including trailing non-commands (whitespace etc.) *)
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    65
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    66
fun command_ranges spans =
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    67
  let
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    68
    fun ranges NONE [] result = rev result
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    69
      | ranges (SOME pos) [] result =
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    70
          let val end_pos = #2 (range (List.last spans))
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    71
          in rev (Position.range (pos, end_pos) :: result) end
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    72
      | ranges start_pos (span :: rest) result =
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    73
          (case (start_pos, kind span) of
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    74
            (NONE, Command_Span _) => ranges (SOME (#1 (range span))) rest result
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    75
          | (SOME pos, Command_Span _) =>
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    76
              let
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    77
                val pos' = #1 (range span);
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    78
                val result' = Position.range (pos, pos') :: result;
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    79
              in ranges (SOME pos') rest result' end
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    80
          | _ => ranges start_pos rest result);
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    81
  in ranges NONE spans [] end;
fa8067dc6787 more markup for batch build: command ranges with trailing whitespace;
wenzelm
parents: 82679
diff changeset
    82
57905
c0c5652e796e separate module Command_Span: mostly syntactic representation;
wenzelm
parents:
diff changeset
    83
end;