Merge remote-tracking branch 'origin/master' into add-text-based-reference-hovering

# Conflicts:
#	premake5.files.lua

Author: koppor

.gitignore

@@ -7,6 +7,7 @@
 *.cov
 out.txt
 out/
+agent-tools/
 mupdf/generated/
 .vs/
 .vscode/db/
@@ -33,11 +34,11 @@ docs/scratch.txt
 bin/zopflipng.exe
 
 docs-www/
-*.pdf
-*.cbr
-*.cbz
 translations/translations.txt.lzsa
 log.txt
 sumlog.txt
 vs2022/enc_temp_folder
 docs/md/.obsidian
+
+# temporary / scratch output written by tests (see tests/util.ts tmpPath())
+tests/tmp/

AUTHORS

@@ -50,9 +50,8 @@ SyncTeX        ext/.../synctex_parser.c       https://itexmac.sourceforge.net/Sy
 zlib           ext/zlib/zlib.h                https://www.zlib.net/
 lzma           ext/lzma/lzma.txt              https://www.7-zip.org/sdk.html
 libwebp        ext/libwebp/COPYING       BSD  https://developers.google.com/speed/webp/
-unarr          ext/unarr/COPYING         LGPL https://github.com/zeniko/unarr
 
-CMap Resources mupdf/.../cmaps/README         https://sourceforge.net/adobe/cmap/home/Home/
+CMap Resources mupdf/.../cmaps/README         https://sourceforge.net/adobe/cmap/home/Home/
 XySSL          mupdf/.../crypt-aes.c     BSD  https://en.wikipedia.org/wiki/PolarSSL#History
 Arcfour        mupdf/.../crypt-arc4.c         https://tools.ietf.org/html/draft-kaukonen-cipher-arcfour-01
 RSA's MD5      mupdf/.../crypt-md5.c          https://tools.ietf.org/html/rfc1321

agents.md

@@ -14,10 +14,12 @@ To debug run: `windbgx -Q -o -g ./out/dbg64/SumatraPDF-dll.exe`
 
 When launching SumatraPDF.exe for ad-hoc testing, always pass the `-for-testing` cmd-line flag. It starts a new instance (won't interfere with an already running SumatraPDF), doesn't restore the previous session (only loads files given on the cmd-line) and doesn't save settings (won't overwrite the settings of the user).
 
-After making a change to .cpp, .c or .h file (and before running build.ts), run clang-format on those files to reformat them in place
+After making a change to a .cpp, .c or .h file under `src/` (and before running build.ts), run clang-format on those files to reformat them in place. Do **not** clang-format third-party / vendored code (`mupdf/`, `ext/`, etc.) — keep edits there minimal and match the existing local style.
 
 Never commit changes automatically. Always wait for explicit command to commit changes.
 
+When committing a fix for a GitHub issue, include `(fixes #<issue-no>)` at the end of the commit message.
+
 ## Adding a new advanced setting
 
 To add a new advanced setting:
@@ -40,6 +42,42 @@ To add a new cmd-line flag:
 - implement handling in Flags.cpp
 - document in docs/md/Version-history.md in **next** section
 
