LegacyFormatsProvider.h

/*
 * Copyright (c) Meta Platforms, Inc. and 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.
 */
 
#pragma once
 
#include <mutex>
 
#include <vrs/RecordFormat.h>
#include <vrs/VrsExport.h>
 
namespace vrs {
 
using std::map;
using std::recursive_mutex;
using std::string;
using std::unique_ptr;
using std::vector;
 
class DataLayout;
class LegacyFormatsProvider;
 
class VRS_API RecordFormatRegistrar {
  RecordFormatRegistrar() = default;
 
 public:
  // Public interface
 
  static void registerProvider(unique_ptr<LegacyFormatsProvider> provider);
 
  // VRS internal interface
 
  static RecordFormatRegistrar& getInstance();
 
  void getLegacyRecordFormats(RecordableTypeId id, RecordFormatMap& outFormats);
 
  unique_ptr<DataLayout> getLegacyDataLayout(const ContentBlockId& blockId);
 
  unique_ptr<DataLayout> getLatestDataLayout(RecordableTypeId typeId, Record::Type recordType);
 
  bool addLegacyRecordFormat(
      RecordableTypeId typeId,
      Record::Type recordType,
      uint32_t formatVersion,
      const RecordFormat& format,
      const vector<const DataLayout*>& layouts);
 
 private:
  const map<string, string>& getLegacyRegistry(RecordableTypeId typeId);
  void registerProviderInternal(unique_ptr<LegacyFormatsProvider> provider);
 
  recursive_mutex mutex_;
  vector<unique_ptr<LegacyFormatsProvider>> providers_;
  map<RecordableTypeId, map<string, string>> legacyRecordFormats_;
};
 
class VRS_API LegacyFormatsProvider {
 public:
  LegacyFormatsProvider() = default;
  virtual ~LegacyFormatsProvider();
  LegacyFormatsProvider(const LegacyFormatsProvider&) = delete;
  LegacyFormatsProvider& operator=(const LegacyFormatsProvider&) = delete;
  LegacyFormatsProvider(LegacyFormatsProvider&&) = delete;
  LegacyFormatsProvider& operator=(LegacyFormatsProvider&&) = delete;
 
  virtual void registerLegacyRecordFormats(RecordableTypeId typeId) = 0;
 
 protected:
  static bool addLegacyRecordFormat(
      RecordableTypeId typeId,
      Record::Type recordType,
      uint32_t formatVersion,
      const RecordFormat& format,
      const vector<const DataLayout*>& layouts) {
    return RecordFormatRegistrar::getInstance().addLegacyRecordFormat(
        typeId, recordType, formatVersion, format, layouts);
  }
};
 
} // namespace vrs