author | wenzelm |
Fri, 21 Oct 2022 14:45:13 +0200 | |
changeset 76350 | 978f7ca3329f |
parent 76236 | 03dd2f19f1d7 |
child 76351 | 2cee31cd92f0 |
permissions | -rw-r--r-- |
54439 | 1 |
/* Title: Pure/General/bytes.scala |
2 |
Author: Makarius |
|
3 |
||
4 |
Immutable byte vectors versus UTF8 strings. |
|
5 |
*/ |
|
6 |
||
7 |
package isabelle |
|
8 |
||
9 |
||
64004 | 10 |
import java.io.{File => JFile, ByteArrayOutputStream, ByteArrayInputStream, |
64229 | 11 |
OutputStream, InputStream, FileInputStream, FileOutputStream} |
65070 | 12 |
import java.net.URL |
64004 | 13 |
|
14 |
import org.tukaani.xz.{XZInputStream, XZOutputStream} |
|
54440 | 15 |
|
16 |
||
75393 | 17 |
object Bytes { |
54439 | 18 |
val empty: Bytes = new Bytes(Array[Byte](), 0, 0) |
19 |
||
75393 | 20 |
def apply(s: CharSequence): Bytes = { |
54439 | 21 |
val str = s.toString |
22 |
if (str.isEmpty) empty |
|
23 |
else { |
|
62527 | 24 |
val b = UTF8.bytes(str) |
54442
c39972ddd672
more specific Protocol_Output: empty message.body, main content via bytes/text;
wenzelm
parents:
54440
diff
changeset
|
25 |
new Bytes(b, 0, b.length) |
54439 | 26 |
} |
27 |
} |
|
54440 | 28 |
|
63779 | 29 |
def apply(a: Array[Byte]): Bytes = apply(a, 0, a.length) |
30 |
||
54442
c39972ddd672
more specific Protocol_Output: empty message.body, main content via bytes/text;
wenzelm
parents:
54440
diff
changeset
|
31 |
def apply(a: Array[Byte], offset: Int, length: Int): Bytes = |
c39972ddd672
more specific Protocol_Output: empty message.body, main content via bytes/text;
wenzelm
parents:
54440
diff
changeset
|
32 |
if (length == 0) empty |
c39972ddd672
more specific Protocol_Output: empty message.body, main content via bytes/text;
wenzelm
parents:
54440
diff
changeset
|
33 |
else { |
c39972ddd672
more specific Protocol_Output: empty message.body, main content via bytes/text;
wenzelm
parents:
54440
diff
changeset
|
34 |
val b = new Array[Byte](length) |
55618 | 35 |
System.arraycopy(a, offset, b, 0, length) |
54442
c39972ddd672
more specific Protocol_Output: empty message.body, main content via bytes/text;
wenzelm
parents:
54440
diff
changeset
|
36 |
new Bytes(b, 0, b.length) |
c39972ddd672
more specific Protocol_Output: empty message.body, main content via bytes/text;
wenzelm
parents:
54440
diff
changeset
|
37 |
} |
c39972ddd672
more specific Protocol_Output: empty message.body, main content via bytes/text;
wenzelm
parents:
54440
diff
changeset
|
38 |
|
69454 | 39 |
val newline: Bytes = apply("\n") |
54440 | 40 |
|
73576 | 41 |
|
42 |
/* base64 */ |
|
43 |
||
75587 | 44 |
def decode_base64(s: String): Bytes = { |
75620 | 45 |
val a = Base64.decode(s) |
68108 | 46 |
new Bytes(a, 0, a.length) |
47 |
} |
|
48 |
||
75579 | 49 |
|
54440 | 50 |
/* read */ |
51 |
||
64005
f6e965cf1617
clarified magic values (see also java/io/BufferedInputStream.java);
wenzelm
parents:
64004
diff
changeset
|
52 |
def read_stream(stream: InputStream, limit: Int = Integer.MAX_VALUE, hint: Int = 1024): Bytes = |
64004 | 53 |
if (limit == 0) empty |
54 |
else { |
|
73414 | 55 |
val out_size = (if (limit == Integer.MAX_VALUE) hint else limit) max 1024 |
56 |
val out = new ByteArrayOutputStream(out_size) |
|
64005
f6e965cf1617
clarified magic values (see also java/io/BufferedInputStream.java);
wenzelm
parents:
64004
diff
changeset
|
57 |
val buf = new Array[Byte](8192) |
64004 | 58 |
var m = 0 |
54440 | 59 |
|
75709 | 60 |
while ({ |
73554 | 61 |
m = stream.read(buf, 0, buf.length min (limit - out.size)) |
64004 | 62 |
if (m != -1) out.write(buf, 0, m) |
75709 | 63 |
m != -1 && limit > out.size |
64 |
}) () |
|
64004 | 65 |
|
66 |
new Bytes(out.toByteArray, 0, out.size) |
|
54440 | 67 |
} |
64001
7ecb22be8f03
more general read_stream: return actual byte count;
wenzelm
parents:
63779
diff
changeset
|
68 |
|
75393 | 69 |
def read(file: JFile): Bytes = { |
71152
f2d848a596d1
more robust: file length can be invalid in odd situations;
wenzelm
parents:
71151
diff
changeset
|
70 |
val length = file.length |
f2d848a596d1
more robust: file length can be invalid in odd situations;
wenzelm
parents:
71151
diff
changeset
|
71 |
val limit = if (length < 0 || length > Integer.MAX_VALUE) Integer.MAX_VALUE else length.toInt |
f2d848a596d1
more robust: file length can be invalid in odd situations;
wenzelm
parents:
71151
diff
changeset
|
72 |
using(new FileInputStream(file))(read_stream(_, limit = limit)) |
f2d848a596d1
more robust: file length can be invalid in odd situations;
wenzelm
parents:
71151
diff
changeset
|
73 |
} |
64229 | 74 |
|
75 |
def read(path: Path): Bytes = read(path.file) |
|
76 |
||
65070 | 77 |
def read(url: URL): Bytes = using(url.openStream)(read_stream(_)) |
78 |
||
64229 | 79 |
|
80 |
/* write */ |
|
81 |
||
69393
ed0824ef337e
static type for Library.using: avoid Java 11 warnings on "Illegal reflective access";
wenzelm
parents:
69365
diff
changeset
|
82 |
def write(file: JFile, bytes: Bytes): Unit = |
ed0824ef337e
static type for Library.using: avoid Java 11 warnings on "Illegal reflective access";
wenzelm
parents:
69365
diff
changeset
|
83 |
using(new FileOutputStream(file))(bytes.write_stream(_)) |
64229 | 84 |
|
85 |
def write(path: Path, bytes: Bytes): Unit = write(path.file, bytes) |
|
54439 | 86 |
} |
87 |
||
88 |
final class Bytes private( |
|
89 |
protected val bytes: Array[Byte], |
|
90 |
protected val offset: Int, |
|
75393 | 91 |
val length: Int) extends CharSequence { |
54439 | 92 |
/* equality */ |
93 |
||
75393 | 94 |
override def equals(that: Any): Boolean = { |
54440 | 95 |
that match { |
96 |
case other: Bytes => |
|
97 |
if (this eq other) true |
|
98 |
else if (length != other.length) false |
|
99 |
else (0 until length).forall(i => bytes(offset + i) == other.bytes(other.offset + i)) |
|
100 |
case _ => false |
|
101 |
} |
|
102 |
} |
|
103 |
||
75393 | 104 |
private lazy val hash: Int = { |
54439 | 105 |
var h = 0 |
106 |
for (i <- offset until offset + length) { |
|
107 |
val b = bytes(i).asInstanceOf[Int] & 0xFF |
|
108 |
h = 31 * h + b |
|
109 |
} |
|
110 |
h |
|
111 |
} |
|
112 |
||
113 |
override def hashCode(): Int = hash |
|
114 |
||
115 |
||
116 |
/* content */ |
|
117 |
||
54512 | 118 |
lazy val sha1_digest: SHA1.Digest = SHA1.digest(bytes) |
54440 | 119 |
|
69448 | 120 |
def is_empty: Boolean = length == 0 |
121 |
||
122 |
def iterator: Iterator[Byte] = |
|
123 |
for (i <- (offset until (offset + length)).iterator) |
|
124 |
yield bytes(i) |
|
125 |
||
75393 | 126 |
def array: Array[Byte] = { |
69365
c5b3860d29ef
avoid loading of font file, to eliminate "Illegal reflective access by com.lowagie.text.pdf.MappedRandomAccessFile$1 (iText-2.1.5.jar) to method java.nio.DirectByteBuffer.cleaner()" -- due to com.lowagie.text.pdf.TrueTypeFont.process() / RandomAccessFileOrArray;
wenzelm
parents:
68167
diff
changeset
|
127 |
val a = new Array[Byte](length) |
c5b3860d29ef
avoid loading of font file, to eliminate "Illegal reflective access by com.lowagie.text.pdf.MappedRandomAccessFile$1 (iText-2.1.5.jar) to method java.nio.DirectByteBuffer.cleaner()" -- due to com.lowagie.text.pdf.TrueTypeFont.process() / RandomAccessFileOrArray;
wenzelm
parents:
68167
diff
changeset
|
128 |
System.arraycopy(bytes, offset, a, 0, length) |
c5b3860d29ef
avoid loading of font file, to eliminate "Illegal reflective access by com.lowagie.text.pdf.MappedRandomAccessFile$1 (iText-2.1.5.jar) to method java.nio.DirectByteBuffer.cleaner()" -- due to com.lowagie.text.pdf.TrueTypeFont.process() / RandomAccessFileOrArray;
wenzelm
parents:
68167
diff
changeset
|
129 |
a |
c5b3860d29ef
avoid loading of font file, to eliminate "Illegal reflective access by com.lowagie.text.pdf.MappedRandomAccessFile$1 (iText-2.1.5.jar) to method java.nio.DirectByteBuffer.cleaner()" -- due to com.lowagie.text.pdf.TrueTypeFont.process() / RandomAccessFileOrArray;
wenzelm
parents:
68167
diff
changeset
|
130 |
} |
c5b3860d29ef
avoid loading of font file, to eliminate "Illegal reflective access by com.lowagie.text.pdf.MappedRandomAccessFile$1 (iText-2.1.5.jar) to method java.nio.DirectByteBuffer.cleaner()" -- due to com.lowagie.text.pdf.TrueTypeFont.process() / RandomAccessFileOrArray;
wenzelm
parents:
68167
diff
changeset
|
131 |
|
73561
c83152933579
clarified signature: Bytes extends CharSequence already (see d201996f72a8);
wenzelm
parents:
73559
diff
changeset
|
132 |
def text: String = UTF8.decode_permissive(this) |
65279
fa62e095d8f1
clarified signature (again, see also 3ed43cfc8b14);
wenzelm
parents:
65070
diff
changeset
|
133 |
|
76236 | 134 |
def wellformed_text: Option[String] = { |
135 |
val s = text |
|
136 |
if (this == Bytes(s)) Some(s) else None |
|
137 |
} |
|
138 |
||
75587 | 139 |
def encode_base64: String = { |
68094 | 140 |
val b = |
141 |
if (offset == 0 && length == bytes.length) bytes |
|
142 |
else Bytes(bytes, offset, length).bytes |
|
75620 | 143 |
Base64.encode(b) |
68094 | 144 |
} |
145 |
||
76236 | 146 |
def maybe_encode_base64: (Boolean, String) = |
147 |
wellformed_text match { |
|
148 |
case Some(s) => (false, s) |
|
149 |
case None => (true, encode_base64) |
|
150 |
} |
|
68106 | 151 |
|
68150
f0f34cbed539
clarified output: avoid costly operations on huge blobs;
wenzelm
parents:
68149
diff
changeset
|
152 |
override def toString: String = "Bytes(" + length + ")" |
54439 | 153 |
|
72885 | 154 |
def proper: Option[Bytes] = if (is_empty) None else Some(this) |
155 |
def proper_text: Option[String] = if (is_empty) None else Some(text) |
|
65630 | 156 |
|
54439 | 157 |
def +(other: Bytes): Bytes = |
72885 | 158 |
if (other.is_empty) this |
159 |
else if (is_empty) other |
|
54439 | 160 |
else { |
161 |
val new_bytes = new Array[Byte](length + other.length) |
|
55618 | 162 |
System.arraycopy(bytes, offset, new_bytes, 0, length) |
163 |
System.arraycopy(other.bytes, other.offset, new_bytes, length, other.length) |
|
54439 | 164 |
new Bytes(new_bytes, 0, new_bytes.length) |
165 |
} |
|
54440 | 166 |
|
167 |
||
60833 | 168 |
/* CharSequence operations */ |
169 |
||
170 |
def charAt(i: Int): Char = |
|
171 |
if (0 <= i && i < length) (bytes(offset + i).asInstanceOf[Int] & 0xFF).asInstanceOf[Char] |
|
172 |
else throw new IndexOutOfBoundsException |
|
173 |
||
75393 | 174 |
def subSequence(i: Int, j: Int): Bytes = { |
60833 | 175 |
if (0 <= i && i <= j && j <= length) new Bytes(bytes, offset + i, j - i) |
176 |
else throw new IndexOutOfBoundsException |
|
177 |
} |
|
178 |
||
69448 | 179 |
def trim_line: Bytes = |
180 |
if (length >= 2 && charAt(length - 2) == 13 && charAt(length - 1) == 10) |
|
181 |
subSequence(0, length - 2) |
|
182 |
else if (length >= 1 && (charAt(length - 1) == 13 || charAt(length - 1) == 10)) |
|
183 |
subSequence(0, length - 1) |
|
184 |
else this |
|
185 |
||
60833 | 186 |
|
64004 | 187 |
/* streams */ |
188 |
||
189 |
def stream(): ByteArrayInputStream = new ByteArrayInputStream(bytes, offset, length) |
|
190 |
||
191 |
def write_stream(stream: OutputStream): Unit = stream.write(bytes, offset, length) |
|
192 |
||
193 |
||
194 |
/* XZ data compression */ |
|
54440 | 195 |
|
76350
978f7ca3329f
clarified signature: default cache is actually dummy and not changed dynamically;
wenzelm
parents:
76236
diff
changeset
|
196 |
def uncompress(cache: XZ.Cache = XZ.Cache.none): Bytes = |
68018 | 197 |
using(new XZInputStream(stream(), cache))(Bytes.read_stream(_, hint = length)) |
64004 | 198 |
|
76350
978f7ca3329f
clarified signature: default cache is actually dummy and not changed dynamically;
wenzelm
parents:
76236
diff
changeset
|
199 |
def compress(options: XZ.Options = XZ.options(), cache: XZ.Cache = XZ.Cache.none): Bytes = { |
64004 | 200 |
val result = new ByteArrayOutputStream(length) |
68018 | 201 |
using(new XZOutputStream(result, options, cache))(write_stream(_)) |
64004 | 202 |
new Bytes(result.toByteArray, 0, result.size) |
203 |
} |
|
68167 | 204 |
|
75393 | 205 |
def maybe_compress( |
206 |
options: XZ.Options = XZ.options(), |
|
76350
978f7ca3329f
clarified signature: default cache is actually dummy and not changed dynamically;
wenzelm
parents:
76236
diff
changeset
|
207 |
cache: XZ.Cache = XZ.Cache.none |
75393 | 208 |
) : (Boolean, Bytes) = { |
68167 | 209 |
val compressed = compress(options = options, cache = cache) |
210 |
if (compressed.length < length) (true, compressed) else (false, this) |
|
211 |
} |
|
54439 | 212 |
} |