extensions/renderer/bindings/api_type_reference_map.h

// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef EXTENSIONS_RENDERER_BINDINGS_API_TYPE_REFERENCE_MAP_H_
#define EXTENSIONS_RENDERER_BINDINGS_API_TYPE_REFERENCE_MAP_H_

#include <map>
#include <memory>
#include <string>

#include "base/callback.h"
#include "base/macros.h"

namespace extensions {
class APISignature;
class ArgumentSpec;

// A map storing type specifications and method signatures for API definitions.
class APITypeReferenceMap {
 public:
  // A callback used to initialize an unknown type, so that these can be
  // created lazily.
  using InitializeTypeCallback = base::Callback<void(const std::string& name)>;

  explicit APITypeReferenceMap(const InitializeTypeCallback& initialize_type);
  ~APITypeReferenceMap();

  // Adds the |spec| to the map under the given |name|.
  void AddSpec(const std::string& name, std::unique_ptr<ArgumentSpec> spec);

  // Returns the spec for the given |name|.
  const ArgumentSpec* GetSpec(const std::string& name) const;

  // Adds the |signature| to the map under the given |name|. |name| is expected
  // to be fully qualified with the API and method name, e.g. tabs.create.
  void AddAPIMethodSignature(const std::string& name,
                             std::unique_ptr<APISignature> signature);

  // Returns the signature for the given |name|. |name| is expected
  // to be fully qualified with the API and method name, e.g. tabs.create.
  const APISignature* GetAPIMethodSignature(const std::string& name) const;

  // Adds the |signature| to the map under the given |name|. |name| is expected
  // to be fully qualified with API, type, and method (e.g.
  // storage.StorageArea.get).
  void AddTypeMethodSignature(const std::string& name,
                              std::unique_ptr<APISignature> signature);

  // Returns the signature for the given |name|. |name| is expected
  // to be fully qualified with API, type, and method (e.g.
  // storage.StorageArea.get).
  const APISignature* GetTypeMethodSignature(const std::string& name) const;

  // Returns true if the map has a signature for the given |name|. Unlike
  // GetTypeMethodSignature(), this will not try to fetch the type by loading
  // an API.
  bool HasTypeMethodSignature(const std::string& name) const;

  // Adds a custom signature for bindings to use.
  void AddCustomSignature(const std::string& name,
                          std::unique_ptr<APISignature> signature);

  // Looks up a custom signature that was previously added.
  const APISignature* GetCustomSignature(const std::string& name) const;

  // Adds an expected signature for an API callback.
  void AddCallbackSignature(const std::string& name,
                            std::unique_ptr<APISignature> signature);

  const APISignature* GetCallbackSignature(const std::string& name) const;

  bool empty() const { return type_refs_.empty(); }
  size_t size() const { return type_refs_.size(); }

 private:
  InitializeTypeCallback initialize_type_;

  std::map<std::string, std::unique_ptr<ArgumentSpec>> type_refs_;
  std::map<std::string, std::unique_ptr<APISignature>> api_methods_;
  std::map<std::string, std::unique_ptr<APISignature>> type_methods_;
  std::map<std::string, std::unique_ptr<APISignature>> custom_signatures_;
  std::map<std::string, std::unique_ptr<APISignature>> callback_signatures_;

  DISALLOW_COPY_AND_ASSIGN(APITypeReferenceMap);
};

}  // namespace extensions

#endif  // EXTENSIONS_RENDERER_BINDINGS_API_TYPE_REFERENCE_MAP_H_