• Skip to content
• Skip to link menu

KDE 3.5 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

kviewshell

DjVuPort.h

Go to the documentation of this file.

//C-  -*- C++ -*-
//C- -------------------------------------------------------------------
//C- DjVuLibre-3.5
//C- Copyright (c) 2002  Leon Bottou and Yann Le Cun.
//C- Copyright (c) 2001  AT&T
//C-
//C- This software is subject to, and may be distributed under, the
//C- GNU General Public License, Version 2. The license should have
//C- accompanied the software or you may obtain a copy of the license
//C- from the Free Software Foundation at http://www.fsf.org .
//C-
//C- This program is distributed in the hope that it will be useful,
//C- but WITHOUT ANY WARRANTY; without even the implied warranty of
//C- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//C- GNU General Public License for more details.
//C- 
//C- DjVuLibre-3.5 is derived from the DjVu(r) Reference Library
//C- distributed by Lizardtech Software.  On July 19th 2002, Lizardtech 
//C- Software authorized us to replace the original DjVu(r) Reference 
//C- Library notice by the following text (see doc/lizard2002.djvu):
//C-
//C-  ------------------------------------------------------------------
//C- | DjVu (r) Reference Library (v. 3.5)
//C- | Copyright (c) 1999-2001 LizardTech, Inc. All Rights Reserved.
//C- | The DjVu Reference Library is protected by U.S. Pat. No.
//C- | 6,058,214 and patents pending.
//C- |
//C- | This software is subject to, and may be distributed under, the
//C- | GNU General Public License, Version 2. The license should have
//C- | accompanied the software or you may obtain a copy of the license
//C- | from the Free Software Foundation at http://www.fsf.org .
//C- |
//C- | The computer code originally released by LizardTech under this
//C- | license and unmodified by other parties is deemed "the LIZARDTECH
//C- | ORIGINAL CODE."  Subject to any third party intellectual property
//C- | claims, LizardTech grants recipient a worldwide, royalty-free, 
//C- | non-exclusive license to make, use, sell, or otherwise dispose of 
//C- | the LIZARDTECH ORIGINAL CODE or of programs derived from the 
//C- | LIZARDTECH ORIGINAL CODE in compliance with the terms of the GNU 
//C- | General Public License.   This grant only confers the right to 
//C- | infringe patent claims underlying the LIZARDTECH ORIGINAL CODE to 
//C- | the extent such infringement is reasonably necessary to enable 
//C- | recipient to make, have made, practice, sell, or otherwise dispose 
//C- | of the LIZARDTECH ORIGINAL CODE (or portions thereof) and not to 
//C- | any greater extent that may be necessary to utilize further 
//C- | modifications or combinations.
//C- |
//C- | The LIZARDTECH ORIGINAL CODE is provided "AS IS" WITHOUT WARRANTY
//C- | OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
//C- | TO ANY WARRANTY OF NON-INFRINGEMENT, OR ANY IMPLIED WARRANTY OF
//C- | MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
//C- +------------------------------------------------------------------
// 
// $Id: DjVuPort.h,v 1.8 2003/11/07 22:08:21 leonb Exp $
// $Name: release_3_5_15 $

#ifndef _DJVUPORT_H
#define _DJVUPORT_H
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#if NEED_GNUG_PRAGMAS
# pragma interface
#endif


#include "GThreads.h"
#include "GURL.h"

#ifdef HAVE_NAMESPACES
namespace DJVU {
# ifdef NOT_DEFINED // Just to fool emacs c++ mode
}
#endif
#endif

class DataPool;


class DjVuPort;
class DjVuPortcaster;
class DjVuFile;

class DjVuPort : public GPEnabled
{
public:
   DjVuPort();
   virtual ~DjVuPort();
   static void *operator new (size_t sz);
   static void operator delete(void *addr);

   static DjVuPortcaster *get_portcaster(void);

   DjVuPort(const DjVuPort & port);

   DjVuPort & operator=(const DjVuPort & port);

   virtual bool     inherits(const GUTF8String &class_name) const;


   virtual GURL     id_to_url(const DjVuPort * source, const GUTF8String &id);

   virtual GP<DjVuFile> id_to_file(const DjVuPort * source, const GUTF8String &id);

   virtual GP<DataPool> request_data(const DjVuPort * source, const GURL & url);

   virtual bool     notify_error(const DjVuPort * source, const GUTF8String &msg);

   virtual bool     notify_status(const DjVuPort * source, const GUTF8String &msg);

   virtual void     notify_redisplay(const class DjVuImage * source);

   virtual void     notify_relayout(const class DjVuImage * source);

   virtual void     notify_chunk_done(const DjVuPort * source, const GUTF8String &name);

