FileHandlerFactory.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 <map>
#include <memory>
#include <mutex>
#include <string>
 
#include <vrs/ForwardDefinitions.h>
#include <vrs/VrsExport.h>
 
namespace vrs {
 
using std::map;
using std::mutex;
using std::string;
using std::unique_ptr;
 
// Exported base class meant to be subclassed, for example FakeFileHandlerFactory in tests.
class VRS_API FileHandlerFactory { // NOLINT(cppcoreguidelines-virtual-class-destructor)
 public:
  static FileHandlerFactory& getInstance();
 
  void registerFileDelegator(const string& name, unique_ptr<FileDelegator>&& delegator);
  void unregisterFileDelegator(const string& name);
 
  void registerExtraDelegator(
      const string& extraName,
      const string& extraValue,
      unique_ptr<FileDelegator>&& delegator);
  void unregisterExtraDelegator(const string& extraName, const string& extraValue);
  FileDelegator* getExtraDelegator(const FileSpec& fileSpec);
  FileDelegator* getExtraDelegator(const string& extraName, const string& extraValue);
 
  void registerFileHandler(unique_ptr<FileHandler>&& fileHandler);
 
  void registerFileHandler(const string& name, unique_ptr<FileHandler>&& fileHandler);
  void unregisterFileHandler(const string& fileHandlerName);
  unique_ptr<FileHandler> getFileHandler(const string& name);
  FileDelegator* getFileDelegator(const string& name);
 
  virtual int delegateOpen(const string& path, unique_ptr<FileHandler>& outNewDelegate);
  virtual int delegateOpen(const FileSpec& fileSpec, unique_ptr<FileHandler>& outNewDelegate);
 
  virtual int parseUri(FileSpec& inOutFileSpec, size_t colonIndex);
 
 protected:
  FileHandlerFactory();
  virtual ~FileHandlerFactory() = default;
 
 private:
  mutex mutex_;
  map<string, unique_ptr<FileDelegator>> fileDelegatorMap_;
  map<string, unique_ptr<FileHandler>> fileHandlerMap_;
  map<string, map<string, unique_ptr<FileDelegator>>> extraDelegatorMap_;
};
 
} // namespace vrs