FBB::OHexBuf(3bobcat)

📦
version 6.15.01 · 7 versions
, in ubuntu stonking

💅 FBB::OHexBuf — from the 3bobcat manual, bestie 🫶

okay so quick vibe check: this whole page is about FBB::OHexBuf, from the bobcat gang, and it's giving "turn literally everything into hex" energy. no cap. let's get into it 🌸

✨ NAME ✨

FBB::OHexBuf — Writes characters written to an ostream as hex values

🦋 SYNOPSIS 🦋

#include <bobcat/ohexbuf>
Linking option: -lbobcat

💜 DESCRIPTION 💜

So OHexBuf is a specialization of FBB::OFilterBuf, and what it does is take all the characters it receives and insert them into a destination file as 2-character wide hexadecimal values. iconic. Optionally you can also tell it a maximum linelength, if you're that kind of girl 💅

okay but pay attention to this part because it's highkey important: every single thing an OHexBuf object receives gets inserted as (a series of) hexadecimal values — not just plain characters. like, fr fr. e.g. when you insert the value 123, the characters '1', '2' and '3' are successively inserted, and so that'll result in the string 313233 being inserted into the destination stream. that's the whole bit. that's the assignment 😭

🎀 NAMESPACE 🎀

FBB

All constructors, members, operators and manipulators mentioned in this man-page are defined in the namespace FBB.

🌸 INHERITS FROM 🌸

FBB::OFilterBuf

💖 CONSTRUCTOR 💖

  • OHexBuf(std::ostream &stream, size_t width = 0, std::string const &separator = "") — the hexadecimal characters produced by the OFilterBuf object get inserted into stream. Optionally you can pass the maximum line width (in number of characters) with width. The (default) value 0 means "no line breaks requested, we're free-spiriting it". And separator defines the separator that's inserted between hexadecimal character values. By default? no separator at all. clean. minimal. slay.

Copy and move constructors (and assignment operators) are not available. they said no × no cancellations. periodt.

The destructor writes any buffered information to the destination stream and then flushes the destination stream. And finally, the destructor restores the original formatting flags of the receiving ostream. it puts everything back the way it found it, like a good houseguest 💅

⭐ MEMBER FUNCTIONS ⭐

All members of FBB::OFilterBuf, in particular its out() and reset members, are available, because FBB::OHexBuf inherits from this class. genetic inheritance but make it C++.

  • void eoi() — this member completes the current hexadecimal character conversion, clears the separator, and no longer uses a the maximum output line width. Instead of calling this member the eoi manipulator (see below) can be used. two paths, one destination 🦋
  • void separator(bool reset = true) — this member clears the separator that's inserted between hexadecimal character values. When the reset parameter is set to true (which is the default), the currently used output width is reset to 0.
  • void separator(std::string const &separator, bool reset = true) — this member resets the separator that's inserted between hexadecimal character values to separator's value. When the reset parameter is set to true (which is the default), the currently used output width is reset to 0.
  • void setWidth(size_t width) — this member sets the width of the generated output lines to width characters. No maximum line width is used when width = 0 is specified. so zero means "unlimited, live your truth".
  • size_t size() const — this member returns the next column offset where the next hexadecimal character will appear. If a maximum line length is requested and size() does not return 0, then the last line inserted was not terminated by a '\n' character. See also the example below 👇
ngl, this member's return value is undefined if no maximum line length was requested. so don't come crying to me, bestie, set that width first 😭

🌈 MANIPULATOR 🌈

  • FBB::eoi — the eoi manipulator can be inserted into the ostream to complete the hexaecimal conversion. It acts identically to calling the end member. If inserted into a plain std::ostream, nothing happens. absolutely nothing. it just vibes. 🫶

👑 STATIC MEMBER 👑

  • std::string text2bin(std::string const &in) — this static member converts a series of hexadecimal characters generated by a OHexBuf object back to their binary form. E.g., when called as OHexBuf::text2bin("736d616c6c206976"), then the returned std::string will contain 8 characters, having respectively the binary values 0x73, 0x6d, 0x61, 0x6c, 0x6c, 0x20, 0x69, and 0x76. it's the remix. the reverse. the un-hexing 💖
This function does not 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. so like... garbage in, mystery out. you've been warned 🩷

🧚 EXAMPLE 🧚

#include <iostream>
#include <bobcat/ohexbuf>

using namespace std;
using namespace FBB;

int main()
{
    OHexBuf ohex(cout, 40);
    ostream out(&ohex);
    out << cin.rdbuf();
    if (ohex.size())
        cout << '\n';
}

see how it checks ohex.size() before adding that '\n'? that's the whole point of size(), bestie. main character behavior ✨

🍓 FILES 🍓

  • bobcat/ohexbuf — defines the class interface

🌟 SEE ALSO 🌟

💀 BUGS 💀

None Reported.

(the bug tracker is at peace. we love that for it. no cap.)

🎀 BOBCAT PROJECT FILES 🎀

Debian Bobcat project files:

  • libbobcat6 — debian package containing the shared library, changelog and copyright note;
  • libbobcat-dev — debian package containing the static library, headers, manual pages, and developer info;

💜 BOBCAT 💜

Bobcat is an acronym of Brokken's Own Base Classes And Templates. it's a backronym and it ate, honestly 🔥

This is free software, distributed under the terms of the GNU General Public License (GPL).

✨ AUTHOR ✨

Frank B. Brokken (f.b.brokken@rug.nl).

and that's the page, bestie 🫶 this was libbobcat-dev version 6.15.01, living its life from 2005-2026, and honestly? still slaying 💅✨🎀

📦 where this page comes from