qubit_codec_misc/
c_integer_literal_codec.rs

1// =============================================================================
2//    Copyright (c) 2026 Haixing Hu.
3//
4//    SPDX-License-Identifier: Apache-2.0
5//
6//    Licensed under the Apache License, Version 2.0.
7// =============================================================================
8//! C integer literal decoder.
9
10use qubit_codec::ValueDecoder;
11
12use crate::MiscCodecError;
13use crate::MiscCodecResult;
14use crate::internal::LiteralComponents;
15
16/// Decodes restricted non-negative C integer literal fragments.
17///
18/// This codec accepts decimal literals such as `123`, octal literals such as
19/// `0123`, and hexadecimal literals such as `0x123` or `0X123`. It trims
20/// surrounding whitespace and returns a `u64`. It intentionally accepts only
21/// a complete unsigned token: signs, integer suffixes, digit separators, and
22/// token-stream boundaries are outside this codec's contract.
23#[must_use]
24#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
25pub struct CIntegerLiteralCodec;
26
27impl CIntegerLiteralCodec {
28    /// Creates a C integer literal codec.
29    ///
30    /// # Returns
31    /// A stateless C integer literal codec.
32    #[inline]
33    pub fn new() -> Self {
34        Self
35    }
36
37    /// Decodes a C integer literal into a `u64`.
38    ///
39    /// # Parameters
40    /// - `text`: C integer literal text.
41    ///
42    /// # Returns
43    /// Parsed integer value.
44    ///
45    /// # Errors
46    /// Returns [`MiscCodecError::InvalidInput`] when the input is empty, lacks
47    /// digits, or overflows `u64`; returns [`MiscCodecError::InvalidDigit`]
48    /// when a character is not valid for the detected radix.
49    #[inline]
50    pub fn decode(&self, text: &str) -> MiscCodecResult<u64> {
51        let (trimmed, trim_offset) = trim_with_offset(text);
52        if trimmed.is_empty() {
53            return Err(invalid_c_integer_input("expected at least one digit"));
54        }
55        let components = LiteralComponents::parse(trimmed, trim_offset)?;
56        validate_digits(components)?;
57        u64::from_str_radix(components.digits, components.radix)
58            .map_err(|error| invalid_c_integer_input(&format!("integer literal is out of range: {error}")))
59    }
60}
61
62impl ValueDecoder<str> for CIntegerLiteralCodec {
63    type Error = MiscCodecError;
64    type Output = u64;
65
66    /// Decodes a C integer literal into a `u64`.
67    #[inline]
68    fn decode(&mut self, input: &str) -> Result<Self::Output, Self::Error> {
69        CIntegerLiteralCodec::decode(self, input)
70    }
71}
72
73/// Trims surrounding whitespace while preserving the start byte offset.
74///
75/// # Parameters
76/// - `text`: Input text.
77///
78/// # Returns
79/// Trimmed text and the byte offset where it starts in `text`.
80#[inline]
81fn trim_with_offset(text: &str) -> (&str, usize) {
82    let trimmed_start = text.trim_start();
83    let start = text.len() - trimmed_start.len();
84    (trimmed_start.trim_end(), start)
85}
86
87/// Validates that every character is valid for the detected radix.
88///
89/// # Parameters
90/// - `components`: Parsed literal components.
91///
92/// # Errors
93/// Returns [`MiscCodecError::InvalidDigit`] with the original input byte index
94/// of the invalid character.
95fn validate_digits(components: LiteralComponents<'_>) -> MiscCodecResult<()> {
96    for (index, character) in components.digits.char_indices() {
97        if character.is_digit(components.radix) {
98            continue;
99        }
100        return Err(MiscCodecError::InvalidDigit {
101            radix: components.radix,
102            index: components.digits_offset + index,
103            character,
104        });
105    }
106    Ok(())
107}
108
109/// Builds an invalid C integer literal input error.
110///
111/// # Parameters
112/// - `reason`: Human-readable reason the input was rejected.
113///
114/// # Returns
115/// An invalid input error for the C integer literal codec.
116fn invalid_c_integer_input(reason: &str) -> MiscCodecError {
117    MiscCodecError::InvalidInput {
118        codec: "c-integer-literal",
119        reason: reason.to_owned(),
120    }
121}
qubit_codec_misc/c_integer_literal_codec.rs

qubit_codec_misc/
c_integer_literal_codec.rs
