v/vlib/strings/builder.v

152 lines
3.8 KiB
V
Raw Normal View History

// Copyright (c) 2019-2021 Alexander Medvednikov. All rights reserved.
2019-06-23 04:21:30 +02:00
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
2019-09-14 22:48:30 +02:00
module strings
2019-06-22 20:20:28 +02:00
// strings.Builder is used to efficiently append many strings to a large
2020-12-21 21:00:32 +01:00
// dynamically growing buffer, then use the resulting large string. Using
// a string builder is much better for performance/memory usage than doing
// constantly string concatenation.
2019-10-24 11:47:21 +02:00
pub struct Builder {
2020-05-09 15:16:48 +02:00
pub mut:
2019-12-19 22:29:37 +01:00
buf []byte
len int
initial_size int = 1
2019-06-22 20:20:28 +02:00
}
2020-12-21 21:00:32 +01:00
// new_builder returns a new string builder, with an initial capacity of `initial_size`
pub fn new_builder(initial_size int) Builder {
2019-12-19 22:29:37 +01:00
return Builder{
2020-12-21 21:00:32 +01:00
// buf: make(0, initial_size)
buf: []byte{cap: initial_size}
2020-05-18 21:38:06 +02:00
len: 0
initial_size: initial_size
2019-06-22 20:20:28 +02:00
}
}
2020-12-21 21:00:32 +01:00
// write_bytes appends `bytes` to the accumulated buffer
[deprecated: 'use Builder.write_ptr() instead']
[deprecated_after: '2021-04-18']
[unsafe]
pub fn (mut b Builder) write_bytes(bytes &byte, len int) {
unsafe { b.write_ptr(bytes, len) }
}
// write_ptr writes `len` bytes provided byteptr to the accumulated buffer
[unsafe]
pub fn (mut b Builder) write_ptr(ptr &byte, len int) {
unsafe { b.buf.push_many(ptr, len) }
b.len += len
2019-12-11 17:20:46 +01:00
}
2020-12-21 21:00:32 +01:00
// write_b appends a single `data` byte to the accumulated buffer
2020-05-17 13:51:18 +02:00
pub fn (mut b Builder) write_b(data byte) {
2019-12-06 21:02:09 +01:00
b.buf << data
2019-12-08 12:11:19 +01:00
b.len++
2019-12-06 21:02:09 +01:00
}
// write implements the Writer interface
pub fn (mut b Builder) write(data []byte) ?int {
b.buf << data
b.len += data.len
return data.len
}
2020-12-21 21:00:32 +01:00
// write appends the string `s` to the buffer
[inline]
pub fn (mut b Builder) write_string(s string) {
2019-12-24 18:54:43 +01:00
if s == '' {
return
}
unsafe { b.buf.push_many(s.str, s.len) }
2019-12-19 22:29:37 +01:00
// for c in s {
// b.buf << c
// }
// b.buf << []byte(s) // TODO
2019-06-22 20:20:28 +02:00
b.len += s.len
}
2020-12-21 21:00:32 +01:00
// go_back discards the last `n` bytes from the buffer
2020-05-17 13:51:18 +02:00
pub fn (mut b Builder) go_back(n int) {
2020-12-21 21:00:32 +01:00
b.buf.trim(b.buf.len - n)
b.len -= n
}
2020-03-10 23:21:26 +01:00
2020-12-21 21:00:32 +01:00
// cut_last cuts the last `n` bytes from the buffer and returns them
2020-06-17 00:59:33 +02:00
pub fn (mut b Builder) cut_last(n int) string {
2021-05-07 18:41:27 +02:00
res := b.buf[b.len - n..].bytestr()
2020-12-21 21:00:32 +01:00
b.buf.trim(b.buf.len - n)
2020-06-17 00:59:33 +02:00
b.len -= n
return res
2020-06-17 00:59:33 +02:00
}
2021-05-07 18:41:27 +02:00
// cut_to cuts the string after `pos` and returns it.
// if `pos` is superior to builder length, returns an empty string
// and cancel further operations
2020-06-17 00:59:33 +02:00
pub fn (mut b Builder) cut_to(pos int) string {
2021-05-07 18:41:27 +02:00
if pos > b.len {
return ''
}
return b.cut_last(b.buf.len - pos)
2020-06-17 00:59:33 +02:00
}
2021-05-07 18:41:27 +02:00
2020-12-21 21:00:32 +01:00
// go_back_to resets the buffer to the given position `pos`
// NB: pos should be < than the existing buffer length.
2020-05-17 13:51:18 +02:00
pub fn (mut b Builder) go_back_to(pos int) {
2020-04-28 13:15:37 +02:00
b.buf.trim(pos)
b.len = pos
}
2020-12-21 21:00:32 +01:00
// writeln appends the string `s`, and then a newline character.
[inline]
2020-05-17 13:51:18 +02:00
pub fn (mut b Builder) writeln(s string) {
2019-12-19 22:29:37 +01:00
// for c in s {
// b.buf << c
// }
unsafe { b.buf.push_many(s.str, s.len) }
2019-12-19 22:29:37 +01:00
// b.buf << []byte(s) // TODO
b.buf << byte(`\n`)
2019-06-22 20:20:28 +02:00
b.len += s.len + 1
}
2020-03-21 07:01:06 +01:00
// buf == 'hello world'
// last_n(5) returns 'world'
2020-03-21 07:04:53 +01:00
pub fn (b &Builder) last_n(n int) string {
2020-03-21 07:01:06 +01:00
if n > b.len {
return ''
}
2021-05-07 18:41:27 +02:00
return b.buf[b.len - n..].bytestr()
2020-03-21 07:01:06 +01:00
}
// buf == 'hello world'
// after(6) returns 'world'
2020-03-21 07:04:53 +01:00
pub fn (b &Builder) after(n int) string {
2020-03-21 07:01:06 +01:00
if n >= b.len {
return ''
}
2021-05-07 18:41:27 +02:00
return b.buf[n..].bytestr()
2020-03-21 07:01:06 +01:00
}
// str returns a copy of all of the accumulated buffer content.
// NB: after a call to b.str(), the builder b should not be
// used again, you need to call b.free() first, or just leave
// it to be freed by -autofree when it goes out of scope.
// The returned string *owns* its own separate copy of the
// accumulated data that was in the string builder, before the
// .str() call.
2020-05-17 13:51:18 +02:00
pub fn (mut b Builder) str() string {
b.buf << byte(0)
bcopy := unsafe { &byte(memdup(b.buf.data, b.buf.len)) }
s := unsafe { bcopy.vstring_with_len(b.len) }
b.len = 0
b.buf.trim(0)
return s
2019-06-22 20:20:28 +02:00
}
// free - manually free the contents of the buffer
[unsafe]
2020-05-17 13:51:18 +02:00
pub fn (mut b Builder) free() {
unsafe { free(b.buf.data) }
b.len = 0
2019-06-24 22:34:21 +02:00
}