ya-struct 0.0.5 → 0.0.7

package/lib/index.js

@@ -1,159 +0,0 @@
-import b2a from "buffer2address";
-import os from "os";
-
-import fieldBuilder from "./builder.js";
-
-const defineWithBuilderAndAbi = ({ builder, abi }) => {
-  const { fields, size, marshal, unmarshal } =
-    fieldBuilder.createFieldsViaBuilder({ builder, abi });
-
-  const parse = (buf) => {
-    if (!Buffer.isBuffer(buf)) {
-      throw new Error(`given argument is not a buffer`);
-    }
-
-    if (buf.length < size) {
-      throw new Error(
-        `given buffer is too small for structure (has ${buf.length} bytes, needs ${size} bytes)`
-      );
-    }
-
-    return unmarshal({ buffer: buf });
-  };
-
-  let emptyData = {};
-  Object.keys(fields).forEach((fieldName) => {
-    emptyData = {
-      ...emptyData,
-      [fieldName]: 0n,
-    };
-  });
-
-  const format = (data) => {
-    if (typeof data !== "object") {
-      throw new Error(`given argument is not a object`);
-    }
-
-    let primitives = {};
-    let buffers = {};
-    let links = [];
-
-    Object.keys(data).forEach((fieldName) => {
-      const value = data[fieldName];
-      if (Buffer.isBuffer(value)) {
-        buffers = Object.assign({}, buffers, {
-          [fieldName]: value,
-        });
-        links = [...links, value];
-      } else if (typeof value === "bigint") {
-        primitives = Object.assign({}, primitives, {
-          [fieldName]: value,
-        });
-      } else {
-        throw new Error(
-          `only Buffer and BigInt supported, "${fieldName}" was of type "${typeof value}"`
-        );
-      }
-    });
-
-    let bufferDataToMarshal = {};
-
-    Object.keys(buffers).forEach((fieldName) => {
-      const value = b2a.buffer2address(data[fieldName]);
-
-      bufferDataToMarshal = {
-        ...bufferDataToMarshal,
-        [fieldName]: value,
-      };
-    });
-
-    return marshal({
-      data: {
-        ...emptyData,
-        ...primitives,
-        ...bufferDataToMarshal,
-      },
-      links,
-    });
-  };
-
-  return {
-    fields,
-    size,
-
-    parse,
-    format,
-  };
-};
-
-const hostDataModels = {
-  x64: {
-    win32: "LLP64",
-    linux: "LP64",
-  },
-  arm: {
-    linux: "ILP32",
-  },
-  arm64: {
-    linux: "LP64",
-  },
-};
-
-const findDataModelFor = ({ arch, platform }) => {
-  const archDataModels = hostDataModels[arch];
-  if (!archDataModels) {
-    throw new Error(`unsupported CPU architecture ${arch}`);
-  }
-
-  const dataModel = archDataModels[platform];
-  if (!dataModel) {
-    throw new Error(`unsupported platform ${platform}`);
-  }
-
-  return dataModel;
-};
-
-const findHostDataModel = () => {
-  return findDataModelFor({
-    arch: process.arch,
-    platform: process.platform,
-  });
-};
-
-const findLikelyHostCompiler = () => {
-  return "gcc";
-};
-
-const define = (builder) => {
-  const abi = ({ endianness, dataModel, compiler }) => {
-    return defineWithBuilderAndAbi({
-      builder,
-      abi: {
-        endianness,
-        dataModel,
-        compiler,
-      },
-    });
-  };
-
-  const forHost = () => {
-    const endianness = os.endianness();
-    const dataModel = findHostDataModel();
-    const compiler = findLikelyHostCompiler();
-
-    return abi({
-      endianness,
-      dataModel,
-      compiler,
-    });
-  };
-
-  return {
-    abi,
-    forHost,
-  };
-};
-
-export default {
-  define,
-};

package/lib/marshaller.js

