aboutsummaryrefslogtreecommitdiff
path: root/src/stable/hex.h
blob: 3595faebccc28f625a7b82db0e75c9940ab43703 (plain)
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
/*
 * Copyright (C) 2007-2011 Xagasoft, All rights reserved.
 *
 * This file is part of the libbu++ library and is released under the
 * terms of the license contained in the file LICENSE.
 */

#ifndef BU_HEX_H
#define BU_HEX_H

#include "bu/filter.h"

namespace Bu
{
	/**
	 * This very simple filter encodes to/decodes from hex encoded string data.
	 * The primary use of this filter is in debugging, use it with
	 * Bu::encodeStr to easily create hex dumps of string data, even other raw
	 * structures.
	 *
	 *@code
	 Bu::println("Hexdump: " + Bu::encodeStr<Bu::Hex>("Test data ;)") );
	 @endcode
	 * Or...
	 *@code
	 complex_struct data;
	 ...
	 Bu::println("Hexdump: " +
	 	Bu::encodeStr<Bu::Hex>(
	 		Bu::String( &data, sizeof(data) )
			)
		);
	 @endcode
	 **/
	class Hex : public Bu::Filter
	{
	public:
		Hex( Bu::Stream &rNext, bool bUpperCase=false, int iChunk=-1 );
		virtual ~Hex();

		virtual void start();
		virtual Bu::size stop();

		virtual Bu::size read( void *pBuf, Bu::size iBytes );
		virtual Bu::size write( const void *pBuf, Bu::size iBytes );
		using Bu::Stream::write;

	private:
		int iChunk;
		Bu::size iPos;
		char cIn[2];
		int iIn;
		const char *sChrs;
	};
};

#endif