mv-bytecode-source-map 0.3.2

Move bytecode source map
Documentation 
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

// Copyright (c) The Diem Core Contributors
// Copyright (c) The Move Contributors
// SPDX-License-Identifier: Apache-2.0

use move_binary_format::file_format::{
    CodeOffset, FunctionDefinitionIndex, MemberCount, StructDefinitionIndex, TableIndex,
};
use std::collections::{BTreeMap, HashMap};

/// A data structure used to track any markings or extra information that is desired to be exposed
/// in the disassembled function definition. Every marking can have multiple messages associated with it.
#[derive(Debug, Default)]
pub struct FunctionMarking {
    // Code offset markings
    pub code_offsets: BTreeMap<CodeOffset, Vec<String>>,

    // Type parameters markings
    pub type_param_offsets: BTreeMap<usize, Vec<String>>,
}

/// A data structure used to track any markings or extra information that is desired to be exposed
/// in the disassembled struct definition. Every marking can have multiple messages associated with it.
#[derive(Debug, Default)]
pub struct StructMarking {
    // Field markings
    pub fields: BTreeMap<MemberCount, Vec<String>>,

    // Type parameter markings
    pub type_param_offsets: BTreeMap<usize, Vec<String>>,
}

/// A data structure that contains markings for both functions and structs. This will be used for
/// printing out error messages and the like.
#[derive(Debug, Default)]
pub struct MarkedSourceMapping {
    // Any function markings
    function_marks: HashMap<TableIndex, FunctionMarking>,

    // Any struct marking
    struct_marks: HashMap<TableIndex, StructMarking>,
}

impl FunctionMarking {
    pub fn new() -> Self {
        Self {
            code_offsets: BTreeMap::new(),
            type_param_offsets: BTreeMap::new(),
        }
    }

    pub fn code_offset(&mut self, code_offset: CodeOffset, message: String) {
        self.code_offsets
            .entry(code_offset)
            .or_insert_with(Vec::new)
            .push(message)
    }

    pub fn type_param(&mut self, type_param_index: usize, message: String) {
        self.type_param_offsets
            .entry(type_param_index)
            .or_insert_with(Vec::new)
            .push(message)
    }
}

impl StructMarking {
    pub fn new() -> Self {
        Self {
            fields: BTreeMap::new(),
            type_param_offsets: BTreeMap::new(),
        }
    }

    pub fn field(&mut self, field_index: MemberCount, message: String) {
        self.fields
            .entry(field_index)
            .or_insert_with(Vec::new)
            .push(message)
    }

    pub fn type_param(&mut self, type_param_index: usize, message: String) {
        self.type_param_offsets
            .entry(type_param_index)
            .or_insert_with(Vec::new)
            .push(message)
    }
}

impl MarkedSourceMapping {
    pub fn new() -> Self {
        Self {
            function_marks: HashMap::new(),
            struct_marks: HashMap::new(),
        }
    }

    pub fn mark_code_offset(
        &mut self,
        function_definition_index: FunctionDefinitionIndex,
        code_offset: CodeOffset,
        message: String,
    ) {
        self.function_marks
            .entry(function_definition_index.0)
            .or_insert_with(FunctionMarking::new)
            .code_offset(code_offset, message)
    }

    pub fn mark_function_type_param(
        &mut self,
        function_definition_index: FunctionDefinitionIndex,
        type_param_offset: usize,
        message: String,
    ) {
        self.function_marks
            .entry(function_definition_index.0)
            .or_insert_with(FunctionMarking::new)
            .type_param(type_param_offset, message)
    }

    pub fn mark_struct_field(
        &mut self,
        struct_definition_index: StructDefinitionIndex,
        field_index: MemberCount,
        message: String,
    ) {
        self.struct_marks
            .entry(struct_definition_index.0)
            .or_insert_with(StructMarking::new)
            .field(field_index, message)
    }

    pub fn mark_struct_type_param(
        &mut self,
        struct_definition_index: StructDefinitionIndex,
        type_param_offset: usize,
        message: String,
    ) {
        self.struct_marks
            .entry(struct_definition_index.0)
            .or_insert_with(StructMarking::new)
            .type_param(type_param_offset, message)
    }
}