# artifexsoftware/mupdf-android-viewer-old architecture

> Architecture diagram of the GitHub repository artifexsoftware/mupdf-android-viewer-old, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/artifexsoftware/mupdf-android-viewer-old
- Repository: https://github.com/artifexsoftware/mupdf-android-viewer-old

## Overview

##### Project type and purpose
- This is an Android mobile application (“MuPDF Android viewer”) for viewing PDF documents.
- It combines a native PDF rendering engine (MuPDF) with an Android-Java UI that displays pages, handles user interaction (pan/zoom/search/print), and orchestrates background work.

##### File structure
- Top-level build files:
– build.gradle, gradlew(.bat), gradle/… → Gradle-based Android build.
– AndroidManifest.xml → app entry points and permissions.
– Makefile, jni/Android.mk, Application.mk → NDK build scripts for native code.
- Native layer:
– jni/ → C glue (mupdf.c) and Android.mk include of core, third-party.
– libmupdf (submodule) provides the MuPDF engine sources.
- Java layer:
– src/com/artifex/mupdfdemo/ → Activities, Views, Adapters, AsyncTasks, JNI wrapper (MuPDFCore.java).
- UI resources:
– res/layout/, res/drawable-*/, res/values-*/ → layouts, styles, images, translations.
- Third-party & generated content:
– README describes “generated” directory for fonts/CMAPs, and thirdparty libs via git submodule.

##### README for additional insights
- The README emphasizes a two-stage build:
– 1) Native host build (‘make generate’) to produce “generated” assets (fonts/CMAPs).
– 2) Android viewer build (ndk-build, ant/Gradle).
- Dependencies: Android SDK/NDK, Java JDK, Ant (historical), Android Studio recommended.

##### Main components & their interactions
a. Android Application (Java layer)
– Activities (MuPDFActivity, OutlineActivity, ChoosePDFActivity, PrintDialogActivity)
– Views & Adapters (MuPDFView, PageAdapter, ReaderView, ReflowView)
– AsyncTasks (SearchTask, CancellableAsyncTask) for PDF parsing, text search.
– JNI wrapper (MuPDFCore.java) exposes native functions to load documents, render pages, extract metadata.
– Resource manager loads layouts, drawables, strings.
b. Native MuPDF Engine (C/C++ layer)
– Core parsing/rendering library (libmupdf)
– JNI bridge functions (jni/mupdf.c)
– “generated” assets: compressed fonts, CMAP tables
– Third-party dependencies (jbig2, fz, pdf modules)
c. Storage and I/O
– PDF files on device storage (via file picker or intent).
– SD card/emulator push for test PDFs.
d. Build System
– Gradle + Android Studio orchestrates Java compilation, resource packaging.
– ndk-build compiles native code into .so; Android.mk maps sources.
– git submodules for thirdparty.
– Optional Ant steps (historical).

