IMG_FormatPassThru.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        IMG_FormatPassThru.h ( IMG Library, C++)
 *
 * COMMENTS:    Creates a format which is used for creating a pass-thru image
 *              format.  For example a flip or scale format which gets
 *              information from the parent format.
 */

#ifndef __IMG_FormatPassThru__
#define __IMG_FormatPassThru__

#include "IMG_API.h"
#include "IMG_Format.h"


class IMG_API IMG_FormatPassThru : public IMG_Format
{
public:
    // Ensure we pass through to the non-list based img format so
    // we don't have to remove ourselves from the list.
    // This also avoids threading problems if we create pass throughs
    // in a multi-threaded environment as the list isn't locked.
    IMG_FormatPassThru(const IMG_File *parent_file) : IMG_Format(false)
                {
                    myParent = parent_file;
                }

    const char  *getFormatName() const override
                 { return getParent()->getFormatName(); }
    const char  *getFormatLabel() const override
                 { return getParent()->getFormatLabel(); }
    const char  *getFormatDescription() const override
                 { return getParent()->getFormatDescription(); }
    const char  *getDefaultExtension() const override
                 { return getParent()->getDefaultExtension(); }
    const char  *getFormatLocation() const override
                 { return getParent()->getFormatLocation(); }

    int          checkExtension(const char *filename) const override
                 { return getParent()->checkExtension(filename); }
    int          checkMagic(unsigned int magic) const override
                 { return getParent()->checkMagic(magic); }
    int          checkMagicSeekable(UT_IStream &is) const override
                 { return getParent()->checkMagicSeekable(is); }

    bool         isPassThrough() const override { return true; }

    int          checkDevice(const char *filename) const override
                 { return getParent()->checkDevice(filename); }

    IMG_DataType        getSupportedTypes() const override
                        { return getParent()->getSupportedTypes(); }
    IMG_ColorModel      getSupportedColorModels() const override
                        { return getParent()->getSupportedColorModels(); }
    void                getMaxResolution(unsigned &x,
                                         unsigned &y) const override
                        { getParent()->getMaxResolution( x, y ); }


    int          isReadRandomAccess() const override
                 { return getParent()->isReadRandomAccess(); }
    int          isWriteRandomAccess() const override
                 { return getParent()->isWriteRandomAccess(); }
    int          isTopFirst() const override
                 { return getParent()->isTopFirst(); }
    int          isLeftFirst() const override
                 { return getParent()->isLeftFirst(); }

    bool         isDataWindowSupported() const override
                 { return getParent()->isDataWindowSupported(); }
    bool         isDataWindowStreakSupported() const override
                 { return getParent()->isDataWindowStreakSupported(); }

    bool         isDeepRasterSupported() const override
                 { return getParent()->isDeepRasterSupported(); }

    bool         isDataInterleaved() const override
                 { return getParent()->isDataInterleaved(); }

    bool         canPlaneTypesDiffer() const override
                 { return getParent()->canPlaneTypesDiffer(); }

    const IMG_FileOptionList    *getOptions() const override
                 { return getParent()->getOptions(); }
    const IMG_MetadataOptions   &formatMetadata() const override
                { return getParent()->formatMetadata(); }

    PXL_ColorSpace      formatColorSpace() const override
                        { return getParent()->formatColorSpace(); }
    fpreal              formatColorSpaceGamma() const override
                        { return getParent()->formatColorSpaceGamma(); }
    bool                formatStoresColorSpace() const override
                        { return getParent()->formatStoresColorSpace();}

protected:

    IMG_File    *createFile()    const override
                 { return nullptr; }
    int          isFormatOk(const IMG_Stat &) const override
                 { return 0; }

    const IMG_Format    *getParent() const
        { return myParent->getBaseFile()->getFormat(); }
    
    const IMG_File      *myParent;
    
private:
    // Forbid the plain declaration of this class as we want to always
    // invoked IMG_Format(false).
    IMG_FormatPassThru() { }
};

#endif