   virtual void     notify_file_flags_changed(const class DjVuFile * source,
                          long set_mask, long clr_mask);

   virtual void     notify_doc_flags_changed(const class DjVuDocument * source,
                         long set_mask, long clr_mask);
   
   virtual void     notify_decode_progress(const DjVuPort * source, float done);

   enum ErrorRecoveryAction {ABORT=0,SKIP_PAGES=1,SKIP_CHUNKS=2,KEEP_ALL=3 }; 
public:
   class DjVuPortCorpse;
private:
   static GCriticalSection  * corpse_lock;
   static DjVuPortCorpse    * corpse_head, * corpse_tail;
   static int           corpse_num;
};

class DjVuSimplePort : public DjVuPort
{
public:
   virtual bool     inherits(const GUTF8String &class_name) const;

   virtual GP<DataPool> request_data(const DjVuPort * source, const GURL & url);

   virtual bool     notify_error(const DjVuPort * source, const GUTF8String &msg);
   
   virtual bool     notify_status(const DjVuPort * source, const GUTF8String &msg);
};


class DjVuMemoryPort : public DjVuPort
{
public:
   virtual bool     inherits(const GUTF8String &class_name) const;

   virtual GP<DataPool> request_data(const DjVuPort * source, const GURL & url);

   void     add_data(const GURL & url, const GP<DataPool> & pool);
private:
   GCriticalSection lock;
   GPMap<GURL, DataPool>map;
};



class DjVuPortcaster
{
public:
   static DjVuPortcaster *get_portcaster(void)
    { return DjVuPort::get_portcaster(); } ;

   DjVuPortcaster(void);

   virtual ~DjVuPortcaster(void);

   void     del_port(const DjVuPort * port);
   
   void     add_route(const DjVuPort *src, DjVuPort *dst);

   void     del_route(const DjVuPort *src, DjVuPort *dst);

   void     copy_routes(DjVuPort *dst, const DjVuPort *src);

   GP<DjVuPort> is_port_alive(DjVuPort *port);

   void     add_alias(const DjVuPort * port, const GUTF8String &alias);

   static void      clear_all_aliases(void);

   void     clear_aliases(const DjVuPort * port);

   GP<DjVuPort> alias_to_port(const GUTF8String &name);

   GPList<DjVuPort> prefix_to_ports(const GUTF8String &prefix);

   virtual GURL     id_to_url(const DjVuPort * source, const GUTF8String &id);

   virtual GP<DjVuFile> id_to_file(const DjVuPort * source, const GUTF8String &id);

   virtual GP<DataPool> request_data(const DjVuPort * source, const GURL & url);

   virtual bool     notify_error(const DjVuPort * source, const GUTF8String &msg);

   virtual bool     notify_status(const DjVuPort * source, const GUTF8String &msg);

   virtual void     notify_redisplay(const class DjVuImage * source);

   virtual void     notify_relayout(const class DjVuImage * source);

   virtual void     notify_chunk_done(const DjVuPort * source, const GUTF8String &name);

   virtual void     notify_file_flags_changed(const class DjVuFile * source,
                          long set_mask, long clr_mask);

   virtual void     notify_doc_flags_changed(const class DjVuDocument * source,
                         long set_mask, long clr_mask);
   
   virtual void     notify_decode_progress(const DjVuPort * source, float done);

private:
      // We use these 'void *' to minimize template instantiations.
   friend class DjVuPort;
   GCriticalSection     map_lock;
   GMap<const void *, void *>   route_map;  // GMap<DjVuPort *, GList<DjVuPort *> *>
   GMap<const void *, void *>   cont_map;   // GMap<DjVuPort *, DjVuPort *>
   GMap<GUTF8String, const void *>  a2p_map;    // GMap<GUTF8String, DjVuPort *>
   void add_to_closure(GMap<const void*, void*> & set,
                       const DjVuPort *dst, int distance);
   void compute_closure(const DjVuPort *src, GPList<DjVuPort> &list,
                        bool sorted=false);
};


inline bool
DjVuPort::inherits(const GUTF8String &class_name) const
{
   return (class_name == "DjVuPort");
}

inline bool
DjVuSimplePort::inherits(const GUTF8String &class_name) const
{
   return
      (class_name == "DjVuSimplePort") || DjVuPort::inherits(class_name);
}

inline bool
DjVuMemoryPort::inherits(const GUTF8String &class_name) const
{
   return
      (class_name == "DjVuMemoryPort") || DjVuPort::inherits(class_name);
}



#ifdef HAVE_NAMESPACES
}
# ifndef NOT_USING_DJVU_NAMESPACE
using namespace DJVU;
# endif
#endif
#endif

kviewshell

Skip menu "kviewshell"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members

API Reference

Skip menu "API Reference"

• kviewshell

Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal