• Skip to content
• Skip to link menu

KDE 3.5 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

kviewshell

DataPool.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: DataPool.h,v 1.10 2003/11/07 22:08:20 leonb Exp $
// $Name: release_3_5_15 $

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


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

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

class ByteStream;


class DataPool : public GPEnabled
{
public: // Classes used internally by DataPool
    // These are declared public to support buggy C++ compilers.
   class Incrementor;
   class Reader;
   class Trigger;
   class OpenFiles;
   class OpenFiles_File;
   class BlockList;
   class Counter;
protected:
   DataPool(void);

public:
   static GP<DataPool> create(void);

   static GP<DataPool> create(const GP<ByteStream> & str);

   static GP<DataPool> create(const GP<DataPool> & master_pool, int start=0, int length=-1);

   static GP<DataPool> create(const GURL &url, int start=0, int length=-1);

   virtual ~DataPool();

   void     connect(const GP<DataPool> & master_pool, int start=0, int length=-1);
   void     connect(const GURL &url, int start=0, int length=-1);

   void     stop(bool only_blocked=false);

   void     add_data(const void * buffer, int size);

   void     add_data(const void * buffer, int offset, int size);

   void     set_eof(void);

   int      get_data(void * buffer, int offset, int size);

   GP<ByteStream>   get_stream(void);

   bool     is_connected(void) const;
   
   bool     has_data(int start, int length);

      /* Returns #TRUE# if no more data is planned to be added.

     {\bf Note:} This function always returns #TRUE# when the #DataPool#
     has been initialized with a file name. */
   bool     is_eof(void) const {return eof_flag;}

   int      get_length(void) const;
   int      get_size(void) const {return get_size(0, -1);}

   void     add_trigger(int start, int length,
//              void (* callback)(GP<GPEnabled> &), GP<GPEnabled> cl_data);
                void (* callback)(void *), void * cl_data);

//   void       add_trigger(int thresh, void (* callback)(GP<GPEnabled> &), GP<GPEnabled> cl_data);
   void     add_trigger(int thresh, void (* callback)(void *), void * cl_data);

   void     del_trigger(void (* callback)(void *), void *  cl_data);
//   void       del_trigger(void (* callback)(GP<GPEnabled> &), GP<GPEnabled>  cl_data);

   void     load_file(void);
   static void  load_file(const GURL &url);

   static void  close_all(void);

      // Internal. Used by 'OpenFiles'
   void     clear_stream(const bool release = true);

   bool simple_compare(DataPool &pool) const;
private:
   bool     eof_flag;
   bool     stop_flag;
   bool     stop_blocked_flag;

   Counter  *active_readers;
   
      // Source or storage of data
   GP<DataPool>     pool;
   GURL     furl;
   GP<OpenFiles_File>   fstream;
   GCriticalSection class_stream_lock;
   GP<ByteStream>   data;
   GCriticalSection data_lock;
   BlockList        *block_list;
   int          add_at;
   int          start, length;

      // List of readers waiting for data
   GPList<Reader>   readers_list;
   GCriticalSection readers_lock;

      // Triggers
   GPList<Trigger>  triggers_list;      // List of passed or our triggers
   GCriticalSection triggers_lock;      // Lock for the list above
   GCriticalSection trigger_lock;       // Lock for static_trigger_cb()

   void     init(void);
   void     wait_for_data(const GP<Reader> & reader);
   void     wake_up_all_readers(void);
   void     check_triggers(void);
   int      get_data(void * buffer, int offset, int size, int level);
   int      get_size(int start, int length) const;
   void     restart_readers(void);

//   static void    static_trigger_cb(GP<GPEnabled> &);
   static void  static_trigger_cb(void *);
   void     trigger_cb(void);
   void     analyze_iff(void);
   void     added_data(const int offset, const int size);
public:
  static const char *Stop;
  friend class FCPools;
};

inline bool 
DataPool::simple_compare(DataPool &pool) const
{
  // return true if these pools are identical.  False means they may or may
  // not be identical.
  return (this == &pool)
    ||(furl.is_valid()&&!furl.is_empty()&&pool.furl.is_valid()&&(furl == pool.furl))
    ||(data && (data == pool.data));
}

inline bool
DataPool::is_connected(void) const
{
   return furl.is_local_file_url() || pool!=0;
}



#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