[PDF Ink Signatures] Clean up PdfInkBrush code

- Change GetInkBrush() to an accessor, since that is what it is.
- Mark `ink_brush_` as const.
- Clarify comments.
- Remove an unused #include.

Change-Id: Ib08ddb893dfba56737851d0b7428a882e4b6355c
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5918058
Reviewed-by: Andy Phan <andyphan@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1366264}

pdf/pdf_ink_brush.cc

@@ -103,10 +103,6 @@ PdfInkBrush::PdfInkBrush(Type brush_type, Params brush_params)
 
 PdfInkBrush::~PdfInkBrush() = default;
 
-const ink::Brush& PdfInkBrush::GetInkBrush() const {
-  return ink_brush_;
-}
-
 gfx::Rect PdfInkBrush::GetInvalidateArea(const gfx::PointF& center1,
                                          const gfx::PointF& center2) const {
   // For a line connecting `center1` to `center2`, the invalidate

pdf/pdf_ink_brush.h

@@ -5,7 +5,6 @@
 #ifndef PDF_PDF_INK_BRUSH_H_
 #define PDF_PDF_INK_BRUSH_H_
 
-#include <memory>
 #include <optional>
 #include <string>
 
@@ -19,7 +18,7 @@ class PointF;
 
 namespace chrome_pdf {
 
-// A class used to create ink brushes for PDF annotation mode and support
+// A class used to create Ink brushes for PDF annotation mode and support
 // invalidation for rendering.
 class PdfInkBrush {
  public:
@@ -36,7 +35,6 @@ class PdfInkBrush {
   };
 
   PdfInkBrush(Type brush_type, Params brush_params);
-
   PdfInkBrush(const PdfInkBrush&) = delete;
   PdfInkBrush& operator=(const PdfInkBrush&) = delete;
   ~PdfInkBrush();
@@ -55,12 +53,11 @@ class PdfInkBrush {
   // Returns whether `size` is in range or not.
   static bool IsToolSizeInRange(float size);
 
-  // Returns the `ink::Brush` that `this` represents.
-  const ink::Brush& GetInkBrush() const;
+  const ink::Brush& ink_brush() const { return ink_brush_; }
 
  private:
-  // The ink brush of type `type_` with params` params_`.
-  ink::Brush ink_brush_;
+  // The Ink brush initialized based on the PdfInkBrush ctor parameters.
+  const ink::Brush ink_brush_;
 };
 
 }  // namespace chrome_pdf

pdf/pdf_ink_module.cc

@@ -662,7 +662,7 @@ PdfInkModule::CreateInProgressStrokeSegmentsFromInputs() const {
     }
 
     ink::InProgressStroke stroke;
-    stroke.Start(state.brush->GetInkBrush());
+    stroke.Start(state.brush->ink_brush());
     auto enqueue_results =
         stroke.EnqueueInputs(segment, /*predicted_inputs=*/{});
     CHECK(enqueue_results.ok());
@@ -824,7 +824,7 @@ void PdfInkModule::MaybeSetCursor() {
   SkColor color;
   float brush_size;
   if (is_drawing_stroke()) {
-    const auto& ink_brush = drawing_stroke_state().brush->GetInkBrush();
+    const auto& ink_brush = drawing_stroke_state().brush->ink_brush();
     color = GetSkColorFromInkBrush(ink_brush);
     brush_size = ink_brush.GetSize();
   } else {

pdf/pdf_ink_module_unittest.cc

@@ -303,7 +303,7 @@ TEST_F(PdfInkModuleTest, HandleSetAnnotationBrushMessagePen) {
   const PdfInkBrush* brush = ink_module().GetPdfInkBrushForTesting();
   ASSERT_TRUE(brush);
 
-  const ink::Brush& ink_brush = brush->GetInkBrush();
+  const ink::Brush& ink_brush = brush->ink_brush();
   EXPECT_EQ(ink::Color::FromUint8(/*red=*/10, /*green=*/255, /*blue=*/50,
                                   /*alpha=*/255),
             ink_brush.GetColor());
@@ -331,7 +331,7 @@ TEST_F(PdfInkModuleTest, HandleSetAnnotationBrushMessageHighlighter) {
   const PdfInkBrush* brush = ink_module().GetPdfInkBrushForTesting();
   ASSERT_TRUE(brush);
 
-  const ink::Brush& ink_brush = brush->GetInkBrush();
+  const ink::Brush& ink_brush = brush->ink_brush();
   EXPECT_EQ(ink::Color::FromUint8(/*red=*/240, /*green=*/133, /*blue=*/0,
                                   /*alpha=*/255),
             ink_brush.GetColor());
@@ -358,7 +358,7 @@ TEST_F(PdfInkModuleTest, HandleSetAnnotationBrushMessageColorZero) {
   const PdfInkBrush* brush = ink_module().GetPdfInkBrushForTesting();
   ASSERT_TRUE(brush);
 
-  const ink::Brush& ink_brush = brush->GetInkBrush();
+  const ink::Brush& ink_brush = brush->ink_brush();
   EXPECT_EQ(ink::Color::Black(), ink_brush.GetColor());
   EXPECT_EQ(4.5f, ink_brush.GetSize());
   ASSERT_EQ(1u, ink_brush.CoatCount());
@@ -1306,10 +1306,10 @@ TEST_F(PdfInkModuleGetVisibleStrokesTest, MultiplePageStrokes) {
   EXPECT_THAT(
       collected_strokes,
       ElementsAre(
-          Pair(0, Pointwise(InkStrokeEq(brush->GetInkBrush()),
+          Pair(0, Pointwise(InkStrokeEq(brush->ink_brush()),
                             {expected_page0_horz_line_input_batch.value(),
                              expected_page0_vert_line_input_batch.value()})),
-          Pair(1, Pointwise(InkStrokeEq(brush->GetInkBrush()),
+          Pair(1, Pointwise(InkStrokeEq(brush->ink_brush()),
                             {expected_page1_horz_line_input_batch.value()}))));
 }
 

pdf/pdfium/pdfium_ink_writer_unittest.cc

@@ -130,7 +130,7 @@ TEST_P(PDFiumInkWriterTest, Basic) {
   std::optional<ink::StrokeInputBatch> inputs =
       CreateInkInputBatch(kBasicInputs);
   ASSERT_TRUE(inputs.has_value());
-  ink::Stroke stroke(brush->GetInkBrush(), inputs.value());
+  ink::Stroke stroke(brush->ink_brush(), inputs.value());
   ASSERT_TRUE(WriteStrokeToPage(engine->doc(), page, stroke));
 
   ASSERT_TRUE(FPDFPage_GenerateContent(page));
@@ -155,7 +155,7 @@ TEST_P(PDFiumInkWriterTest, EmptyStroke) {
 
   auto brush =
       std::make_unique<PdfInkBrush>(PdfInkBrush::Type::kPen, kBasicBrushParams);
-  ink::Stroke unused_stroke(brush->GetInkBrush());
+  ink::Stroke unused_stroke(brush->ink_brush());
   ASSERT_FALSE(WriteStrokeToPage(engine->doc(), page, unused_stroke));
 }
 
@@ -171,7 +171,7 @@ TEST_P(PDFiumInkWriterTest, NoDocumentNoPage) {
 
   auto brush =
       std::make_unique<PdfInkBrush>(PdfInkBrush::Type::kPen, kBasicBrushParams);
-  ink::Stroke unused_stroke(brush->GetInkBrush());
+  ink::Stroke unused_stroke(brush->ink_brush());
   ASSERT_FALSE(
       WriteStrokeToPage(/*document=*/nullptr, /*page=*/nullptr, unused_stroke));
   ASSERT_FALSE(WriteStrokeToPage(/*document=*/nullptr, page, unused_stroke));