thru-abi-gen 0.2.30

ABI code generation utilities for the Thru blockchain
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
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
use crate::abi::expr::{ExprKind, LiteralExpr};
use crate::abi::resolved::{ResolvedType, ResolvedTypeKind, Size};
use crate::abi::types::{FloatingPointType, IntegralType, PrimitiveType};
use std::collections::{BTreeMap, HashMap};
use std::fmt::Write;

/* Convert literal expression to C code string */
pub fn literal_to_c_string(literal: &LiteralExpr) -> String {
    match literal {
        LiteralExpr::U64(v) => v.to_string(),
        LiteralExpr::U32(v) => v.to_string(),
        LiteralExpr::U16(v) => v.to_string(),
        LiteralExpr::U8(v) => v.to_string(),
        LiteralExpr::I64(v) => v.to_string(),
        LiteralExpr::I32(v) => v.to_string(),
        LiteralExpr::I16(v) => v.to_string(),
        LiteralExpr::I8(v) => v.to_string(),
    }
}

pub fn flatten_variable_refs_map(
    variable_refs: &HashMap<String, HashMap<String, PrimitiveType>>,
) -> BTreeMap<String, PrimitiveType> {
    let mut out = BTreeMap::new();
    for refs in variable_refs.values() {
        for (path, prim_type) in refs {
            out.entry(path.clone()).or_insert_with(|| prim_type.clone());
        }
    }
    out
}

pub fn flatten_size_refs(size: &Size) -> BTreeMap<String, PrimitiveType> {
    match size {
        Size::Const(_) => BTreeMap::new(),
        Size::Variable(map) => flatten_variable_refs_map(map),
    }
}

pub fn variable_ref_param_names(refs: &BTreeMap<String, PrimitiveType>) -> Vec<String> {
    refs.keys()
        .map(|ref_path| ref_path.replace('.', "_"))
        .collect()
}

