PbmFile.H

Go to the documentation of this file.

/*---------------------------------------------------------------------+
 | Library QgarLib, graphics analysis and recognition                  |
 | Copyright (C) 2002  Qgar Project, LORIA                             |
 |                                                                     |
 | This library is free software; you can redistribute it and/or       |
 | modify it under the terms of the GNU Lesser General Public          |
 | License version 2.1, as published by the Free Software Foundation.  |
 |                                                                     |
 | This library 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 Lesser General Public License for more details.         |
 |                                                                     |
 | The GNU Lesser General Public License is included in the file       |
 | LICENSE.LGPL, in the root directory of the Qgar packaging. See      |
 | http://www.gnu.org/licenses/lgpl.html for the terms of the licence. |
 | To receive a paper copy, write to the Free Software Foundation,     |
 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.       |
 |                                                                     |
 | Contact Project Qgar for any information:                           |
 |   LORIA - équipe Qgar                                               |
 |   B.P. 239, 54506 Vandoeuvre-lès-Nancy Cedex, France                |
 |   email: qgar-contact@loria.fr                                      |
 |   http://www.qgar.org/                                              |
 *---------------------------------------------------------------------*/


#ifndef __PBMFILE_H_INCLUDED__
#define __PBMFILE_H_INCLUDED__


/**
 * @file     PbmFile.H
 * @brief    Header file of class qgar::PbmFile.
 *
 * @author   <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Karl Tombre</a>
 * @date     Jul, 3  2001  17:11
 * @since    Qgar 1.0
 */

// For RCS/CVS use: Do not delete
/* $Id: PbmFile.H,v 1.14 2005/09/15 18:19:35 masini Exp $ */



// QGAR
#include <qgarlib/AbstractPbmPlusFile.H>
#include <qgarlib/QgarErrorIO.H>



namespace qgar
{

/**
 * @class PbmFile PbmFile.H "qgarlib/PbmFile.H"
 * @ingroup IO_FILE
 *
 * @brief File containing a binary image in PBM format.
 * 
 * Most of the code documented here is an adaptation of code from the PBM
 * software package. Here is the copyright notice of this package:
@verbatim
 +------------------------------------------------------------------------+
 | Copyright (C) 1988 by Jef Poskanzer                                    |
 |                                                                        |
 | Permission to use, copy, modify, and distribute this software and its  |
 | documentation for any purpose and without fee is hereby granted,       |
 | provided that the above copyright notice appear in all copies and that |
 | both that copyright notice and this permission notice appear in        |
 | supporting documentation.  This software is provided "as is" without   |
 | express or implied warranty.                                           |
 +------------------------------------------------------------------------+
@endverbatim
 *  For more information about PBM, see the
 *  <a href="http://www.bath.ac.uk/BUCS/Software/graphics/pbm/pbm.html">PBMPLUS home page</a>.
 *
 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Karl Tombre</a>
 * @date   Jul, 3  2001  17:11
 * @since  Qgar 1.0
 */
class PbmFile

  : public AbstractPbmPlusFile

{
// -------------------------------------------------------------------
// P U B L I C    M E M B E R S
// -------------------------------------------------------------------
public:

  /** @name Constructors */
  //        ============
  //@{

  /**
   * @brief Initialize from file name and format.
   *
   * @param aFileName name of the new file
   * @param aFormat   format of the image contained in the file (default qgar::QGE_PBM_RAW)
   *
   * @warning
   * <ul>
   * <li>The number of rows and columns of the corresponding image
   *     are set to default (<b>0</b>).</li>
   * <li>Such a file cannot be opened
   *     in <b>write-only</b> or <b>read-write</b> modes.</li>
   * </ul>
   */
  PbmFile(const char* aFileName, QGEpbmFormat aFormat = QGE_PBM_RAW);

  /**
   * @brief Initialize from full data.
   *
   * @param aFileName name of the new file
   * @param aRowCnt   number of rows of the corresponding image
   * @param aColCnt   number of columns of the corresponding image
   * @param aFormat   format of the image contained in the file (default qgar::QGE_PBM_RAW)
   *
   * @warning Such a file is supposed to be used
   *   in <b>write-only</b> or <b>read-write</b> modes.
   */
  PbmFile(const char* aFileName,
          unsigned int aRowCnt,
          unsigned int aColCnt,
          QGEpbmFormat aFormat = QGE_PBM_RAW);

  //@}


  /** @name Input */
  //        =====
  //@{

  /**
   * @brief Read a row from the file.
   */
  void readRow();

  //@}


  /** @name Output */
  //        ======
  //@{

  /**
   * @brief Write a row into the file.
   */
  void writeRow();

  //@}


// -------------------------------------------------------------------
// P R O T E C T E D    M E M B E R S
// -------------------------------------------------------------------
protected:

  /** @name Magic numbers */
  //        =============
  //@{

  /**
   * @brief <b>PLAIN</b> format.
   */
  static const unsigned short _s_pbm_format;

  /**
   * @brief <b>PLAIN</b> format: Magic-1.
   */
  static const unsigned char  _s_pbm_magic1;

  /**
   * @brief <b>PLAIN</b> format: Magic-2.
   */
  static const unsigned char  _s_pbm_magic2;

  /**
   * @brief <b>RAW</b> format.
   */
  static const unsigned short _s_rpbm_format;

  /**
   * @brief <b>RAW</b> format: Magic-2.
   */
  static const unsigned char  _s_rpbm_magic2;

  //@}


  /** @name Input */
  //        =====
  //@{

  /**
   * @brief Read file header and allocate a new row.
   *
   * @exception qgar::QgarErrorIO (EOF while reading, bad magic number)
   *            
   */
  void readHeader() throw(QgarErrorIO);

  /**
   * @brief Return the next bit from the file.
   *
   * @exception qgar::QgarErrorIO (junk in file)
   */
  unsigned char getBit() throw(QgarErrorIO);

  //@}


  /** @name Output */
  //        ======
  //@{

  /**
   * @brief Write file header.
   */
  void writeHeader();

  /**
   * @brief Write file footer.
   */
  void writeFooter();

  //@}


// -------------------------------------------------------------------

}; // class PbmFile


} // namespace qgar 

#endif /* __PBMFILE_H_INCLUDED__ */