status-im/nim-stint
2
0
Fork 0
mirror of https://github.com/status-im/nim-stint.git synced 2025-02-21 11:28:23 +00:00
Code Issues Projects Releases Wiki Activity

BREAKING: Change named param from base to radix in io procs

Browse Source
This commit is contained in:
mratsim 2018-10-08 20:17:39 +02:00 committed by tersec
parent 0f5fd20679
commit 2d6ea71657
2 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
stint/io.nim
View File

@ -106,7 +106,7 @@ func readHexChar(c: char): int8 {.inline.}=
else: else:
raise newException(ValueError, $c & "is not a hexadecimal character") raise newException(ValueError, $c & "is not a hexadecimal character")
func skipPrefixes(current_idx: var int, str: string, base: range[2..16]) {.inline.} = func skipPrefixes(current_idx: var int, str: string, radix: range[2..16]) {.inline.} =
## Returns the index of the first meaningful char in `hexStr` by skipping ## Returns the index of the first meaningful char in `hexStr` by skipping
## "0x" prefix ## "0x" prefix
@ -116,13 +116,13 @@ func skipPrefixes(current_idx: var int, str: string, base: range[2..16]) {.inlin
assert current_idx == 0, "skipPrefixes only works for prefixes (position 0 and 1 of the string)" assert current_idx == 0, "skipPrefixes only works for prefixes (position 0 and 1 of the string)"
if str[0] == '0': if str[0] == '0':
if str[1] in {'x', 'X'}: if str[1] in {'x', 'X'}:
assert base == 16, "Parsing mismatch, 0x prefix is only valid for a hexadecimal number (base 16)" assert radix == 16, "Parsing mismatch, 0x prefix is only valid for a hexadecimal number (base 16)"
current_idx = 2 current_idx = 2
elif str[1] in {'o', 'O'}: elif str[1] in {'o', 'O'}:
assert base == 8, "Parsing mismatch, 0o prefix is only valid for an octal number (base 8)" assert radix == 8, "Parsing mismatch, 0o prefix is only valid for an octal number (base 8)"
current_idx = 2 current_idx = 2
elif str[1] in {'b', 'B'}: elif str[1] in {'b', 'B'}:
assert base == 2, "Parsing mismatch, 0b prefix is only valid for a binary number (base 2)" assert radix == 2, "Parsing mismatch, 0b prefix is only valid for a binary number (base 2)"
current_idx = 2 current_idx = 2
func nextNonBlank(current_idx: var int, s: string) {.inline.} = func nextNonBlank(current_idx: var int, s: string) {.inline.} =
@ -139,38 +139,38 @@ func readDecChar(c: range['0'..'9']): int {.inline.}=
# specialization without branching for base <= 10. # specialization without branching for base <= 10.
ord(c) - ord('0') ord(c) - ord('0')
func parse*[bits: static[int]](input: string, T: typedesc[Stuint[bits]], base: static[uint8] = 10): T = func parse*[bits: static[int]](input: string, T: typedesc[Stuint[bits]], radix: static[uint8] = 10): T =
## Parse a string and store the result in a Stint[bits] or Stuint[bits]. ## Parse a string and store the result in a Stint[bits] or Stuint[bits].
static: assert (base >= 2) and base <= 16, "Only base from 2..16 are supported" static: assert (radix >= 2) and radix <= 16, "Only base from 2..16 are supported"
# TODO: use static[range[2 .. 16]], not supported at the moment (2018-04-26) # TODO: use static[range[2 .. 16]], not supported at the moment (2018-04-26)
# TODO: we can special case hex result/input as an array of bytes # TODO: we can special case hex result/input as an array of bytes
# and be much faster # and be much faster
const radix = base.uint8.stuint(bits) const base = radix.uint8.stuint(bits)
var curr = 0 # Current index in the string var curr = 0 # Current index in the string
skipPrefixes(curr, input, base) skipPrefixes(curr, input, radix)
while curr < input.len: while curr < input.len:
# TODO: overflow detection # TODO: overflow detection
when base <= 10: when radix <= 10:
result = result * radix + input[curr].readDecChar.stuint(bits) result = result * base + input[curr].readDecChar.stuint(bits)
else: else:
result = result * radix + input[curr].readHexChar.stuint(bits) result = result * base + input[curr].readHexChar.stuint(bits)
nextNonBlank(curr, input) nextNonBlank(curr, input)
func parse*[bits: static[int]](input: string, T: typedesc[Stint[bits]], base: static[int8] = 10): T = func parse*[bits: static[int]](input: string, T: typedesc[Stint[bits]], radix: static[int8] = 10): T =
## Parse a string and store the result in a Stint[bits] or Stuint[bits]. ## Parse a string and store the result in a Stint[bits] or Stuint[bits].
static: assert (base >= 2) and base <= 16, "Only base from 2..16 are supported" static: assert (radix >= 2) and radix <= 16, "Only base from 2..16 are supported"
# TODO: use static[range[2 .. 16]], not supported at the moment (2018-04-26) # TODO: use static[range[2 .. 16]], not supported at the moment (2018-04-26)
# TODO: we can special case hex result/input as an array of bytes # TODO: we can special case hex result/input as an array of bytes
# and be much faster # and be much faster
# For conversion we require overflowing operations (for example for negative hex numbers) # For conversion we require overflowing operations (for example for negative hex numbers)
const radix = base.int8.stuint(bits) const base = radix.int8.stuint(bits)
var var
curr = 0 # Current index in the string curr = 0 # Current index in the string
@ -178,18 +178,18 @@ func parse*[bits: static[int]](input: string, T: typedesc[Stint[bits]], base: st
no_overflow: Stuint[bits] no_overflow: Stuint[bits]
if input[curr] == '-': if input[curr] == '-':
assert base == 10, "Negative numbers are only supported with base 10 input." assert radix == 10, "Negative numbers are only supported with base 10 input."
isNeg = true isNeg = true
inc curr inc curr
else: else:
skipPrefixes(curr, input, base) skipPrefixes(curr, input, radix)
while curr < input.len: while curr < input.len:
# TODO: overflow detection # TODO: overflow detection
when base <= 10: when radix <= 10:
no_overflow = no_overflow * radix + input[curr].readDecChar.stuint(bits) no_overflow = no_overflow * base + input[curr].readDecChar.stuint(bits)
else: else:
no_overflow = no_overflow * radix + input[curr].readHexChar.stuint(bits) no_overflow = no_overflow * base + input[curr].readHexChar.stuint(bits)
nextNonBlank(curr, input) nextNonBlank(curr, input)
# TODO: we can't create the lowest int this way # TODO: we can't create the lowest int this way
@ -200,60 +200,60 @@ func parse*[bits: static[int]](input: string, T: typedesc[Stint[bits]], base: st
func fromHex*(T: type StUint, s: string): T {.inline.} = func fromHex*(T: type StUint, s: string): T {.inline.} =
## Convert an hex string to the corresponding unsigned integer ## Convert an hex string to the corresponding unsigned integer
parse(s, type result, base = 16) parse(s, type result, radix = 16)
func hexToUint*[bits: static[int]](hexString: string): Stuint[bits] {.inline.} = func hexToUint*[bits: static[int]](hexString: string): Stuint[bits] {.inline.} =
## Convert an hex string to the corresponding unsigned integer ## Convert an hex string to the corresponding unsigned integer
parse(hexString, type result, base = 16) parse(hexString, type result, radix = 16)
func toString*[bits: static[int]](num: StUint[bits], base: static[uint8] = 10): string = func toString*[bits: static[int]](num: StUint[bits], radix: static[uint8] = 10): string =
## Convert a Stint or Stuint to string. ## Convert a Stint or Stuint to string.
## In case of negative numbers: ## In case of negative numbers:
## - they are prefixed with "-" for base 10. ## - they are prefixed with "-" for base 10.
## - if not base 10, they are returned raw in two-complement form. ## - if not base 10, they are returned raw in two-complement form.
static: assert (base >= 2) and base <= 16, "Only base from 2..16 are supported" static: assert (radix >= 2) and radix <= 16, "Only base from 2..16 are supported"
# TODO: use static[range[2 .. 16]], not supported at the moment (2018-04-26) # TODO: use static[range[2 .. 16]], not supported at the moment (2018-04-26)
const hexChars = "0123456789abcdef" const hexChars = "0123456789abcdef"
const radix = base.uint8.stuint(bits) const base = radix.uint8.stuint(bits)
result = "" result = ""
var (q, r) = divmod(num, radix) var (q, r) = divmod(num, base)
while true: while true:
result.add hexChars[r.toInt] result.add hexChars[r.toInt]
if q.isZero: if q.isZero:
break break
(q, r) = divmod(q, radix) (q, r) = divmod(q, base)
reverse(result) reverse(result)
func toString*[bits: static[int]](num: Stint[bits], base: static[int8] = 10): string = func toString*[bits: static[int]](num: Stint[bits], radix: static[int8] = 10): string =
## Convert a Stint or Stuint to string. ## Convert a Stint or Stuint to string.
## In case of negative numbers: ## In case of negative numbers:
## - they are prefixed with "-" for base 10. ## - they are prefixed with "-" for base 10.
## - if not base 10, they are returned raw in two-complement form. ## - if not base 10, they are returned raw in two-complement form.
static: assert (base >= 2) and base <= 16, "Only base from 2..16 are supported" static: assert (radix >= 2) and radix <= 16, "Only base from 2..16 are supported"
# TODO: use static[range[2 .. 16]], not supported at the moment (2018-04-26) # TODO: use static[range[2 .. 16]], not supported at the moment (2018-04-26)
const hexChars = "0123456789abcdef" const hexChars = "0123456789abcdef"
const radix = base.int8.stint(bits) const base = radix.int8.stint(bits)
result = "" result = ""
let isNeg = num.isNegative let isNeg = num.isNegative
let num = if base == 10 and isNeg: -num let num = if radix == 10 and isNeg: -num
else: num else: num
var (q, r) = divmod(num, radix) var (q, r) = divmod(num, base)
while true: while true:
result.add hexChars[r.toInt] result.add hexChars[r.toInt]
if q.isZero: if q.isZero:
break break
(q, r) = divmod(q, radix) (q, r) = divmod(q, base)
if isNeg: if isNeg:
result.add '-' result.add '-'

6
tests/test_io.nim
View File

@ -34,14 +34,14 @@ suite "Testing input and output procedures":
test "Creation from hex strings": test "Creation from hex strings":
block: block:
let a = "0xFF".parse(Stint[64], base = 16) let a = "0xFF".parse(Stint[64], radix = 16)
let b = 255.stint(64) let b = 255.stint(64)
check: a == b check: a == b
check: 255'i64 == cast[int64](a) check: 255'i64 == cast[int64](a)
block: block:
let a = "0xFF".parse(Stuint[64], base = 16) let a = "0xFF".parse(Stuint[64], radix = 16)
let b = 255.stuint(64) let b = 255.stuint(64)
check: a == b check: a == b
@ -158,7 +158,7 @@ suite "Testing conversion functions: Hex, Bytes, Endianness using secp256k1 curv
x.to(Int128).bits == 128 x.to(Int128).bits == 128
test "hex -> uint256": test "hex -> uint256":
check: SECPK1_N_HEX.parse(Stuint[256], base = 16) == SECPK1_N check: SECPK1_N_HEX.parse(Stuint[256], radix = 16) == SECPK1_N
test "uint256 -> hex": test "uint256 -> hex":
check: SECPK1_N.dumpHex == SECPK1_N_HEX check: SECPK1_N.dumpHex == SECPK1_N_HEX