@@ -1,88 +0,0 @@
-import refbuf from "./refbuf.js";
-
-const createInterpretingMarshaller = ({ fieldDefinitions, size }) => {
-  const findReadWriteMethodName = ({ signed, fieldSizeInBits, endianness }) => {
-    const bigOrNot = fieldSizeInBits === 64 ? "Big" : "";
-    const signedOrNot = signed ? "" : "U";
-    const intType = `Int${fieldSizeInBits}`;
-
-    return `${bigOrNot}${signedOrNot}${intType}${endianness || ""}`;
-  };
-
-  const marshal = ({ data, links }) => {
-    const result = refbuf.create({ links, size });
-
-    Object.keys(fieldDefinitions).forEach((fieldName) => {
-      const {
-        signed,
-        offset,
-        size: fieldSize,
-        endianness,
-      } = fieldDefinitions[fieldName];
-
-      const fieldSizeInBits = fieldSize * 8;
-      const writeFuncName = `write${findReadWriteMethodName({
-        signed,
-        fieldSizeInBits,
-        endianness,
-      })}`;
-      const valueToWrite = writeFuncName.includes("Big")
-        ? BigInt(data[fieldName])
-        : Number(data[fieldName]);
-
-      if (!result[writeFuncName]) {
-        throw Error(`can't marshal "${fieldName}" ${JSON.stringify(fieldDefinitions[fieldName])}`);
-      }
-
-      result[writeFuncName](valueToWrite, offset);
-    });
-
-    return result;
-  };
-
-  const unmarshal = ({ buffer }) => {
-    let result = {};
-
-    Object.keys(fieldDefinitions).forEach((fieldName) => {
-      const {
-        signed,
-        offset,
-        size: fieldSize,
-        endianness,
-      } = fieldDefinitions[fieldName];
-
-      const fieldSizeInBits = fieldSize * 8;
-      const readFuncName = `read${findReadWriteMethodName({
-        signed,
-        fieldSizeInBits,
-        endianness,
-      })}`;
-
-      if (!buffer[readFuncName]) {
-        throw Error(`can't unmarshal "${fieldName}" ${JSON.stringify(fieldDefinitions[fieldName])}`);
-      }
-
-      const val = buffer[readFuncName](offset);
-
-      result = {
-        ...result,
-        [fieldName]: BigInt(val),
-      };
-    });
-
-    return result;
-  };
-
-  return {
-    marshal,
-    unmarshal,
-  };
-};
-
-const create = ({ fieldDefinitions, size }) => {
-  return createInterpretingMarshaller({ fieldDefinitions, size });
-};
-
-export default {
-  create,
-};

package/lib/refbuf.js

@@ -1,11 +0,0 @@
-const create = ({ links, size }) => {
-  const buf = Buffer.alloc(size);
-
-  buf.referencedBuffers = links;
-
-  return buf;
-};
-
-export default {
-  create,
-};

package/lib/types/basic.js

