Skip to content

Expose InspectorClient valueSubtype and descriptionForValueSubtype #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2025
Merged

Expose InspectorClient valueSubtype and descriptionForValueSubtype #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions build.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,23 @@ pub fn build(b: *std.Build) !void {
const mode = b.standardOptimizeOption(.{});
const target = b.standardTargetOptions(.{});

var build_opts = b.addOptions();
build_opts.addOption(
bool,
"inspector_subtype",
b.option(bool, "inspector_subtype", "Export default valueSubtype and descriptionForValueSubtype") orelse true,
);

_ = createGetTools(b);
_ = createGetV8(b, icu);

const v8 = try createV8_Build(b, target, mode, use_zig_tc, icu);

const create_test = createTest(b, target, mode, use_zig_tc);
const create_test = createTest(b, target, mode, use_zig_tc, build_opts);
const run_test = b.addRunArtifact(create_test);
b.step("test", "Run tests.").dependOn(&run_test.step);

const build_exe = createCompileStep(b, path, target, mode, use_zig_tc);
const build_exe = createCompileStep(b, path, target, mode, use_zig_tc, build_opts);
b.step("exe", "Build exe with main file at -Dpath").dependOn(&build_exe.step);

const run_exe = b.addRunArtifact(build_exe);
Expand Down Expand Up @@ -510,13 +517,14 @@ fn linkV8(b: *std.Build, step: *std.Build.Step.Compile, use_zig_tc: bool) void {
}
}

