console_types.hpp

Go to the documentation of this file.

/* BSD 3-Clause License
 *
 * Copyright © 2008-2026, Jice and the libtcod contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#pragma once
#ifndef TCOD_CONSOLE_TYPES_HPP_
#define TCOD_CONSOLE_TYPES_HPP_
 
#include <memory>
#include <stdexcept>
#include <string>
#include <utility>
 
#include "console.h"
 
namespace tcod {
struct ConsoleDeleter {
  void operator()(TCOD_Console* console) const { TCOD_console_delete(console); }
};

typedef std::unique_ptr<struct TCOD_Console, ConsoleDeleter> ConsolePtr;

class Console {
 public:
  TCODLIB_BEGIN_IGNORE_DEPRECATIONS // Remove this after references to TCOD_Console methods are removed.

  Console() : Console{0, 0} {}

  explicit Console(int width, int height) : console_(TCOD_console_new(width, height)) {
    if (!console_) throw std::runtime_error(TCOD_get_error());
  }

  explicit Console(const std::array<int, 2>& size) : Console{size[0], size[1]} {}

  explicit Console(const Console& other) : Console{other.console_->w, other.console_->h} {
    std::copy(other.console_->begin(), other.console_->end(), console_->begin());
  }

  explicit Console(ConsolePtr ptr) : console_{std::move(ptr)} {
    if (!console_) throw std::invalid_argument("Pointer must not be nullptr.");
  }

  explicit Console(TCOD_Console* ptr) : console_{ptr} {
    if (!console_) throw std::invalid_argument("TCOD_Console pointer must not be nullptr.");
  }

  Console& operator=(const Console& rhs) {
    if (console_->w != rhs.console_->w || console_->h != rhs.console_->h) {
      *this = Console{{rhs.console_->w, rhs.console_->h}};
    }
    std::copy(rhs.console_->begin(), rhs.console_->end(), console_->begin());
    return *this;
  }

  Console(Console&&) noexcept = default;

  Console& operator=(Console&& rhs) noexcept {
    swap(*this, rhs);
    return *this;
  }

  ~Console() noexcept = default;

  friend void swap(Console& lhs, Console& rhs) noexcept {
    using std::swap;
    swap(lhs.console_, rhs.console_);
  }

  [[nodiscard]] operator TCOD_Console&() { return *console_; }

  [[nodiscard]] operator const TCOD_Console&() const { return *console_; }

  [[nodiscard]] auto get() noexcept -> TCOD_Console* { return console_.get(); }

  [[nodiscard]] auto get() const noexcept -> const TCOD_Console* { return console_.get(); }

  auto release() noexcept -> TCOD_Console* { return console_.release(); }

  [[nodiscard]] auto begin() noexcept -> TCOD_ConsoleTile* { return console_->tiles; }

  [[nodiscard]] auto begin() const noexcept -> const TCOD_ConsoleTile* { return console_->tiles; }

  [[nodiscard]] auto end() noexcept -> TCOD_ConsoleTile* { return console_->tiles + console_->elements; }

  [[nodiscard]] auto end() const noexcept -> const TCOD_ConsoleTile* { return console_->tiles + console_->elements; }

  [[nodiscard]] auto get_width() const noexcept -> int { return console_->w; }

  [[nodiscard]] auto get_height() const noexcept -> int { return console_->h; }

  [[nodiscard]] auto get_shape() const noexcept -> std::array<int, 2> { return {console_->w, console_->h}; }

  void clear(const TCOD_ConsoleTile& tile = {0x20, {255, 255, 255, 255}, {0, 0, 0, 255}}) noexcept {
    for (auto& it : *this) it = tile;
  }

  [[nodiscard]] auto operator[](const std::array<int, 2>& xy) noexcept -> TCOD_ConsoleTile& {
    return console_->tiles[get_index(xy)];
  }

  [[nodiscard]] auto operator[](const std::array<int, 2>& xy) const noexcept -> const TCOD_ConsoleTile& {
    return console_->tiles[get_index(xy)];
  }

  [[nodiscard]] auto at(const std::array<int, 2>& xy) -> TCOD_ConsoleTile& { return console_->tiles[bounds_check(xy)]; }

  [[nodiscard]] auto at(const std::array<int, 2>& xy) const -> const TCOD_ConsoleTile& {
    return console_->tiles[bounds_check(xy)];
  }

  [[nodiscard]] auto at(int x, int y) -> TCOD_ConsoleTile& { return at({x, y}); }

  [[nodiscard]] auto at(int x, int y) const -> const TCOD_ConsoleTile& { return at({x, y}); }

  [[nodiscard]] bool in_bounds(const std::array<int, 2>& xy) const noexcept { return console_->in_bounds(xy); }
  TCODLIB_END_IGNORE_DEPRECATIONS
 
 private:

  auto bounds_check(const std::array<int, 2>& xy) const -> int {
    if (!in_bounds(xy)) {
      throw std::out_of_range(
          std::string("Out of bounds lookup {") + std::to_string(xy[0]) + ", " + std::to_string(xy[1]) +
          "} on console of shape {" + std::to_string(console_->w) + ", " + std::to_string(console_->h) + "}.");
    }
    return get_index(xy);
  }

  [[nodiscard]] auto get_index(const std::array<int, 2>& xy) const noexcept -> int {
    return console_->w * xy[1] + xy[0];
  }
 
  ConsolePtr console_ = nullptr;  // The owned TCOD_Console pointer.
};
}  // namespace tcod
#endif  // TCOD_CONSOLE_TYPES_HPP_