1 // Copyright 2016 PDFium Authors. All rights reserved.
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_H_
8 #define CORE_FPDFAPI_PARSER_CPDF_STREAM_H_
9
10 #include <memory>
11 #include <set>
12 #include <sstream>
13
14 #include "core/fpdfapi/parser/cpdf_object.h"
15 #include "core/fxcrt/fx_memory_wrappers.h"
16 #include "core/fxcrt/fx_stream.h"
17
18 class CPDF_Stream final : public CPDF_Object {
19 public:
20 static const int kFileBufSize = 512;
21
22 template <typename T, typename... Args>
23 friend RetainPtr<T> pdfium::MakeRetain(Args&&... args);
24
25 // CPDF_Object:
26 Type GetType() const override;
27 RetainPtr<CPDF_Object> Clone() const override;
28 CPDF_Dictionary* GetDict() override;
29 const CPDF_Dictionary* GetDict() const override;
30 WideString GetUnicodeText() const override;
31 bool IsStream() const override;
32 CPDF_Stream* AsStream() override;
33 const CPDF_Stream* AsStream() const override;
34 bool WriteTo(IFX_ArchiveStream* archive,
35 const CPDF_Encryptor* encryptor) const override;
36
GetRawSize()37 uint32_t GetRawSize() const { return m_dwSize; }
38 // Will be null in case when stream is not memory based.
39 // Use CPDF_StreamAcc to data access in all cases.
GetInMemoryRawData()40 uint8_t* GetInMemoryRawData() const { return m_pDataBuf.get(); }
41
42 // Copies span into internally-owned buffer.
43 void SetData(pdfium::span<const uint8_t> pData);
44
45 void TakeData(std::unique_ptr<uint8_t, FxFreeDeleter> pData, uint32_t size);
46
47 void SetDataFromStringstream(std::ostringstream* stream);
48
49 // Set data and remove "Filter" and "DecodeParms" fields from stream
50 // dictionary.
51 void SetDataAndRemoveFilter(pdfium::span<const uint8_t> pData);
52 void SetDataFromStringstreamAndRemoveFilter(std::ostringstream* stream);
53
54 void InitStream(pdfium::span<const uint8_t> pData,
55 RetainPtr<CPDF_Dictionary> pDict);
56 void InitStreamFromFile(const RetainPtr<IFX_SeekableReadStream>& pFile,
57 RetainPtr<CPDF_Dictionary> pDict);
58
59 bool ReadRawData(FX_FILESIZE offset, uint8_t* pBuf, uint32_t buf_size) const;
60
IsMemoryBased()61 bool IsMemoryBased() const { return m_bMemoryBased; }
62 bool HasFilter() const;
63
64 private:
65 CPDF_Stream();
66 CPDF_Stream(std::unique_ptr<uint8_t, FxFreeDeleter> pData,
67 uint32_t size,
68 RetainPtr<CPDF_Dictionary> pDict);
69 ~CPDF_Stream() override;
70
71 RetainPtr<CPDF_Object> CloneNonCyclic(
72 bool bDirect,
73 std::set<const CPDF_Object*>* pVisited) const override;
74
75 bool m_bMemoryBased = true;
76 uint32_t m_dwSize = 0;
77 RetainPtr<CPDF_Dictionary> m_pDict;
78 std::unique_ptr<uint8_t, FxFreeDeleter> m_pDataBuf;
79 RetainPtr<IFX_SeekableReadStream> m_pFile;
80 };
81
ToStream(CPDF_Object * obj)82 inline CPDF_Stream* ToStream(CPDF_Object* obj) {
83 return obj ? obj->AsStream() : nullptr;
84 }
85
ToStream(const CPDF_Object * obj)86 inline const CPDF_Stream* ToStream(const CPDF_Object* obj) {
87 return obj ? obj->AsStream() : nullptr;
88 }
89
ToStream(RetainPtr<CPDF_Object> obj)90 inline RetainPtr<CPDF_Stream> ToStream(RetainPtr<CPDF_Object> obj) {
91 return RetainPtr<CPDF_Stream>(ToStream(obj.Get()));
92 }
93
94 #endif // CORE_FPDFAPI_PARSER_CPDF_STREAM_H_
95