Files
sx/src/ir/jni_descriptor.zig
agra 2882748ae6 ffi 2.11 green: DSL call sites on #jni_class-typed receivers lower to JNI dispatch
`inst.method(args)` on a value typed as a foreign-class alias
(`Activity :: #jni_class("android/app/Activity") { getWindow ::
(self: *Self) -> *Window; }` etc.) now lowers to `jni_msg_send`
with descriptor auto-derived from the sx signature, env from the
enclosing `#jni_env` scope (lexical-direct via 2.16b), and slot
interning re-used from Phase 1C.

Touch surface:
- `Lowering` gains `foreign_class_map: StringHashMap(*const
  ForeignClassDecl)` populated in `scanDecls` + `lowerDecls`.
- New `registerForeignClassDecl` records each declared alias; the
  type-bridge fallback already interns the alias as a 0-field
  struct, so `*Activity` resolves cleanly through `getStructTypeName`.
- New `lowerForeignMethodCall` looks up the method in
  `ForeignClassDecl.members`, derives the descriptor via
  `jni_descriptor.deriveMethod` (with a `ClassRegistry` built from
  `foreign_class_map`), and emits `jni_msg_send` directly. Filters
  by runtime — `jni_class`/`jni_interface` lower; `objc_class` etc.
  surface a clear "not yet supported" diagnostic until Phase 3/4.
- `lowerCall`'s method-dispatch arm inserts the foreign-class
  check before the standard struct-method resolution.

JNI descriptor derivation gains `*void → Ljava/lang/Object;` (the
opaque-jobject convention) — common when sx code doesn't have a
precise Java type for the value. Locked in with a unit test.

IR snapshot at `tests/expected/ffi-jni-class-08-call.ir` shows the
full lowering: env from the enclosing fn param, target from the
foreign-class arg, slot-interned `(class, method, sig)` cache
pair, jni_msg_send to `CallObjectMethod` (slot 34). Mangled slot
names `@SX_JNI_CLS_getWindow____Ljava_lang_Object_` confirm the
derived descriptor.

129/129 examples + 16 jni_descriptor unit tests green.
2026-05-20 11:07:41 +03:00

152 lines
5.7 KiB
Zig

