encoder.hh

Go to the documentation of this file.

/*
   The lestes compiler suite
   Copyright (C) 2002, 2003, 2004, 2005 Miroslav Tichy
   Copyright (C) 2002, 2003, 2004, 2005 Petr Zika
   Copyright (C) 2002, 2003, 2004, 2005 Vojtech Hala
   Copyright (C) 2002, 2003, 2004, 2005 Jiri Kosina
   Copyright (C) 2002, 2003, 2004, 2005 Pavel Sanda
   Copyright (C) 2002, 2003, 2004, 2005 Jan Zouhar
   Copyright (C) 2002, 2003, 2004, 2005 Rudolf Thomas

   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; version 2 of the License.

   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.

   See the full text of the GNU General Public License version 2, and
   the limitations in the file doc/LICENSE.

   By accepting the license the licensee waives any and all claims
   against the copyright holder(s) related in whole or in part to the
   work, its use, and/or the inability to use it.
 
 */
#ifndef lestes__lang__cplus__lex___encoder_hh___included
#define lestes__lang__cplus__lex___encoder_hh___included

/*! \file
  \brief Abstract encoder.
  
  Declaration of encoder class representing abstract character set encoder.
  \author pt
*/

#include <lestes/common.hh>
#include <lestes/lang/cplus/lex/ucn_filter.hh>
package(lestes);
package(lang);
package(cplus);
package(lex);

// forward declaration to break cycle

/*!
  \brief Abstract encoder.
  
  Represents character set encoding skeleton.
  Used as an abstract base class for all encoders.
*/
class encoder: public ucn_filter {
public:
        //! Tests equality to other encoder.
        inline bool equals(const ptr<encoder> &other) const;
protected:
        //! Creates the encoder.
        inline encoder(void);
private:
        //! Hides copy constructor.
        encoder(const encoder &);
        //! Hides assignment operator.
        encoder &operator=(const encoder &);
};

/*!
  Creates new encoder.
*/
inline encoder::encoder(void)
{
}

/*!
  Compares to other encoder. Only the same instances are equal.
  \param other  The encoder to compare to.
  \retur true  If this == other.
*/
inline bool encoder::equals(const ptr<encoder> &other) const
{
        return other == this;
}

end_package(lex);
end_package(cplus);
end_package(lang);
end_package(lestes);

#endif
/* vim: set ft=lestes : */

---