/* Format expression to C code, converting field references to parameter names */
pub fn format_expr_to_c(expr: &ExprKind, params: &[String]) -> String {
    match expr {
        ExprKind::Literal(lit) => literal_to_c_string(lit),
        ExprKind::FieldRef(field_ref) => {
            /* Convert field reference to parameter name */
            let field_path_underscore = field_ref.path.join("_");
            if params.iter().any(|param| param == &field_path_underscore) {
                return field_path_underscore;
            }
            let field_path_dot = field_ref.path.join(".");
            if params.iter().any(|param| param == &field_path_dot) {
                return field_path_underscore;
            }
            if let Some(param) = params.iter().find(|param| {
                param
                    .rsplit('_')
                    .next()
                    .map(|suffix| suffix == field_path_underscore)
                    .unwrap_or(false)
            }) {
                return param.clone();
            }
            let suffix = format!("_{}", field_path_underscore);
            if let Some(param) = params.iter().find(|param| param.ends_with(&suffix)) {
                return param.clone();
            }
            /* If not found in params, use dot notation for struct access */
            field_path_dot
        }
        ExprKind::Sizeof(sizeof_expr) => format!("sizeof({})", sizeof_expr.type_name),
        ExprKind::Alignof(alignof_expr) => format!("alignof({})", alignof_expr.type_name),

        // Binary operations
        ExprKind::Add(e) => format!(
            "({}+{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Sub(e) => format!(
            "({}-{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Mul(e) => format!(
            "({}*{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Div(e) => format!(
            "({}/{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Mod(e) => format!(
            "({}%{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Pow(e) => {
            format!(
                "pow({},{})",
                format_expr_to_c(&e.left, params),
                format_expr_to_c(&e.right, params)
            )
        }

        // Bitwise operations
        ExprKind::BitAnd(e) => {
            format!(
                "({}&{})",
                format_expr_to_c(&e.left, params),
                format_expr_to_c(&e.right, params)
            )
        }
        ExprKind::BitOr(e) => format!(
            "({}|{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::BitXor(e) => {
            format!(
                "({}^{})",
                format_expr_to_c(&e.left, params),
                format_expr_to_c(&e.right, params)
            )
        }
        ExprKind::LeftShift(e) => {
            format!(
                "({}<<{})",
                format_expr_to_c(&e.left, params),
                format_expr_to_c(&e.right, params)
            )
        }
        ExprKind::RightShift(e) => {
            format!(
                "({}>>{})",
                format_expr_to_c(&e.left, params),
                format_expr_to_c(&e.right, params)
            )
        }

        // Unary operations
        ExprKind::BitNot(e) => format!("~({})", format_expr_to_c(&e.operand, params)),
        ExprKind::Neg(e) => format!("-({})", format_expr_to_c(&e.operand, params)),
        ExprKind::Not(e) => format!("!({})", format_expr_to_c(&e.operand, params)),
        ExprKind::Popcount(e) => {
            format!(
                "__builtin_popcount({})",
                format_expr_to_c(&e.operand, params)
            )
        }

        // Comparison operations
        ExprKind::Eq(e) => format!(
            "({}=={})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Ne(e) => format!(
            "({}!={})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Lt(e) => format!(
            "({}<{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Gt(e) => format!(
            "({}>{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Le(e) => format!(
            "({}<={})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Ge(e) => format!(
            "({}>={})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),

        // Logical operations
        ExprKind::And(e) => format!(
            "({}&&{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Or(e) => format!(
            "({}||{})",
            format_expr_to_c(&e.left, params),
            format_expr_to_c(&e.right, params)
        ),
        ExprKind::Xor(e) => {
            format!(
                "(({})!=({}))",
                format_expr_to_c(&e.left, params),
                format_expr_to_c(&e.right, params)
            )
        }
    }
}

pub fn escape_c_keyword(name: &str) -> String {
    const C_KEYWORDS: &[&str] = &[
        // C keywords
        "auto",
        "break",
        "case",
        "char",
        "const",
        "continue",
        "default",
        "do",
        "double",
        "else",
        "enum",
        "extern",
        "float",
        "for",
        "goto",
        "if",
        "inline",
        "int",
        "long",
        "register",
        "restrict",
        "return",
        "short",
        "signed",
        "sizeof",
        "static",
        "struct",
        "switch",
        "typedef",
        "union",
        "unsigned",
        "void",
        "volatile",
        "while",
        // C99 keywords
        "_Alignas",
        "_Alignof",
        "_Atomic",
        "_Bool",
        "_Complex",
        "_Generic",
        "_Imaginary",
        "_Noreturn",
        "_Static_assert",
        "_Thread_local",
        // Common reserved identifiers
        "bool",
        "complex",
        "imaginary",
        // Commonly used types that might conflict
        "size_t",
        "ssize_t",
        "ptrdiff_t",
        "wchar_t",
        "NULL",
    ];

    let mut sanitized: String = name
        .chars()
        .map(|c| {
            if c.is_ascii_alphanumeric() || c == '_' {
                c
            } else {
                '_'
            }
        })
        .collect();

    if sanitized.is_empty() {
        sanitized.push('_');
    }

    if sanitized
        .chars()
        .next()
        .map(|c| c.is_ascii_digit())
        .unwrap_or(false)
    {
        sanitized.insert(0, '_');
    }

    if C_KEYWORDS.contains(&sanitized.as_str()) {
        sanitized.push('_');
    }

    sanitized
}

pub fn sanitize_type_name(name: &str) -> String {
    escape_c_keyword(&name.replace("::", "_"))
}

pub fn primitive_to_c_type(prim_type: &PrimitiveType) -> &'static str {
    match prim_type {
        PrimitiveType::Integral(int_type) => match int_type {
            IntegralType::U8 => "uint8_t",
            IntegralType::U16 => "uint16_t",
            IntegralType::U32 => "uint32_t",
            IntegralType::U64 => "uint64_t",
            IntegralType::I8 => "int8_t",
            IntegralType::I16 => "int16_t",
            IntegralType::I32 => "int32_t",
            IntegralType::I64 => "int64_t",
            IntegralType::Char => "uint8_t",
        },
        PrimitiveType::FloatingPoint(float_type) => match float_type {
            FloatingPointType::F16 => "_Float16",
            FloatingPointType::F32 => "float",
            FloatingPointType::F64 => "double",
        },
    }
}

