// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using System.Buffers; using System.Diagnostics; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; // ReSharper disable once CheckNamespace namespace System.Text; internal ref struct ValueStringBuilder { private char[]? _arrayToReturnToPool; private Span _chars; private int _pos; public ValueStringBuilder(Span initialBuffer) { _arrayToReturnToPool = null; _chars = initialBuffer; _pos = 0; } public ValueStringBuilder(int initialCapacity) { _arrayToReturnToPool = ArrayPool.Shared.Rent(initialCapacity); _chars = _arrayToReturnToPool; _pos = 0; } public int Length { get => _pos; set { Debug.Assert(value >= 0); Debug.Assert(value <= _chars.Length); _pos = value; } } public int Capacity => _chars.Length; public void EnsureCapacity(int capacity) { // This is not expected to be called this with negative capacity Debug.Assert(capacity >= 0); // If the caller has a bug and calls this with negative capacity, make sure to call Grow to throw an exception. if ((uint) capacity > (uint) _chars.Length) Grow(capacity - _pos); } /// /// Get a pinnable reference to the builder. /// Does not ensure there is a null char after /// This overload is pattern matched in the C# 7.3+ compiler so you can omit /// the explicit method call, and write eg "fixed (char* c = builder)" /// public ref char GetPinnableReference() { return ref MemoryMarshal.GetReference(_chars); } /// /// Get a pinnable reference to the builder. /// /// Ensures that the builder has a null char after public ref char GetPinnableReference(bool terminate) { if (terminate) { EnsureCapacity(Length + 1); _chars[Length] = '\0'; } return ref MemoryMarshal.GetReference(_chars); } public ref char this[int index] { get { Debug.Assert(index < _pos); return ref _chars[index]; } } public override string ToString() { string s = _chars.Slice(0, _pos).ToString(); Dispose(); return s; } /// Returns the underlying storage of the builder. public Span RawChars => _chars; /// /// Returns a span around the contents of the builder. /// /// Ensures that the builder has a null char after public ReadOnlySpan AsSpan(bool terminate) { if (terminate) { EnsureCapacity(Length + 1); _chars[Length] = '\0'; } return _chars.Slice(0, _pos); } public ReadOnlySpan AsSpan() => _chars.Slice(0, _pos); public ReadOnlySpan AsSpan(int start) => _chars.Slice(start, _pos - start); public ReadOnlySpan AsSpan(int start, int length) => _chars.Slice(start, length); public void Reverse() { _chars.Slice(0, _pos).Reverse(); } public bool TryCopyTo(Span destination, out int charsWritten) { if (_chars.Slice(0, _pos).TryCopyTo(destination)) { charsWritten = _pos; Dispose(); return true; } else { charsWritten = 0; Dispose(); return false; } } public void Insert(int index, char value, int count) { if (_pos > _chars.Length - count) { Grow(count); } int remaining = _pos - index; _chars.Slice(index, remaining).CopyTo(_chars.Slice(index + count)); _chars.Slice(index, count).Fill(value); _pos += count; } public void Insert(int index, string? s) { if (s == null) { return; } int count = s.Length; if (_pos > (_chars.Length - count)) { Grow(count); } int remaining = _pos - index; _chars.Slice(index, remaining).CopyTo(_chars.Slice(index + count)); s #if !NETCOREAPP .AsSpan() #endif .CopyTo(_chars.Slice(index)); _pos += count; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Append(char c) { int pos = _pos; Span chars = _chars; if ((uint) pos < (uint) chars.Length) { chars[pos] = c; _pos = pos + 1; } else { GrowAndAppend(c); } } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void AppendHex(byte b) { const string Map = "0123456789ABCDEF"; ReadOnlySpan data = [ Map[b / 16], Map[b % 16] ]; Append(data); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Append(string? s) { if (s == null) { return; } int pos = _pos; if (s.Length == 1 && (uint) pos < (uint) _chars.Length) // very common case, e.g. appending strings from NumberFormatInfo like separators, percent symbols, etc. { _chars[pos] = s[0]; _pos = pos + 1; } else { AppendSlow(s); } } #if NET6_0_OR_GREATER [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Append(T value) where T : ISpanFormattable { if (value.TryFormat(_chars.Slice(_pos), out var charsWritten, format: default, provider: null)) { _pos += charsWritten; } else { Append(value.ToString()); } } #else [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Append(int value) { Append(value.ToString(System.Globalization.CultureInfo.InvariantCulture)); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Append(long value) { Append(value.ToString(System.Globalization.CultureInfo.InvariantCulture)); } #endif private void AppendSlow(string s) { int pos = _pos; if (pos > _chars.Length - s.Length) { Grow(s.Length); } s #if !NETCOREAPP .AsSpan() #endif .CopyTo(_chars.Slice(pos)); _pos += s.Length; } public void Append(char c, int count) { if (_pos > _chars.Length - count) { Grow(count); } Span dst = _chars.Slice(_pos, count); for (int i = 0; i < dst.Length; i++) { dst[i] = c; } _pos += count; } public unsafe void Append(char* value, int length) { int pos = _pos; if (pos > _chars.Length - length) { Grow(length); } Span dst = _chars.Slice(_pos, length); for (int i = 0; i < dst.Length; i++) { dst[i] = *value++; } _pos += length; } public void Append(scoped ReadOnlySpan value) { int pos = _pos; if (pos > _chars.Length - value.Length) { Grow(value.Length); } value.CopyTo(_chars.Slice(_pos)); _pos += value.Length; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public Span AppendSpan(int length) { int origPos = _pos; if (origPos > _chars.Length - length) { Grow(length); } _pos = origPos + length; return _chars.Slice(origPos, length); } [MethodImpl(MethodImplOptions.NoInlining)] private void GrowAndAppend(char c) { Grow(1); Append(c); } /// /// Resize the internal buffer either by doubling current buffer size or /// by adding to /// whichever is greater. /// /// /// Number of chars requested beyond current position. /// [MethodImpl(MethodImplOptions.NoInlining)] private void Grow(int additionalCapacityBeyondPos) { Debug.Assert(additionalCapacityBeyondPos > 0); Debug.Assert(_pos > _chars.Length - additionalCapacityBeyondPos, "Grow called incorrectly, no resize is needed."); const uint ArrayMaxLength = 0x7FFFFFC7; // same as Array.MaxLength // Increase to at least the required size (_pos + additionalCapacityBeyondPos), but try // to double the size if possible, bounding the doubling to not go beyond the max array length. int newCapacity = (int) Math.Max( (uint) (_pos + additionalCapacityBeyondPos), Math.Min((uint) _chars.Length * 2, ArrayMaxLength)); // Make sure to let Rent throw an exception if the caller has a bug and the desired capacity is negative. // This could also go negative if the actual required length wraps around. char[] poolArray = ArrayPool.Shared.Rent(newCapacity); _chars.Slice(0, _pos).CopyTo(poolArray); char[]? toReturn = _arrayToReturnToPool; _chars = _arrayToReturnToPool = poolArray; if (toReturn != null) { ArrayPool.Shared.Return(toReturn); } } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Dispose() { char[]? toReturn = _arrayToReturnToPool; this = default; // for safety, to avoid using pooled array if this instance is erroneously appended to again if (toReturn != null) { ArrayPool.Shared.Return(toReturn); } } }