src/Pure/General/utf8.scala
author wenzelm
Mon, 26 Sep 2022 11:30:44 +0200
changeset 76209 365f6a621fc5
parent 75393 87ebf5a50283
child 76355 16816ee9a570
permissions -rw-r--r--
clarified signature;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
64639
bad5de3f9554 clarified directories;
wenzelm
parents: 64617
diff changeset
     1
/*  Title:      Pure/General/utf8.scala
50203
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
     3
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
     4
Variations on UTF-8.
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
     5
*/
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
     6
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
     7
package isabelle
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
     8
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
     9
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    10
import java.nio.charset.Charset
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    11
import scala.io.Codec
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    12
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    13
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73561
diff changeset
    14
object UTF8 {
50203
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    15
  /* charset */
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    16
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    17
  val charset_name: String = "UTF-8"
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    18
  val charset: Charset = Charset.forName(charset_name)
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    19
  def codec(): Codec = Codec(charset)
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    20
62527
aae9a2a855e0 tuned signature;
wenzelm
parents: 54444
diff changeset
    21
  def bytes(s: String): Array[Byte] = s.getBytes(charset)
aae9a2a855e0 tuned signature;
wenzelm
parents: 54444
diff changeset
    22
50203
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    23
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    24
  /* permissive UTF-8 decoding */
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    25
68224
1f7308050349 prefer HTTPS;
wenzelm
parents: 65196
diff changeset
    26
  // see also https://en.wikipedia.org/wiki/UTF-8#Description
54444
a2290f36d1d6 prefer UTF8.decode_permissive;
wenzelm
parents: 54440
diff changeset
    27
  // overlong encodings enable byte-stuffing of low-ASCII
50203
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    28
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73561
diff changeset
    29
  def decode_permissive(text: CharSequence): String = {
73561
c83152933579 clarified signature: Bytes extends CharSequence already (see d201996f72a8);
wenzelm
parents: 73340
diff changeset
    30
    val len = text.length
c83152933579 clarified signature: Bytes extends CharSequence already (see d201996f72a8);
wenzelm
parents: 73340
diff changeset
    31
    val buf = new java.lang.StringBuilder(len)
50203
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    32
    var code = -1
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    33
    var rest = 0
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73561
diff changeset
    34
    def flush(): Unit = {
50203
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    35
      if (code != -1) {
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    36
        if (rest == 0 && Character.isValidCodePoint(code))
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    37
          buf.appendCodePoint(code)
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    38
        else buf.append('\uFFFD')
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    39
        code = -1
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    40
        rest = 0
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    41
      }
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    42
    }
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73561
diff changeset
    43
    def init(x: Int, n: Int): Unit = {
50203
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    44
      flush()
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    45
      code = x
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    46
      rest = n
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    47
    }
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 73561
diff changeset
    48
    def push(x: Int): Unit = {
50203
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    49
      if (rest <= 0) init(x, -1)
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    50
      else {
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    51
        code <<= 6
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    52
        code += x
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    53
        rest -= 1
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    54
      }
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    55
    }
73561
c83152933579 clarified signature: Bytes extends CharSequence already (see d201996f72a8);
wenzelm
parents: 73340
diff changeset
    56
    for (i <- 0 until len) {
50203
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    57
      val c = text.charAt(i)
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    58
      if (c < 128) { flush(); buf.append(c) }
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    59
      else if ((c & 0xC0) == 0x80) push(c & 0x3F)
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    60
      else if ((c & 0xE0) == 0xC0) init(c & 0x1F, 1)
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    61
      else if ((c & 0xF0) == 0xE0) init(c & 0x0F, 2)
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    62
      else if ((c & 0xF8) == 0xF0) init(c & 0x07, 3)
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    63
    }
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    64
    flush()
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    65
    buf.toString
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    66
  }
00d8ad713e32 explicit module UTF8;
wenzelm
parents:
diff changeset
    67
}