FILE-- 0.5 - FILE--: wchar.cc Source File

00001 //
00002 // $Id: wchar.cc,v 1.2 2003/12/28 23:09:28 cholm Exp $
00003 //
00004 //    wchar.cc
00005 //    Copyright (C) 2002  Christian Holm <cholm@linux.HAL3000> 
00006 //   
00007 //    This library is free software; you can redistribute it and/or
00008 //    modify it under the terms of the GNU Lesser General Public
00009 //    License as published by the Free Software Foundation; either
00010 //    version 2.1 of the License, or (at your option) any later
00011 //    version.
00012 //   
00013 //    This library is distributed in the hope that it will be useful,
00014 //    but WITHOUT ANY WARRANTY; without even the implied warranty of
00015 //    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016 //    GNU Lesser General Public License for more details.
00017 //   
00018 //    You should have received a copy of the GNU Lesser General Public
00019 //    License along with this library; if not, write to the Free
00020 //    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
00021 //    MA 02111-1307 USA
00022 //
00023 /** @file   wchar.cc
00024     @author Christian Holm
00025     @date   Sat Jun 21 14:16:54 2003
00026     @brief  @c wchar_t support (documentation)
00027 */
00028 /** @page wchar wchar_t based streams support 
00029 
00030     Please note, that you need a ISO/IEC C++ compliant build
00031     environment for the @c wchar_t support to work properly.  GCC 2.95
00032     and earlier does not provide this per default.  Hence, the headers
00033     does not implement support for @c wchar_t streams for those
00034     compilers. 
00035 
00036     Per default, wide character support is @e not assumed.  If that is
00037     available for your environment, please define the preprocessor
00038     symbol FILEMM_WCHAR_SUPPORT before including filemm/streambuf.hh
00039     @code 
00040     #define FILEMM_WCHAR_SUPPORT
00041     #ifndef FILEMM_streambuf
00042     # include <filemm/streambuf.hh>
00043     #endif
00044     @endcode
00045 
00046     Optionally, you can use the @b Autoconf macros provided in the
00047     file @c filemm.m4 shipped with this package.  Put in your 
00048     @c configure.ac file lines like
00049     @verbatim 
00050     AM_FILEMM_PATH
00051     AM_FILEMM_NEED_WCHAR_TRAITS([AM_FILEMM_HAVE_WCHAR_FUNCS])
00052     AM_FILEMM_HAVE_WCHAR_SUPPORT
00053     @endverbatim        
00054     and include the (optional) configuration header before including
00055     filemm/streambuf.hh
00056     @code
00057     #ifndef HAVE_CONFIG_H
00058     # include "config.h"   // Name may vary depending on AC_CONFIG_HEADERS
00059     #endif
00060     #ifndef FILEMM_streambuf
00061     # include <filemm/streambuf.hh>
00062     #endif
00063     @endcode 
00064 
00065     @see @ref build 
00066 */
00067 #error This file is not for compilation
00068 // 
00069 // EOF
00070 //