##### Architectural patterns & design principles
- MVC/MVP-style separation: Activities/Adapters drive Views, delegate heavy work to AsyncTasks and native layer.
- JNI boundary isolates performance-critical rendering in native code, while UI runs on Dalvik/ART.
- Asynchronous background tasks prevent UI blocking on parsing or search.
- Modular subcomponents (ChoosePDF, Outline, Print) each handled by separate Activities and layouts.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "UI Layer"
        MuPDFActivity["MuPDFActivity"]:::java
        ChoosePDFActivity["ChoosePDFActivity"]:::java
        OutlineActivity["OutlineActivity"]:::java
        PrintDialogActivity["PrintDialogActivity"]:::java
        MuPDFView["MuPDFView"]:::java
        MuPDFPageView["MuPDFPageView"]:::java
        ReaderView["ReaderView"]:::java
        MuPDFReflowView["MuPDFReflowView"]:::java
        MuPDFPageAdapter["MuPDFPageAdapter"]:::java
        OutlineAdapter["OutlineAdapter"]:::java
        ChoosePDFAdapter["ChoosePDFAdapter"]:::java
        MuPDFReflowAdapter["MuPDFReflowAdapter"]:::java
    end

    subgraph "Application Logic Layer"
        SearchTask["SearchTask"]:::java
        CancellableAsyncTask["CancellableAsyncTask"]:::java
        AsyncTaskBase["AsyncTask.java"]:::java
        CancellableTaskDef["CancellableTaskDefinition"]:::java
        MuPDFCore["MuPDFCore (JNI wrapper)"]:::java
    end

    subgraph "Native Layer"
        JNIGlue["jni/mupdf.c"]:::native
        AndroidMK["Android.mk"]:::native
        ApplicationMK["Application.mk"]:::native
        CoreMK["Core.mk"]:::native
        ThirdPartyMK["ThirdParty.mk"]:::native
        libmupdf["libmupdf (engine)"]:::native
        GeneratedAssets["generated (fonts/CMAPs)"]:::native
    end

    subgraph "Storage / Platform"
        Storage["Android File System"]:::storage
        PrintFW["Android Print Framework"]:::storage
    end

    subgraph "Build System & Toolchain"
        Gradle["Gradle/Android Studio"]:::build
        NDK["NDK/ndk-build"]:::build
        MakeGen["make generate"]:::build
        GitSub["git submodules"]:::build
    end

    %% Data and control flow
    MuPDFActivity -->|"searchText()"| SearchTask
    MuPDFActivity -->|"loadPage()"| MuPDFCore
    ChoosePDFActivity -->|"select file"| Storage
    OutlineActivity -->|"load outline"| MuPDFCore
    PrintDialogActivity -->|"print request"| PrintFW

    SearchTask -->|"parse/render"| MuPDFCore
    MuPDFCore -->|"JNI call"| JNIGlue
    JNIGlue -->|"invoke engine"| libmupdf
    libmupdf -->|"renderBitmap"| JNIGlue
    JNIGlue -->|"return bitmap"| MuPDFView

    Storage -->|"file path"| MuPDFCore
    GeneratedAssets -->|"assets for engine"| libmupdf

    %% Build flows
    MakeGen --> GeneratedAssets
    GitSub --> libmupdf
    NDK -->|build native| JNIGlue & libmupdf
    Gradle -->|compile Java & package| MuPDFActivity & SearchTask & MuPDFCore

    %% Click Events
    click MuPDFActivity "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/MuPDFActivity.java"
    click ChoosePDFActivity "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/ChoosePDFActivity.java"
    click OutlineActivity "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/OutlineActivity.java"
    click PrintDialogActivity "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/PrintDialogActivity.java"

    click MuPDFView "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/MuPDFView.java"
    click MuPDFPageView "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/MuPDFPageView.java"
    click ReaderView "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/ReaderView.java"
    click MuPDFReflowView "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/MuPDFReflowView.java"

    click MuPDFPageAdapter "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/MuPDFPageAdapter.java"
    click OutlineAdapter "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/OutlineAdapter.java"
    click ChoosePDFAdapter "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/ChoosePDFAdapter.java"
    click MuPDFReflowAdapter "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/MuPDFReflowAdapter.java"

    click SearchTask "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/SearchTask.java"
    click CancellableAsyncTask "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/CancellableAsyncTask.java"
    click AsyncTaskBase "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/AsyncTask.java"
    click CancellableTaskDef "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/CancellableTaskDefinition.java"

    click MuPDFCore "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/src/com/artifex/mupdfdemo/MuPDFCore.java"

    click JNIGlue "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/jni/mupdf.c"
    click AndroidMK "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/jni/Android.mk"
    click ApplicationMK "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/jni/Application.mk"
    click CoreMK "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/jni/Core.mk"
    click ThirdPartyMK "https://github.com/artifexsoftware/mupdf-android-viewer-old/blob/master/jni/ThirdParty.mk"

    click libmupdf "https://github.com/artifexsoftware/mupdf-android-viewer-old/tree/master/libmupdf/"

    %% Styles
    classDef java fill:#D0E8FF,stroke:#0366D6,color:#0366D6;
    classDef native fill:#E0F7E9,stroke:#1B5E20,color:#1B5E20;
    classDef build fill:#FFE8B3,stroke:#FF8C00,color:#FF8C00;
    classDef storage fill:#F0F0F0,stroke:#666666,color:#666666;
```
