view_index.h

/* Copyright (C) 2013-2014 Michal Brzozowski (rusolis@poczta.fm)

   This file is part of KeeperRL.

   KeeperRL is free software; you can redistribute it and/or modify it under the terms of the
   GNU General Public License as published by the Free Software Foundation; either version 2
   of the License, or (at your option) any later version.

   KeeperRL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
   even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License along with this program.
   If not, see http://www.gnu.org/licenses/ . */

#pragma once

#include "enums.h"
#include "util.h"
#include "view_layer.h"
#include "item_counts.h"
#include "t_string.h"

class ViewObject;
class TStringId;

RICH_ENUM(HighlightType,
  DIG,
  CUT_TREE,
  FETCH_ITEMS,
  PERMANENT_FETCH_ITEMS,
  RECT_SELECTION,
  RECT_DESELECTION,
  MEMORY,
  PRIORITY_TASK,
  FORBIDDEN_ZONE,
  UNAVAILABLE,
  CREATURE_DROP,
  CLICKABLE_FURNITURE,
  CLICKED_FURNITURE,
  STORAGE_EQUIPMENT,
  STORAGE_RESOURCES,
  QUARTERS,
  LEISURE,
  INDOORS,
  INSUFFICIENT_LIGHT,
  GUARD_ZONE1,
  GUARD_ZONE2,
  GUARD_ZONE3,
  HOSTILE_TOTEM,
  ALLIED_TOTEM,
  TORTURE_UNAVAILABLE,
  PRISON_NOT_CLOSED,
  PIGSTY_NOT_CLOSED,
  TILE_BELOW
);

extern optional<TStringId> getDescription(HighlightType);
ViewId getViewId(HighlightType, bool active);

class ViewIndex {
  public:
  ViewIndex();
  void insert(ViewObject);
  bool hasObject(ViewLayer) const;
  void removeObject(ViewLayer);
  const ViewObject& getObject(ViewLayer) const;
  ViewObject& getObject(ViewLayer);
  const ViewObject* getTopObject(const vector<ViewLayer>&) const;
  void mergeFromMemory(const ViewIndex& memory);
  void mergeGroundBelow(const ViewIndex& memory);
  bool isEmpty() const;
  bool noObjects() const;
  bool hasAnyHighlight() const;
  ~ViewIndex();
  // If the tile is not visible, we still need the id of the floor tile to render connections properly.
  optional<ViewId> getHiddenId() const;
  void setHiddenId(ViewId);
  vector<ViewObject>& getAllObjects();
  const vector<ViewObject>& getAllObjects() const;

  void setHighlight(HighlightType, bool = true);
  void addGasAmount(TString name, Color);
  void setNightAmount(double);

  bool isHighlight(HighlightType) const;
  double getNightAmount() const;

  struct TileGasInfo {
    Color SERIAL(color);
    TString SERIAL(name);
    SERIALIZE_ALL(color, name)
  };
  const vector<TileGasInfo>& getGasAmounts() const;

  const ItemCounts& getItemCounts() const;
  const ItemCounts& getEquipmentCounts() const;
  ItemCounts& modItemCounts();
  ItemCounts& modEquipmentCounts();

  template <class Archive>
  void serialize(Archive& ar, const unsigned int version);

  private:
  heap_optional<pair<ItemCounts, ItemCounts>> SERIAL(itemCounts);
  std::array<char, EnumInfo<ViewLayer>::size> SERIAL(objIndex);
  vector<ViewObject> SERIAL(objects);
  EnumSet<HighlightType> SERIAL(highlights);

  vector<TileGasInfo> SERIAL(tileGas);
  std::uint8_t SERIAL(nightAmount);
  bool SERIAL(anyHighlight) = false;
  optional<ViewId> hiddenId;
};