//-*-C++-*-

/*  inc/Char.hpp  */


/*
 * Author: Philogelos A. <Philogelos@yahoo.com>
 * Maintainer: Philogelos A.
 * Keywords: C++, library, containers
 *
 * Copyright (C) 1998 Philogelos A.
 *
 * This file is part of Quercus Robusta.
 *
 * Quercus Robusta is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Library General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This software 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 Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this software; see the file COPYING.LIB.  If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 */


#ifndef __CHAR_HPP__

#define __CHAR_HPP__
/* $Id: Char.hpp,v 1.2 1999/03/03 19:09:01 philogelos Exp $ */

#include "defines.h"
#include "Object.hpp"
#include "String.hpp"

/** 
	Character. Interface for objects representing
	characters. Sub-classes probably will correspond
	to different coding schemas.

	@author Philogelos
	@created
*/
abstract class Char : virtual public Top
{
  /**
	 Returns fresh-allocated char array with
	 bit pattern of this character.
  */
public:  virtual char   *toCChar() const = 0;

  /**
	 Returns string initialised with bit-pattern of this
	 character.

	 @see #toCChar()
  */
public:  virtual String  asString() const;

  /**
	 Returns UTF8 representation of this character.
  */
public:  virtual char   *toUTF8() const = 0;

  /**
	 Returns UCS2 representation of this character.

	 @see unichar
  */
public:  virtual unichar          getUNICODE() const = 0;

  /**
	 Returns high byte of UCS2 representation.
  */
public:  virtual unsigned char    getPage() const;

  /**
	 Returns low byte of UCS2 representation.
  */
public:  virtual unsigned char    getOffset() const;

  /**
	 Checks that two characters are the same.
  */
public:  virtual boolean equals( const Top *anOther ) const;
};


/* $Log: Char.hpp,v $
 * Revision 1.2  1999/03/03 19:09:01  philogelos
 * Put sources under GNU Library License
 *
 * Revision 1.1  1999/02/28 12:47:07  philogelos
 * *** empty log message ***
 * */

/* __CHAR_HPP__ */
#endif

