00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        fastformat/sinks/null.hpp
00003  *
00004  * Purpose:     A class that acts as a bit-bucket sink.
00005  *
00006  * Created:     3rd December 2008
00007  * Updated:     18th January 2009
00008  *
00009  * Home:        http://www.fastformat.org/
00010  *
00011  * Copyright (c) 2008-2009, Matthew Wilson and Synesis Software
00012  * All rights reserved.
00013  *
00014  * Redistribution and use in source and binary forms, with or without
00015  * modification, are permitted provided that the following conditions are
00016  * met:
00017  *
00018  * - Redistributions of source code must retain the above copyright notice,
00019  *   this list of conditions and the following disclaimer.
00020  * - Redistributions in binary form must reproduce the above copyright
00021  *   notice, this list of conditions and the following disclaimer in the
00022  *   documentation and/or other materials provided with the distribution.
00023  * - Neither the names of Matthew Wilson and Synesis Software nor the names
00024  *   of any contributors may be used to endorse or promote products derived
00025  *   from this software without specific prior written permission.
00026  *
00027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00028  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00029  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00030  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00031  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00032  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00033  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00034  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00035  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00036  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00037  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038  *
00039  * ////////////////////////////////////////////////////////////////////// */
00040 
00041 
00047 #ifndef FASTFORMAT_INCL_FASTFORMAT_SINK_HPP_NULL
00048 #define FASTFORMAT_INCL_FASTFORMAT_SINK_HPP_NULL
00049 
00050 /* /////////////////////////////////////////////////////////////////////////
00051  * Version information
00052  */
00053 
00054 #ifndef FASTFORMAT_DOCUMENTATION_SKIP_SECTION
00055 # define FASTFORMAT_VER_FASTFORMAT_SINK_HPP_NULL_MAJOR      1
00056 # define FASTFORMAT_VER_FASTFORMAT_SINK_HPP_NULL_MINOR      1
00057 # define FASTFORMAT_VER_FASTFORMAT_SINK_HPP_NULL_REVISION   1
00058 # define FASTFORMAT_VER_FASTFORMAT_SINK_HPP_NULL_EDIT       2
00059 #endif /* !FASTFORMAT_DOCUMENTATION_SKIP_SECTION */
00060 
00061 /* /////////////////////////////////////////////////////////////////////////
00062  * Language
00063  */
00064 
00065 #ifndef __cplusplus
00066 # error This file can only be included in C++ compilation units
00067 #endif /* !__cplusplus */
00068 
00069 /* /////////////////////////////////////////////////////////////////////////
00070  * Includes
00071  */
00072 
00073 #include <fastformat/fastformat.h>
00074 #include <fastformat/format/standard_flags.hpp>
00075 #include <fastformat/quality/contract.h>
00076 
00077 /* /////////////////////////////////////////////////////////////////////////
00078  * Namespace
00079  */
00080 
00081 #if !defined(FASTFORMAT_NO_NAMESPACE)
00082 namespace fastformat
00083 {
00084 namespace sinks
00085 {
00086 #endif /* !FASTFORMAT_NO_NAMESPACE */
00087 
00088 /* /////////////////////////////////////////////////////////////////////////
00089  * Classes
00090  */
00091 
00094 struct null_sink
00095 {
00096     size_t  numWrites;  
00097     size_t  numSlices;  
00098     size_t  cchTotal;   
00100 public: 
00101 
00103     null_sink()
00104         : numWrites(0u)
00105         , numSlices(0u)
00106         , cchTotal(0u)
00107     {}
00108 };
00109 
00110 /* /////////////////////////////////////////////////////////////////////////
00111  * Action Shims
00112  */
00113 
00116 inline null_sink& fmt_slices(null_sink& sink, int /* flags */, size_t cchTotal, size_t numResults, ff_string_slice_t const* /* results */)
00117 {
00118     ++sink.numWrites;
00119     sink.numSlices  +=  numResults;
00120     sink.cchTotal   +=  cchTotal;
00121 
00122     return sink;
00123 }
00124 
00125 /* /////////////////////////////////////////////////////////////////////////
00126  * Namespace
00127  */
00128 
00129 #if !defined(FASTFORMAT_NO_NAMESPACE)
00130 } /* namespace sinks */
00131 } /* namespace fastformat */
00132 #endif /* !FASTFORMAT_NO_NAMESPACE */
00133 
00134 /* ////////////////////////////////////////////////////////////////////// */
00135 
00136 #endif /* FASTFORMAT_INCL_FASTFORMAT_SINK_HPP_NULL */
00137 
00138 /* ////////////////////////////////////////////////////////////////////// */

FastFormat Library documentation © Matthew Wilson, 2006-2009