@mlightcad/libredwg-web 0.5.0 → 0.6.0

package/README.md

@@ -1,148 +1,148 @@
-# libredwg-web
-
-This is a DWG/DXF JavaScript parser based on libredwg. It can be used in browser and Node.js environments. 
-
-- [Live demo](https://mlightcad.github.io/libredwg-web/)
-- [API docs](https://mlightcad.github.io/libredwg-web/docs/)
-
-## Build WebAssembly
-
-Download and install emscripten according to [this doc](https://emscripten.org/docs/getting_started/downloads.html). Please make sure the following command is executed to activate `PATH` and other environment variables in the current terminal before building web assembly.
-
-Download and install [automake](https://www.gnu.org/software/automake/)
-
-Download and install [pnpm](https://pnpm.io)
-
-All can also be installed using homebrew:
-
-```bash
-brew install emscripten
-brew install automake
-brew install pnpm
-```
-
-```bash
-# Activate PATH and other environment variables for emscripten in the current terminal if needed
-source ./emsdk_env.sh
-
-# run autogen
-./autogen.sh
-
-# change directory
-cd bindings/javascript
-
-# Install npm dependencies to build JavaScript bindings for libredwg
-pnpm install
-
-# Check for dependencies, available tools, and system configurations and prepare the software package for building libredwg on a specific system
-pnpm build:prepare
-
-# Compile and build libredwg
-pnpm build:obj
-
-# Use emscripten to build web assembly for libredwg
-pnpm build:wasm
-
-# Copy web assembly (wasm file and JavaScript glue code file) from build directory to distribution directory of this package
-pnpm copy
-
-# Build web assembly wrapper so that it is easier to use it
-pnpm build
-```
-
-In order to reduce the size of wasm file, the following functionalities are not included by default when building web assembly.
-
-- write dwg file
-- read/write dxf file
-- import/export json file
-
-If you want those functionalities, just modify command `build:prepare` defined in [package.json](./package.json) and remove the following options.
-
-- disable-write
-- disable-json
-- disable-dxf
-
-## Usage
-
-There are two approaches to use this package. No matter which approach to use, please do remember copying wasm file (libredwg.wasm) to the same folder as your JavaScript bundle file when deploying your application. 
-
-```bash
-npm install @mlightcad/libredwg-web
-```
-
-### Use Raw Web Assembly
-
-The raw web assembly module (wasm file and JavaScript glue code file) is stored in folder [wasm](./wasm/). 
-
-```javascript
-import { createModule } from "@mlightcad/libredwg-web/wasm/libredwg-web.js";
-
-// Create libredwg module
-const libredwg = await createModule();
-
-// Store file content to one temporary file and read it
-const fileName = 'tmp.dwg';
-libredwg.FS.writeFile(
-  fileName,
-  new Uint8Array(fileContent)
-);
-const result = libredwg.dwg_read_file(fileName);
-if (result.error != 0) {
-  console.log('Failed to open dwg file with error code: ', result.error);
-}
-libredwg.FS.unlink(fileName);
-
-// Get pointer to Dwg_Data
-const data = result.data;
-```
-
-### Use Web Assembly Wrapper
-
-Web assembly wrapper is stored in folder [dist](./dist/). It provides one class `LibreDwg` to wrap the web assembly. This class provides
-
-- Method to convert dwg data to [DwgDatabase](https://mlightcad.github.io/libredwg-web/docs/interfaces/database_database.DwgDatabase.html) instance with the strong type definition so that it is easy to use.
-- More methods that the raw web assembly API doesn't provide. 
-
-```typescript
-import { Dwg_File_Type, LibreDwg } from '@mlightcad/libredwg-web';
-const libredwg = await LibreDwg.create();
-const dwg = libredwg.dwg_read_data(fileContent, Dwg_File_Type.DWG);
-const db = this.libredwg.convert(dwg);
-
-// Affter conversion, 'dwg' isn't needed any more. So you can call
-// function 'dwg_free' to free its memory.
-this.libredwg.dwg_free(db);
-```
-
-### Usage with node.js
-
-```typescript
-import { Dwg_File_Type, LibreDwg } from '@mlightcad/libredwg-web'
-// manually reference the wasm directory
-const libredwg = await LibreDwg.create(
-  './node_modules/@mlightcad/libredwg-web/wasm/'
-)
-…
-```
-
-## Interfaces
-
-There are two kinds of interfaces defined to access dwg/dxf drawing data. 
-
-### Interfaces with prifix 'Dwg'
-
-Those interfaces are much more easier to use with better data structure. It is quite similar to interfaces defined in project [@mlightcad/dxf-json](https://github.com/mlightcad/dxf-json). Those interfaces describe most of commonly used objects in the dwg/dxf drawing.
-
-### Interfaces with prefix 'Dwg_'
-
-Those interfaces are JavaScript version of `structs` defined in libredwg C++ code. Only a few `structs` have the correponding JavaScript interface. Most of them are defined to make it easier to convert libredwg data structure to [DwgDatabase](https://mlightcad.github.io/libredwg-web/docs/interfaces/database_database.DwgDatabase.html).
-
-So it is recommend to use interfaces with prefix 'Dwg'.
-
-## Demo App
-
-One demo app is provided in folder [examples](./examples/). You can run the following command to launch it.
-
-```javascript
-pnpm demo
+# libredwg-web
+
+This is a DWG/DXF JavaScript parser based on libredwg. It can be used in browser and Node.js environments. 
+
+- [Live demo](https://mlightcad.github.io/libredwg-web/)
+- [API docs](https://mlightcad.github.io/libredwg-web/docs/)
+
+## Build WebAssembly
+
+Download and install emscripten according to [this doc](https://emscripten.org/docs/getting_started/downloads.html). Please make sure the following command is executed to activate `PATH` and other environment variables in the current terminal before building web assembly.
+
+Download and install [automake](https://www.gnu.org/software/automake/)
+
+Download and install [pnpm](https://pnpm.io)
+
+All can also be installed using homebrew:
+
+```bash
+brew install emscripten
+brew install automake
+brew install pnpm
+```
+
+```bash
+# Activate PATH and other environment variables for emscripten in the current terminal if needed
+source ./emsdk_env.sh
+
+# run autogen
+./autogen.sh
+
+# change directory
+cd bindings/javascript
+
+# Install npm dependencies to build JavaScript bindings for libredwg
+pnpm install
+
+# Check for dependencies, available tools, and system configurations and prepare the software package for building libredwg on a specific system
+pnpm build:prepare
+
+# Compile and build libredwg
+pnpm build:obj
+
+# Use emscripten to build web assembly for libredwg
+pnpm build:wasm
+
+# Copy web assembly (wasm file and JavaScript glue code file) from build directory to distribution directory of this package
+pnpm copy
+
+# Build web assembly wrapper so that it is easier to use it
+pnpm build
+```
+
+In order to reduce the size of wasm file, the following functionalities are not included by default when building web assembly.
+
+- write dwg file
+- read/write dxf file
+- import/export json file
+
+If you want those functionalities, just modify command `build:prepare` defined in [package.json](./package.json) and remove the following options.
+
+- disable-write
+- disable-json
+- disable-dxf
+
+## Usage
+
+There are two approaches to use this package. No matter which approach to use, please do remember copying wasm file (libredwg.wasm) to the same folder as your JavaScript bundle file when deploying your application. 
+
+```bash
+npm install @mlightcad/libredwg-web
+```
+
+### Use Raw Web Assembly
+
+The raw web assembly module (wasm file and JavaScript glue code file) is stored in folder [wasm](./wasm/). 
+
+```javascript
+import { createModule } from "@mlightcad/libredwg-web/wasm/libredwg-web.js";
+
+// Create libredwg module
+const libredwg = await createModule();
+
+// Store file content to one temporary file and read it
+const fileName = 'tmp.dwg';
+libredwg.FS.writeFile(
+  fileName,
+  new Uint8Array(fileContent)
+);
+const result = libredwg.dwg_read_file(fileName);
+if (result.error != 0) {
+  console.log('Failed to open dwg file with error code: ', result.error);
+}
+libredwg.FS.unlink(fileName);
+
+// Get pointer to Dwg_Data
+const data = result.data;
+```
+
+### Use Web Assembly Wrapper
+
+Web assembly wrapper is stored in folder [dist](./dist/). It provides one class `LibreDwg` to wrap the web assembly. This class provides
+
+- Method to convert dwg data to [DwgDatabase](https://mlightcad.github.io/libredwg-web/docs/interfaces/database_database.DwgDatabase.html) instance with the strong type definition so that it is easy to use.
+- More methods that the raw web assembly API doesn't provide. 
+
+```typescript
+import { Dwg_File_Type, LibreDwg } from '@mlightcad/libredwg-web';
+const libredwg = await LibreDwg.create();
+const dwg = libredwg.dwg_read_data(fileContent, Dwg_File_Type.DWG);
+const db = this.libredwg.convert(dwg);
+
+// Affter conversion, 'dwg' isn't needed any more. So you can call
+// function 'dwg_free' to free its memory.
+this.libredwg.dwg_free(db);
+```
+
+### Usage with node.js
+
+```typescript
+import { Dwg_File_Type, LibreDwg } from '@mlightcad/libredwg-web'
+// manually reference the wasm directory
+const libredwg = await LibreDwg.create(
+  './node_modules/@mlightcad/libredwg-web/wasm/'
+)
+…
+```
+
+## Interfaces
+
+There are two kinds of interfaces defined to access dwg/dxf drawing data. 
+
+### Interfaces with prifix 'Dwg'
+
+Those interfaces are much more easier to use with better data structure. It is quite similar to interfaces defined in project [@mlightcad/dxf-json](https://github.com/mlightcad/dxf-json). Those interfaces describe most of commonly used objects in the dwg/dxf drawing.
+
+### Interfaces with prefix 'Dwg_'
+
+Those interfaces are JavaScript version of `structs` defined in libredwg C++ code. Only a few `structs` have the correponding JavaScript interface. Most of them are defined to make it easier to convert libredwg data structure to [DwgDatabase](https://mlightcad.github.io/libredwg-web/docs/interfaces/database_database.DwgDatabase.html).
+
+So it is recommend to use interfaces with prefix 'Dwg'.
+
+## Demo App
+
+One demo app is provided in folder [examples](./examples/). You can run the following command to launch it.
+
+```javascript
+pnpm demo
 ```

package/dist/libredwg-web.js

@@ -9,6 +9,16 @@ const isModelSpace = (name) => {
 const isPaperSpace = (name) => {
   return name && name.toUpperCase().startsWith(MODEL_SPACE_PREFIX);
 };
+const idToString = (id) => {
+  return id.toString(16).toUpperCase();
+};
+const isValidPointer = (ptr) => {
+  if (typeof ptr === "bigint") {
+    return ptr !== 0n;
+  } else {
+    return ptr !== 0;
+  }
+};
 var DwgCodePage = /* @__PURE__ */ ((DwgCodePage2) => {
   DwgCodePage2[DwgCodePage2["CP_UTF8"] = 0] = "CP_UTF8";
   DwgCodePage2[DwgCodePage2["CP_US_ASCII"] = 1] = "CP_US_ASCII";
@@ -6679,14 +6689,26 @@ class LibreEntityConverter {
     const gridSpacing = libredwg.dwg_dynapi_entity_value(entity, "GRIDUNIT").data;
     const viewDirection = libredwg.dwg_dynapi_entity_value(entity, "VIEWDIR").data;
     const targetPoint = libredwg.dwg_dynapi_entity_value(entity, "view_target").data;
-    const perspectiveLensLength = libredwg.dwg_dynapi_entity_value(entity, "lens_length").data;
+    const perspectiveLensLength = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "lens_length"
+    ).data;
     const frontClipZ = libredwg.dwg_dynapi_entity_value(entity, "front_clip_z").data;
     const backClipZ = libredwg.dwg_dynapi_entity_value(entity, "back_clip_z").data;
     const viewHeight = libredwg.dwg_dynapi_entity_value(entity, "VIEWSIZE").data;
     const snapAngle = libredwg.dwg_dynapi_entity_value(entity, "SNAPANG").data;
-    const viewTwistAngle = libredwg.dwg_dynapi_entity_value(entity, "twist_angle").data;
-    const circleZoomPercent = libredwg.dwg_dynapi_entity_value(entity, "circle_zoom").data;
-    const statusBitFlags = libredwg.dwg_dynapi_entity_value(entity, "status_flag").data;
+    const viewTwistAngle = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "twist_angle"
+    ).data;
+    const circleZoomPercent = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "circle_zoom"
+    ).data;
+    const statusBitFlags = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "status_flag"
+    ).data;
     const sheetName = libredwg.dwg_dynapi_entity_value(entity, "style_sheet").data;
     const renderMode = libredwg.dwg_dynapi_entity_value(entity, "render_mode").data;
     const ucsPerViewport = libredwg.dwg_dynapi_entity_value(entity, "UCSVP").data;
@@ -6697,19 +6719,40 @@ class LibreEntityConverter {
     const ucsId = libredwg.dwg_ref_get_absref(named_ucs_ref);
     const base_ucs_ref = libredwg.dwg_dynapi_entity_value(entity, "base_ucs").data;
     const ucsBaseId = libredwg.dwg_ref_get_absref(base_ucs_ref);
-    const orthographicType = libredwg.dwg_dynapi_entity_value(entity, "UCSORTHOVIEW").data;
+    const orthographicType = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "UCSORTHOVIEW"
+    ).data;
     const elevation = libredwg.dwg_dynapi_entity_value(entity, "ucs_elevation").data;
-    const shadePlotMode = libredwg.dwg_dynapi_entity_value(entity, "shadeplot_mode").data;
-    const isDefaultLighting = libredwg.dwg_dynapi_entity_value(entity, "use_default_lights").data;
-    const defaultLightingType = libredwg.dwg_dynapi_entity_value(entity, "default_lighting_type").data;
+    const shadePlotMode = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "shadeplot_mode"
+    ).data;
+    const isDefaultLighting = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "use_default_lights"
+    ).data;
+    const defaultLightingType = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "default_lighting_type"
+    ).data;
     const brightness = libredwg.dwg_dynapi_entity_value(entity, "brightness").data;
     const contrast = libredwg.dwg_dynapi_entity_value(entity, "contrast").data;
-    const majorGridFrequency = libredwg.dwg_dynapi_entity_value(entity, "grid_major").data;
-    const background_ref = libredwg.dwg_dynapi_entity_value(entity, "background").data;
+    const majorGridFrequency = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "grid_major"
+    ).data;
+    const background_ref = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "background"
+    ).data;
     const backgroundId = libredwg.dwg_ref_get_absref(background_ref);
     const shadeplot_ref = libredwg.dwg_dynapi_entity_value(entity, "shadeplot").data;
     const shadePlotId = libredwg.dwg_ref_get_absref(shadeplot_ref);
-    const visualstyle_ref = libredwg.dwg_dynapi_entity_value(entity, "visualstyle").data;
+    const visualstyle_ref = libredwg.dwg_dynapi_entity_value(
+      entity,
+      "visualstyle"
+    ).data;
     const visualStyleId = libredwg.dwg_ref_get_absref(visualstyle_ref);
     const sun_ref = libredwg.dwg_dynapi_entity_value(entity, "sun").data;
     const sunId = libredwg.dwg_ref_get_absref(sun_ref);
@@ -6741,20 +6784,20 @@ class LibreEntityConverter {
       ucsOrigin,
       ucsXAxis,
       ucsYAxis,
-      ucsId: ucsId.toString(),
-      ucsBaseId: ucsBaseId.toString(),
+      ucsId: idToString(ucsId),
+      ucsBaseId: idToString(ucsBaseId),
       orthographicType,
       elevation,
       shadePlotMode,
       majorGridFrequency,
-      backgroundId: backgroundId.toString(),
-      shadePlotId: shadePlotId.toString(),
-      visualStyleId: visualStyleId.toString(),
+      backgroundId: idToString(backgroundId),
+      shadePlotId: idToString(shadePlotId),
+      visualStyleId: idToString(visualStyleId),
       isDefaultLighting: !!isDefaultLighting,
       defaultLightingType,
       brightness,
       contrast,
-      sunId: sunId.toString()
+      sunId: idToString(sunId)
     };
   }
   convertWipeout(entity, commonAttrs) {
@@ -6891,8 +6934,8 @@ class LibreEntityConverter {
     const lineTypeScale = libredwg.dwg_object_entity_get_ltype_scale(entity);
     const isVisible = !libredwg.dwg_object_entity_get_invisible(entity);
     return {
-      handle: handle.value,
-      ownerBlockRecordSoftId: ownerhandle.absolute_ref,
+      handle: idToString(handle.value),
+      ownerBlockRecordSoftId: idToString(ownerhandle.absolute_ref),
       layer,
       color: rgbColor,
       colorIndex,
@@ -6908,13 +6951,13 @@ class LibreEntityConverter {
   getLayerName(entity) {
     const libredwg = this.libredwg;
     const layer = libredwg.dwg_object_entity_get_layer_object_ref(entity);
-    const name = this.layers.get(layer.handleref.value);
+    const name = this.layers.get(idToString(layer.handleref.value));
     return name ?? "0";
   }
   getLtypeName(entity) {
     const libredwg = this.libredwg;
     const ltype = libredwg.dwg_object_entity_get_ltype_object_ref(entity);
-    const name = this.ltypes.get(ltype.handleref.value);
+    const name = this.ltypes.get(idToString(ltype.handleref.value));
     return name ?? "";
   }
 }
@@ -7091,7 +7134,10 @@ class LibreDwgConverter {
     let entities = this.convertEntities(obj, commonAttrs.handle);
     if (entities.length == 0) {
       const entities_ptr = libredwg.dwg_dynapi_entity_value(item, "entities").data;
-      const object_ref_ptr_array = libredwg.dwg_ptr_to_object_ref_ptr_array(entities_ptr, num_owned);
+      const object_ref_ptr_array = libredwg.dwg_ptr_to_object_ref_ptr_array(
+        entities_ptr,
+        num_owned
+      );
       const converter = this.entityConverter;
       entities = [];
       for (let index = 0; index < num_owned; index++) {
@@ -7453,9 +7499,9 @@ class LibreDwgConverter {
     const elevation = libredwg.dwg_dynapi_entity_value(item, "ucs_elevation").data;
     const majorGridLines = libredwg.dwg_dynapi_entity_value(item, "grid_major").data;
     const background = libredwg.dwg_dynapi_entity_value(item, "background").data;
-    const backgroundObjectId = background ? libredwg.dwg_ref_get_absref(background).toString() : void 0;
+    const backgroundObjectId = background ? idToString(libredwg.dwg_ref_get_absref(background)) : void 0;
     const visualstyle = libredwg.dwg_dynapi_entity_value(item, "visualstyle").data;
-    const visualStyleObjectId = visualstyle ? libredwg.dwg_ref_get_absref(visualstyle).toString() : void 0;
+    const visualStyleObjectId = visualstyle ? idToString(libredwg.dwg_ref_get_absref(visualstyle)) : void 0;
     return {
       ...commonAttrs,
       standardFlag,
@@ -7507,8 +7553,8 @@ class LibreDwgConverter {
     const ownerhandle = libredwg.dwg_object_object_get_ownerhandle_object(object_tio);
     const handle = libredwg.dwg_object_get_handle_object(obj);
     return {
-      handle: handle.value,
-      ownerHandle: ownerhandle.absolute_ref,
+      handle: idToString(handle.value),
+      ownerHandle: idToString(ownerhandle.absolute_ref),
       name: libredwg.dwg_dynapi_entity_value(tio, "name").data
     };
   }
@@ -7548,6 +7594,22 @@ class LibreDwgConverter {
     const minExtent = libredwg.dwg_dynapi_entity_value(item, "EXTMIN").data;
     const maxExtent = libredwg.dwg_dynapi_entity_value(item, "EXTMAX").data;
     const elevation = libredwg.dwg_dynapi_entity_value(item, "ucs_elevation").data;
+    const block_header_ref = libredwg.dwg_dynapi_entity_value(
+      item,
+      "block_header"
+    ).data;
+    const paperSpaceTableId = idToString(
+      libredwg.dwg_ref_get_absref(block_header_ref)
+    );
+    const active_viewport_ref = libredwg.dwg_dynapi_entity_value(
+      item,
+      "active_viewport"
+    ).data;
+    const viewportId = idToString(
+      libredwg.dwg_ref_get_absref(active_viewport_ref)
+    );
+    const named_ucs_ref = libredwg.dwg_dynapi_entity_value(item, "named_ucs").data;
+    const namedUcsId = isValidPointer(named_ucs_ref) ? idToString(libredwg.dwg_ref_get_absref(named_ucs_ref)) : void 0;
     return {
       ...commonAttrs,
       layoutName,
@@ -7563,11 +7625,9 @@ class LibreDwgConverter {
       ucsXAxis,
       ucsYAxis,
       orthographicType,
-      paperSpaceTableId: "",
-      // TODO: Set the correct value
-      viewportId: "",
-      // TODO: Set the correct value
-      // namedUcsId?: string;
+      paperSpaceTableId,
+      viewportId,
+      namedUcsId,
       // orthographicUcsId?: string;
       shadePlotId: ""
       // TODO: Set the correct value
@@ -9060,8 +9120,8 @@ const _LibreDwg = class _LibreDwg {
     return converter.convert(data);
   }
   /**
-   * Converts Dwg_Data instance to DwgDatabase instance and returns conversion statistics. 
-   * DwgDatabase instance doesn't depend on Dwg_Data instance any more after conversion. 
+   * Converts Dwg_Data instance to DwgDatabase instance and returns conversion statistics.
+   * DwgDatabase instance doesn't depend on Dwg_Data instance any more after conversion.
    * So you can call function dwg_free to free memory occupied by Dwg_Data.
    * @param data Pointer to Dwg_Data instance.
    * @returns Returns the converted DwgDatabase and conversion statistics.
@@ -9985,6 +10045,8 @@ export {
   createModule,
   dwgCodePageToEncoding,
   dwgVersions,
+  idToString,
   isModelSpace,
-  isPaperSpace
+  isPaperSpace,
+  isValidPointer
 };