Builder.h

Go to the documentation of this file.

// BSD 3-Clause License; see https://github.com/scikit-hep/awkward/blob/main/LICENSE
 
#ifndef AWKWARD_FILLABLE_H_
#define AWKWARD_FILLABLE_H_
 
#include <complex>
#include <string>
#include <vector>
 
#include "awkward/common.h"
 
namespace awkward {
  class Builder;
  using BuilderPtr = std::shared_ptr<Builder>;

  class BuffersContainer {
  public:
    virtual void
      copy_buffer(const std::string& name, const void* source, int64_t num_bytes) = 0;

    virtual void
      full_buffer(const std::string& name, int64_t length, int64_t value, const std::string& dtype) = 0;
 
    virtual void*
      empty_buffer(const std::string& name, int64_t num_bytes) = 0;
  };

  class EXPORT_SYMBOL Builder: public std::enable_shared_from_this<Builder> {
  public:
    virtual ~Builder();

    virtual const std::string
      classname() const = 0;

    virtual const std::string
      to_buffers(BuffersContainer& container, int64_t& form_key_id) const = 0;

    virtual int64_t
      length() const = 0;

    virtual void
      clear() = 0;

    virtual bool
      active() const = 0;

    virtual const BuilderPtr
      null() = 0;

    virtual const BuilderPtr
      boolean(bool x) = 0;

    virtual const BuilderPtr
      integer(int64_t x) = 0;

    virtual const BuilderPtr
      real(double x) = 0;

    virtual const BuilderPtr
      complex(std::complex<double> x) = 0;

    virtual const BuilderPtr
      datetime(int64_t x, const std::string& unit) = 0;

    virtual const BuilderPtr
      timedelta(int64_t x, const std::string& unit) = 0;

    virtual const BuilderPtr
      string(const char* x, int64_t length, const char* encoding) = 0;

    virtual const BuilderPtr
      beginlist() = 0;

    virtual const BuilderPtr
      endlist() = 0;

    virtual const BuilderPtr
      begintuple(int64_t numfields) = 0;

    virtual const BuilderPtr
      index(int64_t index) = 0;

    virtual const BuilderPtr
      endtuple() = 0;

    virtual const BuilderPtr
      beginrecord(const char* name, bool check) = 0;

    virtual void
      field(const char* key, bool check) = 0;

    virtual const BuilderPtr
      endrecord() = 0;
  };
}
 
#endif // AWKWARD_FILLABLE_H_