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
use anyhow::{bail, Result};
use move_command_line_common::files::MOVE_ERROR_DESC_EXTENSION;
use move_core_types::{
account_address::AccountAddress,
errmap::{ErrorDescription, ErrorMapping},
identifier::Identifier,
language_storage::ModuleId,
};
use move_model::{
ast::Value,
model::{GlobalEnv, ModuleEnv, NamedConstantEnv},
symbol::Symbol,
};
use serde::{Deserialize, Serialize};
use std::{convert::TryFrom, rc::Rc};
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ErrmapOptions {
pub error_prefix: String,
pub error_category_module: ModuleId,
pub output_file: String,
}
impl Default for ErrmapOptions {
fn default() -> Self {
Self {
error_prefix: "E".to_string(),
error_category_module: ModuleId::new(
AccountAddress::from_hex_literal("0x1").unwrap(),
Identifier::new("Errors").unwrap(),
),
output_file: MOVE_ERROR_DESC_EXTENSION.to_string(),
}
}
}
pub struct ErrmapGen<'env> {
options: &'env ErrmapOptions,
env: &'env GlobalEnv,
output: ErrorMapping,
}
impl<'env> ErrmapGen<'env> {
pub fn new(env: &'env GlobalEnv, options: &'env ErrmapOptions) -> Self {
Self {
options,
env,
output: ErrorMapping::default(),
}
}
pub fn save_result(&self) {
self.output.to_file(&self.options.output_file);
}
pub fn gen(&mut self) {
for module in self.env.get_modules() {
if !module.is_script_module() && module.is_target() {
self.build_error_map(&module).unwrap()
}
}
}
fn build_error_map(&mut self, module: &ModuleEnv<'_>) -> Result<()> {
let module_id = self.get_module_id_for_name(module);
if module_id == self.options.error_category_module {
self.build_error_categories(module)?
} else {
self.build_error_map_for_module(&module_id, module)?
}
Ok(())
}
fn build_error_categories(&mut self, module: &ModuleEnv<'_>) -> Result<()> {
for named_constant in module.get_named_constants() {
let name = self.name_string(named_constant.get_name());
let error_category = self.get_abort_code(&named_constant)?;
self.output.add_error_category(
error_category,
ErrorDescription {
code_name: name.to_string(),
code_description: named_constant.get_doc().to_string(),
},
)?
}
Ok(())
}
fn build_error_map_for_module(
&mut self,
module_id: &ModuleId,
module: &ModuleEnv<'_>,
) -> Result<()> {
for named_constant in module.get_named_constants() {
let name = self.name_string(named_constant.get_name());
if name.starts_with(&self.options.error_prefix) {
let abort_code = self.get_abort_code(&named_constant)?;
self.output.add_module_error(
module_id.clone(),
abort_code,
ErrorDescription {
code_name: name.to_string(),
code_description: named_constant.get_doc().to_string(),
},
)?
}
}
Ok(())
}
fn get_abort_code(&self, constant: &NamedConstantEnv<'_>) -> Result<u64> {
match constant.get_value() {
Value::Number(big_int) => u64::try_from(big_int).map_err(|err| err.into()),
x => bail!(
"Invalid abort code constant {} found for code {}",
x,
self.name_string(constant.get_name())
),
}
}
fn get_module_id_for_name(&self, module: &ModuleEnv<'_>) -> ModuleId {
let name = module.get_name();
let addr = AccountAddress::from_hex_literal(&format!("0x{:x}", name.addr())).unwrap();
let name = Identifier::new(self.name_string(name.name()).to_string()).unwrap();
ModuleId::new(addr, name)
}
fn name_string(&self, symbol: Symbol) -> Rc<String> {
self.env.symbol_pool().string(symbol)
}
}