bin/zxdb/symbols/mock_module_symbols.h

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

#pragma once

#include <map>

#include "garnet/bin/zxdb/symbols/module_symbol_index.h"
#include "garnet/bin/zxdb/symbols/module_symbols.h"
#include "garnet/bin/zxdb/symbols/symbol.h"

namespace zxdb {

// A mock for symbol lookup.
class MockModuleSymbols : public ModuleSymbols {
 public:
  explicit MockModuleSymbols(const std::string& local_file_name);
  ~MockModuleSymbols() override;

  // Adds a mock mapping from the given name to the list of locations.
  void AddSymbolLocations(const std::string& name, std::vector<Location> locs);

  // Adds a mock mapping from address to line details. This matches an exact
  // address only, not a range.
  void AddLineDetails(uint64_t absolute_address, LineDetails details);

  // Injects a response to IndexDieRefToSymbol for resolving symbols from the
  // index. See index() getter.
  void AddDieRef(const ModuleSymbolIndexNode::DieRef& die,
                 fxl::RefPtr<Symbol> symbol);

  // Provides writable access to the index for tests to insert data. To hook
  // up symbols, add them to the index and call AddDieRef() with the same
  // DieRef and the symbol you want it to resolve to.
  ModuleSymbolIndex& index() { return index_; }

  // ModuleSymbols implementation.
  ModuleSymbolStatus GetStatus() const override;
  std::vector<Location> ResolveInputLocation(
      const SymbolContext& symbol_context, const InputLocation& input_location,
      const ResolveOptions& options) const override;
  LineDetails LineDetailsForAddress(const SymbolContext& symbol_context,
                                    uint64_t address) const override;
  std::vector<std::string> FindFileMatches(
      const std::string& name) const override;
  const ModuleSymbolIndex& GetIndex() const override;
  LazySymbol IndexDieRefToSymbol(
      const ModuleSymbolIndexNode::DieRef&) const override;

 private:
  ModuleSymbolIndex index_;

  std::string local_file_name_;

  // Maps manually-added symbols to their locations.
  std::map<std::string, std::vector<Location>> symbols_;

  // Maps manually-added addresses to line details.
  std::map<uint64_t, LineDetails> lines_;

  // Maps manually-aded DieRefs offsets to symbols.
  std::map<uint32_t, fxl::RefPtr<Symbol>> die_refs_;
};

}  // namespace zxdb