aboutsummaryrefslogtreecommitdiff
path: root/libgrust/libproc_macro/literal.rs
blob: a22839342d97d63bd2f10e73c9bf1f02e85b7285 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
// Copyright (C) 2023-2024 Free Software Foundation, Inc.
//
// This file is part of the GNU Proc Macro Library.  This library is free
// software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the
// Free Software Foundation; either version 3, or (at your option)
// any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.

// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
// <http://www.gnu.org/licenses/>.

use bridge;
use std::fmt;
use std::str::FromStr;
use LexError;
use Span;

/// A type representing a literal value except `true` and `false`.
///
/// This could be one of the following:
/// * literal string (`"hello"`)
/// * byte string (`b"hello"`)
/// * character (`'a'`)
/// * byte character (`b'a'`)
/// * unsuffixed integer (`42`)
/// * suffixed integer (`42u8`)
/// * unsuffixed floating point number (`1.618`)
/// * suffixed floating point number (`1.618f32`)
///
/// # Note
///
/// Boolean literals like `true` and `false` are `Ident`s and do not belong
/// here.
#[derive(Clone)]
pub struct Literal(pub(crate) bridge::literal::Literal);

impl Literal {
    // TODO: Add experimental API functions for this type
    // TODO: Generate those constructor with 1/2 macros instead

    pub fn u8_suffixed(n: u8) -> Self {
        Literal(bridge::literal::Literal::u8_suffixed(n))
    }

    pub fn u16_suffixed(n: u16) -> Self {
        Literal(bridge::literal::Literal::u16_suffixed(n))
    }

    pub fn u32_suffixed(n: u32) -> Self {
        Literal(bridge::literal::Literal::u32_suffixed(n))
    }

    pub fn u64_suffixed(n: u64) -> Self {
        Literal(bridge::literal::Literal::u64_suffixed(n))
    }

    pub fn u128_suffixed(n: u128) -> Self {
        Literal(bridge::literal::Literal::u128_suffixed(n))
    }

    pub fn usize_suffixed(n: usize) -> Self {
        Literal(bridge::literal::Literal::usize_suffixed(n))
    }

    pub fn i8_suffixed(n: i8) -> Self {
        Literal(bridge::literal::Literal::i8_suffixed(n))
    }

    pub fn i16_suffixed(n: i16) -> Self {
        Literal(bridge::literal::Literal::i16_suffixed(n))
    }

    pub fn i32_suffixed(n: i32) -> Self {
        Literal(bridge::literal::Literal::i32_suffixed(n))
    }

    pub fn i64_suffixed(n: i64) -> Self {
        Literal(bridge::literal::Literal::i64_suffixed(n))
    }

    pub fn i128_suffixed(n: i128) -> Self {
        Literal(bridge::literal::Literal::i128_suffixed(n))
    }

    pub fn isize_suffixed(n: isize) -> Self {
        Literal(bridge::literal::Literal::isize_suffixed(n))
    }

    // Unsuffixed

    pub fn u8_unsuffixed(n: u8) -> Self {
        Literal(bridge::literal::Literal::u8_unsuffixed(n))
    }

    pub fn u16_unsuffixed(n: u16) -> Self {
        Literal(bridge::literal::Literal::u16_unsuffixed(n))
    }

    pub fn u32_unsuffixed(n: u32) -> Self {
        Literal(bridge::literal::Literal::u32_unsuffixed(n))
    }

    pub fn u64_unsuffixed(n: u64) -> Self {
        Literal(bridge::literal::Literal::u64_unsuffixed(n))
    }

    pub fn u128_unsuffixed(n: u128) -> Self {
        Literal(bridge::literal::Literal::u128_unsuffixed(n))
    }

    pub fn usize_unsuffixed(n: usize) -> Self {
        Literal(bridge::literal::Literal::usize_unsuffixed(n))
    }

    pub fn i8_unsuffixed(n: i8) -> Self {
        Literal(bridge::literal::Literal::i8_unsuffixed(n))
    }

    pub fn i16_unsuffixed(n: i16) -> Self {
        Literal(bridge::literal::Literal::i16_unsuffixed(n))
    }

    pub fn i32_unsuffixed(n: i32) -> Self {
        Literal(bridge::literal::Literal::i32_unsuffixed(n))
    }

    pub fn i64_unsuffixed(n: i64) -> Self {
        Literal(bridge::literal::Literal::i64_unsuffixed(n))
    }

    pub fn i128_unsuffixed(n: i128) -> Self {
        Literal(bridge::literal::Literal::i128_unsuffixed(n))
    }

    pub fn isize_unsuffixed(n: isize) -> Self {
        Literal(bridge::literal::Literal::isize_unsuffixed(n))
    }

    pub fn f32_unsuffixed(n: f32) -> Self {
        Literal(bridge::literal::Literal::f32_unsuffixed(n))
    }

    pub fn f32_suffixed(n: f32) -> Self {
        Literal(bridge::literal::Literal::f32_suffixed(n))
    }

    pub fn f64_unsuffixed(n: f64) -> Self {
        Literal(bridge::literal::Literal::f64_unsuffixed(n))
    }

    pub fn f64_suffixed(n: f64) -> Self {
        Literal(bridge::literal::Literal::f64_suffixed(n))
    }

    pub fn string(string: &str) -> Self {
        Literal(bridge::literal::Literal::string(string))
    }

    pub fn character(c: char) -> Self {
        Literal(bridge::literal::Literal::character(c))
    }

    pub fn byte_string(bytes: &[u8]) -> Self {
        Literal(bridge::literal::Literal::byte_string(bytes))
    }

    /// Get the [`Span`] for this literal.
    pub fn span(&self) -> Span {
        Span(self.0.span())
    }

    /// Set the span for this literal.
    ///
    /// # Arguments
    ///
    /// * `span` - The new span value.
    pub fn set_span(&mut self, span: Span) {
        self.0.set_span(span.0);
    }
}

impl fmt::Debug for Literal {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl fmt::Display for Literal {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl FromStr for Literal {
    type Err = LexError;

    fn from_str(src: &str) -> Result<Self, LexError> {
        bridge::literal::Literal::from_str(src).map(Literal)
    }
}