Filter.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPFiltersFilter
#define PDFTRON_H_CPPFiltersFilter
 
#include <Common/UString.h>
#include <C/Filters/TRN_Filter.h>
#include <C/Common/TRN_Types.h>
#include <stdio.h>
 
namespace pdftron { 
    namespace Filters {

class Filter
{
public:
     Filter();
     ~Filter ();
 
     Filter(const Filter& copy);
    
     Filter& operator=(const Filter& other);
 
     operator bool () { return m_impl!=0;}

     void AttachFilter(Filter attach_filter);

     Filter ReleaseAttachedFilter ();    

     Filter GetAttachedFilter ();

     Filter GetSourceFilter ();

     const char* GetName () const;

     const char* GetDecodeName () const;
 
#ifndef SWIG
     UChar* Begin ();
#endif

     size_t Size ();

     void Consume (size_t num_bytes);

     size_t Count ();

     size_t SetCount (size_t new_count);

     void SetStreamLength (size_t bytes); 

     void Flush ();

     void FlushAll ();

     bool IsInputFilter ();

     bool CanSeek ();

    enum ReferencePos 
    { 
        e_begin = SEEK_SET,
        e_end   = SEEK_END, 
        e_cur   = SEEK_CUR
    };

     void Seek (ptrdiff_t offset, ReferencePos origin);

     ptrdiff_t Tell ();

     size_t Truncate (size_t new_size);

     Filter CreateInputIterator ();

     const UString GetFilePath() const;

     void Destroy();

     void WriteToFile(const UString& path, bool append);
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    TRN_Filter m_impl;
    Filter(TRN_Filter impl, bool is_owner);
    bool m_owner;
#endif
// @endcond
};
 
 
#include <Impl/Filter.inl>
 
 
    };  // namespace Filters
};  // namespace pdftron
 
#endif // PDFTRON_H_CPPFiltersFilter