libbobcat-dev 4.01.03-2ubuntu1 / usr / share / doc / libbobcat4-dev / man / ohexstreambuf.3.html

This file is indexed.

/usr/share/doc/libbobcat4-dev/man/ohexstreambuf.3.html is in libbobcat-dev 4.01.03-2ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<title>FBB::OHexStreambuf</title>
<style type="text/css">
    figure {text-align: center;}
    img {vertical-align: center;}
</style>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::OHexStreambuf</h1>
<h2>libbobcat-dev_4.01.03-x.tar.gz</h2>
<h2>2005-2015</h2>

<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<style type="text/css">
    figure {text-align: center;}
    img {vertical-align: center;}
    figure {text-align: center;}
    img {vertical-align: center;}
</style>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1></h1>

<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<title>FBB::OHexStreambuf(3bobcat)</title>
<style type="text/css">
    figure {text-align: center;}
    img {vertical-align: center;}
    figure {text-align: center;}
    img {vertical-align: center;}
    figure {text-align: center;}
    img {vertical-align: center;}
</style>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::OHexStreambuf(3bobcat)</h1>
<h2>libbobcat-dev_4.01.03-x.tar.gz Write hex values</h2>
<h2>2005-2015</h2>


<p>
<h2>NAME</h2>FBB::OHexStreambuf - Writes characters written to an ostream as hex
values
<p>
<h2>SYNOPSIS</h2>
    <strong>#include &lt;bobcat/ohexstreambuf&gt;</strong><br>
    Linking option: <em>-lbobcat</em> 
<p>
<h2>DESCRIPTION</h2>
<p>
<strong>OHexStreambuf</strong> is a specialization of <em>FBB::OFilterStreambuf</em>
inserting all the characters it receives to a destination file as 2-character
wide hexadecimal values. Optionally a maximum linelength can be specified.
<p>
Note that all information received by an <em>OHexStreambuf</em> object is inserted
as (a series of) hexadecimal values, not only plain characters. E.g., when
inserting the value 123 the characters <em>'1', '2'</em> and <em>'3'</em> are
successively inserted and so this will result in the string <em>313233</em> being
inserted into the destination stream.
<p>
<h2>NAMESPACE</h2>
    <strong>FBB</strong><br>
    All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace <strong>FBB</strong>.
<p>
<h2>INHERITS FROM</h2>
    FBB::OFilterStreambuf
<p>
<h2>CONSTRUCTOR</h2>
    <ul>
    <li> <strong>OFoldStreambuf(std::ostream &amp;stream, size_t width = 0)</strong>:<br>
    The hexadecimal characters produced by the <em>OFoldStreambuf</em> object will
be inserted into <em>stream</em>. Optionally the maximum line width (in number of
characters) may be specified using <em>width</em>. The (default) value 0 indicates
that no line breaks are requested.
    </ul>
<p>
The destructor writes any buffered information to the destination stream
and will then flushes the destination stream.
<p>
<h2>MEMBER FUNCTIONS</h2>
     All members of <strong>FBB::OFilterStreambuf</strong>, in particular its <em>out()</em> and
<em>open()</em> members are available, as <strong>FBB::OHexStreambuf</strong> inherits from
this class.
    <ul>
    <li> <strong>size_t size() const</strong>:<br>
        This member returns the next column offset where the next
hexadecimal character will appear. If a maximum line length is requested and
<em>size()</em> does not return 0 then the last line inserted was not terminated by
a <em>'\n'</em> character. See also the example below.
<p>
This member's return value is undefined if  no maximum line length was
requested. 
    </ul>
<p>
<h2>PROTECTED MEMBER FUNCTION</h2>
<p>
The member listed in this section implements the tasks of the comparably
named virtual function in the class's private interface. This separates the
redefinable interface from the user-interface. The class <strong>OHexStreambuf</strong>
can, in accordance with Liskov's Substitution Principle, be used as a
<em>std:streambuf</em>; but it also offers a facility for classes deriving from
<strong>OHexStreambuf</strong>. This facility is listed here.
    <ul>
    <li> <strong>int pSync()</strong>:<br>
        The contents of the <strong>OHexStreambuf</strong>'s internal buffer is flushed.
    </ul>
<p>
<h2>STATIC MEMBER</h2>
    <ul>
    <li> <strong>std::string text2bin(std::string const &amp;in)</strong>:<br>
        This static member can be used to convert a series of hexadecimal
characters generated by a <em>OHexStreambuf</em> object back to their binary
form. E.g, when called as <em>OHexStreambuf::text2bin("736d616c6c206976")</em> then
the returned <em>std::string</em> will contain 8 characters, having respectively
the binary values 0x73, 0x6d, 0x61, 0x6c, 0x6c, 0x20, 0x69, and 0x76.
<p>
This function does <em>not</em> verify whether its argument is properly
formed. A properly formed argument consists of an even number of hexadecimal
number characters ('0' until '9', 'a' until 'f' (or uppercase)). For
improperly formed arguments the return value is undefined.
<p>
</ul>
<p>
<h2>EXAMPLE</h2>
        <pre>

    #include &lt;iostream&gt;
    #include &lt;bobcat/ohexstreambuf&gt;
    
    using namespace std;
    using namespace FBB;
    
    int main()
    {   
        OHexStreambuf ohex(cout, 40);
        ostream out(&amp;ohex);
        out &lt;&lt; cin.rdbuf();
        if (ohex.size())
            cout &lt;&lt; '\n';
    }
            
</pre>

<p>
<h2>FILES</h2>
    <em>bobcat/ohexstreambuf</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
    <strong>bobcat</strong>(7), <strong>ofilterstreambuf</strong>(3bobcat)
<p>
<h2>BUGS</h2>
    None Reported.
<p>

<h2>DISTRIBUTION FILES</h2>
    <ul>
    <li> <em>bobcat_4.01.03-x.dsc</em>: detached signature;
    <li> <em>bobcat_4.01.03-x.tar.gz</em>: source archive;
    <li> <em>bobcat_4.01.03-x_i386.changes</em>: change log;
    <li> <em>libbobcat1_4.01.03-x_*.deb</em>: debian package holding the
            libraries;
    <li> <em>libbobcat1-dev_4.01.03-x_*.deb</em>: debian package holding the
            libraries, headers and manual pages;
    <li> <em>http://sourceforge.net/projects/bobcat</em>: public archive location;
    </ul>
<p>
<h2>BOBCAT</h2>
    Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.
<p>
<h2>COPYRIGHT</h2>
    This is free software, distributed under the terms of the 
    GNU General Public License (GPL).
<p>
<h2>AUTHOR</h2>
    Frank B. Brokken (<strong>f.b.brokken@rug.nl</strong>).
<p>

APT Browse - Built by Thomas Orozco.