summaryrefslogtreecommitdiff
path: root/lang/java/src/com/wiredtiger/db/PackFormatInputStream.java
blob: 02639bfe77af670193e765e9ba06172141f39db6 (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
/*-
 * Public Domain 2014-2016 MongoDB, Inc.
 * Public Domain 2008-2014 WiredTiger, Inc.
 *
 * This is free and unencumbered software released into the public domain.
 *
 * Anyone is free to copy, modify, publish, use, compile, sell, or
 * distribute this software, either in source code form or as a compiled
 * binary, for any purpose, commercial or non-commercial, and by any
 * means.
 *
 * In jurisdictions that recognize copyright laws, the author or authors
 * of this software dedicate any and all copyright interest in the
 * software to the public domain. We make this dedication for the benefit
 * of the public at large and to the detriment of our heirs and
 * successors. We intend this dedication to be an overt act of
 * relinquishment in perpetuity of all present and future rights to this
 * software under copyright law.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
package com.wiredtiger.db;

import java.io.ByteArrayInputStream;
import java.lang.StringBuffer;
import com.wiredtiger.db.PackUtil;
import com.wiredtiger.db.WiredTigerPackingException;

/**
 * An internal helper class for consuming pack format strings.
 *
 * Applications should not need to use this class.
 */
public class PackFormatInputStream {

    protected String format;
    protected int formatOff;
    protected int formatRepeatCount;

    /**
     * Constructor for a format stream.
     *
     * \param format the encoded format backing string.
     */
    protected PackFormatInputStream(String format) {
        this.format = format;
        formatOff = 0;
        formatRepeatCount = 0;
    }

    /**
     * Standard toString - returns the string used during construction.
     */
    public String toString() {
        return format;
    }

    /**
     * Returns the approximate count of elements left in the format.
     * This method does not account for repeat counts or string length
     * encodings - so should be used as a guide only.
     */
    public int available() {
        return format.length() - formatOff + formatRepeatCount;
    }

    /**
     * Reset the current stream position.
     */
    public void reset() {
        formatOff = 0;
        formatRepeatCount = 0;
    }

    /**
     * Return the decoded type for the next entry in the format stream. Does
     * not adjust the position of the stream.
     */
    protected char getType()
    throws WiredTigerPackingException {
        if (formatOff >= format.length()) {
            throw new WiredTigerPackingException(
                "No more fields in format.");
        }

        String fieldName;
        boolean lenOK = false;
        int countOff = 0;

        while (PackUtil.PackSpecialCharacters.indexOf(
                    format.charAt(formatOff + countOff)) != -1) {
            countOff++;
        }
        // Skip repeat counts and sizes
        while (Character.isDigit(format.charAt(formatOff + countOff))) {
            countOff++;
        }
        return format.charAt(formatOff + countOff);
    }

    /**
     * Check to see if the next entry is compatible with the requested type.
     *
     * \param asking the format type to match.
     * \param consume indicates whether to update the stream position.
     */
    protected void checkType(char asking, boolean consume)
    throws WiredTigerPackingException {

        char expected = getType();
        if (Character.toLowerCase(expected) != Character.toLowerCase(asking))
            throw new WiredTigerPackingException(
                "Format mismatch. Wanted: " + asking + ", got: " + expected);
        if (consume) {
            consume();
        }
    }

    /**
     * Move the format stream position ahead one position.
     */
    protected void consume() {
        if (formatRepeatCount > 1) {
            --formatRepeatCount;
        } else if (formatRepeatCount == 1) {
            formatRepeatCount = 0;
            ++formatOff;
        } else {
            while (PackUtil.PackSpecialCharacters.indexOf(
                        format.charAt(formatOff)) != -1) {
                ++formatOff;
            }

            // Don't need to worry about String or byte array size counts
            // since they have already been consumed.
            formatRepeatCount = getIntFromFormat(true);
            if (formatRepeatCount == 0) {
                ++formatOff;
            }
        }
    }

    /**
     * Decode an integer from the format string, return zero if not starting
     * on a digit.
     *
     * \param advance whether to move the stream position.
     */
    private int getIntFromFormat(boolean advance) {
        int valueLen = 0;
        int countOff;
        for (countOff = 0;
                Character.isDigit(format.charAt(formatOff + countOff));
                countOff++) {
            valueLen *= 10;
            valueLen += Character.digit(format.charAt(formatOff + countOff), 10);
        }
        if (advance) {
            formatOff += countOff;
        }
        return valueLen;
    }

    /**
     * Retrieve a length from the format string. Either for a repeat count
     * or a string length. Return one if no explicit repeat count.
     *
     * \param advance whether to move the stream position.
     */
    protected int getLengthFromFormat(boolean advance) {
        int valueLen = getIntFromFormat(advance);
        if (valueLen == 0) {
            valueLen = 1;
        }
        return valueLen;
    }

    /**
     * Return whether there is an explicit length indicated in the format
     * string.
     */
    protected boolean hasLength() {
        return (getIntFromFormat(false) > 0);
    }
}