build.cc Go to the documentation of this file. // // $Id: build.cc,v 1.2 2003/12/28 23:09:28 cholm Exp $ // // build.cc // Copyright (C) 2002 Christian Holm <cholm@linux.HAL3000> // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public // License as published by the Free Software Foundation; either // version 2.1 of the License, or (at your option) any later // version. // // 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. // // You should have received a copy of the GNU Lesser General Public // License along with this library; if not, write to the Free // Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, // MA 02111-1307 USA // /** @file build.cc @author Christian Holm Christensen <cholm@nbi.dk> @date Mon Dec 29 00:07:31 2003 @brief Using FILE-- in a project (documentation) */ /** @page build Using FILE-- in your project @b FILE-- consist entirely of declaration (or header) files. All you need to do, is to include those file in your project code. You can copy the header files into your source code, or you can use them from their installed location - it's entirely up to you, though you should read and understand the terms of the @link lgpl licence@endlink The included file <tt>filemm.m4</tt> defines the @b Autoconf macro <tt>AM_FILEMM_PATH</tt> that you can use in your <tt>configure.ac</tt> file. It defines the substitution variable <tt>FILEMM_CPPFLAGS</tt> to contain the path to the @b FILE-- header files. Put that macro in your configuration file @verbatim ... AM_FILEMM_PATH ... @endverbatim and in your <tt>Makefile.am</tt>s, do @verbatim ... AM_CPPFLAGS = $(FILEMM_CPPFLAGS) ... @endverbatim Alternatively, you can use the included script <tt>filemm-config</tt> to obtain the information. @section compat Compatibility Some older compilers does not provide standard headers, in particular <tt>std::char_traits<typename Char_Type></tt> may be missing, and <tt>std::streambuf</tt> may not define the nested types <tt>std::streambuf::char_type</tt>, <tt>std::streambuf::int_type</tt>, and <tt>std::streambuf::traits_type</tt>. In case that <tt>std::char_traits<typename Char_Type></tt> isn't defined, FILE-- provides an implementation - just define @c FILEMM_NEED_CHAR_TRAITS in your source file before including filemm/streambuf.hh @code #define FILEMM_NEED_CHAR_TRAITS #ifndef FILEMM_streambuf # include <filemm/streambuf.hh> #endif @endcode In case <tt>std::streambuf</tt> doesn't define the nested types, define @c FILEMM_NEED_STREAMBUF_TYPES in your source file before including filemm/streambuf.hh @code #define FILEMM_NEED_STREAMBUF_TYPES #ifndef FILEMM_streambuf # include <filemm/streambuf.hh> #endif @endcode If you use the provided @b Autoconf macros, all these checks can be done for you automatically. Put lines like @verbatim AM_FILEMM_PATH AM_FILEMM_NEED_CHAR_TRAITS AM_FILEMM_NEED_STREAMBUF_H AM_FILEMM_NEED_STREAMBUF_TYPES @endverbatim in your @c configure.ac file, and include the (optional) configuration header before including filemm/streambuf.hh @code #ifndef HAVE_CONFIG_H # include "config.h" // Name may vary depending on AC_CONFIG_HEADERS #endif #ifndef FILEMM_streambuf # include <filemm/streambuf.hh> #endif @endcode @see @ref wchar */ #error This file is not for compilation // // EOF //