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
|
// BSD 3-Clause License; see https://github.com/scikit-hep/awkward/blob/main/LICENSE
#ifndef AWKWARD_STRINGBUILDER_H_
#define AWKWARD_STRINGBUILDER_H_
#include "awkward/common.h"
#include "awkward/BuilderOptions.h"
#include "awkward/GrowableBuffer.h"
#include "awkward/builder/Builder.h"
namespace awkward {
/// @class StringBuilder
///
/// @brief Builder node that accumulates strings.
class EXPORT_SYMBOL StringBuilder: public Builder {
public:
/// @brief Create an empty StringBuilder.
/// @param options Configuration options for building an array;
/// these are passed to every Builder's constructor.
/// @param encoding If `nullptr`, the string is an unencoded bytestring;
/// if `"utf-8"`, it is encoded with variable-width UTF-8.
/// Currently, no other encodings have been defined.
static const BuilderPtr
fromempty(const BuilderOptions& options, const char* encoding);
/// @brief Create a StringBuilder from a full set of parameters.
///
/// @param options Configuration options for building an array;
/// these are passed to every Builder's constructor.
/// @param offsets Contains the accumulated offsets (like
/// {@link ListOffsetArrayOf#offsets ListOffsetArray::offsets}).
/// @param content Another GrowableBuffer, but for the characters in all
/// the strings.
/// @param encoding If `nullptr`, the string is an unencoded bytestring;
/// if `"utf-8"`, it is encoded with variable-width UTF-8.
/// Currently, no other encodings have been defined.
StringBuilder(const BuilderOptions& options,
GrowableBuffer<int64_t> offsets,
GrowableBuffer<uint8_t> content,
const char* encoding);
/// @brief If `nullptr`, the string is an unencoded bytestring;
/// if `"utf-8"`, it is encoded with variable-width UTF-8.
/// Currently, no other encodings have been defined.
const char*
encoding() const;
/// @brief User-friendly name of this class: `"StringBuilder"`.
const std::string
classname() const override;
const std::string
to_buffers(BuffersContainer& container, int64_t& form_key_id) const override;
int64_t
length() const override;
void
clear() override;
/// @copydoc Builder::active()
///
/// A StringBuilder is never active.
bool
active() const override;
const BuilderPtr
null() override;
const BuilderPtr
boolean(bool x) override;
const BuilderPtr
integer(int64_t x) override;
const BuilderPtr
real(double x) override;
const BuilderPtr
complex(std::complex<double> x) override;
const BuilderPtr
datetime(int64_t x, const std::string& unit) override;
const BuilderPtr
timedelta(int64_t x, const std::string& unit) override;
const BuilderPtr
string(const char* x, int64_t length, const char* encoding) override;
const BuilderPtr
beginlist() override;
const BuilderPtr
endlist() override;
const BuilderPtr
begintuple(int64_t numfields) override;
const BuilderPtr
index(int64_t index) override;
const BuilderPtr
endtuple() override;
const BuilderPtr
beginrecord(const char* name, bool check) override;
void
field(const char* key, bool check) override;
const BuilderPtr
endrecord() override;
const BuilderOptions&
options() const { return options_; }
const GrowableBuffer<int64_t>& buffer() const { return offsets_; }
const GrowableBuffer<uint8_t>& content() const { return content_; }
private:
const BuilderOptions options_;
GrowableBuffer<int64_t> offsets_;
GrowableBuffer<uint8_t> content_;
const char* encoding_;
};
}
#endif // AWKWARD_STRINGBUILDER_H_
|