blob: 129491c210ef3d98e2ed4a652b51cba7f4d068e4 [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
#include "fpdfsdk/cpdfsdk_baannot.h"
#include <algorithm>
#include <utility>
#include "core/fpdfapi/parser/cpdf_array.h"
#include "core/fpdfapi/parser/cpdf_document.h"
#include "core/fpdfapi/parser/cpdf_name.h"
#include "core/fpdfapi/parser/cpdf_number.h"
#include "core/fpdfapi/parser/cpdf_reference.h"
#include "core/fpdfapi/parser/cpdf_stream.h"
#include "core/fpdfapi/parser/cpdf_string.h"
#include "core/fpdfapi/parser/fpdf_parser_decode.h"
#include "fpdfsdk/cpdfsdk_datetime.h"
#include "fpdfsdk/cpdfsdk_pageview.h"
CPDFSDK_BAAnnot::CPDFSDK_BAAnnot(CPDF_Annot* pAnnot,
CPDFSDK_PageView* pPageView)
: CPDFSDK_Annot(pPageView), m_pAnnot(pAnnot) {}
CPDFSDK_BAAnnot::~CPDFSDK_BAAnnot() {}
CPDF_Annot* CPDFSDK_BAAnnot::GetPDFAnnot() const {
return m_pAnnot;
}
CPDF_Annot* CPDFSDK_BAAnnot::GetPDFPopupAnnot() const {
return m_pAnnot->GetPopupAnnot();
}
CPDF_Dictionary* CPDFSDK_BAAnnot::GetAnnotDict() const {
return m_pAnnot->GetAnnotDict();
}
void CPDFSDK_BAAnnot::SetRect(const CFX_FloatRect& rect) {
ASSERT(rect.right - rect.left >= GetMinWidth());
ASSERT(rect.top - rect.bottom >= GetMinHeight());
m_pAnnot->GetAnnotDict()->SetRectFor("Rect", rect);
}
CFX_FloatRect CPDFSDK_BAAnnot::GetRect() const {
return m_pAnnot->GetRect();
}
CPDF_Annot::Subtype CPDFSDK_BAAnnot::GetAnnotSubtype() const {
return m_pAnnot->GetSubtype();
}
void CPDFSDK_BAAnnot::DrawAppearance(CFX_RenderDevice* pDevice,
const CFX_Matrix* pUser2Device,
CPDF_Annot::AppearanceMode mode,
const CPDF_RenderOptions* pOptions) {
m_pAnnot->DrawAppearance(m_pPageView->GetPDFPage(), pDevice, pUser2Device,
mode, pOptions);
}
bool CPDFSDK_BAAnnot::IsAppearanceValid() {
return !!m_pAnnot->GetAnnotDict()->GetDictFor("AP");
}
bool CPDFSDK_BAAnnot::IsAppearanceValid(CPDF_Annot::AppearanceMode mode) {
CPDF_Dictionary* pAP = m_pAnnot->GetAnnotDict()->GetDictFor("AP");
if (!pAP)
return false;
// Choose the right sub-ap
const char* ap_entry = "N";
if (mode == CPDF_Annot::Down)
ap_entry = "D";
else if (mode == CPDF_Annot::Rollover)
ap_entry = "R";
if (!pAP->KeyExist(ap_entry))
ap_entry = "N";
// Get the AP stream or subdirectory
CPDF_Object* psub = pAP->GetDirectObjectFor(ap_entry);
return !!psub;
}
void CPDFSDK_BAAnnot::DrawBorder(CFX_RenderDevice* pDevice,
const CFX_Matrix* pUser2Device,
const CPDF_RenderOptions* pOptions) {
m_pAnnot->DrawBorder(pDevice, pUser2Device, pOptions);
}
void CPDFSDK_BAAnnot::ClearCachedAP() {
m_pAnnot->ClearCachedAP();
}
void CPDFSDK_BAAnnot::SetContents(const CFX_WideString& sContents) {
if (sContents.IsEmpty()) {
m_pAnnot->GetAnnotDict()->RemoveFor("Contents");
} else {
m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_String>(
"Contents", PDF_EncodeText(sContents), false);
}
}
CFX_WideString CPDFSDK_BAAnnot::GetContents() const {
return m_pAnnot->GetAnnotDict()->GetUnicodeTextFor("Contents");
}
void CPDFSDK_BAAnnot::SetAnnotName(const CFX_WideString& sName) {
if (sName.IsEmpty()) {
m_pAnnot->GetAnnotDict()->RemoveFor("NM");
} else {
m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_String>(
"NM", PDF_EncodeText(sName), false);
}
}
CFX_WideString CPDFSDK_BAAnnot::GetAnnotName() const {
return m_pAnnot->GetAnnotDict()->GetUnicodeTextFor("NM");
}
void CPDFSDK_BAAnnot::SetModifiedDate(const FX_SYSTEMTIME& st) {
CPDFSDK_DateTime dt(st);
CFX_ByteString str = dt.ToPDFDateTimeString();
if (str.IsEmpty())
m_pAnnot->GetAnnotDict()->RemoveFor("M");
else
m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_String>("M", str, false);
}
FX_SYSTEMTIME CPDFSDK_BAAnnot::GetModifiedDate() const {
FX_SYSTEMTIME systime;
CFX_ByteString str = m_pAnnot->GetAnnotDict()->GetStringFor("M");
CPDFSDK_DateTime dt(str);
dt.ToSystemTime(systime);
return systime;
}
void CPDFSDK_BAAnnot::SetFlags(uint32_t nFlags) {
m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_Number>("F",
static_cast<int>(nFlags));
}
uint32_t CPDFSDK_BAAnnot::GetFlags() const {
return m_pAnnot->GetAnnotDict()->GetIntegerFor("F");
}
void CPDFSDK_BAAnnot::SetAppState(const CFX_ByteString& str) {
if (str.IsEmpty())
m_pAnnot->GetAnnotDict()->RemoveFor("AS");
else
m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_String>("AS", str, false);
}
CFX_ByteString CPDFSDK_BAAnnot::GetAppState() const {
return m_pAnnot->GetAnnotDict()->GetStringFor("AS");
}
void CPDFSDK_BAAnnot::SetStructParent(int key) {
m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_Number>("StructParent", key);
}
int CPDFSDK_BAAnnot::GetStructParent() const {
return m_pAnnot->GetAnnotDict()->GetIntegerFor("StructParent");
}
// border
void CPDFSDK_BAAnnot::SetBorderWidth(int nWidth) {
CPDF_Array* pBorder = m_pAnnot->GetAnnotDict()->GetArrayFor("Border");
if (pBorder) {
pBorder->SetNewAt<CPDF_Number>(2, nWidth);
} else {
CPDF_Dictionary* pBSDict = m_pAnnot->GetAnnotDict()->GetDictFor("BS");
if (!pBSDict)
pBSDict = m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_Dictionary>("BS");
pBSDict->SetNewFor<CPDF_Number>("W", nWidth);
}
}
int CPDFSDK_BAAnnot::GetBorderWidth() const {
if (CPDF_Array* pBorder = m_pAnnot->GetAnnotDict()->GetArrayFor("Border"))
return pBorder->GetIntegerAt(2);
if (CPDF_Dictionary* pBSDict = m_pAnnot->GetAnnotDict()->GetDictFor("BS"))
return pBSDict->GetIntegerFor("W", 1);
return 1;
}
void CPDFSDK_BAAnnot::SetBorderStyle(BorderStyle nStyle) {
CPDF_Dictionary* pBSDict = m_pAnnot->GetAnnotDict()->GetDictFor("BS");
if (!pBSDict)
pBSDict = m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_Dictionary>("BS");
switch (nStyle) {
case BorderStyle::SOLID:
pBSDict->SetNewFor<CPDF_Name>("S", "S");
break;
case BorderStyle::DASH:
pBSDict->SetNewFor<CPDF_Name>("S", "D");
break;
case BorderStyle::BEVELED:
pBSDict->SetNewFor<CPDF_Name>("S", "B");
break;
case BorderStyle::INSET:
pBSDict->SetNewFor<CPDF_Name>("S", "I");
break;
case BorderStyle::UNDERLINE:
pBSDict->SetNewFor<CPDF_Name>("S", "U");
break;
default:
break;
}
}
BorderStyle CPDFSDK_BAAnnot::GetBorderStyle() const {
CPDF_Dictionary* pBSDict = m_pAnnot->GetAnnotDict()->GetDictFor("BS");
if (pBSDict) {
CFX_ByteString sBorderStyle = pBSDict->GetStringFor("S", "S");
if (sBorderStyle == "S")
return BorderStyle::SOLID;
if (sBorderStyle == "D")
return BorderStyle::DASH;
if (sBorderStyle == "B")
return BorderStyle::BEVELED;
if (sBorderStyle == "I")
return BorderStyle::INSET;
if (sBorderStyle == "U")
return BorderStyle::UNDERLINE;
}
CPDF_Array* pBorder = m_pAnnot->GetAnnotDict()->GetArrayFor("Border");
if (pBorder) {
if (pBorder->GetCount() >= 4) {
CPDF_Array* pDP = pBorder->GetArrayAt(3);
if (pDP && pDP->GetCount() > 0)
return BorderStyle::DASH;
}
}
return BorderStyle::SOLID;
}
void CPDFSDK_BAAnnot::SetColor(FX_COLORREF color) {
CPDF_Array* pArray = m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_Array>("C");
pArray->AddNew<CPDF_Number>(static_cast<float>(FXSYS_GetRValue(color)) /
255.0f);
pArray->AddNew<CPDF_Number>(static_cast<float>(FXSYS_GetGValue(color)) /
255.0f);
pArray->AddNew<CPDF_Number>(static_cast<float>(FXSYS_GetBValue(color)) /
255.0f);
}
void CPDFSDK_BAAnnot::RemoveColor() {
m_pAnnot->GetAnnotDict()->RemoveFor("C");
}
bool CPDFSDK_BAAnnot::GetColor(FX_COLORREF& color) const {
if (CPDF_Array* pEntry = m_pAnnot->GetAnnotDict()->GetArrayFor("C")) {
size_t nCount = pEntry->GetCount();
if (nCount == 1) {
float g = pEntry->GetNumberAt(0) * 255;
color = FXSYS_RGB((int)g, (int)g, (int)g);
return true;
} else if (nCount == 3) {
float r = pEntry->GetNumberAt(0) * 255;
float g = pEntry->GetNumberAt(1) * 255;
float b = pEntry->GetNumberAt(2) * 255;
color = FXSYS_RGB((int)r, (int)g, (int)b);
return true;
} else if (nCount == 4) {
float c = pEntry->GetNumberAt(0);
float m = pEntry->GetNumberAt(1);
float y = pEntry->GetNumberAt(2);
float k = pEntry->GetNumberAt(3);
float r = 1.0f - std::min(1.0f, c + k);
float g = 1.0f - std::min(1.0f, m + k);
float b = 1.0f - std::min(1.0f, y + k);
color = FXSYS_RGB((int)(r * 255), (int)(g * 255), (int)(b * 255));
return true;
}
}
return false;
}
void CPDFSDK_BAAnnot::WriteAppearance(const CFX_ByteString& sAPType,
const CFX_FloatRect& rcBBox,
const CFX_Matrix& matrix,
const CFX_ByteString& sContents,
const CFX_ByteString& sAPState) {
CPDF_Dictionary* pAPDict = m_pAnnot->GetAnnotDict()->GetDictFor("AP");
if (!pAPDict)
pAPDict = m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_Dictionary>("AP");
CPDF_Stream* pStream = nullptr;
CPDF_Dictionary* pParentDict = nullptr;
if (sAPState.IsEmpty()) {
pParentDict = pAPDict;
pStream = pAPDict->GetStreamFor(sAPType);
} else {
CPDF_Dictionary* pAPTypeDict = pAPDict->GetDictFor(sAPType);
if (!pAPTypeDict)
pAPTypeDict = pAPDict->SetNewFor<CPDF_Dictionary>(sAPType);
pParentDict = pAPTypeDict;
pStream = pAPTypeDict->GetStreamFor(sAPState);
}
if (!pStream) {
CPDF_Document* pDoc = m_pPageView->GetPDFDocument();
pStream = pDoc->NewIndirect<CPDF_Stream>();
pParentDict->SetNewFor<CPDF_Reference>(sAPType, pDoc, pStream->GetObjNum());
}
CPDF_Dictionary* pStreamDict = pStream->GetDict();
if (!pStreamDict) {
auto pNewDict = pdfium::MakeUnique<CPDF_Dictionary>(
m_pAnnot->GetDocument()->GetByteStringPool());
pStreamDict = pNewDict.get();
pStreamDict->SetNewFor<CPDF_Name>("Type", "XObject");
pStreamDict->SetNewFor<CPDF_Name>("Subtype", "Form");
pStreamDict->SetNewFor<CPDF_Number>("FormType", 1);
pStream->InitStream(nullptr, 0, std::move(pNewDict));
}
pStreamDict->SetMatrixFor("Matrix", matrix);
pStreamDict->SetRectFor("BBox", rcBBox);
pStream->SetData((uint8_t*)sContents.c_str(), sContents.GetLength());
}
bool CPDFSDK_BAAnnot::IsVisible() const {
uint32_t nFlags = GetFlags();
return !((nFlags & ANNOTFLAG_INVISIBLE) || (nFlags & ANNOTFLAG_HIDDEN) ||
(nFlags & ANNOTFLAG_NOVIEW));
}
CPDF_Action CPDFSDK_BAAnnot::GetAction() const {
return CPDF_Action(m_pAnnot->GetAnnotDict()->GetDictFor("A"));
}
void CPDFSDK_BAAnnot::SetAction(const CPDF_Action& action) {
CPDF_Dictionary* pDict = action.GetDict();
if (pDict != m_pAnnot->GetAnnotDict()->GetDictFor("A")) {
CPDF_Document* pDoc = m_pPageView->GetPDFDocument();
if (pDict->IsInline())
pDict = pDoc->AddIndirectObject(pDict->Clone())->AsDictionary();
m_pAnnot->GetAnnotDict()->SetNewFor<CPDF_Reference>("A", pDoc,
pDict->GetObjNum());
}
}
void CPDFSDK_BAAnnot::RemoveAction() {
m_pAnnot->GetAnnotDict()->RemoveFor("A");
}
CPDF_AAction CPDFSDK_BAAnnot::GetAAction() const {
return CPDF_AAction(m_pAnnot->GetAnnotDict()->GetDictFor("AA"));
}
void CPDFSDK_BAAnnot::SetAAction(const CPDF_AAction& aa) {
if (aa.GetDict() != m_pAnnot->GetAnnotDict()->GetDictFor("AA"))
m_pAnnot->GetAnnotDict()->SetFor("AA", pdfium::WrapUnique(aa.GetDict()));
}
void CPDFSDK_BAAnnot::RemoveAAction() {
m_pAnnot->GetAnnotDict()->RemoveFor("AA");
}
CPDF_Action CPDFSDK_BAAnnot::GetAAction(CPDF_AAction::AActionType eAAT) {
CPDF_AAction AAction = GetAAction();
if (AAction.ActionExist(eAAT))
return AAction.GetAction(eAAT);
if (eAAT == CPDF_AAction::ButtonUp)
return GetAction();
return CPDF_Action();
}
void CPDFSDK_BAAnnot::Annot_OnDraw(CFX_RenderDevice* pDevice,
CFX_Matrix* pUser2Device,
CPDF_RenderOptions* pOptions) {
m_pAnnot->GetAPForm(m_pPageView->GetPDFPage(), CPDF_Annot::Normal);
m_pAnnot->DrawAppearance(m_pPageView->GetPDFPage(), pDevice, pUser2Device,
CPDF_Annot::Normal, nullptr);
}
void CPDFSDK_BAAnnot::SetOpenState(bool bOpenState) {
if (CPDF_Annot* pAnnot = m_pAnnot->GetPopupAnnot())
pAnnot->SetOpenState(bOpenState);
}