Files
swift-nio/dev/generate-bytebuffer-multi-int.sh
Aditya Singh 9ebe69d269 Add get/setMultipleIntegers on ByteBuffer (#3606)
`ByteBuffer` exposes `read`, `write`, and (since the peek work landed)
`peek`
variants of `MultipleIntegers`, but not the absolute-index `get`/`set`
pair that
every other integer accessor on `ByteBuffer` has. This fills that gap,
which is
what #2736 originally asked for.

The thread on #2736 settled on adding `peek*` first so that the common
"look without consuming" use case has a non-mutating, index-free
spelling, and
that is now in place. `get`/`set` remain useful for the niche cases that
genuinely need to address an arbitrary index, so this completes the set
of four
for `MultipleIntegers` to match `getInteger`/`setInteger`.

Both methods are generated from `dev/generate-bytebuffer-multi-int.sh`,
the same
script that produces the read/write/peek variants, so they stay in
lockstep with
the rest of the file across all arities (2 through 15):

- `getMultipleIntegers(at:endianness:as:)` reads at an explicit index
without
moving the reader index and returns `nil` when the requested bytes are
not
  readable, exactly like `getInteger(at:)`.
- `setMultipleIntegers(_:at:endianness:as:)` writes at an explicit index
without
moving the writer index and returns the number of bytes written, exactly
like
  `setInteger(_:at:)`.

The new tests mirror the existing read/write and peek tests: a
round-trip across
both endiannesses, a check that the bytes written by `set` are
byte-for-byte
identical to `writeMultipleIntegers`, coverage of every arity, a check
that
neither method moves the reader or writer index, and the out-of-bounds /
before-reader-index cases that must return `nil`.

Resolves #2736
2026-05-29 12:30:55 +00:00

249 lines
7.7 KiB
Bash
Executable File

#!/bin/bash
##===----------------------------------------------------------------------===##
##
## This source file is part of the SwiftNIO open source project
##
## Copyright (c) 2021 Apple Inc. and the SwiftNIO project authors
## Licensed under Apache License v2.0
##
## See LICENSE.txt for license information
## See CONTRIBUTORS.txt for the list of SwiftNIO project authors
##
## SPDX-License-Identifier: Apache-2.0
##
##===----------------------------------------------------------------------===##
set -eu
here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
function gen() {
how_many=$1
# READ
echo " @inlinable"
echo " @_alwaysEmitIntoClient"
echo -n " public mutating func readMultipleIntegers<T1: FixedWidthInteger"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n: FixedWidthInteger"
done
echo -n ">("
echo -n "endianness: Endianness = .big, as: (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo -n ").Type = (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo -n ").self) -> (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo ")? {"
echo " guard let result = self.getMultipleIntegers(at: self.readerIndex, endianness: endianness, as: \`as\`) else {"
echo " return nil"
echo " }"
echo " var bytesRequired: Int = MemoryLayout<T1>.size"
for n in $(seq 2 "$how_many"); do
echo " bytesRequired &+= MemoryLayout<T$n>.size"
done
echo " self._moveReaderIndex(forwardBy: bytesRequired)"
echo " return result"
echo " }"
echo
# PEEK
echo " @inlinable"
echo " @_alwaysEmitIntoClient"
echo -n " public func peekMultipleIntegers<T1: FixedWidthInteger"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n: FixedWidthInteger"
done
echo -n ">("
echo -n "endianness: Endianness = .big, as: (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo -n ").Type = (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo -n ").self) -> (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo ")? {"
echo " self.getMultipleIntegers(at: self.readerIndex, endianness: endianness, as: \`as\`)"
echo " }"
echo
# GET
echo " @inlinable"
echo " @_alwaysEmitIntoClient"
echo -n " public func getMultipleIntegers<T1: FixedWidthInteger"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n: FixedWidthInteger"
done
echo -n ">("
echo -n "at index: Int, endianness: Endianness = .big, as: (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo -n ").Type = (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo -n ").self) -> (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo ")? {"
echo " var bytesRequired: Int = MemoryLayout<T1>.size"
for n in $(seq 2 "$how_many"); do
echo " bytesRequired &+= MemoryLayout<T$n>.size"
done
echo
echo " guard let range = self.rangeWithinReadableBytes(index: index, length: bytesRequired) else {"
echo " return nil"
echo " }"
echo
for n in $(seq 1 "$how_many"); do
echo " var v$n: T$n = 0"
done
echo " var offset = range.lowerBound"
echo " self.withUnsafeReadableBytes { ptr in"
echo " assert(ptr.count >= range.lowerBound + bytesRequired)"
echo " let basePtr = ptr.baseAddress! // safe, ptr is non-empty"
for n in $(seq 1 "$how_many"); do
echo " withUnsafeMutableBytes(of: &v$n) { destPtr in"
echo " destPtr.baseAddress!.copyMemory(from: basePtr + offset, byteCount: MemoryLayout<T$n>.size)"
echo " }"
echo " offset = offset &+ MemoryLayout<T$n>.size"
done
echo " assert(offset == range.upperBound)"
echo " }"
echo " switch endianness {"
for endianness in big little; do
echo " case .$endianness:"
echo -n " return (T1(${endianness}Endian: v1)"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n(${endianness}Endian: v$n)"
done
echo ")"
done
echo " }"
echo " }"
echo
# WRITE
echo " @inlinable"
echo " @_alwaysEmitIntoClient"
echo " @discardableResult"
echo -n " public mutating func writeMultipleIntegers<T1: FixedWidthInteger"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n: FixedWidthInteger"
done
echo -n ">(_ value1: T1"
for n in $(seq 2 "$how_many"); do
echo -n ", _ value$n: T$n"
done
echo -n ", endianness: Endianness = .big, as: (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo -n ").Type = (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo ").self) -> Int {"
echo -n " let bytesWritten = self.setMultipleIntegers(value1"
for n in $(seq 2 "$how_many"); do
echo -n ", value$n"
done
echo ", at: self.writerIndex, endianness: endianness, as: \`as\`)"
echo " self._moveWriterIndex(forwardBy: bytesWritten)"
echo " return bytesWritten"
echo " }"
echo
# SET
echo " @inlinable"
echo " @_alwaysEmitIntoClient"
echo " @discardableResult"
echo -n " public mutating func setMultipleIntegers<T1: FixedWidthInteger"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n: FixedWidthInteger"
done
echo -n ">(_ value1: T1"
for n in $(seq 2 "$how_many"); do
echo -n ", _ value$n: T$n"
done
echo -n ", at index: Int, endianness: Endianness = .big, as: (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo -n ").Type = (T1"
for n in $(seq 2 "$how_many"); do
echo -n ", T$n"
done
echo ").self) -> Int {"
for n in $(seq 1 "$how_many"); do
echo " var v$n: T$n"
done
echo " switch endianness {"
for endianness in .big .little; do
echo " case $endianness:"
for n in $(seq 1 "$how_many"); do
echo " v$n = value$n${endianness}Endian"
done
done
echo " }"
echo
echo " var offset = index"
echo " var bytesWritten = 0"
for n in $(seq 1 "$how_many"); do
echo " bytesWritten &+= Swift.withUnsafeBytes(of: &v$n) { self.setBytes(\$0, at: offset) }"
echo " offset = offset &+ MemoryLayout<T$n>.size"
done
echo " return bytesWritten"
echo " }"
echo
}
grep -q "ByteBuffer" "${BASH_SOURCE[0]}" || {
echo >&2 "ERROR: ${BASH_SOURCE[0]}: file or directory not found (this should be this script)"
exit 1
}
{
cat <<"EOF"
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2021 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
/// NOTE: THIS FILE IS AUTO-GENERATED BY dev/generate-bytebuffer-multi-int.sh
EOF
echo
echo "extension ByteBuffer {"
# note:
# - widening the inverval below (eg. going from {2..15} to {2..25}) is Semver minor
# - narrowing the interval below is SemVer _MAJOR_!
for n in {2..15}; do
gen "$n"
done
echo "}"
} > "$here/../Sources/NIOCore/ByteBuffer-multi-int.swift"