// JNI descriptor derivation for #jni_class methods (Phase 2 step 2.8).
//
// Walks sx parameter / return type AST nodes through the standard JNI
// signature alphabet (JLS §4.3.3 and JNI spec §3.3) to produce the
// descriptor string consumed by `GetMethodID` / `GetStaticMethodID`.
//
// void → V
// bool → Z (jboolean)
// s8 → B (jbyte)
// s16 → S (jshort)
// s32 → I (jint)
// s64 → J (jlong)
// u8 → B (jbyte — JNI bytes are signed; sx u8 still bridges via B)
// u16 → C (jchar — unsigned 16-bit)
// f32 → F (jfloat)
// f64 → D (jdouble)
// []T → [<elem>
// [*]T → [<elem> (sx many-pointer treated as array for now)
// *Self → L<enclosing-foreign-path>;
// *Foo → L<Foo's foreign path>; (cross-class — step 2.9)
//
// `#jni_method_descriptor("...")` (step 2.6) overrides this whole walk
// when set; sema/lowering use the override verbatim.
const std = @import("std");
const ast = @import("../ast.zig");
const Node = ast.Node;
pub const DeriveError = error{
UnknownPrimitive,
UnknownClassAlias, // *Foo where Foo isn't a declared #jni_class
UnsupportedType,
OutOfMemory,
};
/// Map from sx-side alias → foreign path of declared `#jni_class` /
/// `#jni_interface` decls. Used to resolve `*Foo` into `L<path>;` in
/// the descriptor. Built during lowering's scan pass.
pub const ClassRegistry = std.StringHashMap([]const u8);
pub const Context = struct {
/// Foreign path of the enclosing #jni_class — used to resolve `*Self`.
/// e.g. "android/view/View".
enclosing_path: []const u8,
/// Lookup for sibling/forward-declared `#jni_class` aliases. When null,
/// only `*Self` resolves; any other pointer-to-named-type errors.
classes: ?*const ClassRegistry = null,
};
/// Appends a single JNI type-descriptor to `buf` for `type_node`.
/// A null type_node represents a void return ('V').
pub fn writeType(
allocator: std.mem.Allocator,
buf: *std.ArrayList(u8),
ctx: Context,
type_node: ?*const Node,
) DeriveError!void {
if (type_node == null) {
try buf.append(allocator, 'V');
return;
}
const tn = type_node.?;
switch (tn.data) {
.type_expr => |te| {
const ch = primitiveChar(te.name) orelse return DeriveError.UnknownPrimitive;
try buf.append(allocator, ch);
},
.slice_type_expr => |sl| {
try buf.append(allocator, '[');
try writeType(allocator, buf, ctx, sl.element_type);
},
.many_pointer_type_expr => |mp| {
try buf.append(allocator, '[');
try writeType(allocator, buf, ctx, mp.element_type);
},
.array_type_expr => |arr| {
try buf.append(allocator, '[');
try writeType(allocator, buf, ctx, arr.element_type);
},
.pointer_type_expr => |ptr| {
// *Self → L<enclosing>;, *Foo → L<Foo's foreign path>;,
// *void → Ljava/lang/Object; (opaque jobject — common when
// users don't have a precise Java type for the value).
const inner = ptr.pointee_type;
if (inner.data != .type_expr) return DeriveError.UnsupportedType;
const target_name = inner.data.type_expr.name;
const target_path: []const u8 = if (std.mem.eql(u8, target_name, "Self"))
ctx.enclosing_path
else if (std.mem.eql(u8, target_name, "void"))
"java/lang/Object"
else if (ctx.classes) |reg|
reg.get(target_name) orelse return DeriveError.UnknownClassAlias
else
return DeriveError.UnknownClassAlias;
try buf.append(allocator, 'L');
try buf.appendSlice(allocator, target_path);
try buf.append(allocator, ';');
},
else => return DeriveError.UnsupportedType,
}
}
/// Derives the full `(args)ret` method descriptor for a `ForeignMethodDecl`.
/// The first param is skipped when `is_static == false` (it's the implicit
/// `self: *Self` receiver, which doesn't appear in the JNI descriptor).
pub fn deriveMethod(
allocator: std.mem.Allocator,
ctx: Context,
method: ast.ForeignMethodDecl,
) DeriveError![]u8 {
// `#jni_method_descriptor("(Sig)Ret")` short-circuits derivation
// entirely. Allocate a copy so the caller has uniform ownership
// semantics regardless of which branch ran.
if (method.jni_descriptor_override) |override| {
return allocator.dupe(u8, override);
}
var buf: std.ArrayList(u8) = .empty;
errdefer buf.deinit(allocator);
try buf.append(allocator, '(');
const start: usize = if (method.is_static) 0 else 1;
if (method.params.len < start) return DeriveError.UnsupportedType;
for (method.params[start..]) |param| {
try writeType(allocator, &buf, ctx, param);
}
try buf.append(allocator, ')');
try writeType(allocator, &buf, ctx, method.return_type);
return buf.toOwnedSlice(allocator);
}
fn primitiveChar(name: []const u8) ?u8 {
const table = [_]struct { name: []const u8, ch: u8 }{
.{ .name = "void", .ch = 'V' },
.{ .name = "bool", .ch = 'Z' },
.{ .name = "s8", .ch = 'B' },
.{ .name = "u8", .ch = 'B' },
.{ .name = "s16", .ch = 'S' },
.{ .name = "u16", .ch = 'C' },
.{ .name = "s32", .ch = 'I' },
.{ .name = "s64", .ch = 'J' },
.{ .name = "f32", .ch = 'F' },
.{ .name = "f64", .ch = 'D' },
};
for (table) |entry| {
if (std.mem.eql(u8, name, entry.name)) return entry.ch;
}
return null;
}