Object.h

Go to the documentation of this file.

// Copyright (c) 2018 the Talvos developers. All rights reserved.
//
// This file is distributed under a three-clause BSD license. For full license
// terms please see the LICENSE file distributed with this source code.


#ifndef TALVOS_OBJECT_H
#define TALVOS_OBJECT_H

#include <cstdint>
#include <iosfwd>
#include <vector>

namespace talvos
{

class Memory;
class Type;

struct PtrMatrixLayout
{
  enum
  {
    ROW_MAJOR,
    COL_MAJOR
  } Order;

  uint32_t Stride = 0;

  operator bool() const { return Stride != 0; }
};

struct DescriptorElement
{
  uint64_t Address;  
  uint64_t NumBytes; 
};

class Object
{
public:
  Object() { Data = nullptr; }

  Object(const Type *Ty, const uint8_t *Data = nullptr);

  template <typename T> Object(const Type *Ty, T Value);

  ~Object();

  Object(const Object &Src);

  Object &operator=(const Object &Src);

  Object(Object &&Src) noexcept;

  Object extract(const std::vector<uint32_t> &Indices) const;

  template <typename T> T get(uint32_t Element = 0) const;

  uint8_t *getData() { return Data; }

  const uint8_t *getData() const { return Data; }

  const DescriptorElement *getDescriptorElements() const;

  const PtrMatrixLayout &getMatrixLayout() const;

  const Type *getType() const { return Ty; }

  void insert(const std::vector<uint32_t> &Indices, const Object &Element);

  operator bool() const { return Data ? true : false; }

  friend std::ostream &operator<<(std::ostream &Stream, const Object &O);

  template <typename T> void set(T Value, uint32_t Element = 0);

  void setDescriptorElements(const DescriptorElement *DAE);

  void setMatrixLayout(const PtrMatrixLayout &ML);

  void store(Memory &Mem, uint64_t Address) const;

  void store(Memory &Mem, const Object &Pointer) const;

  void zero();

  static Object load(const Type *Ty, const Memory &Mem, uint64_t Address);

  static Object load(const Type *Ty, const Memory &Mem, const Object &Pointer);

private:
  const Type *Ty; 
  uint8_t *Data;  

  PtrMatrixLayout MatrixLayout;

  const DescriptorElement *DescriptorElements = nullptr;
};

} // namespace talvos

#endif