256 lines
8.2 KiB
C++
256 lines
8.2 KiB
C++
/*
|
|
* This file is a part of Winix
|
|
* and is distributed under the 2-Clause BSD licence.
|
|
* Author: Tomasz Sowa <t.sowa@ttmath.org>
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2010-2021, Tomasz Sowa
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*/
|
|
|
|
#ifndef headerfile_winix_templates_htmltextstream
|
|
#define headerfile_winix_templates_htmltextstream
|
|
|
|
#include <ctime>
|
|
#include "core/textstream.h"
|
|
|
|
namespace Winix
|
|
{
|
|
|
|
|
|
/*
|
|
HtmlTextStream is used as a buffer for creating a html page
|
|
By default all operators<< escape its string arguments. If you don't want
|
|
to escape an argument you should use a helper function R() (raw argument)
|
|
note: you have to define the function yourself, we do not provide it
|
|
because such a short name would make a mess in namespaces
|
|
|
|
sample:
|
|
create a helper function R as follows:
|
|
|
|
template<class RawType>
|
|
HtmlTextStream::RawText<RawType> R(const RawType & par)
|
|
{
|
|
return HtmlTextStream::RawText<RawType>(par);
|
|
}
|
|
|
|
now you can use HtmlTextStream in an easy way:
|
|
HtmlTextStream page;
|
|
std::string key = "some <b>string</b>";
|
|
page << key << R("<h2>html goes here</h2>");
|
|
only html tags "<b>" and "</b>" will be correctly escaped
|
|
|
|
currently following characters are escaped:
|
|
< -> <
|
|
> -> >
|
|
& ->
|
|
" -> "
|
|
' -> ' (it is "'" but IE8 has a problem with ')
|
|
10 ->
|
|
13 ->
|
|
*/
|
|
class HtmlTextStream : public TextStream<std::wstring>
|
|
{
|
|
public:
|
|
|
|
|
|
HtmlTextStream();
|
|
|
|
|
|
/*
|
|
* clearing the buffer and setting 'escape' flag to true
|
|
*/
|
|
void Clear();
|
|
void clear(); // utf8 methods call clear(), in the future Clear() will be renamed to clear()
|
|
|
|
void to_str(std::wstring & str);
|
|
|
|
/*
|
|
a helper struct to select a proper operator<<
|
|
(for non-escaping versions of these operators)
|
|
*/
|
|
template<class RawType>
|
|
struct RawText
|
|
{
|
|
const RawType & par;
|
|
|
|
RawText(const RawText<RawType> & p) : par(p.par) {}
|
|
RawText(const RawType & p) : par(p) {}
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
without escaping
|
|
*/
|
|
HtmlTextStream & PutChar(char);
|
|
HtmlTextStream & PutChar(wchar_t);
|
|
|
|
HtmlTextStream & PutText(const char *);
|
|
HtmlTextStream & PutText(const char *, size_t len);
|
|
HtmlTextStream & PutText(const std::string *);
|
|
HtmlTextStream & PutText(const std::string &);
|
|
HtmlTextStream & PutText(const wchar_t * str);
|
|
HtmlTextStream & PutText(const wchar_t * str, size_t len);
|
|
HtmlTextStream & PutText(const std::wstring * str);
|
|
HtmlTextStream & PutText(const std::wstring & str);
|
|
|
|
/*
|
|
we need this template operator for such calling:
|
|
HtmlTextStream_object << R("some string");
|
|
"some string" is actually a table (not a pointer)
|
|
*/
|
|
template<size_t str_size>
|
|
HtmlTextStream & operator<<(const RawText<char [str_size]> & raw) { return PutText(raw.par); }
|
|
|
|
template<size_t str_size>
|
|
HtmlTextStream & operator<<(const RawText<wchar_t [str_size]> & raw) { return PutText(raw.par); }
|
|
|
|
HtmlTextStream & operator<<(const RawText<const char*> & raw);
|
|
HtmlTextStream & operator<<(const RawText<const wchar_t*> & raw);
|
|
HtmlTextStream & operator<<(RawText<const std::string*> raw);
|
|
HtmlTextStream & operator<<(RawText<const std::wstring*> raw);
|
|
HtmlTextStream & operator<<(RawText<std::string> raw);
|
|
HtmlTextStream & operator<<(RawText<std::wstring> raw);
|
|
|
|
HtmlTextStream & operator<<(RawText<char> raw);
|
|
HtmlTextStream & operator<<(RawText<wchar_t> raw);
|
|
HtmlTextStream & operator<<(RawText<int> raw);
|
|
HtmlTextStream & operator<<(RawText<long> raw);
|
|
HtmlTextStream & operator<<(RawText<unsigned int> raw);
|
|
HtmlTextStream & operator<<(RawText<unsigned long> raw);
|
|
HtmlTextStream & operator<<(RawText<double> raw);
|
|
HtmlTextStream & operator<<(RawText<void*> raw);
|
|
HtmlTextStream & operator<<(RawText<pt::Space> raw);
|
|
HtmlTextStream & operator<<(RawText<pt::Date> raw);
|
|
|
|
template<typename arg_char_type, size_t arg_stack_size, size_t arg_heap_block_size>
|
|
HtmlTextStream & operator<<(RawText<pt::TextStreamBase<arg_char_type, arg_stack_size, arg_heap_block_size> > raw);
|
|
|
|
|
|
// this method doesn't escape stream as there is no need for such behavior - stream should be already escaped
|
|
HtmlTextStream & operator<<(const HtmlTextStream & stream);
|
|
|
|
|
|
// 'write' don't escapes too
|
|
// with these methods you can write a zero character too
|
|
HtmlTextStream & Write(const char * buf, size_t len);
|
|
HtmlTextStream & Write(const wchar_t * buf, size_t len);
|
|
// for compatibility with standard library (Ezc uses it)
|
|
HtmlTextStream & write(const char * buf, size_t len);
|
|
HtmlTextStream & write(const wchar_t * buf, size_t len);
|
|
|
|
|
|
/*
|
|
with escaping
|
|
*/
|
|
|
|
HtmlTextStream & ETextPutChar(char c);
|
|
HtmlTextStream & ETextPutChar(wchar_t c);
|
|
|
|
HtmlTextStream & EPutText(const char * str);
|
|
HtmlTextStream & EPutText(const char * str, size_t len);
|
|
HtmlTextStream & EPutText(const std::string * str);
|
|
HtmlTextStream & EPutText(const std::string & str);
|
|
HtmlTextStream & EPutText(const wchar_t * str);
|
|
HtmlTextStream & EPutText(const wchar_t * str, size_t len);
|
|
HtmlTextStream & EPutText(const std::wstring * str);
|
|
HtmlTextStream & EPutText(const std::wstring & str);
|
|
|
|
/*
|
|
* by default all operator<< shown below use escaping
|
|
* but you can turn it off by calling Escape(false)
|
|
*/
|
|
void Escape(bool escape_characters);
|
|
|
|
HtmlTextStream & operator<<(const char * str);
|
|
HtmlTextStream & operator<<(const std::string * str);
|
|
HtmlTextStream & operator<<(const std::string & str);
|
|
HtmlTextStream & operator<<(const wchar_t * str);
|
|
HtmlTextStream & operator<<(const std::wstring * str);
|
|
HtmlTextStream & operator<<(const std::wstring & str);
|
|
HtmlTextStream & operator<<(char);
|
|
HtmlTextStream & operator<<(wchar_t);
|
|
HtmlTextStream & operator<<(int);
|
|
HtmlTextStream & operator<<(long);
|
|
HtmlTextStream & operator<<(unsigned int);
|
|
HtmlTextStream & operator<<(unsigned long);
|
|
HtmlTextStream & operator<<(double);
|
|
HtmlTextStream & operator<<(const void *);
|
|
HtmlTextStream & operator<<(const pt::Space & space);
|
|
HtmlTextStream & operator<<(const pt::Date & Date);
|
|
|
|
template<typename arg_char_type, size_t arg_stack_size, size_t arg_heap_block_size>
|
|
HtmlTextStream & operator<<(const pt::TextStreamBase<arg_char_type, arg_stack_size, arg_heap_block_size> & arg);
|
|
|
|
|
|
private:
|
|
|
|
//TextStream<std::wstring> tmp_stream;
|
|
std::wstring tmp_string;
|
|
bool escape;
|
|
|
|
};
|
|
|
|
|
|
|
|
template<typename arg_char_type, size_t arg_stack_size, size_t arg_heap_block_size>
|
|
HtmlTextStream & HtmlTextStream::operator<<(RawText<pt::TextStreamBase<arg_char_type, arg_stack_size, arg_heap_block_size> > raw)
|
|
{
|
|
TextStream<std::wstring>::operator<<(raw.par);
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
template<typename arg_char_type, size_t arg_stack_size, size_t arg_heap_block_size>
|
|
HtmlTextStream & HtmlTextStream::operator<<(const pt::TextStreamBase<arg_char_type, arg_stack_size, arg_heap_block_size> & arg)
|
|
{
|
|
typename pt::TextStreamBase<arg_char_type, arg_stack_size, arg_heap_block_size>::const_iterator i;
|
|
|
|
if( escape )
|
|
{
|
|
/*
|
|
* warning: char* (utf-8) string will not be correctly handled here
|
|
*/
|
|
for(i=arg.begin() ; i != arg.end() ; ++i)
|
|
ETextPutChar(*i);
|
|
}
|
|
else
|
|
{
|
|
TextStream<std::wstring>::operator<<(arg);
|
|
}
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
} // namespace Winix
|
|
|
|
#endif
|
|
|