schema.h

// Copyright 2018-2019 Delft University of Technology
//
// 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.
 
#pragma once
 
#include <arrow/api.h>
#include <cerata/api.h>
 
#include <memory>
#include <vector>
#include <optional>
#include <string>
 
#include "fletchgen/bus.h"
#include "fletchgen/utils.h"
 
namespace fletchgen {
 
using fletcher::Mode;
 
class FletcherSchema {
 public:
  explicit FletcherSchema(const std::shared_ptr<arrow::Schema> &arrow_schema, const std::string &schema_name = "");
 
  static std::shared_ptr<FletcherSchema> Make(const std::shared_ptr<arrow::Schema> &arrow_schema,
                                              const std::string &schema_name = "");
 
  [[nodiscard]] std::shared_ptr<arrow::Schema> arrow_schema() const { return arrow_schema_; }
 
  [[nodiscard]] Mode mode() const { return mode_; }
  [[nodiscard]] std::string name() const { return name_; }
 
 private:
  std::shared_ptr<arrow::Schema> arrow_schema_;
  Mode mode_;
  std::string name_;
  BusDim bus_dims_;
};
 
class SchemaSet : public cerata::Named {
 public:
  explicit SchemaSet(std::string name);
  static std::shared_ptr<SchemaSet> Make(const std::string &name);
  [[nodiscard]] bool RequiresReading() const;
  [[nodiscard]] bool RequiresWriting() const;
  [[nodiscard]] bool HasSchemaWithName(const std::string &name) const;
  [[nodiscard]] std::optional<std::shared_ptr<FletcherSchema>> GetSchema(const std::string &name) const;
  void AppendSchema(const std::shared_ptr<arrow::Schema> &schema);
  [[nodiscard]] std::vector<std::shared_ptr<FletcherSchema>> schemas() const { return schemas_; }
  [[nodiscard]] std::vector<std::shared_ptr<FletcherSchema>> read_schemas() const;
  [[nodiscard]] std::vector<std::shared_ptr<FletcherSchema>> write_schemas() const;
  void Sort();
 
 private:
  std::vector<std::shared_ptr<FletcherSchema>> schemas_;
};
 
}  // namespace fletchgen