123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340 |
- // Copyright 2020 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- #ifndef PDF_PDF_VIEW_PLUGIN_BASE_H_
- #define PDF_PDF_VIEW_PLUGIN_BASE_H_
- #include <stdint.h>
- #include <memory>
- #include <string>
- #include <utility>
- #include <vector>
- #include "base/callback.h"
- #include "base/i18n/rtl.h"
- #include "base/memory/weak_ptr.h"
- #include "base/strings/string_piece.h"
- #include "base/values.h"
- #include "pdf/accessibility_structs.h"
- #include "pdf/paint_manager.h"
- #include "pdf/pdf_engine.h"
- #include "pdf/pdfium/pdfium_form_filler.h"
- #include "third_party/abseil-cpp/absl/types/optional.h"
- #include "third_party/blink/public/web/web_print_params.h"
- #include "third_party/skia/include/core/SkBitmap.h"
- #include "ui/gfx/geometry/rect.h"
- namespace gfx {
- class PointF;
- class Vector2d;
- class Vector2dF;
- } // namespace gfx
- namespace chrome_pdf {
- class PDFiumEngine;
- class PaintReadyRect;
- struct AccessibilityCharInfo;
- struct AccessibilityDocInfo;
- struct AccessibilityPageInfo;
- struct AccessibilityPageObjects;
- struct AccessibilityTextRunInfo;
- struct AccessibilityViewportInfo;
- // TODO(crbug.com/1302059): Merge with PdfViewWebPlugin.
- class PdfViewPluginBase : public PDFEngine::Client,
- public PaintManager::Client {
- public:
- // Do not save files with over 100 MB. This cap should be kept in sync with
- // and is also enforced in chrome/browser/resources/pdf/pdf_viewer.js.
- static constexpr size_t kMaximumSavedFileSize = 100 * 1000 * 1000;
- enum class AccessibilityState {
- kOff = 0, // Off.
- kPending, // Enabled but waiting for doc to load.
- kLoaded, // Fully loaded.
- };
- enum class DocumentLoadState {
- kLoading = 0,
- kComplete,
- kFailed,
- };
- PdfViewPluginBase(const PdfViewPluginBase& other) = delete;
- PdfViewPluginBase& operator=(const PdfViewPluginBase& other) = delete;
- // PDFEngine::Client:
- void Invalidate(const gfx::Rect& rect) override;
- void DidScroll(const gfx::Vector2d& offset) override;
- void ScrollToX(int x_screen_coords) override;
- void ScrollToY(int y_screen_coords) override;
- void ScrollBy(const gfx::Vector2d& delta) override;
- void ScrollToPage(int page) override;
- void NavigateTo(const std::string& url,
- WindowOpenDisposition disposition) override;
- void NavigateToDestination(int page,
- const float* x,
- const float* y,
- const float* zoom) override;
- void NotifyTouchSelectionOccurred() override;
- void Email(const std::string& to,
- const std::string& cc,
- const std::string& bcc,
- const std::string& subject,
- const std::string& body) override;
- void DocumentLoadComplete() override;
- void DocumentLoadFailed() override;
- void DocumentLoadProgress(uint32_t available, uint32_t doc_size) override;
- void FormFieldFocusChange(PDFEngine::FocusFieldType type) override;
- void SetIsSelecting(bool is_selecting) override;
- void SelectionChanged(const gfx::Rect& left, const gfx::Rect& right) override;
- void DocumentFocusChanged(bool document_has_focus) override;
- // PaintManager::Client:
- void OnPaint(const std::vector<gfx::Rect>& paint_rects,
- std::vector<PaintReadyRect>& ready,
- std::vector<gfx::Rect>& pending) override;
- // Gets the content restrictions based on the permissions which `engine_` has.
- int GetContentRestrictions() const;
- // Gets the accessibility doc info based on the information from `engine_`.
- AccessibilityDocInfo GetAccessibilityDocInfo() const;
- DocumentLoadState document_load_state_for_testing() const {
- return document_load_state_;
- }
- protected:
- struct BackgroundPart {
- gfx::Rect location;
- uint32_t color;
- };
- PdfViewPluginBase();
- ~PdfViewPluginBase() override;
- // Creates a new `PDFiumEngine`.
- virtual std::unique_ptr<PDFiumEngine> CreateEngine(
- PDFEngine::Client* client,
- PDFiumFormFiller::ScriptOption script_option) = 0;
- virtual const PDFiumEngine* engine() const = 0;
- virtual PDFiumEngine* engine() = 0;
- // Gets a weak pointer with a lifetime matching the derived class.
- virtual base::WeakPtr<PdfViewPluginBase> GetWeakPtr() = 0;
- // Runs when document load completes in Print Preview, before
- // `OnDocumentLoadComplete()`.
- virtual void OnPrintPreviewLoaded() = 0;
- // Runs when document load completes.
- virtual void OnDocumentLoadComplete() = 0;
- // Enqueues a "message" event carrying `message` to the embedder. Messages are
- // guaranteed to be received in the order that they are sent. This method is
- // non-blocking.
- virtual void SendMessage(base::Value::Dict message) = 0;
- // Sends the loading progress, where `percentage` represents the progress, or
- // -1 for loading error.
- void SendLoadingProgress(double percentage);
- // Schedules invalidation tasks after painting finishes.
- void InvalidateAfterPaintDone();
- // Updates the available area and the background parts, notifies the PDF
- // engine, and updates the accessibility information.
- void OnGeometryChanged(double old_zoom, float old_device_scale);
- // A helper of OnGeometryChanged() which updates the available area and
- // the background parts, and notifies the PDF engine of geometry changes.
- void RecalculateAreas(double old_zoom, float old_device_scale);
- // Figures out the location of any background rectangles (i.e. those that
- // aren't painted by the PDF engine).
- void CalculateBackgroundParts();
- // Computes document width/height in device pixels, based on current zoom and
- // device scale
- int GetDocumentPixelWidth() const;
- int GetDocumentPixelHeight() const;
- // Sets the text input type for this plugin based on `in_focus`.
- virtual void SetFormTextFieldInFocus(bool in_focus) = 0;
- // Sets the accessibility information about the PDF document in the renderer.
- virtual void SetAccessibilityDocInfo(AccessibilityDocInfo doc_info) = 0;
- // Sets the accessibility information about the given `page_index` in the
- // renderer.
- void PrepareAndSetAccessibilityPageInfo(int32_t page_index);
- // Sets the accessibility information about the page in the renderer.
- virtual void SetAccessibilityPageInfo(
- AccessibilityPageInfo page_info,
- std::vector<AccessibilityTextRunInfo> text_runs,
- std::vector<AccessibilityCharInfo> chars,
- AccessibilityPageObjects page_objects) = 0;
- // Prepares the accessibility information about the current viewport. Calls
- // SetAccessibilityViewportInfo() internally to set this information in the
- // renderer. This is done once when accessibility is first loaded and again
- // when the geometry changes.
- void PrepareAndSetAccessibilityViewportInfo();
- // Sets the accessibility information about the current viewport in the
- // renderer.
- virtual void SetAccessibilityViewportInfo(
- AccessibilityViewportInfo viewport_info) = 0;
- // Prints the pages specified by `page_numbers` using the parameters passed to
- // `PrintBegin()` Returns a vector of bytes containing the printed output. An
- // empty returned value indicates failure.
- std::vector<uint8_t> PrintPages(const std::vector<int>& page_numbers);
- // Disables browser commands because of restrictions on how the data is to be
- // used (i.e. can't copy/print). `content_restrictions` should have its bits
- // set by `chrome_pdf::ContentRestriction` enum values.
- virtual void SetContentRestrictions(int content_restrictions) = 0;
- // Sends start/stop loading notifications to the plugin's render frame.
- virtual void DidStartLoading() = 0;
- virtual void DidStopLoading() = 0;
- // Notifies the embedder of the top-left and bottom-right coordinates of the
- // current selection.
- virtual void NotifySelectionChanged(const gfx::PointF& left,
- int left_height,
- const gfx::PointF& right,
- int right_height) = 0;
- // Records user actions.
- virtual void UserMetricsRecordAction(const std::string& action) = 0;
- PaintManager& paint_manager() { return paint_manager_; }
- SkBitmap& image_data() { return image_data_; }
- virtual bool full_frame() const = 0;
- const gfx::Rect& available_area() const { return available_area_; }
- const gfx::Size& document_size() const { return document_size_; }
- void set_document_size(const gfx::Size& size) { document_size_ = size; }
- virtual const gfx::Size& plugin_dip_size() const = 0;
- // TODO(crbug.com/1288847): Don't provide direct access to the origin of
- // `plugin_rect_`, as this exposes the unintuitive "paint offset."
- virtual const gfx::Rect& plugin_rect() const = 0;
- // Sets the new zoom scale.
- void SetZoom(double scale);
- double zoom() const { return zoom_; }
- virtual float device_scale() const = 0;
- virtual bool needs_reraster() const = 0;
- virtual base::i18n::TextDirection ui_direction() const = 0;
- virtual bool received_viewport_message() const = 0;
- double last_progress_sent() const { return last_progress_sent_; }
- void set_last_progress_sent(double progress) {
- last_progress_sent_ = progress;
- }
- DocumentLoadState document_load_state() const { return document_load_state_; }
- void set_document_load_state(DocumentLoadState state) {
- document_load_state_ = state;
- }
- AccessibilityState accessibility_state() const {
- return accessibility_state_;
- }
- void set_accessibility_state(AccessibilityState state) {
- accessibility_state_ = state;
- }
- static constexpr bool IsSaveDataSizeValid(size_t size) {
- return size > 0 && size <= kMaximumSavedFileSize;
- }
- // Converts a scroll offset (which is relative to a UI direction-dependent
- // scroll origin) to a scroll position (which is always relative to the
- // top-left corner).
- gfx::PointF GetScrollPositionFromOffset(
- const gfx::Vector2dF& scroll_offset) const;
- // Paints the given invalid area of the plugin to the given graphics device.
- // PaintManager::Client::OnPaint() should be its only caller.
- void DoPaint(const std::vector<gfx::Rect>& paint_rects,
- std::vector<PaintReadyRect>& ready,
- std::vector<gfx::Rect>& pending);
- // The preparation when painting on the image data buffer for the first
- // time.
- virtual void PrepareForFirstPaint(std::vector<PaintReadyRect>& ready) = 0;
- // Callback to clear deferred invalidates after painting finishes.
- void ClearDeferredInvalidates();
- // Starts loading accessibility information.
- void LoadAccessibility();
- // Converts `frame_coordinates` to PDF coordinates.
- gfx::Point FrameToPdfCoordinates(const gfx::PointF& frame_coordinates) const;
- private:
- // TODO(crbug.com/1302059): `PdfViewPluginBase` is being merged into
- // `PdfViewWebPlugin`, so all methods should be protected or public.
- PaintManager paint_manager_{this};
- // Image data buffer for painting.
- SkBitmap image_data_;
- std::vector<BackgroundPart> background_parts_;
- // Deferred invalidates while `in_paint_` is true.
- std::vector<gfx::Rect> deferred_invalidates_;
- // Remaining area, in pixels, to render the pdf in after accounting for
- // horizontal centering.
- gfx::Rect available_area_;
- // The size of the entire document in pixels (i.e. if each page is 800 pixels
- // high and there are 10 pages, the height will be 8000).
- gfx::Size document_size_;
- // Current zoom factor.
- double zoom_ = 1.0;
- // Whether OnPaint() is in progress or not.
- bool in_paint_ = false;
- // The last document load progress value sent to the web page.
- double last_progress_sent_ = 0.0;
- // The current state of document load.
- DocumentLoadState document_load_state_ = DocumentLoadState::kLoading;
- // The current state of accessibility.
- AccessibilityState accessibility_state_ = AccessibilityState::kOff;
- // The next accessibility page index, used to track interprocess calls when
- // reconstructing the tree for new document layouts.
- int32_t next_accessibility_page_index_ = 0;
- };
- } // namespace chrome_pdf
- #endif // PDF_PDF_VIEW_PLUGIN_BASE_H_
|