Preliminary page rotation support.

.vscode/settings.json

@@ -42,6 +42,7 @@
     "microtask",
     "nullptr",
     "PAGELINK",
+    "PDFACTION",
     "pdfium",
     "Pdfjs",
     "pdfrx",
@@ -142,4 +143,4 @@
     "xloctime": "cpp",
     "xstring": "cpp"
   }
-}
+}

README.md

@@ -390,3 +390,45 @@ You can also cancel the background search:
 ```dart
 textSearcher.resetTextSearch();
 ```
+
+### PdfDocumentViewBuilder/PdfPageView
+
+[PdfPageView](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfPageView-class.html) is just another PDF widget that shows only one page. It accepts [PdfDocument](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfDocument-class.html) and page number to show a page within the document.
+
+[PdfDocumentViewBuilder](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfDocumentViewBuilder-class.html) is used to safely manage [PdfDocument](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfDocument-class.html) inside widget tree and it accepts `builder` parameter that creates child widgets.
+
+The following fragment is a typical use of these widgets:
+
+```dart
+PdfDocumentViewBuilder.asset(
+  'asset/test.pdf',
+  builder: (context, document) => ListView.builder(
+    itemCount: document?.pages.length ?? 0,
+    itemBuilder: (context, index) {
+      return Container(
+        margin: const EdgeInsets.all(8),
+        height: 240,
+        child: Column(
+          children: [
+            SizedBox(
+              height: 220,
+              child: PdfPageView(
+                document: document,
+                pageNumber: index + 1,
+                alignment: Alignment.center,
+              ),
+            ),
+            Text(
+              '${index + 1}',
+            ),
+          ],
+        ),
+      );
+    },
+  ),
+),
+```
+
+## PdfDocument management and sharing it between widgets
+
+[PdfDocumentViewBuilder](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfDocumentViewBuilder-class.html) can accept [PdfDocumentRef](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfDocumentRef-class.html) from [PdfViewer](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfViewer-class.html) to safely share the same [PdfDocument](https://pub.dev/documentation/pdfrx/latest/pdfrx/PdfDocument-class.html) instance. For more information, see [example/lib/thumbnails_view.dart](example/lib/thumbnails_view.dart).

example/lib/main.dart

@@ -31,6 +31,7 @@ class MainPage extends StatefulWidget {
 }
 
 class _MainPageState extends State<MainPage> {
+  final documentRef = ValueNotifier<PdfDocumentRef?>(null);
   final controller = PdfViewerController();
   final showLeftPane = ValueNotifier<bool>(false);
   final outline = ValueNotifier<List<PdfOutlineNode>?>(null);
@@ -48,6 +49,7 @@ class _MainPageState extends State<MainPage> {
     textSearcher.dispose();
     showLeftPane.dispose();
     outline.dispose();
+    documentRef.dispose();
     super.dispose();
   }
 
@@ -106,15 +108,25 @@ class _MainPageState extends State<MainPage> {
                       Expanded(
                         child: TabBarView(
                           children: [
-                            TextSearchView(textSearcher: textSearcher),
+                            // NOTE: documentRef is not explicitly used but it indicates that
+                            // the document is changed.
+                            ValueListenableBuilder(
+                              valueListenable: documentRef,
+                              builder: (context, documentRef, child) => child!,
+                              child: TextSearchView(textSearcher: textSearcher),
+                            ),
                             ValueListenableBuilder(
                               valueListenable: outline,
                               builder: (context, outline, child) => OutlineView(
                                 outline: outline,
                                 controller: controller,
                               ),
                             ),
-                            ThumbnailsView(controller: controller),
+                            ValueListenableBuilder(
+                              valueListenable: documentRef,
+                              builder: (context, documentRef, child) => child!,
+                              child: ThumbnailsView(controller: controller),
+                            ),
                           ],
                         ),
                       ),
@@ -236,6 +248,8 @@ class _MainPageState extends State<MainPage> {
                       textSearcher.pageTextMatchPaintCallback
                     ],
                     onDocumentChanged: (document) async {
+                      documentRef.value =
+                          controller.isReady ? controller.documentRef : null;
                       outline.value = await document?.loadOutline();
                     },
                   ),

example/lib/search_view.dart

@@ -22,7 +22,7 @@ class _TextSearchViewState extends State<TextSearchView> {
   final focusNode = FocusNode();
   final searchTextController = TextEditingController();
   late final pageTextStore =
-      PdfPageTextStore(textSearcher: widget.textSearcher);
+      PdfPageTextCache(textSearcher: widget.textSearcher);
   final scrollController = ScrollController();
 
   @override
@@ -229,7 +229,7 @@ class SearchResultTile extends StatefulWidget {
 
   final PdfTextMatch match;
   final void Function() onTap;
-  final PdfPageTextStore pageTextStore;
+  final PdfPageTextCache pageTextStore;
   final double height;
   final bool isCurrent;
 
@@ -347,9 +347,9 @@ class _SearchResultTileState extends State<SearchResultTile> {
 }
 
 /// A helper class to cache loaded page texts.
-class PdfPageTextStore {
+class PdfPageTextCache {
   final PdfTextSearcher textSearcher;
-  PdfPageTextStore({
+  PdfPageTextCache({
     required this.textSearcher,
   });
 

example/lib/thumbnails_view.dart

@@ -13,7 +13,7 @@ class ThumbnailsView extends StatelessWidget {
   Widget build(BuildContext context) {
     return Container(
       color: Colors.grey,
-      child: controller?.documentRef == null
+      child: controller?.isReady != true || controller?.documentRef == null
           ? null
           : PdfDocumentViewBuilder(
               documentRef: controller!.documentRef,

lib/src/pdf_api.dart

@@ -241,6 +241,9 @@ abstract class PdfPage {
   /// PDF page height in points (height in pixels at 72 dpi) (rotated).
   double get height;
 
+  /// PDF page rotation.
+  PdfPageRotation get rotation;
+
   /// Render a sub-area or full image of specified PDF file.
   /// Returned image should be disposed after use.
   /// [x], [y], [width], [height] specify sub-area to render in pixels.
@@ -286,6 +289,13 @@ abstract class PdfPage {
   Future<List<PdfLink>> loadLinks();
 }
 
+enum PdfPageRotation {
+  none,
+  clockwise90,
+  clockwise180,
+  clockwise270,
+}
+
 /// Annotation rendering mode.
 /// - [none]: Do not render annotations.
 /// - [annotation]: Render annotations.
@@ -616,15 +626,52 @@ class PdfRect {
   /// Convert to [Rect] in Flutter coordinate. [height] specifies the height of the page (original size).
   /// [scale] is used to scale the rectangle.
   Rect toRect({
-    required double height,
-    double scale = 1.0,
-  }) =>
-      Rect.fromLTRB(
-        left * scale,
-        (height - top) * scale,
-        right * scale,
-        (height - bottom) * scale,
-      );
+    required PdfPage page,
+    Size? scaledTo,
+    int? rotation,
+  }) {
+    final rotated = rotate(rotation ?? page.rotation.index, page);
+    final scale = scaledTo == null ? 1.0 : scaledTo.height / page.height;
+    return Rect.fromLTRB(
+      rotated.left * scale,
+      (page.height - rotated.top) * scale,
+      rotated.right * scale,
+      (page.height - rotated.bottom) * scale,
+    );
+  }
+
+  PdfRect rotate(int rotation, PdfPage page) {
+    final swap = (page.rotation.index & 1) == 1;
+    final width = swap ? page.height : page.width;
+    final height = swap ? page.width : page.height;
+    switch (rotation & 3) {
+      case 0:
+        return this;
+      case 1:
+        return PdfRect(
+          bottom,
+          width - left,
+          top,
+          width - right,
+        );
+      case 2:
+        return PdfRect(
+          width - right,
+          height - bottom,
+          width - left,
+          height - top,
+        );
+      case 3:
+        return PdfRect(
+          height - top,
+          right,
+          height - bottom,
+          left,
+        );
+      default:
+        throw ArgumentError.value(rotate, 'rotate');
+    }
+  }
 
   @override
   bool operator ==(Object other) {