xref: /aosp_15_r20/external/pdfium/core/fpdfapi/parser/cpdf_flateencoder.h (revision 3ac0a46f773bac49fa9476ec2b1cf3f8da5ec3a4)
1 // Copyright 2017 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_FLATEENCODER_H_
8 #define CORE_FPDFAPI_PARSER_CPDF_FLATEENCODER_H_
9 
10 #include <stdint.h>
11 
12 #include "core/fxcrt/data_vector.h"
13 #include "core/fxcrt/retain_ptr.h"
14 #include "third_party/abseil-cpp/absl/types/variant.h"
15 #include "third_party/base/containers/span.h"
16 
17 class CPDF_Dictionary;
18 class CPDF_Encryptor;
19 class CPDF_Stream;
20 class CPDF_StreamAcc;
21 class IFX_ArchiveStream;
22 
23 class CPDF_FlateEncoder {
24  public:
25   CPDF_FlateEncoder(RetainPtr<const CPDF_Stream> pStream, bool bFlateEncode);
26   ~CPDF_FlateEncoder();
27 
28   void UpdateLength(size_t size);
29   bool WriteDictTo(IFX_ArchiveStream* archive,
30                    const CPDF_Encryptor* encryptor) const;
31 
32   pdfium::span<const uint8_t> GetSpan() const;
33 
34  private:
is_owned()35   bool is_owned() const {
36     return absl::holds_alternative<DataVector<uint8_t>>(m_Data);
37   }
38 
39   // Returns |m_pClonedDict| if it is valid. Otherwise returns |m_pDict|.
40   const CPDF_Dictionary* GetDict() const;
41 
42   // Must outlive `m_Data`.
43   RetainPtr<CPDF_StreamAcc> const m_pAcc;
44 
45   absl::variant<pdfium::span<const uint8_t>, DataVector<uint8_t>> m_Data;
46 
47   // Only one of these two pointers is valid at any time.
48   RetainPtr<const CPDF_Dictionary> m_pDict;
49   RetainPtr<CPDF_Dictionary> m_pClonedDict;
50 };
51 
52 #endif  // CORE_FPDFAPI_PARSER_CPDF_FLATEENCODER_H_
53