aboutsummaryrefslogtreecommitdiffstats
path: root/libparc/parc/algol/parc_BufferComposer.c
blob: 30e23acf21b1328cdda7a1984a6fc6057e1f3573 (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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 */

#include <config.h>

#include <parc/assert/parc_Assert.h>

#include <stdlib.h>
#include <stdarg.h>
#include <stdio.h>

#include <parc/algol/parc_Memory.h>
#include <parc/algol/parc_Object.h>
#include <parc/algol/parc_BufferComposer.h>
#include <parc/algol/parc_Buffer.h>

struct parc_buffer_composer {
    size_t incrementHeuristic;
    PARCBuffer *buffer;
};

static void
_finalize(PARCBufferComposer **bufferPtr)
{
    if (bufferPtr != NULL) {
        PARCBufferComposer *composer = *bufferPtr;
        parcBufferComposer_OptionalAssertValid(composer);
        if (composer->buffer != NULL) {
            parcBuffer_Release(&composer->buffer);
        }
    }
}

parcObject_ExtendPARCObject(PARCBufferComposer, _finalize, NULL, NULL, parcBufferComposer_Equals, NULL, NULL, NULL);

static PARCBufferComposer *
_create(void)
{
    return parcObject_CreateInstance(PARCBufferComposer);
}

/**
 * Ensure that the given `PARCBufferComposer` has at least the required number of bytes remaining.
 *
 * If the remaining capacity (the difference between the capacity of the buffer and its current position)
 * of the underlying `PARCBuffer` is less than the required number of bytes,
 * the underlying PARCBuffer is expanded with sufficient space to accomodate the required number of bytes.
 *
 * The position, limit, and mark remain unchanged.
 * The capacity is increased.
 */
static PARCBufferComposer *
_ensureRemaining(PARCBufferComposer *composer, size_t required)
{
    parcBufferComposer_OptionalAssertValid(composer);

    size_t remainingCapacity = parcBuffer_Capacity(composer->buffer) - parcBuffer_Position(composer->buffer);

    if (remainingCapacity < required) {
        size_t incrementAmount = required;
        if (incrementAmount < composer->incrementHeuristic) {
            incrementAmount = composer->incrementHeuristic;
        }
        size_t newCapacity = parcBuffer_Capacity(composer->buffer) + incrementAmount;

        PARCBuffer *newBuffer = parcBuffer_Allocate(newCapacity);
        parcBuffer_Flip(composer->buffer);
        parcBuffer_PutBuffer(newBuffer, composer->buffer);
        parcBuffer_Release(&composer->buffer);
        composer->buffer = newBuffer;
    }

    return composer;
}

void
parcBufferComposer_AssertValid(const PARCBufferComposer *composer)
{
    parcTrapIllegalValueIf(composer == NULL, "Parameter must be a non-null pointer to a valid PARCBufferComposer.");
    parcTrapIllegalValueIf(composer->incrementHeuristic < sizeof(void *), "Heuristic cannot be < sizeof(void *) (%zd), actual %zd", sizeof(void *), composer->incrementHeuristic);
}

PARCBufferComposer *
parcBufferComposer_Create(void)
{
    return parcBufferComposer_Allocate(parcMemory_RoundUpToCacheLine(LEVEL1_DCACHE_LINESIZE));
}

PARCBufferComposer *
parcBufferComposer_Allocate(size_t size)
{
    PARCBufferComposer *result = _create();
    if (result != NULL) {
        result->buffer = parcBuffer_Allocate(size);
        result->incrementHeuristic = parcMemory_RoundUpToCacheLine(size);
        if (result->buffer == NULL) {
            result->incrementHeuristic = sizeof(void *); // minimum size
            parcBufferComposer_Release(&result);
        }
    }
    return result;
}

parcObject_ImplementAcquire(parcBufferComposer, PARCBufferComposer);

parcObject_ImplementRelease(parcBufferComposer, PARCBufferComposer);

bool
parcBufferComposer_Equals(const PARCBufferComposer *x, const PARCBufferComposer *y)
{
    if (x == y) {
        return true;
    }
    if (x == NULL || y == NULL) {
        return false;
    }

    if (x->incrementHeuristic == y->incrementHeuristic) {
        if (parcBuffer_Equals(x->buffer, y->buffer)) {
            return true;
        }
    }

    return false;
}

PARCBufferComposer *
parcBufferComposer_PutArray(PARCBufferComposer *composer, const unsigned char *bytes, size_t length)
{
    if (length > 0) {
        composer = _ensureRemaining(composer, length);
        if (composer != NULL) {
            parcBuffer_PutArray(composer->buffer, length, bytes);
        }
    }

    return composer;
}

PARCBufferComposer *
parcBufferComposer_PutChar(PARCBufferComposer *composer, char val)
{
    return parcBufferComposer_PutUint8(composer, (uint8_t) val);
}

PARCBufferComposer *
parcBufferComposer_PutUint8(PARCBufferComposer *composer, uint8_t byte)
{
    composer = _ensureRemaining(composer, 1);
    if (composer != NULL) {
        parcBuffer_PutUint8(composer->buffer, byte);
    }

    return composer;
}

PARCBufferComposer *
parcBufferComposer_PutUint16(PARCBufferComposer *composer, uint16_t value)
{
    composer = _ensureRemaining(composer, 2);
    if (composer != NULL) {
        parcBuffer_PutUint16(composer->buffer, value);
    }

    return composer;
}

PARCBufferComposer *
parcBufferComposer_PutUint32(PARCBufferComposer *composer, uint32_t value)
{
    composer = _ensureRemaining(composer, 4);
    if (composer != NULL) {
        parcBuffer_PutUint32(composer->buffer, value);
    }

    return composer;
}

PARCBufferComposer *
parcBufferComposer_PutUint64(PARCBufferComposer *composer, uint64_t value)
{
    composer = _ensureRemaining(composer, 8);
    if (composer != NULL) {
        parcBuffer_PutUint64(composer->buffer, value);
    }

    return composer;
}

PARCBufferComposer *
parcBufferComposer_PutBuffer(PARCBufferComposer *composer, const PARCBuffer *source)
{
    composer = _ensureRemaining(composer, parcBuffer_Remaining(source));
    if (composer != NULL) {
        parcBuffer_PutBuffer(composer->buffer, source);
    }

    return composer;
}

PARCBufferComposer *
parcBufferComposer_PutString(PARCBufferComposer *composer, const char *string)
{
    PARCBuffer *wrapper = parcBuffer_AllocateCString(string);

    composer = _ensureRemaining(composer, parcBuffer_Remaining(wrapper));
    if (composer != NULL) {
        parcBuffer_PutBuffer(composer->buffer, wrapper);
    }

    parcBuffer_Release(&wrapper);

    return composer;
}

PARCBufferComposer *
parcBufferComposer_PutStrings(PARCBufferComposer *composer, ...)
{
    va_list ap;
    va_start(ap, composer);

    char *arg;
    while ((arg = va_arg(ap, char *)) != NULL) {
        parcBufferComposer_PutString(composer, arg);
    }
    va_end(ap);

    return composer;
}

PARCBufferComposer *
parcBufferComposer_Format(PARCBufferComposer *composer, const char *format, ...)
{
    va_list ap;
    va_start(ap, format);
    char *cString;
    ssize_t written = vasprintf(&cString, format, ap);
    parcAssertTrue(written >= 0, "Got error from vasprintf");
    va_end(ap);

    parcBufferComposer_PutString(composer, cString);
    free(cString);

    return composer;
}

PARCBuffer *
parcBufferComposer_GetBuffer(const PARCBufferComposer *composer)
{
    return composer->buffer;
}

PARCBuffer *
parcBufferComposer_CreateBuffer(PARCBufferComposer *composer)
{
    return parcBuffer_Duplicate(composer->buffer);
}

PARCBuffer *
parcBufferComposer_ProduceBuffer(PARCBufferComposer *composer)
{
    return parcBuffer_Acquire(parcBuffer_Flip(composer->buffer));
}

char *
parcBufferComposer_ToString(PARCBufferComposer *composer)
{
    PARCBuffer *buffer = parcBuffer_Flip(parcBuffer_Duplicate(composer->buffer));

    char *result = parcBuffer_ToString(buffer);
    parcBuffer_Release(&buffer);

    return result;
}