aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/poco/Foundation/include/Poco/HexBinaryEncoder.h
blob: dad6d0badf5075c72d60dd9aacae971eb4083796 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
// 
// HexBinaryEncoder.h 
// 
// Library: Foundation 
// Package: Streams 
// Module:  HexBinary 
// 
// Definition of the HexBinaryEncoder class. 
// 
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. 
// and Contributors. 
// 
// SPDX-License-Identifier:	BSL-1.0 
// 
 
 
#ifndef Foundation_HexBinaryEncoder_INCLUDED 
#define Foundation_HexBinaryEncoder_INCLUDED 
 
 
#include "Poco/Foundation.h" 
#include "Poco/UnbufferedStreamBuf.h" 
#include <ostream> 
 
 
namespace Poco { 
 
 
class Foundation_API HexBinaryEncoderBuf: public UnbufferedStreamBuf 
	/// This streambuf encodes all data written 
	/// to it in hexBinary encoding and forwards it to a connected 
	/// ostream.  
	/// In hexBinary encoding, each binary octet is encoded as a character tuple,   
	/// consisting of two hexadecimal digits ([0-9a-fA-F]) representing the octet code. 
	/// See also: XML Schema Part 2: Datatypes (http://www.w3.org/TR/xmlschema-2/), 
	/// section 3.2.15. 
	/// 
	/// Note: The characters are directly written 
	/// to the ostream's streambuf, thus bypassing 
	/// the ostream. The ostream's state is therefore 
	/// not updated to match the buffer's state. 
{ 
public: 
	HexBinaryEncoderBuf(std::ostream& ostr); 
	~HexBinaryEncoderBuf(); 
	 
	int close(); 
		/// Closes the stream buffer. 
	 
	void setLineLength(int lineLength); 
		/// Specify the line length. 
		/// 
		/// After the given number of characters have been written,  
		/// a newline character will be written. 
		/// 
		/// Specify 0 for an unlimited line length. 
		 
	int getLineLength() const; 
		/// Returns the currently set line length. 
		 
	void setUppercase(bool flag = true); 
		/// Specify whether hex digits a-f are written in upper or lower case. 
	 
private: 
	int writeToDevice(char c); 
 
	int _pos; 
	int _lineLength; 
	int _uppercase; 
	std::streambuf& _buf; 
}; 
 
 
class Foundation_API HexBinaryEncoderIOS: public virtual std::ios 
	/// The base class for HexBinaryEncoder. 
	/// 
	/// This class is needed to ensure the correct initialization 
	/// order of the stream buffer and base classes. 
{ 
public: 
	HexBinaryEncoderIOS(std::ostream& ostr); 
	~HexBinaryEncoderIOS(); 
	int close(); 
	HexBinaryEncoderBuf* rdbuf(); 
 
protected: 
	HexBinaryEncoderBuf _buf; 
}; 
 
 
class Foundation_API HexBinaryEncoder: public HexBinaryEncoderIOS, public std::ostream 
	/// This ostream encodes all data 
	/// written to it in BinHex encoding and forwards it to 
	/// a connected ostream. 
	/// Always call close() when done 
	/// writing data, to ensure proper 
	/// completion of the encoding operation. 
	/// In hexBinary encoding, each binary octet is encoded as a character tuple,   
	/// consisting of two hexadecimal digits ([0-9a-fA-F]) representing the octet code. 
	/// See also: XML Schema Part 2: Datatypes (http://www.w3.org/TR/xmlschema-2/), 
	/// section 3.2.15. 
	/// 
	/// Note: The characters are directly written 
	/// to the ostream's streambuf, thus bypassing 
	/// the ostream. The ostream's state is therefore 
	/// not updated to match the buffer's state. 
{ 
public: 
	HexBinaryEncoder(std::ostream& ostr); 
	~HexBinaryEncoder(); 
}; 
 
 
} // namespace Poco 
 
 
#endif // Foundation_HexBinaryEncoder_INCLUDED