@@ -1,200 +0,0 @@
-const dataAndAlignmentModels = {
-  LP64: {
-    gcc: {
-      Int8: {
-        signed: true,
-        align: 1,
-        size: 1,
-      },
-      Int16: {
-        signed: true,
-        align: 2,
-        size: 2,
-      },
-      Int32: {
-        signed: true,
-        align: 4,
-        size: 4,
-      },
-      Int64: {
-        signed: true,
-        align: 8,
-        size: 8,
-      },
-
-      UInt8: {
-        signed: false,
-        align: 1,
-        size: 1,
-      },
-      UInt16: {
-        signed: false,
-        align: 2,
-        size: 2,
-      },
-      UInt32: {
-        signed: false,
-        align: 4,
-        size: 4,
-      },
-      UInt64: {
-        signed: false,
-        align: 8,
-        size: 8,
-      },
-
-      Pointer: {
-        signed: false,
-        align: 8,
-        size: 8,
-      },
-    },
-  },
-  ILP32: {
-    gcc: {
-      Int8: {
-        signed: true,
-        align: 1,
-        size: 1,
-      },
-      Int16: {
-        signed: true,
-        align: 2,
-        size: 2,
-      },
-      Int32: {
-        signed: true,
-        align: 4,
-        size: 4,
-      },
-      Int64: {
-        signed: true,
-        align: 8,
-        size: 8,
-      },
-
-      UInt8: {
-        signed: false,
-        align: 1,
-        size: 1,
-      },
-      UInt16: {
-        signed: false,
-        align: 2,
-        size: 2,
-      },
-      UInt32: {
-        signed: false,
-        align: 4,
-        size: 4,
-      },
-      UInt64: {
-        signed: false,
-        align: 8,
-        size: 8,
-      },
-
-      Pointer: {
-        signed: false,
-        align: 4,
-        size: 4,
-      },
-    },
-  },
-  default: {
-    Int8: {
-      signed: true,
-      align: 1,
-      size: 1,
-    },
-    Int16: {
-      signed: true,
-      align: 2,
-      size: 2,
-    },
-    Int32: {
-      signed: true,
-      align: 4,
-      size: 4,
-    },
-    Int64: {
-      signed: true,
-      align: 8,
-      size: 8,
-    },
-
-    UInt8: {
-      signed: false,
-      align: 1,
-      size: 1,
-    },
-    UInt16: {
-      signed: false,
-      align: 2,
-      size: 2,
-    },
-    UInt32: {
-      signed: false,
-      align: 4,
-      size: 4,
-    },
-    UInt64: {
-      signed: false,
-      align: 8,
-      size: 8,
-    },
-  },
-};
-
-const abi = ({ dataModel, compiler, endianness: defaultEndianess }) => {
-  const model =
-    dataAndAlignmentModels[dataModel]?.[compiler] ||
-    dataAndAlignmentModels.default;
-
-  const findAlignedOffset = ({ offset, align }) => {
-    return Math.floor((offset + align - 1) / align) * align;
-  };
-
-  const type = ({ signed, align, size, endianness }) => {
-    return ({ offset }) => {
-      const alignedOffset = findAlignedOffset({ offset, align });
-
-      return {
-        signed,
-        offset: alignedOffset,
-        size,
-        endianness,
-      };
-    };
-  };
-
-  return {
-    Int8: type({ ...model.Int8, endianness: undefined }),
-    Int16: type({ ...model.Int16, endianness: defaultEndianess }),
-    Int16LE: type({ ...model.Int16, endianness: "LE" }),
-    Int16BE: type({ ...model.Int16, endianness: "BE" }),
-    Int32: type({ ...model.Int32, endianness: defaultEndianess }),
-    Int32LE: type({ ...model.Int32, endianness: "LE" }),
-    Int32BE: type({ ...model.Int32, endianness: "BE" }),
-    Int64: type({ ...model.Int64, endianness: defaultEndianess }),
-    Int64LE: type({ ...model.Int64, endianness: "LE" }),
-    Int64BE: type({ ...model.Int64, endianness: "BE" }),
-
-    UInt8: type({ ...model.UInt8, endianness: undefined }),
-    UInt16: type({ ...model.UInt16, endianness: defaultEndianess }),
-    UInt16LE: type({ ...model.UInt16, endianness: "LE" }),
-    UInt16BE: type({ ...model.UInt16, endianness: "BE" }),
-    UInt32: type({ ...model.UInt32, endianness: defaultEndianess }),
-    UInt32LE: type({ ...model.UInt32, endianness: "LE" }),
-    UInt32BE: type({ ...model.UInt32, endianness: "BE" }),
-    UInt64: type({ ...model.UInt64, endianness: defaultEndianess }),
-    UInt64LE: type({ ...model.UInt64, endianness: "LE" }),
-    UInt64BE: type({ ...model.UInt64, endianness: "BE" }),
-
-    Pointer: type({ ...model.Pointer, endianness: defaultEndianess }),
-  };
-};
-
-export default {
-  abi,
-};

