KoFilter.h

/* This file is part of the KOffice libraries
   Copyright (C) 2001 Werner Trobin <trobin@kde.org>
                 2002 Werner Trobin <trobin@kde.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#ifndef __koffice_filter_h__
#define __koffice_filter_h__
 
#include <tqobject.h>
#include <tqmap.h>
#include <tqptrstack.h>
#include <koffice_export.h>
class TQIODevice;
class KoFilterChain;

class KOFFICECORE_EXPORT KoFilter : public TQObject
{
    TQ_OBJECT
  
 
    friend class KoFilterEntry;  // needed for the filter chain pointer :(
    friend class KoFilterChain;
 
public:
    enum ConversionStatus { OK, StupidError, UsageError, CreationError, FileNotFound,
                            StorageCreationError, BadMimeType, BadConversionGraph,
                            EmbeddedDocError, WrongFormat, NotImplemented,
                            ParsingError, InternalError, UnexpectedEOF,
                            UnexpectedOpcode, UserCancelled, OutOfMemory,
                            PasswordProtected,
                            JustInCaseSomeBrokenCompilerUsesLessThanAByte = 255 };
 
    virtual ~KoFilter();

    virtual ConversionStatus convert( const TQCString& from, const TQCString& to ) = 0;
 
signals:
    void sigProgress( int value );
 
protected:
    KoFilter();

    KoFilterChain* m_chain;
 
private:
    KoFilter( const KoFilter& rhs );
    KoFilter& operator=( const KoFilter& rhs );
 
    class Private;
    Private* d;
};
 

class KOFFICECORE_EXPORT KoEmbeddingFilter : public KoFilter
{
    TQ_OBJECT
  
 
    friend class KoFilterChain;
 
public:
    virtual ~KoEmbeddingFilter();

    int lruPartIndex() const;

    static TQString mimeTypeByExtension( const TQString& extension );
 
protected:
    KoEmbeddingFilter();

    int embedPart( const TQCString& from, TQCString& to,
                   KoFilter::ConversionStatus& status,
                   const TQString& key = TQString() );

    void startInternalEmbedding( const TQString& key, const TQCString& mimeType );

    void endInternalEmbedding();

    int internalPartReference( const TQString& key ) const;

    TQCString internalPartMimeType( const TQString& key ) const;
 
private:
    struct PartReference
    {
        PartReference( int index = -1, const TQCString& mimeType = "" );
        bool isValid() const;
 
        int m_index;
        TQCString m_mimeType;
    };

    struct PartState
    {
        PartState();
 
        int m_lruPartIndex;
        TQMap<TQString, PartReference> m_partReferences;
    };

    KoEmbeddingFilter( const KoEmbeddingFilter& rhs );
    KoEmbeddingFilter& operator=( const KoEmbeddingFilter& rhs );

    virtual void savePartContents( TQIODevice* file );

    void filterChainEnterDirectory( const TQString& directory ) const;
    void filterChainLeaveDirectory() const;

    TQPtrStack<PartState> m_partStack;
 
    class Private;
    Private* d;
};
 
#endif