@papyrus-sdk/engine-native 0.2.10 → 0.2.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Papyrus Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,38 +1,38 @@
-# Papyrus Engine Native
-
-React Native native engine for PDF rendering (PDFKit on iOS, PDFium on Android),
-plus a WebView runtime for EPUB/TXT via `MobileDocumentEngine`.
-
-## Install
-
-```bash
-npm install @papyrus-sdk/engine-native @papyrus-sdk/core @papyrus-sdk/types
-```
-
-`@papyrus-sdk/core` and `@papyrus-sdk/types` are required peer dependencies.
-
-For EPUB/TXT on mobile, also install:
-
-```bash
-npm install react-native-webview
-```
-
-## Usage
-
-```ts
-import { MobileDocumentEngine, PapyrusPageView } from '@papyrus-sdk/engine-native';
-import { findNodeHandle } from 'react-native';
-
-const engine = new MobileDocumentEngine();
-await engine.load({ type: 'pdf', source: { uri: 'https://example.com/book.pdf' } });
-
-// Render the first page into a native view
-const viewTag = findNodeHandle(pageViewRef.current);
-if (viewTag) {
-  await engine.renderPage(0, viewTag, 2);
-}
-```
-
-Notes:
-- Requires a native build (not Expo Go).
-- Use `PapyrusPageView` for native PDF rendering.
+# Papyrus Engine Native
+
+React Native native engine for PDF rendering (PDFKit on iOS, PDFium on Android),
+plus a WebView runtime for EPUB/TXT via `MobileDocumentEngine`.
+
+## Install
+
+```bash
+npm install @papyrus-sdk/engine-native @papyrus-sdk/core @papyrus-sdk/types
+```
+
+`@papyrus-sdk/core` and `@papyrus-sdk/types` are required peer dependencies.
+
+For EPUB/TXT on mobile, also install:
+
+```bash
+npm install react-native-webview
+```
+
+## Usage
+
+```ts
+import { MobileDocumentEngine, PapyrusPageView } from '@papyrus-sdk/engine-native';
+import { findNodeHandle } from 'react-native';
+
+const engine = new MobileDocumentEngine();
+await engine.load({ type: 'pdf', source: { uri: 'https://example.com/book.pdf' } });
+
+// Render the first page into a native view
+const viewTag = findNodeHandle(pageViewRef.current);
+if (viewTag) {
+  await engine.renderPage(0, viewTag, 2);
+}
+```
+
+Notes:
+- Requires a native build (not Expo Go).
+- Use `PapyrusPageView` for native PDF rendering.

package/android/build.gradle

