# name_section.rs.html -- source
Source to the Rust file `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/parity-wasm-0.40.3/src/elements/name_section.rs`.
Keywords: rust, rustlang, rust-lang

      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
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373

    use crate::rust::{vec::Vec, string::String};
    use crate::io;

    use super::{Deserialize, Error, Module, Serialize, VarUint32, VarUint7, Type};
    use super::index_map::IndexMap;

    const NAME_TYPE_MODULE: u8 = 0;
    const NAME_TYPE_FUNCTION: u8 = 1;
    const NAME_TYPE_LOCAL: u8 = 2;

    /// Debug name information.
    #[derive(Clone, Debug, PartialEq)]
    pub struct NameSection {
    	/// Module name subsection.
    	module: Option<ModuleNameSubsection>,

    	/// Function name subsection.
    	functions: Option<FunctionNameSubsection>,

    	/// Local name subsection.
    	locals: Option<LocalNameSubsection>,
    }

    impl NameSection {
    	/// Creates a new name section.
    	pub fn new(module: Option<ModuleNameSubsection>,
                      functions: Option<FunctionNameSubsection>,
                      locals: Option<LocalNameSubsection>) -> Self {
    		Self {
    			module,
    			functions,
    			locals,
    		}
    	}

    	/// Module name subsection of this section.
    	pub fn module(&self) -> Option<&ModuleNameSubsection> {
    		self.module.as_ref()
    	}

    	/// Module name subsection of this section (mutable).
    	pub fn module_mut(&mut self) -> &mut Option<ModuleNameSubsection> {
    		&mut self.module
    	}

    	/// Functions name subsection of this section.
    	pub fn functions(&self) -> Option<&FunctionNameSubsection> {
    		self.functions.as_ref()
    	}

    	/// Functions name subsection of this section (mutable).
    	pub fn functions_mut(&mut self) -> &mut Option<FunctionNameSubsection> {
    		&mut self.functions
    	}

    	/// Local name subsection of this section.
    	pub fn locals(&self) -> Option<&LocalNameSubsection> {
    		self.locals.as_ref()
    	}

    	/// Local name subsection of this section (mutable).
    	pub fn locals_mut(&mut self) -> &mut Option<LocalNameSubsection> {
    		&mut self.locals
    	}
    }

    impl NameSection {
    	/// Deserialize a name section.
    	pub fn deserialize<R: io::Read>(
    		module: &Module,
    		rdr: &mut R,
    	) -> Result<Self, Error> {
    		let mut module_name: Option<ModuleNameSubsection> = None;
    		let mut function_names: Option<FunctionNameSubsection> = None;
    		let mut local_names: Option<LocalNameSubsection> = None;

    		loop {
    			let subsection_type: u8 = match VarUint7::deserialize(rdr) {
    				Ok(raw_subsection_type) => raw_subsection_type.into(),
    				// todo: be more selective detecting no more subsection
    				Err(_) => { break; },
    			};

    			// deserialize the section size
    			VarUint32::deserialize(rdr)?;

    			match subsection_type {
    				NAME_TYPE_MODULE => {
    					if let Some(_) = module_name {
    						return Err(Error::DuplicatedNameSubsections(NAME_TYPE_FUNCTION));
    					}
    					module_name = Some(ModuleNameSubsection::deserialize(rdr)?);
    				},

    				NAME_TYPE_FUNCTION => {
    					if let Some(_) = function_names {
    						return Err(Error::DuplicatedNameSubsections(NAME_TYPE_FUNCTION));
    					}
    					function_names = Some(FunctionNameSubsection::deserialize(module, rdr)?);
    				},

    				NAME_TYPE_LOCAL => {
    					if let Some(_) = local_names {
    						return Err(Error::DuplicatedNameSubsections(NAME_TYPE_LOCAL));
    					}
    					local_names = Some(LocalNameSubsection::deserialize(module, rdr)?);
    				},

    				_ => return Err(Error::UnknownNameSubsectionType(subsection_type))
    			};
    		}

    		Ok(Self {
    			module: module_name,
    			functions: function_names,
    			locals: local_names,
    		})
    	}
    }

    impl Serialize for NameSection {
    	type Error = Error;

    	fn serialize<W: io::Write>(self, wtr: &mut W) -> Result<(), Error> {
    		fn serialize_subsection<W: io::Write>(wtr: &mut W, name_type: u8, name_payload: &Vec<u8>) -> Result<(), Error> {
    			VarUint7::from(name_type).serialize(wtr)?;
    			VarUint32::from(name_payload.len()).serialize(wtr)?;
    			wtr.write(name_payload).map_err(Into::into)
    		}

    		if let Some(module_name_subsection) = self.module {
    			let mut buffer = vec![];
    			module_name_subsection.serialize(&mut buffer)?;
    			serialize_subsection(wtr, NAME_TYPE_MODULE, &buffer)?;
    		}

    		if let Some(function_name_subsection) = self.functions {
    			let mut buffer = vec![];
    			function_name_subsection.serialize(&mut buffer)?;
    			serialize_subsection(wtr, NAME_TYPE_FUNCTION, &buffer)?;
    		}

    		if let Some(local_name_subsection) = self.locals {
    			let mut buffer = vec![];
    			local_name_subsection.serialize(&mut buffer)?;
    			serialize_subsection(wtr, NAME_TYPE_LOCAL, &buffer)?;
    		}

    		Ok(())
    	}
    }

    /// The name of this module.
    #[derive(Clone, Debug, PartialEq)]
    pub struct ModuleNameSubsection {
    	name: String,
    }

    impl ModuleNameSubsection {
    	/// Create a new module name section with the specified name.
    	pub fn new<S: Into<String>>(name: S) -> ModuleNameSubsection {
    		ModuleNameSubsection { name: name.into() }
    	}

    	/// The name of this module.
    	pub fn name(&self) -> &str {
    		&self.name
    	}

    	/// The name of this module (mutable).
    	pub fn name_mut(&mut self) -> &mut String {
    		&mut self.name
    	}
    }

    impl Serialize for ModuleNameSubsection {
    	type Error = Error;

    	fn serialize<W: io::Write>(self, wtr: &mut W) -> Result<(), Error> {
    		self.name.serialize(wtr)
    	}
    }

    impl Deserialize for ModuleNameSubsection {
    	type Error = Error;

    	fn deserialize<R: io::Read>(rdr: &mut R) -> Result<ModuleNameSubsection, Error> {
    		let name = String::deserialize(rdr)?;
    		Ok(ModuleNameSubsection { name })
    	}
    }

    /// The names of the functions in this module.
    #[derive(Clone, Debug, Default, PartialEq)]
    pub struct FunctionNameSubsection {
    	names: NameMap,
    }

    impl FunctionNameSubsection {
    	/// A map from function indices to names.
    	pub fn names(&self) -> &NameMap {
    		&self.names
    	}

    	/// A map from function indices to names (mutable).
    	pub fn names_mut(&mut self) -> &mut NameMap {
    		&mut self.names
    	}

    	/// Deserialize names, making sure that all names correspond to functions.
    	pub fn deserialize<R: io::Read>(
    		module: &Module,
    		rdr: &mut R,
    	) -> Result<FunctionNameSubsection, Error> {
    		let names = IndexMap::deserialize(module.functions_space(), rdr)?;
    		Ok(FunctionNameSubsection { names })
    	}
    }

    impl Serialize for FunctionNameSubsection {
    	type Error = Error;

    	fn serialize<W: io::Write>(self, wtr: &mut W) -> Result<(), Error> {
    		self.names.serialize(wtr)
    	}
    }

    /// The names of the local variables in this module's functions.
    #[derive(Clone, Debug, Default, PartialEq)]
    pub struct LocalNameSubsection {
    	local_names: IndexMap<NameMap>,
    }

    impl LocalNameSubsection {
    	/// A map from function indices to a map from variables indices to names.
    	pub fn local_names(&self) -> &IndexMap<NameMap> {
    		&self.local_names
    	}

    	/// A map from function indices to a map from variables indices to names
    	/// (mutable).
    	pub fn local_names_mut(&mut self) -> &mut IndexMap<NameMap> {
    		&mut self.local_names
    	}

    	/// Deserialize names, making sure that all names correspond to local
    	/// variables.
    	pub fn deserialize<R: io::Read>(
    		module: &Module,
    		rdr: &mut R,
    	) -> Result<LocalNameSubsection, Error> {
    		let max_entry_space = module.functions_space();

    		let max_signature_args = module
    			.type_section()
    			.map(|ts|
    				ts.types()
    					.iter()
    					.map(|x| { let Type::Function(ref func) = *x; func.params().len() })
    					.max()
    					.unwrap_or(0))
    			.unwrap_or(0);

    		let max_locals = module
    			.code_section()
    			.map(|cs| cs.bodies().iter().map(|f| f.locals().len()).max().unwrap_or(0))
    			.unwrap_or(0);

    		let max_space = max_signature_args + max_locals;

    		let deserialize_locals = |_: u32, rdr: &mut R| IndexMap::deserialize(max_space, rdr);

    		let local_names = IndexMap::deserialize_with(
    			max_entry_space,
    			&deserialize_locals,
    			rdr,
    		)?;
    		Ok(LocalNameSubsection { local_names })
    	}}

    impl Serialize for LocalNameSubsection {
    	type Error = Error;

    	fn serialize<W: io::Write>(self, wtr: &mut W) -> Result<(), Error> {
    		self.local_names.serialize(wtr)
    	}
    }

    /// A map from indices to names.
    pub type NameMap = IndexMap<String>;

    #[cfg(test)]
    mod tests {
    	use super::*;

    	// A helper function for the tests. Serialize a section, deserialize it,
    	// and make sure it matches the original.
    	fn serialize_test(original: NameSection) -> Vec<u8> {
    		let mut buffer = vec![];
    		original
    			.serialize(&mut buffer)
    			.expect("serialize error");
    		buffer
    		// todo: add deserialization to this test
    	}

    	#[test]
    	fn serialize_module_name() {
    		let module_name_subsection = ModuleNameSubsection::new("my_mod");
    		let original = NameSection::new(Some(module_name_subsection), None, None);
    		serialize_test(original.clone());
    	}

    	#[test]
    	fn serialize_function_names() {
    		let mut function_name_subsection = FunctionNameSubsection::default();
    		function_name_subsection.names_mut().insert(0, "hello_world".to_string());
    		let name_section = NameSection::new(None, Some(function_name_subsection), None);
    		serialize_test(name_section);
    	}

    	#[test]
    	fn serialize_local_names() {
    		let mut local_name_subsection = LocalNameSubsection::default();
    		let mut locals = NameMap::default();
    		locals.insert(0, "msg".to_string());
    		local_name_subsection.local_names_mut().insert(0, locals);

    		let name_section = NameSection::new(None, None, Some(local_name_subsection));
    		serialize_test(name_section);
    	}

    	#[test]
    	fn serialize_all_subsections() {
    		let module_name_subsection = ModuleNameSubsection::new("ModuleNameSubsection");

    		let mut function_name_subsection = FunctionNameSubsection::default();
    		function_name_subsection.names_mut().insert(0, "foo".to_string());
    		function_name_subsection.names_mut().insert(1, "bar".to_string());

    		let mut local_name_subsection = LocalNameSubsection::default();
    		let mut locals = NameMap::default();
    		locals.insert(0, "msg1".to_string());
    		locals.insert(1, "msg2".to_string());
    		local_name_subsection.local_names_mut().insert(0, locals);

    		let name_section = NameSection::new(Some(module_name_subsection), Some(function_name_subsection), Some(local_name_subsection));
    		serialize_test(name_section);
    	}

    	#[test]
    	fn deserialize_local_names() {
    		let module = super::super::deserialize_file("./res/cases/v1/names_with_imports.wasm")
    			.expect("Should be deserialized")
    			.parse_names()
    			.expect("Names to be parsed");

    		let name_section = module.names_section().expect("name_section should be present");
    		let local_names = name_section.locals().expect("local_name_section should be present");

    		let locals = local_names.local_names().get(0).expect("entry #0 should be present");
    		assert_eq!(
    			locals.get(0).expect("entry #0 should be present"),
    			"abc"
    		);

    		let locals = local_names.local_names().get(1).expect("entry #1 should be present");
    		assert_eq!(
    			locals.get(0).expect("entry #0 should be present"),
    			"def"
    		);
    	}
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)