← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/poco/gutsy

« back to all changes in this revision

Viewing changes to Foundation/include/Poco/HexBinaryEncoder.h

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Burghardt
  • Date: 2007-04-27 18:33:48 UTC
  • Revision ID: james.westby@ubuntu.com-20070427183348-xgnpct0qd6a2ip34
Tags: upstream-1.2.9
Import upstream version 1.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
Foundation/include/Poco/HexBinaryEncoder.h
 
1
//
 
2
// HexBinaryEncoder.h
 
3
//
 
4
// $Id: //poco/1.2/Foundation/include/Poco/HexBinaryEncoder.h#1 $
 
5
//
 
6
// Library: Foundation
 
7
// Package: Streams
 
8
// Module:  HexBinary
 
9
//
 
10
// Definition of the HexBinaryEncoder class.
 
11
//
 
12
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
 
13
// and Contributors.
 
14
//
 
15
// Permission is hereby granted, free of charge, to any person or organization
 
16
// obtaining a copy of the software and accompanying documentation covered by
 
17
// this license (the "Software") to use, reproduce, display, distribute,
 
18
// execute, and transmit the Software, and to prepare derivative works of the
 
19
// Software, and to permit third-parties to whom the Software is furnished to
 
20
// do so, all subject to the following:
 
21
// 
 
22
// The copyright notices in the Software and this entire statement, including
 
23
// the above license grant, this restriction and the following disclaimer,
 
24
// must be included in all copies of the Software, in whole or in part, and
 
25
// all derivative works of the Software, unless such copies or derivative
 
26
// works are solely in the form of machine-executable object code generated by
 
27
// a source language processor.
 
28
// 
 
29
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
30
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
31
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 
32
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 
33
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 
34
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 
35
// DEALINGS IN THE SOFTWARE.
 
36
//
 
37
 
 
38
 
 
39
#ifndef Foundation_HexBinaryEncoder_INCLUDED
 
40
#define Foundation_HexBinaryEncoder_INCLUDED
 
41
 
 
42
 
 
43
#include "Poco/Foundation.h"
 
44
#include "Poco/UnbufferedStreamBuf.h"
 
45
#include <ostream>
 
46
 
 
47
 
 
48
namespace Poco {
 
49
 
 
50
 
 
51
class Foundation_API HexBinaryEncoderBuf: public UnbufferedStreamBuf
 
52
        /// This streambuf encodes all data written
 
53
        /// to it in hexBinary encoding and forwards it to a connected
 
54
        /// ostream. 
 
55
        /// In hexBinary encoding, each binary octet is encoded as a character tuple,  
 
56
        /// consisting of two hexadecimal digits ([0-9a-fA-F]) representing the octet code.
 
57
        /// See also: XML Schema Part 2: Datatypes (http://www.w3.org/TR/xmlschema-2/),
 
58
        /// section 3.2.15.
 
59
{
 
60
public:
 
61
        HexBinaryEncoderBuf(std::ostream& ostr);
 
62
        ~HexBinaryEncoderBuf();
 
63
        int close();
 
64
        
 
65
        void setLineLength(int lineLength);
 
66
        int getLineLength() const;
 
67
        void setUppercase(bool flag = true);
 
68
        
 
69
private:
 
70
        int writeToDevice(char c);
 
71
 
 
72
        int _pos;
 
73
        int _lineLength;
 
74
        int _uppercase;
 
75
        std::ostream& _ostr;
 
76
};
 
77
 
 
78
 
 
79
class Foundation_API HexBinaryEncoderIOS: public virtual std::ios
 
80
        /// The base class for HexBinaryEncoder.
 
81
        ///
 
82
        /// This class is needed to ensure the correct initialization
 
83
        /// order of the stream buffer and base classes.
 
84
{
 
85
public:
 
86
        HexBinaryEncoderIOS(std::ostream& ostr);
 
87
        ~HexBinaryEncoderIOS();
 
88
        int close();
 
89
        HexBinaryEncoderBuf* rdbuf();
 
90
 
 
91
protected:
 
92
        HexBinaryEncoderBuf _buf;
 
93
};
 
94
 
 
95
 
 
96
class Foundation_API HexBinaryEncoder: public HexBinaryEncoderIOS, public std::ostream
 
97
        /// This ostream encodes all data
 
98
        /// written to it in BinHex encoding and forwards it to
 
99
        /// a connected ostream.
 
100
        /// Always call close() when done
 
101
        /// writing data, to ensure proper
 
102
        /// completion of the encoding operation.
 
103
        /// In hexBinary encoding, each binary octet is encoded as a character tuple,  
 
104
        /// consisting of two hexadecimal digits ([0-9a-fA-F]) representing the octet code.
 
105
        /// See also: XML Schema Part 2: Datatypes (http://www.w3.org/TR/xmlschema-2/),
 
106
        /// section 3.2.15.
 
107
{
 
108
public:
 
109
        HexBinaryEncoder(std::ostream& ostr);
 
110
        ~HexBinaryEncoder();
 
111
};
 
112
 
 
113
 
 
114
} // namespace Poco
 
115
 
 
116
 
 
117
#endif // Foundation_HexBinaryEncoder_INCLUDED