+## Bug reproduction / test files
+
+We keep test and reproduction files for bugs in `C:\Users\kjk\OneDrive\!sumatra\bugs\`, named after the GitHub issue number:
+- a single file is `bug-<bug-no><rest>` (e.g. `bug-534.pdf`)
+- if a repro needs more than one file, use a directory `bug-<bug-no><rest>\`
+
+When fixing a bug, look there first for an existing repro file for that issue and use it. When you create a test/repro file while working on a bug, save it there (using the naming above) after fixing the bug.
+
+## Writing tests
+
+Tests live in tests/ and are run with bun (e.g. `bun tests/issue-5633.ts`). Naming convention, keyed by the GitHub issue number being tested:
+- the test script is `tests/issue-<number>.ts`
+- if it needs a small number (one or two) of extra files, name them `tests/issue-<number>.<rest>`
+- if it needs more files, or a file must live in a directory, put them in `tests/issue-<number>-data/`
+
+Structure of each test (so they compose in tests/all.ts):
+- each `tests/issue-<number>.ts` exports `export async function testit(): Promise<void>` that runs the test logic and THROWS on failure (returns normally on success). It must NOT call `process.exit` or build the app itself.
+- end the file with a standalone runner so it can still be run directly:
+  ```ts
+  if (import.meta.main) {
+    await runStandalone(testit);
+  }
+  ```
+  `runStandalone` (from `tests/util.ts`) builds the app (unless `--no-build`), runs `testit()`, and exits 0 on pass / 1 on failure.
+- shared helpers (`EXE` path, `buildApp`, `runStandalone`) live in `tests/util.ts` — use them instead of re-implementing per file.
+- register every new test in `tests/all.ts` (import its `testit` and add it to the `tests` array). `bun tests/all.ts` builds once and runs them all in order, stopping at the first failure.
+
+Guidelines for test scripts:
+- build the app the same way cmd/build.ts does (via `buildApp`/`runStandalone` in tests/util.ts) and test the resulting out/dbg64/SumatraPDF-dll.exe
+- if a needed external tool (e.g. MiKTeX) isn't installed, don't fail the test: print a clear message (with instructions to install it) and skip that part, returning normally so `tests/all.ts` continues
+- a good test fails when the fix is reverted (verify this) — not just passes with the fix present
+- bun has FFI; if you need to call Windows APIs, put reusable wrappers in tests/winapi.ts
+- prefer driving the app via cmd-line flags that write a machine-readable result (see `-test-synctex`) over GUI automation
+- never write runtime scratch / result files directly into `tests/` — that leaves the repo dirty. Write them under `tests/tmp/` (gitignored), using `tmpPath("name")` from `tests/util.ts` (it creates the dir on demand); the OS temp dir (`os.tmpdir()`) is also fine if you clean up after
+- if a binary test fixture (e.g. a .pdf) is generated from source (LaTeX, a script, etc.), commit the source alongside it (e.g. `tests/issue-<number>.tex` next to `tests/issue-<number>.pdf`) with a comment on how to regenerate it, so the fixture can be modified later
+
 ## Windows Shell Safety
 
 The Bash tool runs under Git Bash (MSYS2), **not** cmd.exe. This causes critical issues with Windows-style commands:

cmd/build-asan.ts

@@ -0,0 +1,75 @@
+import { copyFileSync, existsSync, readdirSync } from "node:fs";
+import { join } from "node:path";
+import { detectVisualStudio2026, runLogged } from "./util";
+import { clearDirPreserveSettings } from "./clean";
+
+const asanDllName = "clang_rt.asan_dynamic-x86_64.dll";
+
+function findAsanDll(vsRoot: string): string {
+  const candidates = [
+    join(vsRoot, String.raw`VC\Tools\MSVC`),
+    join(vsRoot, String.raw`VC\Tools\Llvm\x64\lib\clang`),
+  ];
+  for (const base of candidates) {
+    if (!existsSync(base)) continue;
+    const walk = (dir: string): string | undefined => {
+      for (const name of readdirSync(dir, { withFileTypes: true })) {
+        const p = join(dir, name.name);
+        if (name.isDirectory()) {
+          const hit = walk(p);
+          if (hit) return hit;
+        } else if (name.name === asanDllName) {
+          return p;
+        }
+      }
+      return;
+    };
+    const hit = walk(base);
+    if (hit) return hit;
+  }
+  throw new Error(`could not find ${asanDllName} under ${vsRoot}`);
+}
+
+function copyAsanRuntime(vsRoot: string, outDir: string): void {
+  const src = findAsanDll(vsRoot);
+  const dst = join(outDir, asanDllName);
+  copyFileSync(src, dst);
+  console.log(`copied ${asanDllName}`);
+}
+
+// Build SumatraPDF.exe (static) with MSVC AddressSanitizer (x64_asan).
+// Output: out/dbg64_asan/SumatraPDF.exe or out/rel64_asan/SumatraPDF.exe
+//
+// Usage:
+//   bun cmd/build-asan.ts            # Debug ASan build
+//   bun cmd/build-asan.ts --release  # Release ASan build
+//   bun cmd/build-asan.ts --clean
+
+const isRelease = process.argv.includes("--release");
+const clean = process.argv.includes("--clean");
+const config = isRelease ? "Release" : "Debug";
+const outDir = isRelease ? join("out", "rel64_asan") : join("out", "dbg64_asan");
+
+async function main() {
+  const timeStart = performance.now();
+  console.log(`${config} ASan build (SumatraPDF.exe, x64_asan)`);
+
+  if (clean) {
+    clearDirPreserveSettings(outDir);
+  }
+
+  await runLogged(join("bin", "premake5.exe"), ["vs2022"]);
+
+  const { msbuildPath, vsRoot } = detectVisualStudio2026();
+  const sln = String.raw`vs2022\SumatraPDF.sln`;
+  const t = `/t:SumatraPDF`;
+  const p = `/p:Configuration=${config};Platform=x64_asan`;
+  await runLogged(msbuildPath, [sln, t, p, `/m`]);
+  copyAsanRuntime(vsRoot, outDir);
+
+  const elapsed = ((performance.now() - timeStart) / 1000).toFixed(1);
+  console.log(`build took ${elapsed}s`);
+  console.log(`exe: ${join(outDir, "SumatraPDF.exe")}`);
+}
+
+await main();

cmd/build-with-mingw.ts

@@ -379,43 +379,6 @@ const chm: LibDef = {
   files: [{ dir: "ext/CHMLib", patterns: ["chm_lib.c", "lzx.c"] }],
 };
 
-const unarrlib: LibDef = {
-  name: "unarrlib",
-  alwaysOptimize: true,
-  defines: ["HAVE_ZLIB", "HAVE_BZIP2", "HAVE_7Z", "BZ_NO_STDIO", "_7ZIP_PPMD_SUPPPORT"],
-  includes: ["ext/zlib", "ext/bzip2", "ext/lzma/C"],
-  files: [
-    { dir: "ext/unarr/common", patterns: ["*.c"] },
-    { dir: "ext/unarr/rar", patterns: ["*.c"] },
-    { dir: "ext/unarr/zip", patterns: ["*.c"] },
-    { dir: "ext/unarr/tar", patterns: ["*.c"] },
-    { dir: "ext/unarr/_7z", patterns: ["*.c"] },
-    { dir: "ext/bzip2", patterns: ["bzip_all.c"] },
-    {
-      dir: "ext/unarr/lzmasdk",
-      patterns: ["CpuArch.c", "Ppmd7.c", "Ppmd7Dec.c", "Ppmd8.c", "Ppmd8Dec.c"],
-    },
-    {
-      dir: "ext/lzma/C",
-      patterns: [
-        "LzmaDec.c",
-        "Bra86.c",
-        "LzmaEnc.c",
-        "LzFind.c",
-        "LzFindMt.c",
-        "Threads.c",
-        "7zBuf.c",
-        "7zDec.c",
-        "7zIn.c",
-        "7zStream.c",
-        "Bcj2.c",
-        "Bra.c",
-        "Lzma2Dec.c",
-      ],
-    },
-  ],
-};
-
 const libwebp: LibDef = {
   name: "libwebp",
   alwaysOptimize: true,
@@ -1225,7 +1188,6 @@ const utils: LibDef = {
     "ext/libheif/libheif/api",
     "ext/libwebp/src",
     "ext/dav1d/include",
-    "ext/unarr",
     "mupdf/include",
     "ext/zlib",
   ],
@@ -1752,7 +1714,7 @@ namespace _com_util {
 
 // Order: libraries that have no deps first, then dependents.
 // The link order for archives is: most-dependent first, least-dependent last.
-const ALL_LIBS: LibDef[] = [zlib, unrar, libdjvu, chm, unarrlib, libwebp, dav1d, libheif, mupdfLibs, mupdf, utils];
+const ALL_LIBS: LibDef[] = [zlib, unrar, libdjvu, chm, libwebp, dav1d, libheif, mupdfLibs, mupdf, utils];
 
 async function build(isRelease: boolean, clean: boolean): Promise<void> {
   const config = isRelease ? "release" : "debug";

cmd/bun.lock

@@ -21,8 +21,6 @@ const includes = [
   "-I",
   "ext/synctex",
   "-I",
-  "ext/unarr",
-  "-I",
   "ext/lzma/C",
   "-I",
   "ext/libwebp/src",

cmd/clang-tidy.ts

@@ -81,6 +81,7 @@ export const commands = [
     "CmdZoomFitPage", "Zoom: Fit Page",
     "CmdZoomActualSize", "Zoom: Actual Size",
     "CmdZoomFitWidth", "Zoom: Fit Width",
+    "CmdZoomFitByOrientation", "Zoom: Fit Page or Width by Orientation",
     "CmdZoom6400", "Zoom: 6400%",
     "CmdZoom3200", "Zoom: 3200%",
     "CmdZoom1600", "Zoom: 1600%",
@@ -231,6 +232,12 @@ export const commands = [
     "CmdPauseReadAloud", "Pause Read Aloud",
     "CmdContinueReadAloud", "Continue Read Aloud",
     "CmdToggleHoverPreview", "Toggle Hover Preview",
+    "CmdRemoveDeletedFilesFromHistory", "Remove Deleted Files From History",
+    "CmdCommandPaletteTOC", "Command Palette: Table Of Contents",
+    "CmdDebugToggleRenderInfo", "Debug: Toggle Render Queue Info",
+    "CmdConvertImageToPdf", "Convert Image To PDF",
+    "CmdExpandToCurrentPage", "Expand TOC to Current Page",
+    "CmdStartAutoScroll", "Start Auto-Scroll",
     "CmdNone", "Do nothing",
 ];
 

cmd/gen-commands.ts

@@ -125,7 +125,7 @@ async function main() {
   }
 
   // copy CSS and JS files
-  const htmlFiles = ["sumatra.css", "gen_toc.js", "favicon.ico"];
+  const htmlFiles = ["sumatra.css", "gen_toc.js", "gen_code_copy.js", "favicon.ico"];
   for (const name of htmlFiles) {
     const srcPath = join("docs", name);
     const dstPath = join(websiteDir, "www", name);

cmd/gen-docs-website.ts

@@ -2,6 +2,8 @@
 // vendored in cmd/markdown-it.min.js from https://cdn.jsdelivr.net/npm/markdown-it@14.1.0/dist/markdown-it.min.js
 // @ts-ignore
 import MarkdownIt from "./markdown-it.min.js";
+import hljs from "highlight.js/lib/core";
+import javascript from "highlight.js/lib/languages/javascript";
 import {
   readFileSync,
   writeFileSync,
@@ -27,6 +29,42 @@ const searchJS = `<script>${readFileSync(join(docsDir, "gen_docs.search.js"), "u
 const searchHTML = readFileSync(join(docsDir, "gen_docs.search.html"), "utf-8");
 const tmplManual = readFileSync(join(docsDir, "manual.tmpl.html"), "utf-8");
 
+hljs.registerLanguage("javascript", javascript);
+
+function highlightJsCode(code: string): string {
+  return hljs.highlight(code, { language: "javascript" }).value;
+}
+
+function isMultiLineCode(content: string): boolean {
+  return content.replace(/\r\n/g, "\n").trimEnd().includes("\n");
+}
+
+function genPlainCodeBlockHTML(codeInnerHtml: string, codeClass = ""): string {
+  const cls = codeClass ? ` class="${codeClass}"` : "";
+  return `<pre><code${cls}>${codeInnerHtml}</code></pre>\n`;
+}
+
+function genCodeBlockHTML(codeInnerHtml: string, codeClass = ""): string {
+  const cls = codeClass ? ` class="${codeClass}"` : "";
+  return (
+    `<div class="code-block">` +
+    `<button type="button" class="sum-code-copy-btn" title="Copy to clipboard">Copy</button>` +
+    `<pre><code${cls}>${codeInnerHtml}</code></pre>` +
+    `</div>\n`
+  );
+}
+
+function renderFenceCodeBlock(
+  content: string,
+  codeInnerHtml: string,
+  codeClass = "",
+): string {
+  if (!isMultiLineCode(content)) {
+    return genPlainCodeBlockHTML(codeInnerHtml, codeClass);
+  }
+  return genCodeBlockHTML(codeInnerHtml, codeClass);
+}
+
 function buildTocHTML(currentPage: string): string {
   const text = readFileSync(
     join(mdDir, "SumatraPDF-documentation.md"),
@@ -191,12 +229,21 @@ function mdToHTML(name: string): string {
   md.renderer.rules.paragraph_open = () => "<div>";
   md.renderer.rules.paragraph_close = () => "</div>\n";
 
-  // render ```commands fenced blocks as CSV tables
+  // render ```commands fenced blocks as CSV tables; highlight ```js blocks
   md.renderer.rules.fence = (tokens: MarkdownIt.Token[], idx: number) => {
     const t = tokens[idx];
-    if (t.info.trim() === "commands")
+    const lang = t.info.trim().split(/\s+/)[0];
+    if (lang === "commands")
       return genCsvTableHTML(parseCsv(t.content));
-    return `<pre><code>${md.utils.escapeHtml(t.content)}</code></pre>\n`;
+    if (lang === "js" || lang === "javascript") {
+      const highlighted = highlightJsCode(t.content);
+      return renderFenceCodeBlock(
+        t.content,
+        highlighted,
+        "hljs language-javascript",
+      );
+    }
+    return renderFenceCodeBlock(t.content, md.utils.escapeHtml(t.content));
   };
 
   md.renderer.rules.heading_open = (
@@ -344,7 +391,7 @@ function writeDocsHtmlFiles(): void {
   }
 
   copyDirRecursive(join(wwwOutDir, "img"), join(mdDir, "img"));
-  const htmlFiles = ["sumatra.css", "gen_toc.js", "favicon.ico"];
+  const htmlFiles = ["sumatra.css", "gen_toc.js", "gen_code_copy.js", "favicon.ico"];
   for (const name of htmlFiles) {
     const srcPath = join("docs", name);
     const dstPath = join(wwwOutDir, name);