package/lib/types/ctypes.js

@@ -1,160 +0,0 @@
-const dataAndAlignmentModels = {
-  LP64: {
-    gcc: {
-      signedChar: {
-        signed: true,
-        size: 1,
-        align: 1,
-      },
-      signedShort: {
-        signed: true,
-        size: 2,
-        align: 2,
-      },
-      signedInt: {
-        signed: true,
-        size: 4,
-        align: 4,
-      },
-      signedLong: {
-        signed: true,
-        size: 8,
-        align: 8,
-      },
-      signedLongLong: {
-        signed: true,
-        size: 8,
-        align: 8,
-      },
-      unsignedChar: {
-        signed: false,
-        size: 1,
-        align: 1,
-      },
-      unsignedShort: {
-        signed: false,
-        size: 2,
-        align: 2,
-      },
-      unsignedInt: {
-        signed: false,
-        size: 4,
-        align: 4,
-      },
-      unsignedLong: {
-        signed: false,
-        size: 8,
-        align: 8,
-      },
-      unsignedLongLong: {
-        signed: false,
-        size: 8,
-        align: 8,
-      },
-    },
-  },
-  ILP32: {
-    gcc: {
-      signedChar: {
-        signed: true,
-        size: 1,
-        align: 1,
-      },
-      signedShort: {
-        signed: true,
-        size: 2,
-        align: 2,
-      },
-      signedInt: {
-        signed: true,
-        size: 4,
-        align: 4,
-      },
-      signedLong: {
-        signed: true,
-        size: 4,
-        align: 4,
-      },
-      signedLongLong: {
-        signed: true,
-        size: 8,
-        align: 8,
-      },
-      unsignedChar: {
-        signed: false,
-        size: 1,
-        align: 1,
-      },
-      unsignedShort: {
-        signed: false,
-        size: 2,
-        align: 2,
-      },
-      unsignedInt: {
-        signed: false,
-        size: 4,
-        align: 4,
-      },
-      unsignedLong: {
-        signed: false,
-        size: 4,
-        align: 4,
-      },
-      unsignedLongLong: {
-        signed: false,
-        size: 8,
-        align: 8,
-      },
-    },
-  },
-};
-
-const abi = ({ dataModel, compiler, endianness }) => {
-  const model = dataAndAlignmentModels[dataModel]?.[compiler];
-  if (!model) {
-    throw Error(
-      `data model ${dataModel} on compiler ${compiler} not supported`
-    );
-  }
-
-  const findAlignedOffset = ({ offset, align }) => {
-    return Math.floor((offset + align - 1) / align) * align;
-  };
-
-  const type = ({ signed, size, align }) => {
-    return ({ offset }) => {
-      const alignedOffset = findAlignedOffset({ offset, align });
-
-      return {
-        signed,
-        offset: alignedOffset,
-        size,
-        endianness: size > 1 ? endianness : undefined,
-      };
-    };
-  };
-
-  return {
-    char: type(model.signedChar),
-    short: type(model.signedShort),
-    int: type(model.signedInt),
-    long: type(model.signedLong),
-    longLong: type(model.signedLongLong),
-
-    signedChar: type(model.signedChar),
-    signedShort: type(model.signedShort),
-    signedInt: type(model.signedInt),
-    signedLong: type(model.signedLong),
-    signedLongLong: type(model.signedLongLong),
-
-    unsignedChar: type(model.unsignedChar),
-    unsignedShort: type(model.unsignedShort),
-    unsignedInt: type(model.unsignedInt),
-    unsignedLong: type(model.unsignedLong),
-    unsignedLongLong: type(model.unsignedLongLong),
-  };
-};
-
-export default {
-  abi,
-};