/* Generate code to access a nested field reference, eg "box.first" */
pub fn generate_nested_field_access(field_ref: &str, type_name: &str) -> String {
    let mut output = String::new();
    let var_name = field_ref.replace('.', "_");

    // For both nested and non-nested paths, call the parent-scoped accessor
    // e.g., "first.count" -> ParentType_get_first_count(self)
    // e.g., "count" -> ParentType_get_count(self)
    write!(
        &mut output,
        "  int64_t {} = (int64_t)({}_get_{}( self ));\n",
        var_name, type_name, var_name
    )
    .unwrap();

    output
}

/* Format a type to C string - simplified version for function generation */
pub fn format_type_to_c(resolved_type: &ResolvedType) -> String {
    match &resolved_type.kind {
        ResolvedTypeKind::Primitive { prim_type } => match prim_type {
            PrimitiveType::Integral(int_type) => match int_type {
                IntegralType::U8 => "uint8_t".to_string(),
                IntegralType::U16 => "uint16_t".to_string(),
                IntegralType::U32 => "uint32_t".to_string(),
                IntegralType::U64 => "uint64_t".to_string(),
                IntegralType::I8 => "int8_t".to_string(),
                IntegralType::I16 => "int16_t".to_string(),
                IntegralType::I32 => "int32_t".to_string(),
                IntegralType::I64 => "int64_t".to_string(),
                IntegralType::Char => "uint8_t".to_string(),
            },
            PrimitiveType::FloatingPoint(float_type) => match float_type {
                FloatingPointType::F16 => "_Float16".to_string(),
                FloatingPointType::F32 => "float".to_string(),
                FloatingPointType::F64 => "double".to_string(),
            },
        },
        ResolvedTypeKind::Array { element_type, .. } => {
            format_type_to_c(element_type) // For arrays, just return the element type
        }
        ResolvedTypeKind::TypeRef { target_name, .. } => {
            format!("{}_t", target_name)
        }
        _ => {
            /* For complex inline types, we'll handle them specially in get_c_accessor_type */
            "void".to_string()
        }
    }
}

/* Get the C type for accessor function return types */
pub fn get_c_accessor_type(resolved_type: &ResolvedType) -> String {
    match &resolved_type.kind {
        ResolvedTypeKind::Primitive { .. } => format_type_to_c(resolved_type),
        ResolvedTypeKind::Array { element_type, .. } => {
            format!("{} const *", format_type_to_c(element_type)) //pointer to element type
        }
        ResolvedTypeKind::TypeRef { target_name, .. } => {
            format!("{}_t const *", target_name) /* TypeRefs return pointer to the type */
        }
        _ => {
            /* For complex inline types (struct/union/enum), they have special handling
            in the accessor generation and don't use this function */
            panic!(
                "get_c_accessor_type called with unsupported type: {:?}",
                resolved_type.kind
            )
        }
    }
}

/// Emits shared checked arithmetic helpers used by generated C validators/builders.
pub fn emit_checked_arithmetic_helpers() -> &'static str {
    CHECKED_ARITH_HELPERS
}

const CHECKED_ARITH_HELPERS: &str = "/* Checked arithmetic helpers */\n\
static inline int tn_checked_add_u64( uint64_t a,\n\
                                      uint64_t b,\n\
                                      uint64_t * out ) {\n\
  if( !out ) return 1;\n\
  if( a > UINT64_MAX - b ) return 1;\n\
  *out = a + b;\n\
  return 0;\n\
}\n\
\n\
static inline int tn_checked_mul_u64( uint64_t a,\n\
                                      uint64_t b,\n\
                                      uint64_t * out ) {\n\
  if( !out ) return 1;\n\
  if( a && b > UINT64_MAX / a ) return 1;\n\
  *out = a * b;\n\
  return 0;\n\
}\n";

/* Helper function to check if a type is a nested complex type that needs its own footprint */
pub fn is_nested_complex_type(resolved_type: &ResolvedType) -> bool {
    matches!(
        resolved_type.kind,
        ResolvedTypeKind::Struct { .. }
            | ResolvedTypeKind::Union { .. }
            | ResolvedTypeKind::SizeDiscriminatedUnion { .. }
            | ResolvedTypeKind::Enum { .. }
    )
}