@@ -1,42 +1,42 @@
-apply plugin: 'com.android.library'
-
-def safeExtGet(prop, fallback) {
-  return rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
-}
-
-android {
-  compileSdkVersion safeExtGet('compileSdkVersion', 35)
-  ndkVersion safeExtGet('ndkVersion', '26.1.10909125')
-  namespace 'com.papyrus.engine'
-
-  defaultConfig {
-    minSdkVersion safeExtGet('minSdkVersion', 21)
-    targetSdkVersion safeExtGet('targetSdkVersion', 35)
-    consumerProguardFiles 'consumer-rules.pro'
-    externalNativeBuild {
-      cmake {
-        cppFlags "-std=c++17"
-      }
-    }
-  }
-
-  sourceSets {
-    main {
-      java.srcDirs = ['src/main/java']
-    }
-  }
-
-  externalNativeBuild {
-    cmake {
-      path "src/main/cpp/CMakeLists.txt"
-    }
-  }
-}
-
-dependencies {
-  implementation 'com.facebook.react:react-android'
-  implementation('io.github.oothp:pdfium-android:1.9.5-beta01') {
-    exclude group: 'com.android.support'
-  }
-  testImplementation 'junit:junit:4.13.2'
+apply plugin: 'com.android.library'
+
+def safeExtGet(prop, fallback) {
+  return rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+android {
+  compileSdkVersion safeExtGet('compileSdkVersion', 35)
+  ndkVersion safeExtGet('ndkVersion', '26.1.10909125')
+  namespace 'com.papyrus.engine'
+
+  defaultConfig {
+    minSdkVersion safeExtGet('minSdkVersion', 21)
+    targetSdkVersion safeExtGet('targetSdkVersion', 35)
+    consumerProguardFiles 'consumer-rules.pro'
+    externalNativeBuild {
+      cmake {
+        cppFlags "-std=c++17"
+      }
+    }
+  }
+
+  sourceSets {
+    main {
+      java.srcDirs = ['src/main/java']
+    }
+  }
+
+  externalNativeBuild {
+    cmake {
+      path "src/main/cpp/CMakeLists.txt"
+    }
+  }
+}
+
+dependencies {
+  implementation 'com.facebook.react:react-android'
+  implementation('io.github.oothp:pdfium-android:1.9.5-beta01') {
+    exclude group: 'com.android.support'
+  }
+  testImplementation 'junit:junit:4.13.2'
 }

package/android/consumer-rules.pro

@@ -1 +1 @@
-# Keep rules can be added here if needed.
+# Keep rules can be added here if needed.

package/android/src/main/cpp/CMakeLists.txt

@@ -1,45 +1,45 @@
-cmake_minimum_required(VERSION 3.18.1)
-project(papyrus_text)
-
-option(PAPYRUS_OUTLINE_HOST_TESTS "Build host tests for the outline loader" OFF)
-
-function(papyrus_set_cxx17 target_name)
-  set_target_properties(${target_name} PROPERTIES
-    CXX_STANDARD 17
-    CXX_STANDARD_REQUIRED YES
-  )
-endfunction()
-
-if(ANDROID)
-  add_library(papyrus_text SHARED
-    papyrus_text_search.cpp
-    papyrus_outline.cpp
-    papyrus_outline_loader.cpp
-  )
-
-  papyrus_set_cxx17(papyrus_text)
-  target_compile_options(papyrus_text PRIVATE -Wall -Werror)
-  target_link_options(papyrus_text PRIVATE "-Wl,-z,max-page-size=16384")
-
-  find_library(log-lib log)
-  find_library(android-lib android)
-  find_library(dl-lib dl)
-
-  target_link_libraries(papyrus_text
-    ${log-lib}
-    ${android-lib}
-    ${dl-lib}
-  )
-endif()
-
-if(PAPYRUS_OUTLINE_HOST_TESTS)
-  enable_testing()
-
-  add_executable(papyrus_outline_loader_test
-    papyrus_outline_loader.cpp
-    papyrus_outline_loader_test.cpp
-  )
-
-  papyrus_set_cxx17(papyrus_outline_loader_test)
-  add_test(NAME papyrus_outline_loader_test COMMAND papyrus_outline_loader_test)
+cmake_minimum_required(VERSION 3.18.1)
+project(papyrus_text)
+
+option(PAPYRUS_OUTLINE_HOST_TESTS "Build host tests for the outline loader" OFF)
+
+function(papyrus_set_cxx17 target_name)
+  set_target_properties(${target_name} PROPERTIES
+    CXX_STANDARD 17
+    CXX_STANDARD_REQUIRED YES
+  )
+endfunction()
+
+if(ANDROID)
+  add_library(papyrus_text SHARED
+    papyrus_text_search.cpp
+    papyrus_outline.cpp
+    papyrus_outline_loader.cpp
+  )
+
+  papyrus_set_cxx17(papyrus_text)
+  target_compile_options(papyrus_text PRIVATE -Wall -Werror)
+  target_link_options(papyrus_text PRIVATE "-Wl,-z,max-page-size=16384")
+
+  find_library(log-lib log)
+  find_library(android-lib android)
+  find_library(dl-lib dl)
+
+  target_link_libraries(papyrus_text
+    ${log-lib}
+    ${android-lib}
+    ${dl-lib}
+  )
+endif()
+
+if(PAPYRUS_OUTLINE_HOST_TESTS)
+  enable_testing()
+
+  add_executable(papyrus_outline_loader_test
+    papyrus_outline_loader.cpp
+    papyrus_outline_loader_test.cpp
+  )
+
+  papyrus_set_cxx17(papyrus_outline_loader_test)
+  add_test(NAME papyrus_outline_loader_test COMMAND papyrus_outline_loader_test)
 endif()

package/android/src/main/cpp/papyrus_outline.cpp

@@ -1,173 +1,173 @@
-#include "papyrus_outline_loader.h"
-
-#include <jni.h>
-#include <android/log.h>
-#include <dlfcn.h>
-
-#include <cstring>
-#include <vector>
-
-#define LOG_TAG "PapyrusOutline"
-#define LOGE(...) __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, __VA_ARGS__)
-
-namespace {
-
-OutlineLoaderState g_outline_loader = {};
-
-void *OutlineDlopen(void *, const char *filename, int flags) {
-  return dlopen(filename, flags);
-}
-
-OutlineLoaderDeps::PdfiumSymbol OutlineDlsym(void *, void *handle, const char *symbol_name) {
-  void *raw_symbol = dlsym(handle, symbol_name);
-  OutlineLoaderDeps::PdfiumSymbol symbol = nullptr;
-  static_assert(sizeof(symbol) == sizeof(raw_symbol),
-                "Expected dlsym results to match function pointer size");
-  std::memcpy(&symbol, &raw_symbol, sizeof(symbol));
-  return symbol;
-}
-
-int OutlineDlclose(void *, void *handle) {
-  return dlclose(handle);
-}
-
-const OutlineLoaderDeps kOutlineLoaderDeps = {
-    nullptr,
-    &OutlineDlopen,
-    &OutlineDlsym,
-    &OutlineDlclose,
-    "libmodpdfium.so",
-    RTLD_LAZY,
-};
-
-bool LoadPdfium() {
-  const OutlineLoadAttemptResult result =
-      EnsureOutlinePdfiumLoaded(&g_outline_loader, &kOutlineLoaderDeps);
-  if (!result.loaded && result.transitioned_to_unsupported) {
-    LOGE("Failed to load required PDFium symbols for outline");
-  }
-  return result.loaded;
-}
-
-PdfiumOutlineFns &OutlineFns() {
-  return g_outline_loader.fns;
-}
-
-jstring GetBookmarkTitle(JNIEnv *env, FPDF_BOOKMARK bookmark) {
-  unsigned long length = OutlineFns().bookmarkGetTitle(bookmark, nullptr, 0);
-  if (length <= 2) {
-    return env->NewStringUTF("");
-  }
-
-  std::vector<unsigned short> buffer((length / 2) + 1, 0);
-  unsigned long written = OutlineFns().bookmarkGetTitle(bookmark, buffer.data(), length);
-  int chars = written > 0 ? static_cast<int>(written / 2) - 1
-                          : static_cast<int>(length / 2) - 1;
-  if (chars <= 0) {
-    return env->NewStringUTF("");
-  }
-
-  return env->NewString(reinterpret_cast<const jchar *>(buffer.data()), chars);
-}
-
-jobjectArray BuildOutlineItems(JNIEnv *env,
-                               FPDF_DOCUMENT doc,
-                               FPDF_BOOKMARK parent,
-                               jclass item_class,
-                               jmethodID ctor) {
-  std::vector<jobject> items;
-
-  for (FPDF_BOOKMARK child = OutlineFns().bookmarkGetFirstChild(doc, parent); child;
-       child = OutlineFns().bookmarkGetNextSibling(doc, child)) {
-    jstring title = GetBookmarkTitle(env, child);
-    int page_index = -1;
-    FPDF_DEST dest = OutlineFns().bookmarkGetDest(doc, child);
-    if (dest != nullptr) {
-      page_index = OutlineFns().destGetPageIndex(doc, dest);
-    }
-
-    jobjectArray children = BuildOutlineItems(env, doc, child, item_class, ctor);
-    jobject item = env->NewObject(item_class, ctor, title, page_index, children);
-
-    if (title != nullptr) {
-      env->DeleteLocalRef(title);
-    }
-    if (children != nullptr) {
-      env->DeleteLocalRef(children);
-    }
-
-    if (item != nullptr) {
-      items.push_back(item);
-    }
-  }
-
-  jobjectArray array =
-      env->NewObjectArray(static_cast<jsize>(items.size()), item_class, nullptr);
-  for (jsize i = 0; i < static_cast<jsize>(items.size()); i++) {
-    env->SetObjectArrayElement(array, i, items[i]);
-  }
-
-  return array;
-}
-
-jobjectArray BuildOutline(JNIEnv *env, FPDF_DOCUMENT doc) {
-  jclass item_class = env->FindClass("com/papyrus/engine/PapyrusOutlineItem");
-  if (item_class == nullptr) {
-    return nullptr;
-  }
-
-  jmethodID ctor = env->GetMethodID(
-      item_class, "<init>", "(Ljava/lang/String;I[Lcom/papyrus/engine/PapyrusOutlineItem;)V");
-  if (ctor == nullptr) {
-    return nullptr;
-  }
-
-  return BuildOutlineItems(env, doc, nullptr, item_class, ctor);
-}
-
-}  // namespace
-
-extern "C" JNIEXPORT jboolean JNICALL
-Java_com_papyrus_engine_PapyrusOutline_nativeIsOutlineSupported(JNIEnv *, jclass) {
-  return LoadPdfium() ? JNI_TRUE : JNI_FALSE;
-}
-
-extern "C" JNIEXPORT jobjectArray JNICALL
-Java_com_papyrus_engine_PapyrusOutline_nativeGetOutline(JNIEnv *env, jclass, jlong docPtr) {
-  if (!LoadPdfium()) {
-    return nullptr;
-  }
-  if (!docPtr) {
-    return nullptr;
-  }
-
-  FPDF_DOCUMENT doc = reinterpret_cast<FPDF_DOCUMENT>(docPtr);
-  return BuildOutline(env, doc);
-}
-
-extern "C" JNIEXPORT jobjectArray JNICALL
-Java_com_papyrus_engine_PapyrusOutline_nativeGetOutlineFile(JNIEnv *env,
-                                                            jclass,
-                                                            jstring filePath) {
-  if (!LoadPdfium()) {
-    return nullptr;
-  }
-  if (filePath == nullptr) {
-    return nullptr;
-  }
-
-  const char *path = env->GetStringUTFChars(filePath, nullptr);
-  if (path == nullptr) {
-    return nullptr;
-  }
-
-  FPDF_DOCUMENT doc = OutlineFns().loadDocument(path, nullptr);
-  env->ReleaseStringUTFChars(filePath, path);
-  if (doc == nullptr) {
-    return nullptr;
-  }
-
-  jobjectArray result = BuildOutline(env, doc);
-  OutlineFns().closeDocument(doc);
-  return result;
+#include "papyrus_outline_loader.h"
+
+#include <jni.h>
+#include <android/log.h>
+#include <dlfcn.h>
+
+#include <cstring>
+#include <vector>
+
+#define LOG_TAG "PapyrusOutline"
+#define LOGE(...) __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, __VA_ARGS__)
+
+namespace {
+
+OutlineLoaderState g_outline_loader = {};
+
+void *OutlineDlopen(void *, const char *filename, int flags) {
+  return dlopen(filename, flags);
+}
+
+OutlineLoaderDeps::PdfiumSymbol OutlineDlsym(void *, void *handle, const char *symbol_name) {
+  void *raw_symbol = dlsym(handle, symbol_name);
+  OutlineLoaderDeps::PdfiumSymbol symbol = nullptr;
+  static_assert(sizeof(symbol) == sizeof(raw_symbol),
+                "Expected dlsym results to match function pointer size");
+  std::memcpy(&symbol, &raw_symbol, sizeof(symbol));
+  return symbol;
+}
+
+int OutlineDlclose(void *, void *handle) {
+  return dlclose(handle);
+}
+
+const OutlineLoaderDeps kOutlineLoaderDeps = {
+    nullptr,
+    &OutlineDlopen,
+    &OutlineDlsym,
+    &OutlineDlclose,
+    "libmodpdfium.so",
+    RTLD_LAZY,
+};
+
+bool LoadPdfium() {
+  const OutlineLoadAttemptResult result =
+      EnsureOutlinePdfiumLoaded(&g_outline_loader, &kOutlineLoaderDeps);
+  if (!result.loaded && result.transitioned_to_unsupported) {
+    LOGE("Failed to load required PDFium symbols for outline");
+  }
+  return result.loaded;
+}
+
+PdfiumOutlineFns &OutlineFns() {
+  return g_outline_loader.fns;
+}
+
+jstring GetBookmarkTitle(JNIEnv *env, FPDF_BOOKMARK bookmark) {
+  unsigned long length = OutlineFns().bookmarkGetTitle(bookmark, nullptr, 0);
+  if (length <= 2) {
+    return env->NewStringUTF("");
+  }
+
+  std::vector<unsigned short> buffer((length / 2) + 1, 0);
+  unsigned long written = OutlineFns().bookmarkGetTitle(bookmark, buffer.data(), length);
+  int chars = written > 0 ? static_cast<int>(written / 2) - 1
+                          : static_cast<int>(length / 2) - 1;
+  if (chars <= 0) {
+    return env->NewStringUTF("");
+  }
+
+  return env->NewString(reinterpret_cast<const jchar *>(buffer.data()), chars);
+}
+
+jobjectArray BuildOutlineItems(JNIEnv *env,
+                               FPDF_DOCUMENT doc,
+                               FPDF_BOOKMARK parent,
+                               jclass item_class,
+                               jmethodID ctor) {
+  std::vector<jobject> items;
+
+  for (FPDF_BOOKMARK child = OutlineFns().bookmarkGetFirstChild(doc, parent); child;
+       child = OutlineFns().bookmarkGetNextSibling(doc, child)) {
+    jstring title = GetBookmarkTitle(env, child);
+    int page_index = -1;
+    FPDF_DEST dest = OutlineFns().bookmarkGetDest(doc, child);
+    if (dest != nullptr) {
+      page_index = OutlineFns().destGetPageIndex(doc, dest);
+    }
+
+    jobjectArray children = BuildOutlineItems(env, doc, child, item_class, ctor);
+    jobject item = env->NewObject(item_class, ctor, title, page_index, children);
+
+    if (title != nullptr) {
+      env->DeleteLocalRef(title);
+    }
+    if (children != nullptr) {
+      env->DeleteLocalRef(children);
+    }
+
+    if (item != nullptr) {
+      items.push_back(item);
+    }
+  }
+
+  jobjectArray array =
+      env->NewObjectArray(static_cast<jsize>(items.size()), item_class, nullptr);
+  for (jsize i = 0; i < static_cast<jsize>(items.size()); i++) {
+    env->SetObjectArrayElement(array, i, items[i]);
+  }
+
+  return array;
+}
+
+jobjectArray BuildOutline(JNIEnv *env, FPDF_DOCUMENT doc) {
+  jclass item_class = env->FindClass("com/papyrus/engine/PapyrusOutlineItem");
+  if (item_class == nullptr) {
+    return nullptr;
+  }
+
+  jmethodID ctor = env->GetMethodID(
+      item_class, "<init>", "(Ljava/lang/String;I[Lcom/papyrus/engine/PapyrusOutlineItem;)V");
+  if (ctor == nullptr) {
+    return nullptr;
+  }
+
+  return BuildOutlineItems(env, doc, nullptr, item_class, ctor);
+}
+
+}  // namespace
+
+extern "C" JNIEXPORT jboolean JNICALL
+Java_com_papyrus_engine_PapyrusOutline_nativeIsOutlineSupported(JNIEnv *, jclass) {
+  return LoadPdfium() ? JNI_TRUE : JNI_FALSE;
+}
+
+extern "C" JNIEXPORT jobjectArray JNICALL
+Java_com_papyrus_engine_PapyrusOutline_nativeGetOutline(JNIEnv *env, jclass, jlong docPtr) {
+  if (!LoadPdfium()) {
+    return nullptr;
+  }
+  if (!docPtr) {
+    return nullptr;
+  }
+
+  FPDF_DOCUMENT doc = reinterpret_cast<FPDF_DOCUMENT>(docPtr);
+  return BuildOutline(env, doc);
+}
+
+extern "C" JNIEXPORT jobjectArray JNICALL
+Java_com_papyrus_engine_PapyrusOutline_nativeGetOutlineFile(JNIEnv *env,
+                                                            jclass,
+                                                            jstring filePath) {
+  if (!LoadPdfium()) {
+    return nullptr;
+  }
+  if (filePath == nullptr) {
+    return nullptr;
+  }
+
+  const char *path = env->GetStringUTFChars(filePath, nullptr);
+  if (path == nullptr) {
+    return nullptr;
+  }
+
+  FPDF_DOCUMENT doc = OutlineFns().loadDocument(path, nullptr);
+  env->ReleaseStringUTFChars(filePath, path);
+  if (doc == nullptr) {
+    return nullptr;
+  }
+
+  jobjectArray result = BuildOutline(env, doc);
+  OutlineFns().closeDocument(doc);
+  return result;
 }