aboutsummaryrefslogtreecommitdiff
path: root/src/unstable/blob.h
blob: 2a665add7e21337600ade9f279275b8a8a31d932 (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
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
187
188
189
190
191
192
193
194
195
/*
 * Copyright (C) 2007-2023 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_BLOB_H
#define BU_BLOB_H

#include "bu/config.h"
#include "bu/archivebase.h"

namespace Bu
{
    /**
     * Blob contans a sequence of binary values. This is basically the
     * replacement for the old libbu++ Bu::String, std::string classes, or the
     * tradition C char * string.  The Blob is static and immutable, and a good
     * choice when dealing with any sequence of binary data that you don't
     * need to interpret further.
     *
     * You may note that Blob doesn't have any append, prepend, etc. methods.
     * This is because Blobs are designed to be more or less immutable. If you
     * need that functionality (which is quite likely), check out
     * Bu::BlobBuilder which offers a flexible, fast interface to build Blobs
     * dynamically, piece at a time.
     *
     * If you're dealing with data that contains language, such as human text,
     * then use the Bu::Text class instead.
     */
    class Blob
    {
    friend ArchiveBase &operator<<( ArchiveBase &ar, const Blob &s );
    friend ArchiveBase &operator>>( ArchiveBase &ar, Blob &s );
    public:
        class iterator;
        class const_iterator;

    public:
        Blob();
        Blob( const Blob &rSrc );
        Blob( const class BlobBuilder &rSrc );
        Blob( const char *pSrc );
        Blob( const void *pSrc, int32_t iSize );
        Blob( int32_t iSize );
        Blob( const const_iterator &iStart );
        Blob( const const_iterator &iStart, const const_iterator &iEnd );

        // Obviously temporary
        Blob( const Bu::String &rSrc );
        virtual ~Blob();

        void setSize( int32_t iSize );
        int32_t getSize() const;
        void setData( const char *pSrc, int32_t iSize );
        char *getData() const;
        char *c_str() const;

        char &operator[]( int32_t iIndex );
        char operator[]( int32_t iIndex ) const;

        bool isEmpty() const;
        bool isNull() const;
        bool isNullOrEmpty() const;

        Blob &operator=( const Blob &rRhs );
        Blob &operator=( const char *pRhs );

        bool operator==( const Blob &rRhs ) const;
        bool operator==( const char *rRhs ) const;
        bool operator!=( const Blob &rRhs ) const;
        bool operator!=( const char *rRhs ) const;
        bool operator<( const Blob &rRhs ) const;
        bool operator<( const char *rRhs ) const;
        bool operator<=( const Blob &rRhs ) const;
        bool operator<=( const char *rRhs ) const;
        bool operator>( const Blob &rRhs ) const;
        bool operator>( const char *rRhs ) const;
        bool operator>=( const Blob &rRhs ) const;
        bool operator>=( const char *rRhs ) const;

        iterator begin();
        const_iterator begin() const;
        iterator end();
        const_iterator end() const;
        iterator rbegin();
        const_iterator rbegin() const;
        iterator rend();
        const_iterator rend() const;

        class iterator
        {
        friend class Blob;
        friend class const_iterator;
        private:
            iterator( Blob *pBlob, bool bForward );
            iterator( Blob *pBlob, int32_t iIndex, bool bForward );

        public:
            iterator();
            iterator( const iterator &rSrc );

            bool isValid() const;
            operator bool() const;
            char &operator *();

            iterator &operator++( int32_t );
            iterator &operator++();
            iterator &operator--( int32_t );
            iterator &operator--();
            iterator &operator+=( int32_t iDelta );
            iterator &operator-=( int32_t iDelta );
            iterator operator+( int32_t iDelta ) const;
            iterator operator-( int32_t iDelta ) const;
            bool operator==( const iterator &rRhs );
            bool operator==( const const_iterator &rRhs );
            bool operator!=( const iterator &rRhs );
            bool operator!=( const const_iterator &rRhs );

            iterator &operator=( const iterator &rRhs );

        private:
            Blob *pBlob;
            int32_t iIndex;
            bool bForward;
        };

        class const_iterator
        {
        friend class Blob;
        friend class iterator;
        private:
            const_iterator( const Blob *pBlob, bool bForward );
            const_iterator( const Blob *pBlob, int32_t iIndex, bool bForward );

        public:
            const_iterator();
            const_iterator( const const_iterator &rSrc );
            const_iterator( const iterator &rSrc );
            
            bool isValid() const;
            operator bool() const;
            char operator *() const;

            const_iterator &operator++( int32_t );
            const_iterator &operator++();
            const_iterator &operator--( int32_t );
            const_iterator &operator--();
            const_iterator &operator+=( int32_t iDelta );
            const_iterator &operator-=( int32_t iDelta );
            const_iterator operator+( int32_t iDelta ) const;
            const_iterator operator-( int32_t iDelta ) const;
            bool operator==( const iterator &rRhs );
            bool operator==( const const_iterator &rRhs );
            bool operator!=( const iterator &rRhs );
            bool operator!=( const const_iterator &rRhs );

            const_iterator &operator=( const iterator &rRhs );
            const_iterator &operator=( const const_iterator &rRhs );

        private:
            const Blob *pBlob;
            int32_t iIndex;
            bool bForward;
        };

    private:
        char *pData;
        int32_t iSize;
    };

    ArchiveBase &operator<<( ArchiveBase &ar, const Blob &s );
    ArchiveBase &operator>>( ArchiveBase &ar, Blob &s );

    template<typename T>
    uint32_t __calcHashCode( const T &k );

    template<typename T>
    bool __cmpHashKeys( const T &a, const T &b );

    template<> uint32_t __calcHashCode<Blob>( const Blob &k );
    template<> bool __cmpHashKeys<Blob>(
        const Blob &a, const Blob &b );
    
    template<typename t> void __tracer_format( const t &v );
    template<> void __tracer_format<Blob>( const Blob &v );

    class Formatter;
    Formatter &operator<<( Formatter &rOut, const Blob &b );
    Formatter &operator>>( Formatter &fIn, Blob &b );
}

#endif