Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
cpdf_stream_acc.h
Go to the documentation of this file.
1// Copyright 2016 The PDFium Authors
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7#ifndef CORE_FPDFAPI_PARSER_CPDF_STREAM_ACC_H_
8#define CORE_FPDFAPI_PARSER_CPDF_STREAM_ACC_H_
9
10#include <stdint.h>
11
12#include <memory>
13
14#include "core/fxcrt/bytestring.h"
15#include "core/fxcrt/data_vector.h"
16#include "core/fxcrt/raw_span.h"
17#include "core/fxcrt/retain_ptr.h"
18#include "core/fxcrt/span.h"
19#include "third_party/abseil-cpp/absl/types/variant.h"
20
21class CPDF_Dictionary;
22class CPDF_Stream;
23
24class CPDF_StreamAcc final : public Retainable {
25 public:
27
28 CPDF_StreamAcc(const CPDF_StreamAcc&) = delete;
29 CPDF_StreamAcc& operator=(const CPDF_StreamAcc&) = delete;
30
32 void LoadAllDataFilteredWithEstimatedSize(uint32_t estimated_size);
33 void LoadAllDataImageAcc(uint32_t estimated_size);
34 void LoadAllDataRaw();
35
36 RetainPtr<const CPDF_Stream> GetStream() const;
38
39 uint32_t GetSize() const;
40 pdfium::span<const uint8_t> GetSpan() const;
41 uint64_t KeyForCache() const;
43 ByteString GetImageDecoder() const { return m_ImageDecoder; }
45
46 int GetLength1ForTest() const;
47
48 private:
49 explicit CPDF_StreamAcc(RetainPtr<const CPDF_Stream> pStream);
50 ~CPDF_StreamAcc() override;
51
52 void LoadAllData(bool bRawAccess, uint32_t estimated_size, bool bImageAcc);
53 void ProcessRawData();
54 void ProcessFilteredData(uint32_t estimated_size, bool bImageAcc);
55
56 // Returns the raw data from `m_pStream`, or no data on failure.
57 DataVector<uint8_t> ReadRawStream() const;
58
59 bool is_owned() const {
60 return absl::holds_alternative<DataVector<uint8_t>>(m_Data);
61 }
62
63 ByteString m_ImageDecoder;
64 RetainPtr<const CPDF_Dictionary> m_pImageParam;
65 // Needs to outlive `m_Data` when the data is not owned.
66 RetainPtr<const CPDF_Stream> const m_pStream;
67 absl::variant<pdfium::raw_span<const uint8_t>, DataVector<uint8_t>> m_Data;
68};
69
70#endif // CORE_FPDFAPI_PARSER_CPDF_STREAM_ACC_H_
fxcrt::ByteString ByteString
Definition bytestring.h:180
#define DCHECK
Definition check.h:33
void Scale(float sx, float sy)
std::vector< RetainPtr< CPDF_Object > >::const_iterator const_iterator
Definition cpdf_array.h:29
std::map< ByteString, RetainPtr< CPDF_Object >, std::less<> > DictMap
bool ExportNPagesToOne(pdfium::span< const uint32_t > page_indices, const CFX_SizeF &dest_page_size, size_t pages_on_x_axis, size_t pages_on_y_axis)
static ByteString GenerateSubPageContentStreamForTesting(const ByteString &xobject_name, const NupPageSettings &settings)
CPDF_NPageToOneExporter(CPDF_Document *dest_doc, CPDF_Document *src_doc)
std::unique_ptr< XObjectContext > CreateXObjectContextFromPage(int src_page_index)
WideString GetUnicodeText() const override
Definition cpdf_name.cpp:41
CPDF_Name * AsMutableName() override
Definition cpdf_name.cpp:37
Type GetType() const override
Definition cpdf_name.cpp:21
~CPDF_Name() override
void SetString(const ByteString &str) override
Definition cpdf_name.cpp:33
bool WriteTo(IFX_ArchiveStream *archive, const CPDF_Encryptor *encryptor) const override
Definition cpdf_name.cpp:45
RetainPtr< CPDF_Object > Clone() const override
Definition cpdf_name.cpp:25
ByteString GetString() const override
Definition cpdf_name.cpp:29
const CPDF_Name * AsName() const
virtual CPDF_Stream * AsMutableStream()
virtual CPDF_Reference * AsMutableReference()
const CPDF_Stream * AsStream() const
virtual CPDF_Name * AsMutableName()
const CPDF_Reference * AsReference() const
void SetBackgroundAlphaNeeded(bool needed)
void StartParse(std::unique_ptr< CPDF_ContentParser > pParser)
RetainPtr< const CPDF_Dictionary > GetDict() const
std::map< FontData, ByteString > m_FontsMap
RetainPtr< CPDF_Dictionary > m_pPageResources
RetainPtr< const CPDF_Dictionary > GetResources() const
virtual bool IsPage() const
void SetResources(RetainPtr< CPDF_Dictionary > pDict)
const_iterator end() const
std::optional< ByteString > GraphicsMapSearch(const GraphicsData &gd)
virtual ~CPDF_PageObjectHolder()
const_iterator begin() const
const std::vector< CFX_FloatRect > & GetMaskBoundingBoxes() const
void GraphicsMapInsert(const GraphicsData &gd, const ByteString &str)
void AddImageMaskBoundingBox(const CFX_FloatRect &box)
CPDF_Document * GetDocument() const
std::map< GraphicsData, ByteString > m_GraphicsMap
void AppendPageObject(std::unique_ptr< CPDF_PageObject > pPageObj)
void FontsMapInsert(const FontData &fd, const ByteString &str)
bool ErasePageObjectAtIndex(size_t index)
CPDF_PageObjectHolder(CPDF_Document *pDoc, RetainPtr< CPDF_Dictionary > pDict, RetainPtr< CPDF_Dictionary > pPageResources, RetainPtr< CPDF_Dictionary > pResources)
ParseState GetParseState() const
RetainPtr< CPDF_Dictionary > GetMutableDict()
void ContinueParse(PauseIndicatorIface *pPause)
RetainPtr< CPDF_Dictionary > m_pResources
CPDF_PageObject * GetPageObjectByIndex(size_t index) const
std::unique_ptr< CPDF_PageObject > RemovePageObject(CPDF_PageObject *pPageObj)
const CPDF_Transparency & GetTransparency() const
RetainPtr< CPDF_Dictionary > GetMutableResources()
RetainPtr< const CPDF_Dictionary > GetPageResources() const
CFX_Matrix GetCTMAtBeginningOfStream(int32_t stream)
RetainPtr< CPDF_Dictionary > GetMutablePageResources()
CPDF_Transparency m_Transparency
const CFX_FloatRect & GetBBox() const
CFX_Matrix GetCTMAtEndOfStream(int32_t stream)
std::optional< ByteString > FontsMapSearch(const FontData &fd)
std::set< int32_t > TakeDirtyStreams()
static bool CopyInheritable(RetainPtr< CPDF_Dictionary > dest_page_dict, RetainPtr< const CPDF_Dictionary > src_page_dict, const ByteString &key)
CPDF_Document * dest()
const CPDF_Document * dest() const
static RetainPtr< const CPDF_Object > PageDictGetInheritableTag(RetainPtr< const CPDF_Dictionary > dict, const ByteString &src_tag)
CPDF_PageOrganizer(CPDF_Document *dest_doc, CPDF_Document *src_doc)
const CPDF_Document * src() const
CPDF_Document * src()
bool UpdateReference(RetainPtr< CPDF_Object > obj)
void AddObjectMapping(uint32_t old_page_obj_num, uint32_t new_page_obj_num)
RenderContextClearer(CPDF_Page *pPage)
virtual ~RenderContextIface()=default
virtual void ClearPage(CPDF_Page *pPage)=0
RetainPtr< const CPDF_Array > GetAnnotsArray() const
RetainPtr< CPDF_Array > GetOrCreateAnnotsArray()
CPDF_Document * GetDocument() const override
Definition cpdf_page.cpp:51
float GetPageHeight() const override
Definition cpdf_page.cpp:59
void UpdateDimensions()
std::optional< CFX_PointF > DeviceToPage(const FX_RECT &rect, int rotate, const CFX_PointF &device_point) const override
~CPDF_Page() override
bool IsPage() const override
Definition cpdf_page.cpp:63
float GetPageWidth() const override
Definition cpdf_page.cpp:55
CPDFXFA_Page * AsXFAPage() override
Definition cpdf_page.cpp:47
const CFX_Matrix & GetPageMatrix() const
Definition cpdf_page.h:75
RenderContextIface * GetRenderContext()
Definition cpdf_page.h:84
void ParseContent()
Definition cpdf_page.cpp:67
const CFX_SizeF & GetPageSize() const
Definition cpdf_page.h:74
void SetView(View *pView)
Definition cpdf_page.h:92
RetainPtr< CPDF_Array > GetMutableAnnotsArray()
void ClearView()
void SetRenderContext(std::unique_ptr< RenderContextIface > pContext)
CPDF_Page * AsPDFPage() override
Definition cpdf_page.cpp:43
void AddPageImageCache()
std::optional< CFX_PointF > PageToDevice(const FX_RECT &rect, int rotate, const CFX_PointF &page_point) const override
CFX_Matrix GetDisplayMatrix(const FX_RECT &rect, int iRotate) const override
int GetPageRotation() const
CPDF_PageImageCache * GetPageImageCache()
Definition cpdf_page.h:83
void ClearRenderContext()
RetainPtr< CPDF_Object > CloneNonCyclic(bool bDirect, std::set< const CPDF_Object * > *pVisited) const override
void SetRef(CPDF_IndirectObjectHolder *pDoc, uint32_t objnum)
~CPDF_Reference() override
float GetNumber() const override
int GetInteger() const override
bool HasIndirectObjectHolder() const
const CPDF_Dictionary * GetDictInternal() const override
const CPDF_Object * GetDirectInternal() const override
RetainPtr< CPDF_Reference > MakeReference(CPDF_IndirectObjectHolder *holder) const override
uint32_t GetRefObjNum() const
CPDF_Reference * AsMutableReference() override
bool WriteTo(IFX_ArchiveStream *archive, const CPDF_Encryptor *encryptor) const override
ByteString GetString() const override
Type GetType() const override
RetainPtr< CPDF_Object > Clone() const override
DataVector< uint8_t > ComputeDigest() const
ByteString GetImageDecoder() const
void LoadAllDataFilteredWithEstimatedSize(uint32_t estimated_size)
CPDF_StreamAcc & operator=(const CPDF_StreamAcc &)=delete
pdfium::span< const uint8_t > GetSpan() const
CPDF_StreamAcc(const CPDF_StreamAcc &)=delete
uint64_t KeyForCache() const
int GetLength1ForTest() const
uint32_t GetSize() const
~CPDF_StreamAcc() override
void LoadAllDataImageAcc(uint32_t estimated_size)
RetainPtr< const CPDF_Dictionary > GetImageParam() const
RetainPtr< const CPDF_Stream > GetStream() const
DataVector< uint8_t > DetachData()
bool HasFilter() const
static constexpr int kFileBufSize
Definition cpdf_stream.h:25
bool IsMemoryBased() const
Definition cpdf_stream.h:62
void TakeData(DataVector< uint8_t > data)
RetainPtr< CPDF_Object > Clone() const override
~CPDF_Stream() override
size_t GetRawSize() const
CPDF_Stream * AsMutableStream() override
bool WriteTo(IFX_ArchiveStream *archive, const CPDF_Encryptor *encryptor) const override
bool IsFileBased() const
Definition cpdf_stream.h:59
void SetDataFromStringstreamAndRemoveFilter(fxcrt::ostringstream *stream)
Type GetType() const override
void SetDataAndRemoveFilter(pdfium::span< const uint8_t > pData)
void SetDataFromStringstream(fxcrt::ostringstream *stream)
DataVector< uint8_t > ReadAllRawData() const
void SetData(pdfium::span< const uint8_t > pData)
pdfium::span< const uint8_t > GetInMemoryRawData() const
RetainPtr< CPDF_Object > CloneNonCyclic(bool bDirect, std::set< const CPDF_Object * > *pVisited) const override
WideString GetUnicodeText() const override
const CPDF_Dictionary * GetDictInternal() const override
void InitStreamFromFile(RetainPtr< IFX_SeekableReadStream > file)
bool IsIsolated() const
CPDF_Transparency(const CPDF_Transparency &other)
CPDF_Transparency & operator=(const CPDF_Transparency &other)
virtual std::optional< CFX_PointF > PageToDevice(const FX_RECT &rect, int rotate, const CFX_PointF &page_point) const =0
virtual CPDF_Page * AsPDFPage()=0
virtual CPDF_Document * GetDocument() const =0
virtual CPDFXFA_Page * AsXFAPage()=0
virtual std::optional< CFX_PointF > DeviceToPage(const FX_RECT &rect, int rotate, const CFX_PointF &device_point) const =0
virtual float GetPageWidth() const =0
virtual CFX_Matrix GetDisplayMatrix(const FX_RECT &rect, int iRotate) const =0
virtual float GetPageHeight() const =0
static ByteString Format(const char *pFormat,...)
ByteString & operator+=(const char *str)
#define UNSAFE_BUFFERS(...)
#define UNSAFE_BUFFER_USAGE
CPDF_Name * ToName(CPDF_Object *obj)
Definition cpdf_name.h:36
const CPDF_Name * ToName(const CPDF_Object *obj)
Definition cpdf_name.h:40
RetainPtr< const CPDF_Name > ToName(RetainPtr< CPDF_Object > obj)
Definition cpdf_name.h:44
CPDF_Reference * ToReference(CPDF_Object *obj)
const CPDF_Reference * ToReference(const CPDF_Object *obj)
RetainPtr< CPDF_Reference > ToReference(RetainPtr< CPDF_Object > obj)
const CPDF_Stream * ToStream(const CPDF_Object *obj)
RetainPtr< CPDF_Stream > ToStream(RetainPtr< CPDF_Object > obj)
CPDF_Stream * ToStream(CPDF_Object *obj)
CFX_PTemplate< float > CFX_PointF
CFX_STemplate< float > CFX_SizeF
UNSAFE_BUFFER_USAGE void FXARGB_SetDIB(uint8_t *p, uint32_t argb)
Definition fx_dib.h:221
bool GetIsMaskFromFormat(FXDIB_Format format)
Definition fx_dib.h:169
uint32_t FX_ARGB
Definition fx_dib.h:36
FX_BGRA_STRUCT< uint8_t > ArgbToBGRAStruct(FX_ARGB argb)
Definition fx_dib.cpp:48
UNSAFE_BUFFER_USAGE FX_ARGB FXARGB_GetDIB(const uint8_t *p)
Definition fx_dib.h:215
UNSAFE_BUFFER_USAGE void ReverseCopy3Bytes(uint8_t *dest, const uint8_t *src)
Definition fx_dib.h:238
BlendMode
Definition fx_dib.h:119
@ kExclusion
Definition fx_dib.h:131
@ kNormal
Definition fx_dib.h:120
@ kSaturation
Definition fx_dib.h:133
@ kColorBurn
Definition fx_dib.h:127
@ kLighten
Definition fx_dib.h:125
@ kMultiply
Definition fx_dib.h:121
@ kColorDodge
Definition fx_dib.h:126
@ kScreen
Definition fx_dib.h:122
@ kLuminosity
Definition fx_dib.h:135
@ kSoftLight
Definition fx_dib.h:129
@ kDifference
Definition fx_dib.h:130
@ kOverlay
Definition fx_dib.h:123
@ kHardLight
Definition fx_dib.h:128
@ kDarken
Definition fx_dib.h:124
#define FXARGB_B(argb)
Definition fx_dib.h:199
constexpr FX_CMYK CmykEncode(uint32_t c, uint32_t m, uint32_t y, uint32_t k)
Definition fx_dib.h:192
#define FXARGB_G(argb)
Definition fx_dib.h:198
constexpr uint32_t FXSYS_BGR(uint8_t b, uint8_t g, uint8_t r)
Definition fx_dib.h:139
std::pair< uint8_t, FX_COLORREF > ArgbToAlphaAndColorRef(FX_ARGB argb)
Definition fx_dib.cpp:56
FX_BGR_STRUCT< uint8_t > ArgbToBGRStruct(FX_ARGB argb)
Definition fx_dib.cpp:52
#define FXARGB_A(argb)
Definition fx_dib.h:196
FX_ARGB AlphaAndColorRefToArgb(int a, FX_COLORREF colorref)
Definition fx_dib.cpp:64
uint32_t FX_COLORREF
Definition fx_dib.h:42
UNSAFE_BUFFER_USAGE void FXARGB_SetRGBOrderDIB(uint8_t *p, uint32_t argb)
Definition fx_dib.h:229
constexpr FX_ARGB ArgbEncode(uint32_t a, uint32_t r, uint32_t g, uint32_t b)
Definition fx_dib.h:188
bool GetIsAlphaFromFormat(FXDIB_Format format)
Definition fx_dib.h:173
int GetBppFromFormat(FXDIB_Format format)
Definition fx_dib.h:160
#define FXARGB_R(argb)
Definition fx_dib.h:197
int GetCompsFromFormat(FXDIB_Format format)
Definition fx_dib.h:165
constexpr uint8_t FXSYS_GetRValue(uint32_t bgr)
Definition fx_dib.h:143
FX_COLORREF ArgbToColorRef(FX_ARGB argb)
Definition fx_dib.cpp:60
constexpr unsigned int FXSYS_GetUnsignedAlpha(float alpha)
Definition fx_dib.h:155
FXDIB_Format
Definition fx_dib.h:21
constexpr uint8_t FXSYS_GetGValue(uint32_t bgr)
Definition fx_dib.h:147
constexpr uint8_t FXSYS_GetBValue(uint32_t bgr)
Definition fx_dib.h:151
uint32_t FX_CMYK
Definition fx_dib.h:37
pdfium::CheckedNumeric< int32_t > FX_SAFE_INT32
CPDFXFA_Page * ToXFAPage(IPDF_Page *pBase)
Definition ipdf_page.h:54
CPDF_Page * ToPDFPage(IPDF_Page *pBase)
Definition ipdf_page.h:50
const char kMediaBox[]
const char kContents[]
#define CONSTRUCT_VIA_MAKE_RETAIN
Definition retain_ptr.h:222
fxcrt::ByteStringView ByteStringView
bool HasAnyOptions() const
Definition fx_dib.cpp:44
bool operator<(const FontData &other) const
ByteString baseFont
bool operator<(const GraphicsData &other) const
UnownedPtr< CPDF_Document > dest_doc
RetainPtr< CPDF_Stream > xobject
fxcrt::WideString WideString
Definition widestring.h:207