fn createTest(b: *std.Build, target: std.Build.ResolvedTarget, mode: std.builtin.Mode, use_zig_tc: bool) *std.Build.Step.Compile {
fn createTest(b: *std.Build, target: std.Build.ResolvedTarget, mode: std.builtin.Mode, use_zig_tc: bool, build_opts: *std.Build.Step.Options) *std.Build.Step.Compile {
const step = b.addTest(.{
.root_source_file = b.path("./src/test.zig"),
.target = target,
.optimize = mode,
.link_libc = true,
});
step.root_module.addImport("default_exports", build_opts.createModule());
step.addIncludePath(b.path("./src"));
linkV8(b, step, use_zig_tc);
return step;
Expand Down Expand Up @@ -733,7 +741,7 @@ pub const GetV8SourceStep = struct {
}
};

fn createCompileStep(b: *std.Build, path: []const u8, target: std.Build.ResolvedTarget, mode: std.builtin.Mode, use_zig_tc: bool) *std.Build.Step.Compile {
fn createCompileStep(b: *std.Build, path: []const u8, target: std.Build.ResolvedTarget, mode: std.builtin.Mode, use_zig_tc: bool, build_opts: *std.Build.Step.Options) *std.Build.Step.Compile {
const basename = std.fs.path.basename(path);
const i = std.mem.indexOf(u8, basename, ".zig") orelse basename.len;
const name = basename[0..i];
Expand All @@ -746,7 +754,7 @@ fn createCompileStep(b: *std.Build, path: []const u8, target: std.Build.Resolved
.link_libc = true,
});
step.addIncludePath(b.path("src"));

step.root_module.addImport("default_exports", build_opts.createModule());
if (mode == .ReleaseSafe) {
step.root_module.strip = true;
}
Expand Down
12 changes: 12 additions & 0 deletions src/binding.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1715,6 +1715,10 @@ void v8_inspector__Client__IMPL__consoleAPIMessage(
unsigned columnNumber, v8_inspector::V8StackTrace *stackTrace);
const v8::Context* v8_inspector__Client__IMPL__ensureDefaultContextInGroup(
v8_inspector__Client__IMPL* self, void* data, int contextGroupId);
char* v8_inspector__Client__IMPL__valueSubtype(
v8_inspector__Client__IMPL* self, v8::Local<v8::Value> value);
char* v8_inspector__Client__IMPL__descriptionForValueSubtype(
v8_inspector__Client__IMPL* self, v8::Local<v8::Context> context, v8::Local<v8::Value> value);

// c++ implementation (just wrappers around the c/zig functions)
} // extern "C"
Expand Down Expand Up @@ -1742,6 +1746,14 @@ void v8_inspector__Client__IMPL::consoleAPIMessage(
v8::Local<v8::Context> v8_inspector__Client__IMPL::ensureDefaultContextInGroup(int contextGroupId) {
return ptr_to_local(v8_inspector__Client__IMPL__ensureDefaultContextInGroup(this, this->data, contextGroupId));
}
std::unique_ptr<v8_inspector::StringBuffer> v8_inspector__Client__IMPL::valueSubtype(v8::Local<v8::Value> value) {
auto subType = v8_inspector__Client__IMPL__valueSubtype(this, value);
return v8_inspector::StringBuffer::create(toStringView(subType));
}
std::unique_ptr<v8_inspector::StringBuffer> v8_inspector__Client__IMPL::descriptionForValueSubtype(v8::Local<v8::Context> context, v8::Local<v8::Value> value) {
auto descriptions = v8_inspector__Client__IMPL__descriptionForValueSubtype(this, context, value);
return v8_inspector::StringBuffer::create(toStringView(descriptions));
}

extern "C" {

Expand Down
4 changes: 4 additions & 0 deletions src/binding.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,10 @@ void v8_inspector__Client__IMPL__consoleAPIMessage(
unsigned columnNumber, StackTrace *StackTrace);
const Context* v8_inspector__Client__IMPL__ensureDefaultContextInGroup(
InspectorClientImpl* self, void* data, int contextGroupId);
const Context* v8_inspector__Client__IMPL__valueSubtype(
InspectorClientImpl* self, Value value);
const Context* v8_inspector__Client__IMPL__descriptionForValueSubtype(
InspectorClientImpl* self, Context context, Value value);

// InspectorSession

Expand Down
2 changes: 2 additions & 0 deletions src/inspector.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ class v8_inspector__Client__IMPL
unsigned lineNumber, unsigned columnNumber,
v8_inspector::V8StackTrace* stackTrace) override;
v8::Local<v8::Context> ensureDefaultContextInGroup(int contextGroupId) override;
std::unique_ptr<v8_inspector::StringBuffer> valueSubtype(v8::Local<v8::Value>) override;
std::unique_ptr<v8_inspector::StringBuffer> descriptionForValueSubtype(v8::Local<v8::Context>, v8::Local<v8::Value>) override;
};

#endif // V8INSPECTORIMPL_H
23 changes: 22 additions & 1 deletion src/v8.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const std = @import("std");
const t = std.testing;

const c = @cImport({
pub const c = @cImport({
Copy link
Member

@krichprollsch krichprollsch Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to expose c?

Copy link
Collaborator Author

@karlseguin karlseguin Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the implementation is written in zig-js-runtime (or maybe browser), they'll receive the raw C++ objects (c.Context and c.Value instead of v8.Context and v8.Value).

The only way I figured out how to provide a wrapper, is to do something like StdOptions, but that requires defining these things in main.zig (i.e. root), which, maybe it's just me, but I don't love.

Copy link
Member

@krichprollsch krichprollsch Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm ok it's better to keep it ilke this.

@cInclude("binding.h");
});

Expand Down Expand Up @@ -2551,6 +2551,27 @@ pub export fn v8_inspector__Client__IMPL__ensureDefaultContextInGroup(
return inspector.ctx_handle;
}


usingnamespace if (@import("default_exports").inspector_subtype) struct {
pub export fn v8_inspector__Client__IMPL__valueSubtype(
_: *c.InspectorClientImpl,
value: *const c.Value,
) callconv(.C) [*c]const u8 {
_ = value;
return null;
}

pub export fn v8_inspector__Client__IMPL__descriptionForValueSubtype(
_: *c.InspectorClientImpl,
context: *const c.Context,
value: *const c.Value,
) callconv(.C) [*c]const u8 {
_ = value;
_ = context;
return null;
}
} else struct {};

// InspectorChannel

pub const InspectorChannel = struct {
Expand Down