blob: 8988c56a9b0ded5099548696c66b0ac0a60ef280 [file] [log] [blame]
// Copyright 2016 PDFium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
#ifndef CORE_FPDFDOC_CPDF_ANNOT_H_
#define CORE_FPDFDOC_CPDF_ANNOT_H_
#include <stddef.h>
#include <stdint.h>
#include <map>
#include <memory>
#include "core/fxcrt/fx_coordinates.h"
#include "core/fxcrt/fx_string.h"
#include "core/fxcrt/maybe_owned.h"
#include "core/fxcrt/retain_ptr.h"
#include "core/fxcrt/unowned_ptr.h"
class CFX_RenderDevice;
class CPDF_Array;
class CPDF_Dictionary;
class CPDF_Document;
class CPDF_Form;
class CPDF_Page;
class CPDF_RenderContext;
class CPDF_RenderOptions;
class CPDF_Stream;
class CPDF_Annot {
public:
enum class AppearanceMode { kNormal, kRollover, kDown };
enum class Subtype : uint8_t {
UNKNOWN = 0,
TEXT,
LINK,
FREETEXT,
LINE,
SQUARE,
CIRCLE,
POLYGON,
POLYLINE,
HIGHLIGHT,
UNDERLINE,
SQUIGGLY,
STRIKEOUT,
STAMP,
CARET,
INK,
POPUP,
FILEATTACHMENT,
SOUND,
MOVIE,
WIDGET,
SCREEN,
PRINTERMARK,
TRAPNET,
WATERMARK,
THREED,
RICHMEDIA,
XFAWIDGET,
REDACT
};
static Subtype StringToAnnotSubtype(const ByteString& sSubtype);
static ByteString AnnotSubtypeToString(Subtype nSubtype);
static CFX_FloatRect RectFromQuadPointsArray(const CPDF_Array* pArray,
size_t nIndex);
static CFX_FloatRect BoundingRectFromQuadPoints(
const CPDF_Dictionary* pAnnotDict);
static CFX_FloatRect RectFromQuadPoints(const CPDF_Dictionary* pAnnotDict,
size_t nIndex);
static size_t QuadPointCount(const CPDF_Array* pArray);
CPDF_Annot(CPDF_Dictionary* pDict, CPDF_Document* pDocument);
~CPDF_Annot();
Subtype GetSubtype() const;
uint32_t GetFlags() const;
CFX_FloatRect GetRect() const;
CPDF_Document* GetDocument() const { return m_pDocument.Get(); }
const CPDF_Dictionary* GetAnnotDict() const { return m_pAnnotDict.Get(); }
CPDF_Dictionary* GetAnnotDict() { return m_pAnnotDict.Get(); }
bool IsHidden() const;
bool DrawAppearance(CPDF_Page* pPage,
CFX_RenderDevice* pDevice,
const CFX_Matrix& mtUser2Device,
AppearanceMode mode,
const CPDF_RenderOptions* pOptions);
bool DrawInContext(const CPDF_Page* pPage,
CPDF_RenderContext* pContext,
const CFX_Matrix& mtUser2Device,
AppearanceMode mode);
void ClearCachedAP();
void DrawBorder(CFX_RenderDevice* pDevice,
const CFX_Matrix* pUser2Device,
const CPDF_RenderOptions* pOptions);
CPDF_Form* GetAPForm(const CPDF_Page* pPage, AppearanceMode mode);
void SetOpenState(bool bOpenState) { m_bOpenState = bOpenState; }
CPDF_Annot* GetPopupAnnot() const { return m_pPopupAnnot.Get(); }
void SetPopupAnnot(CPDF_Annot* pAnnot) { m_pPopupAnnot = pAnnot; }
private:
void GenerateAPIfNeeded();
bool ShouldGenerateAP() const;
bool ShouldDrawAnnotation() const;
CFX_FloatRect RectForDrawing() const;
RetainPtr<CPDF_Dictionary> const m_pAnnotDict;
UnownedPtr<CPDF_Document> const m_pDocument;
std::map<CPDF_Stream*, std::unique_ptr<CPDF_Form>> m_APMap;
// If non-null, then this is not a popup annotation.
UnownedPtr<CPDF_Annot> m_pPopupAnnot;
const Subtype m_nSubtype;
const bool m_bIsTextMarkupAnnotation;
// |m_bOpenState| is only set for popup annotations.
bool m_bOpenState = false;
bool m_bHasGeneratedAP;
};
// Get the AP in an annotation dict for a given appearance mode.
// If |eMode| is not Normal and there is not AP for that mode, falls back to
// the Normal AP.
CPDF_Stream* GetAnnotAP(CPDF_Dictionary* pAnnotDict,
CPDF_Annot::AppearanceMode eMode);
// Get the AP in an annotation dict for a given appearance mode.
// No fallbacks to Normal like in GetAnnotAP.
CPDF_Stream* GetAnnotAPNoFallback(CPDF_Dictionary* pAnnotDict,
CPDF_Annot::AppearanceMode eMode);
#endif // CORE_FPDFDOC_CPDF_ANNOT_H_