ie_impGraphic.h

Go to the documentation of this file.

/* -*- c-basic-offset: 4; tab-width: 4; indent-tabs-mode: t -*- */

/* AbiWord
 * Copyright (C) 1998 AbiSource, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */


#ifndef IE_IMPGRAPHIC_H
#define IE_IMPGRAPHIC_H

#include <memory>
#include <string>
#include <vector>

#include "ut_types.h"
#include "fg_Graphic.h"
#include "ie_types.h"
#include "ie_imp.h"

class UT_ByteBuf;
class IE_ImpGraphic;

class ABI_EXPORT IE_ImpGraphicSniffer
{
    friend class IE_ImpGraphic;

public:
    virtual ~IE_ImpGraphicSniffer() {}

    // these you get for free
    inline bool supportsType (IEGraphicFileType type) {return m_type == type;}
    inline IEGraphicFileType getType() const {return m_type;}

    // these you must override these
    virtual const IE_SuffixConfidence * getSuffixConfidence () = 0;
    virtual const IE_MimeConfidence * getMimeConfidence () = 0;
    virtual UT_Confidence_t recognizeContents (const char * szBuf,
                                               UT_uint32 iNumbytes);
    virtual UT_Confidence_t recognizeContents (GsfInput * input);
    virtual bool getDlgLabels (const char ** szDesc,
                   const char ** szSuffixList,
                   IEGraphicFileType * ft) = 0;
    virtual UT_Error constructImporter (IE_ImpGraphic ** ppieg) = 0;

 protected:
    IE_ImpGraphicSniffer()
        :m_type(IEGFT_Unknown) {}

 private:
    // only IE_ImpGraphic ever calls this
    IEGraphicFileType m_type;
    inline void setType (IEGraphicFileType type) {m_type = type;}
};

//
// IE_ImpGraphic defines the abstract base class for graphic file importers.
//
// Subclasses which load raster files should generally convert to a
// PNG format image and construct a FG_GraphicRaster.  Subclasses
// which load vector files should generally convert to a SVG format
// and construct a FG_GraphicVector.
//
// That way, the only formats that the layout and display code need to know
// about are PNG and SVG.  The code to handle other formats should be isolated
// in the impexp package.
//
class ABI_EXPORT IE_ImpGraphic
{
public:

  // constructs an importer of the right type based upon
  // either the filename or sniffing the file.  caller is
  // responsible for destroying the importer when finished
  // with it.

  static IEGraphicFileType  fileTypeForSuffix(const char * szSuffix);
  static IEGraphicFileType  fileTypeForMimetype(const char * szMimetype);
  static IEGraphicFileType  fileTypeForContents(const char * szBuf, UT_uint32 iNumbytes);

  static bool       enumerateDlgLabels(UT_uint32 ndx,
                       const char ** pszDesc,
                       const char ** pszSuffixList,
                       IEGraphicFileType * ft);
  static UT_uint32  getImporterCount(void);
  static void registerImporter (IE_ImpGraphicSniffer * sniffer);
  static void unregisterImporter (IE_ImpGraphicSniffer * sniffer);
  static void unregisterAllImporters ();
  static const std::vector<std::string> & getSupportedMimeTypes();
  static const std::vector<std::string> & getSupportedMimeClasses();
  static const std::vector<std::string> & getSupportedSuffixes();
  static const char * getMimeTypeForSuffix (const char * suffix);

  static UT_Error               constructImporterWithDescription(const char * szDesc, IE_ImpGraphic ** ppieg);

  static UT_Error       constructImporter(const UT_ConstByteBufPtr & bytes,
                          IEGraphicFileType ft,
                          IE_ImpGraphic **ppieg);
  static UT_Error       constructImporter(const char * szFilename,
                          IEGraphicFileType ft,
                          IE_ImpGraphic **ppieg);
  static UT_Error       constructImporter(GsfInput * input,
                          IEGraphicFileType ft,
                          IE_ImpGraphic **ppieg);

  virtual ~IE_ImpGraphic() {}

  static UT_Error loadGraphic(const char * szFilename,
                              IEGraphicFileType iegft,
                              FG_ConstGraphicPtr& pfg);
  static UT_Error loadGraphic(GsfInput * input,
                              IEGraphicFileType iegft,
                              FG_ConstGraphicPtr& pfg);
  static UT_Error loadGraphic(const UT_ConstByteBufPtr &pBB,
                              IEGraphicFileType iegft,
                              FG_ConstGraphicPtr& pfg);

  //  Note subclassers:  ownership of pBB is passed here, so
  //  free pBB if you don't need it.

  // you must override at least one of the importGraphic calls
  virtual UT_Error  importGraphic(const UT_ConstByteBufPtr & pBB,
                                  FG_ConstGraphicPtr& pfg);
  virtual UT_Error  importGraphic(GsfInput * input,
                                  FG_ConstGraphicPtr& pfg);

  UT_Error  importGraphic(const char * szFilename,
                          FG_ConstGraphicPtr& pfg);



private:

};

#endif /* IE_IMP_H */