// Copyright (c) 2005-2021 Jay Berkenbilt
// Copyright (c) 2022-2025 Jay Berkenbilt and Manfred Holger
//
// This file is part of qpdf.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
// in compliance with the License. You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the License
// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
// or implied. See the License for the specific language governing permissions and limitations under
// the License.
//
// Versions of qpdf prior to version 7 were released under the terms of version 2.0 of the Artistic
// License. At your option, you may continue to consider qpdf to be licensed under those terms.
// Please see the manual for additional information.

#ifndef PL_COUNT_HH
#define PL_COUNT_HH

// This pipeline is reusable; i.e., it is safe to call write() after calling finish().

#include <qpdf/Pipeline.hh>
#include <qpdf/Types.h>

class QPDF_DLL_CLASS Pl_Count: public Pipeline
{
  public:
    QPDF_DLL
    Pl_Count(char const* identifier, Pipeline* next);
    QPDF_DLL
    ~Pl_Count() override;
    QPDF_DLL
    void write(unsigned char const*, size_t) override;
    QPDF_DLL
    void finish() override;
    // Returns the number of bytes written
    QPDF_DLL
    qpdf_offset_t getCount() const;
    // Returns the last character written, or '\0' if no characters have been written (in which case
    // getCount() returns 0)
    QPDF_DLL
    unsigned char getLastChar() const;

  private:
    class QPDF_DLL_PRIVATE Members
    {
        friend class Pl_Count;

      public:
        QPDF_DLL
        ~Members() = default;

      private:
        Members();
        Members(Members const&) = delete;

        // Must be qpdf_offset_t, not size_t, to handle writing more than size_t can handle.
        qpdf_offset_t count{0};
        unsigned char last_char{'\0'};
    };

    std::shared_ptr<Members> m;
};

#endif // PL_COUNT_HH