Pnm Class Reference

#include <pnm.hh>

Inheritance diagram for Pnm:

Collaboration diagram for Pnm:

Public Types
using	Ptr = std::shared_ptr< Pnm >
Public Types inherited from PluginInformationInterface
using	Ptr = std::shared_ptr< PluginInformationInterface >
Public Types inherited from Scroom::TiledBitmap::OpenTiledBitmapInterface
using	Ptr = std::shared_ptr< OpenTiledBitmapInterface >

Public Member Functions
std::string	getPluginName () override
std::string	getPluginVersion () override
void	registerCapabilities (ScroomPluginInterface::Ptr host) override
std::list< GtkFileFilter * >	getFilters () override
std::tuple< Scroom::TiledBitmap::BitmapMetaData, Layer::Ptr, Scroom::TiledBitmap::ReloadFunction >	open (const std::string &fileName) override
Public Member Functions inherited from PluginInformationInterface
	PluginInformationInterface ()=default
Public Member Functions inherited from Scroom::Utils::Base
	Base ()=default
	Base (const Base &)=delete
	Base (Base &&)=delete
Base &	operator= (const Base &)=delete
Base &	operator= (Base &&)=delete
virtual	~Base ()=default
template<typename R >
std::shared_ptr< R >	shared_from_this ()
template<typename R >
std::shared_ptr< R const >	shared_from_this () const

Static Public Member Functions
static Ptr	create ()

Private Member Functions
	Pnm ()=default

Private Attributes
Scroom::Logger	m_logger

Additional Inherited Members
Public Attributes inherited from PluginInformationInterface
const int	pluginApiVersion {PLUGIN_API_VERSION}

Member Typedef Documentation

Ptr

using Pnm::Ptr = std::shared_ptr<Pnm>

Constructor & Destructor Documentation

Pnm()

Pnm::Pnm ( )

privatedefault

Referenced by create().

Here is the caller graph for this function:

Member Function Documentation

create()

Pnm::Ptr Pnm::create ( )

static

{ return Ptr(new Pnm()); }

Referenced by getPluginInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

getFilters()

std::list< GtkFileFilter * > Pnm::getFilters ( )

overridevirtual

Implements Scroom::TiledBitmap::OpenTiledBitmapInterface.

{
  std::list<GtkFileFilter*> result;
 
  GtkFileFilter* filter = gtk_file_filter_new();
  gtk_file_filter_set_name(filter, "Pnm files");
  gtk_file_filter_add_pattern(filter, "*.pnm");
  gtk_file_filter_add_pattern(filter, "*.pgm");
  gtk_file_filter_add_pattern(filter, "*.ppm");
  gtk_file_filter_add_pattern(filter, "*.pbm");
  result.push_back(filter);
 
  return result;
}

getPluginName()

std::string Pnm::getPluginName ( )

overridevirtual

Implements PluginInformationInterface.

{ return "Pnm"; }

getPluginVersion()

std::string Pnm::getPluginVersion ( )

overridevirtual

Implements PluginInformationInterface.

{ return PACKAGE_VERSION; }

open()

std::tuple< BitmapMetaData, Layer::Ptr, ReloadFunction > Pnm::open ( const std::string &  fileName )

overridevirtual

Implements Scroom::TiledBitmap::OpenTiledBitmapInterface.

{
  auto r = Scroom::Pnm::open(m_logger, fileName);
  if(r)
  {
    auto [bitmapMetaData, pnm, sourceType] = std::move(*r);
 
    auto layer = Layer::create(
      bitmapMetaData.rect.getWidth(),
      bitmapMetaData.rect.getHeight(),
      bitmapMetaData.bitsPerSample * bitmapMetaData.samplesPerPixel
    );
 
    Scroom::Pnm::Source::Ptr sourcePresentation;
    if(sourceType == Scroom::Pnm::SourceType::Ascii)
    {
      sourcePresentation = Scroom::Pnm::AsciiSource::create(fileName, std::move(pnm), bitmapMetaData);
    }
    else if(sourceType == Scroom::Pnm::SourceType::Ascii1bpp)
    {
      sourcePresentation = Scroom::Pnm::AsciiSource1bpp::create(fileName, std::move(pnm), bitmapMetaData);
    }
    else
    {
      sourcePresentation = Scroom::Pnm::BinarySource::create(fileName, std::move(pnm), bitmapMetaData);
    }
 
    auto load = [sourcePresentation, layer](const ProgressInterface::Ptr& progressInterface)
    {
      return sourcePresentation->resetPresentation() ? scheduleLoadingBitmap(sourcePresentation, layer, progressInterface)
                                                     : Empty();
    };
 
    return {bitmapMetaData, layer, load};
  }
  return {{}, {}, {}};
}

Here is the call graph for this function:

registerCapabilities()

void Pnm::registerCapabilities ( ScroomPluginInterface::Ptr  host )

overridevirtual

Implements PluginInformationInterface.

{
  host->registerOpenTiledBitmapInterface("Pnm viewer", shared_from_this<Pnm>());
}

Member Data Documentation

m_logger

Scroom::Logger Pnm::m_logger

private

Referenced by open().

---

The documentation for this class was generated from the following files:

• plugins/pnm/src/pnm.hh
• plugins/pnm/src/pnm.cc