diff options
| author | Andrew Kelley <andrew@ziglang.org> | 2019-09-19 00:59:04 -0400 |
|---|---|---|
| committer | Andrew Kelley <andrew@ziglang.org> | 2019-09-19 00:59:04 -0400 |
| commit | 380c8ec2c95fa8d732c141c705d9940629eb2012 (patch) | |
| tree | 6f4139367553fea653662d1fb65bd23421bad77a /doc | |
| parent | 76f53960778e84ab49730edb77b85490b07fbea2 (diff) | |
| download | zig-380c8ec2c95fa8d732c141c705d9940629eb2012.tar.gz zig-380c8ec2c95fa8d732c141c705d9940629eb2012.zip | |
implement runtime `@byteSwap` and other fixups
* update docs for `@byteSwap`.
* fix hash & eql functions for ZigLLVMFnIdBswap not updated to
include vector len. this was causing incorrect bswap function
being called in unrelated code
* fix `@byteSwap` behavior tests only testing comptime and not
runtime operations
* implement runtime `@byteSwap`
* fix incorrect logic in ir_render_vector_to_array and
ir_render_array_to_vector with regards to whether or not to bitcast
* `@byteSwap` accepts an array operand which it will cast to vector
* simplify `@byteSwap` semantic analysis code and various fixes
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/langref.html.in | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/langref.html.in b/doc/langref.html.in index 8a303640e6..61fc06fd02 100644 --- a/doc/langref.html.in +++ b/doc/langref.html.in @@ -6542,12 +6542,21 @@ async fn func(y: *i32) void { {#header_close#} {#header_open|@byteSwap#} - <pre>{#syntax#}@byteSwap(comptime T: type, integer: T) T{#endsyntax#}</pre> + <pre>{#syntax#}@byteSwap(comptime T: type, operand: T) T{#endsyntax#}</pre> <p>{#syntax#}T{#endsyntax#} must be an integer type with bit count evenly divisible by 8.</p> + <p>{#syntax#}operand{#endsyntax#} may be an {#link|integer|Integers#} or {#link|vector|Vectors#}.</p> <p> Swaps the byte order of the integer. This converts a big endian integer to a little endian integer, and converts a little endian integer to a big endian integer. </p> + <p> + Note that for the purposes of memory layout with respect to endianness, the integer type should be + related to the number of bytes reported by {#link|@sizeOf#} bytes. This is demonstrated with + {#syntax#}u24{#endsyntax#}. {#syntax#}@sizeOf(u24) == 4{#endsyntax#}, which means that a + {#syntax#}u24{#endsyntax#} stored in memory takes 4 bytes, and those 4 bytes are what are swapped on + a little vs big endian system. On the other hand, if {#syntax#}T{#endsyntax#} is specified to + be {#syntax#}u24{#endsyntax#}, then only 3 bytes are reversed. + </p> {#header_close#} {#header_open|@bitReverse#} |
