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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
/* Copyright 2018 Mozilla Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use crate::{BinaryReader, BinaryReaderError, Result, SectionIterator, SectionReader};
use std::ops::Range;

/// Represents a name for an index from the names section.
#[derive(Debug, Copy, Clone)]
pub struct Naming<'a> {
    /// The index being named.
    pub index: u32,
    /// The name for the index.
    pub name: &'a str,
}

/// Represents the type of name.
#[derive(Debug, Copy, Clone)]
pub enum NameType {
    /// The name is for a module.
    Module,
    /// The name is for a function.
    Function,
    /// The name is for a local.
    Local,
    /// The name is for a label.
    Label,
    /// The name is for a type.
    Type,
    /// The name is for a table.
    Table,
    /// The name is for a memory.
    Memory,
    /// The name is for a global.
    Global,
    /// The name is for an element segment.
    Element,
    /// The name is for a data segment.
    Data,
    /// The name is unknown.
    ///
    /// The value is the unknown section identifier.
    Unknown(u8),
}

/// Represents a single name in the names custom section.
#[derive(Debug, Copy, Clone)]
pub struct SingleName<'a> {
    data: &'a [u8],
    offset: usize,
}

impl<'a> SingleName<'a> {
    /// Gets the name as a string.
    pub fn get_name<'b>(&self) -> Result<&'b str>
    where
        'a: 'b,
    {
        let mut reader = BinaryReader::new_with_offset(self.data, self.offset);
        reader.read_string()
    }

    /// Gets the original position of the name.
    pub fn original_position(&self) -> usize {
        self.offset
    }
}

/// A reader for direct names in the names custom section.
pub struct NamingReader<'a> {
    reader: BinaryReader<'a>,
    count: u32,
}

impl<'a> NamingReader<'a> {
    fn new(data: &'a [u8], offset: usize) -> Result<NamingReader<'a>> {
        let mut reader = BinaryReader::new_with_offset(data, offset);
        let count = reader.read_var_u32()?;
        Ok(NamingReader { reader, count })
    }

    fn skip(reader: &mut BinaryReader) -> Result<()> {
        let count = reader.read_var_u32()?;
        for _ in 0..count {
            reader.read_var_u32()?;
            reader.skip_string()?;
        }
        Ok(())
    }

    /// Gets the original position of the reader.
    pub fn original_position(&self) -> usize {
        self.reader.original_position()
    }

    /// Gets the count of items in the section.
    pub fn get_count(&self) -> u32 {
        self.count
    }

    /// Reads a name from the names custom section.
    pub fn read<'b>(&mut self) -> Result<Naming<'b>>
    where
        'a: 'b,
    {
        let index = self.reader.read_var_u32()?;
        let name = self.reader.read_string()?;
        Ok(Naming { index, name })
    }
}

/// Represents a name map from the names custom section.
#[derive(Debug, Copy, Clone)]
pub struct NameMap<'a> {
    data: &'a [u8],
    offset: usize,
}

impl<'a> NameMap<'a> {
    /// Gets a naming reader for the map.
    pub fn get_map<'b>(&self) -> Result<NamingReader<'b>>
    where
        'a: 'b,
    {
        NamingReader::new(self.data, self.offset)
    }

    /// Gets the original position of the map.
    pub fn original_position(&self) -> usize {
        self.offset
    }
}

/// Represents an indirect name in the names custom section.
#[derive(Debug, Copy, Clone)]
pub struct IndirectNaming<'a> {
    /// The indirect index of the name.
    pub indirect_index: u32,
    data: &'a [u8],
    offset: usize,
}

impl<'a> IndirectNaming<'a> {
    /// Gets the naming reader for the indirect name.
    pub fn get_map<'b>(&self) -> Result<NamingReader<'b>>
    where
        'a: 'b,
    {
        NamingReader::new(self.data, self.offset)
    }

    /// Gets the original position of the indirect name.
    pub fn original_position(&self) -> usize {
        self.offset
    }
}

/// Represents a reader for indirect names from the names custom section.
pub struct IndirectNamingReader<'a> {
    reader: BinaryReader<'a>,
    count: u32,
}

impl<'a> IndirectNamingReader<'a> {
    fn new(data: &'a [u8], offset: usize) -> Result<IndirectNamingReader<'a>> {
        let mut reader = BinaryReader::new_with_offset(data, offset);
        let count = reader.read_var_u32()?;
        Ok(IndirectNamingReader { reader, count })
    }

    /// Gets the count of indirect names.
    pub fn get_indirect_count(&self) -> u32 {
        self.count
    }

    /// Gets the original position of the reader.
    pub fn original_position(&self) -> usize {
        self.reader.original_position()
    }

    /// Reads an indirect name from the reader.
    pub fn read<'b>(&mut self) -> Result<IndirectNaming<'b>>
    where
        'a: 'b,
    {
        let index = self.reader.read_var_u32()?;
        let start = self.reader.position;
        NamingReader::skip(&mut self.reader)?;
        let end = self.reader.position;
        Ok(IndirectNaming {
            indirect_index: index,
            data: &self.reader.buffer[start..end],
            offset: self.reader.original_offset + start,
        })
    }
}

/// Represents an indirect name map.
#[derive(Debug, Copy, Clone)]
pub struct IndirectNameMap<'a> {
    data: &'a [u8],
    offset: usize,
}

impl<'a> IndirectNameMap<'a> {
    /// Gets an indirect naming reader for the map.
    pub fn get_indirect_map<'b>(&self) -> Result<IndirectNamingReader<'b>>
    where
        'a: 'b,
    {
        IndirectNamingReader::new(self.data, self.offset)
    }

    /// Gets an original position of the map.
    pub fn original_position(&self) -> usize {
        self.offset
    }
}

/// Represents a name read from the names custom section.
#[derive(Debug, Clone)]
pub enum Name<'a> {
    /// The name is for the module.
    Module(SingleName<'a>),
    /// The name is for the functions.
    Function(NameMap<'a>),
    /// The name is for the function locals.
    Local(IndirectNameMap<'a>),
    /// The name is for the function labels.
    Label(IndirectNameMap<'a>),
    /// The name is for the types.
    Type(NameMap<'a>),
    /// The name is for the tables.
    Table(NameMap<'a>),
    /// The name is for the memories.
    Memory(NameMap<'a>),
    /// The name is for the globals.
    Global(NameMap<'a>),
    /// The name is for the element segments.
    Element(NameMap<'a>),
    /// The name is for the data segments.
    Data(NameMap<'a>),
    /// An unknown [name subsection](https://webassembly.github.io/spec/core/appendix/custom.html#subsections).
    Unknown {
        /// The identifier for this subsection.
        ty: u8,
        /// The contents of this subsection.
        data: &'a [u8],
        /// The range of bytes, relative to the start of the original data
        /// stream, that the contents of this subsection reside in.
        range: Range<usize>,
    },
}

/// A reader for the name custom section of a WebAssembly module.
pub struct NameSectionReader<'a> {
    reader: BinaryReader<'a>,
}

impl<'a> NameSectionReader<'a> {
    /// Constructs a new `NameSectionReader` from the given data and offset.
    pub fn new(data: &'a [u8], offset: usize) -> Result<NameSectionReader<'a>> {
        Ok(NameSectionReader {
            reader: BinaryReader::new_with_offset(data, offset),
        })
    }

    fn verify_section_end(&self, end: usize) -> Result<()> {
        if self.reader.buffer.len() < end {
            return Err(BinaryReaderError::new(
                "name entry extends past end of the code section",
                self.reader.original_offset + self.reader.buffer.len(),
            ));
        }
        Ok(())
    }

    /// Determines if the reader is at the end of the section.
    pub fn eof(&self) -> bool {
        self.reader.eof()
    }

    /// Gets the original position of the section reader.
    pub fn original_position(&self) -> usize {
        self.reader.original_position()
    }

    /// Reads a name from the section.
    pub fn read<'b>(&mut self) -> Result<Name<'b>>
    where
        'a: 'b,
    {
        let ty = self.reader.read_name_type()?;
        let payload_len = self.reader.read_var_u32()? as usize;
        let payload_start = self.reader.position;
        let payload_end = payload_start + payload_len;
        self.verify_section_end(payload_end)?;
        let offset = self.reader.original_offset + payload_start;
        let data = &self.reader.buffer[payload_start..payload_end];
        self.reader.skip_to(payload_end);
        Ok(match ty {
            NameType::Module => Name::Module(SingleName { data, offset }),
            NameType::Function => Name::Function(NameMap { data, offset }),
            NameType::Local => Name::Local(IndirectNameMap { data, offset }),
            NameType::Label => Name::Label(IndirectNameMap { data, offset }),
            NameType::Type => Name::Type(NameMap { data, offset }),
            NameType::Table => Name::Table(NameMap { data, offset }),
            NameType::Memory => Name::Memory(NameMap { data, offset }),
            NameType::Global => Name::Global(NameMap { data, offset }),
            NameType::Element => Name::Element(NameMap { data, offset }),
            NameType::Data => Name::Data(NameMap { data, offset }),
            NameType::Unknown(ty) => Name::Unknown {
                ty,
                data,
                range: offset..offset + payload_len,
            },
        })
    }
}

impl<'a> SectionReader for NameSectionReader<'a> {
    type Item = Name<'a>;
    fn read(&mut self) -> Result<Self::Item> {
        NameSectionReader::read(self)
    }
    fn eof(&self) -> bool {
        NameSectionReader::eof(self)
    }
    fn original_position(&self) -> usize {
        NameSectionReader::original_position(self)
    }
    fn range(&self) -> Range<usize> {
        self.reader.range()
    }
}

impl<'a> IntoIterator for NameSectionReader<'a> {
    type Item = Result<Name<'a>>;
    type IntoIter = SectionIterator<NameSectionReader<'a>>;

    fn into_iter(self) -> Self::IntoIter {
        SectionIterator::new(self)
    }
}