feat(C & JS API): Add BinaryenHasMemorySegment

This pr adds `BinaryenHasMemorySegment(module, name)` to the c api and `module.hasMemorySegment(name)` to the js api.

chore: formatting

fix: Ensure to call `preserveStack` before calling `strToStack`

Author: spotandjake

CHANGELOG.md

@@ -59,6 +59,8 @@ v126
      `BinaryenMemoryOrder` param. The functions formerly implicitly used
      `BinaryenMemoryOrderSeqCst()`. In JS this param is optional and thus not
      breaking.
+  - Add `BinaryenHasMemorySegment(<module>, <name>)` to the C API and
+    `module.hasMemorySegment(name)` to the JS API. Allowing users to check if a segment exists.
 
 v125
 ----

src/binaryen-c.cpp

@@ -5487,6 +5487,10 @@ void BinaryenSetMemory(BinaryenModuleRef module,
 uint32_t BinaryenGetNumMemorySegments(BinaryenModuleRef module) {
   return ((Module*)module)->dataSegments.size();
 }
+bool BinaryenHasMemorySegment(BinaryenModuleRef module,
+                              const char* segmentName) {
+  return (Module*)module->getDataSegmentOrNull(Name(segmentName)) != NULL;
+}
 uint32_t BinaryenGetMemorySegmentByteOffset(BinaryenModuleRef module,
                                             const char* segmentName) {
   auto* wasm = (Module*)module;

src/binaryen-c.h

@@ -3004,6 +3004,8 @@ BINARYEN_API bool BinaryenMemoryIs64(BinaryenModuleRef module,
 // Memory segments. Query utilities.
 
 BINARYEN_API uint32_t BinaryenGetNumMemorySegments(BinaryenModuleRef module);
+BINARYEN_API bool BinaryenHasMemorySegment(BinaryenModuleRef module,
+                                           const char* segmentName);
 BINARYEN_API uint32_t BinaryenGetMemorySegmentByteOffset(
   BinaryenModuleRef module, const char* segmentName);
 BINARYEN_API size_t BinaryenGetMemorySegmentByteLength(BinaryenModuleRef module,

src/js/binaryen.js-post.js

@@ -2772,6 +2772,14 @@ function wrapModule(module, self = {}) {
   self['getNumMemorySegments'] = function() {
     return Module['_BinaryenGetNumMemorySegments'](module);
   };
+  /**
+   * Determines wether a memory segment with the given name exists within the given module.
+   * @param {string} name - The name of the memory segment to check exists.
+   * @returns `true` if the memory segment exists, `false` otherwise
+   */
+  self['hasMemorySegment'] = function(name) {
+    return preserveStack(() => Boolean(Module['_BinaryenHasMemorySegment'](module, strToStack(name))));
+  };
   self['getMemorySegmentInfo'] = function(name) {
     return preserveStack(() => {
       const passive = Boolean(Module['_BinaryenGetMemorySegmentPassive'](module, strToStack(name)));

test/binaryen.js/kitchen-sink.js

@@ -1142,6 +1142,8 @@ function test_for_each() {
       data: expected_data[2].split('').map(function(x) { return x.charCodeAt(0) })
     }
   ], false);
+  assert(module.hasMemorySegment(expected_names[0]));
+  assert(!module.hasMemorySegment("NonExistantSegment"));
   for (i = 0; i < module.getNumMemorySegments(); i++) {
     var segment = module.getMemorySegmentInfo(expected_names[i]);
     assert(expected_offsets[i] === segment.offset);

test/example/c-api-kitchen-sink.c

@@ -2006,7 +2006,8 @@ void test_for_each() {
                       BinaryenTypeInt32(),
                       0,
                       makeInt32(module, expected_offsets[1]));
-
+    assert(BinaryenHasMemorySegment(module, segmentNames[0]));
+    assert(!BinaryenHasMemorySegment(module, "NonExistantSegment"));
     for (i = 0; i < BinaryenGetNumMemorySegments(module); i++) {
       char out[15] = {};
       assert(BinaryenGetMemorySegmentByteOffset(module, segmentNames[i]) ==