Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.24 KB

README.md

File metadata and controls

65 lines (40 loc) · 2.24 KB
Raw

@vonsim/common

This package contains common utilites used across the VonSim project.

@vonsim/common/address

This package exports MemoryAddress, a class that represents a memory address. It ensures that the address is within the bounds of the memory, and provides utilities for convertion and manipulation of addresses.

import { MemoryAddress } from "@vonsim/common/address";

MemoryAddress.from(0x0000); // MemoryAddress { #address: 0x0000 }
MemoryAddress.from(-1); // RangeError

@vonsim/common/ascii

This package exports utilities for converting between ASCII and binary, using a common encoding defined in by the VonSim specification.

@vonsim/common/byte

This package exports Byte, a class that represents a byte. It ensures that the byte is within the bounds of a byte, and provides utilities for convertion and manipulation of bytes.

Each Byte can be of either 8 or 16 bits.

import { Byte } from "@vonsim/common/byte";

Byte.fromUnsigned(0x00, 8); // Byte { #value: 0x00, #size: 8 }
Byte.fromUnsigned(0xffff, 8); // RangeError

@vonsim/common/i18n

This package exports utilities for internationalization. It's implemented this way to achieve type safety. More information can be found in the src/i18n.ts.

@vonsim/common/loops

This package exports utilities for looping over a range of numbers.

@vonsim/common/paths

Utilities to access deep properties of an object using a string path. Plus type safety.

import getFromPath, { Path, PathValue, TerminalObjPath } from "@vonsim/common/paths";

const obj = { a: { b: { c: 1984 } } };

type Obj = typeof obj;
type EndValue = number; // This type indicates when to stop traversing the object
type ObjPath = Path<Obj, EndValue>; // "a" | "a.b" | "a.b.c"
type TerminalObjPath = TerminalObjPath<Obj, EndValue>; // "a.b.c"
type PathValue<P extends ObjPath> = PathValue<Obj, P, EndValue>;

PathValue<"a.b.c">; // number
PathValue<"a.b">; // { c: number }

getFromPath(obj, "a.b.c") === obj.a.b.c;
getFromPath(obj, "a.b") === obj.a.b;

@vonsim/common/position

This package exports Position, a class that represents a position (or a range) inside the source assembly code, plus some utilities.