.. _program_listing_file_libtcod_console_printing.hpp:

Program Listing for File console_printing.hpp
=============================================

|exhale_lsh| :ref:`Return to documentation for file <file_libtcod_console_printing.hpp>` (``libtcod/console_printing.hpp``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /* 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_PRINTING_HPP_
   #define TCOD_CONSOLE_PRINTING_HPP_
   
   #include <stdio.h>
   
   #include <array>
   #include <cstdarg>
   #include <optional>
   #include <stdexcept>
   #include <string>
   #include <string_view>
   
   #include "console_printing.h"
   
   namespace tcod {
   #ifndef TCOD_NO_UNICODE
   
   inline void print(
       TCOD_Console& console,
       const std::array<int, 2>& xy,
       std::string_view str,
       std::optional<TCOD_ColorRGB> fg,
       std::optional<TCOD_ColorRGB> bg,
       TCOD_alignment_t alignment = TCOD_LEFT,
       TCOD_bkgnd_flag_t flag = TCOD_BKGND_SET) {
     const TCOD_ColorRGB* fg_ptr = fg ? &fg.value() : nullptr;
     const TCOD_ColorRGB* bg_ptr = bg ? &bg.value() : nullptr;
     check_throw_error(
         TCOD_console_printn(&console, xy.at(0), xy.at(1), str.size(), str.data(), fg_ptr, bg_ptr, flag, alignment));
   }
   
   inline int print_rect(
       TCOD_Console& console,
       const std::array<int, 4>& rect,
       std::string_view str,
       std::optional<TCOD_ColorRGB> fg,
       std::optional<TCOD_ColorRGB> bg,
       TCOD_alignment_t alignment = TCOD_LEFT,
       TCOD_bkgnd_flag_t flag = TCOD_BKGND_SET) {
     return check_throw_error(TCOD_console_printn_rect(
         &console,
         rect.at(0),
         rect.at(1),
         rect.at(2),
         rect.at(3),
         str.size(),
         str.data(),
         fg ? &fg.value() : nullptr,
         bg ? &bg.value() : nullptr,
         flag,
         alignment));
   }
   
   inline int get_height_rect(int width, std::string_view str) {
     return check_throw_error(TCOD_console_get_height_rect_wn(width, str.size(), str.data()));
   }
   TCODLIB_BEGIN_IGNORE_DEPRECATIONS
   [[deprecated("It is recommended that you print your own banners for frames.")]] inline void print_frame(
       struct TCOD_Console& console,
       const std::array<int, 4>& rect,
       std::string_view title,
       const TCOD_ColorRGB* fg,
       const TCOD_ColorRGB* bg,
       TCOD_bkgnd_flag_t flag = TCOD_BKGND_SET,
       bool clear = true) {
     check_throw_error(TCOD_console_printn_frame(
         &console, rect.at(0), rect.at(1), rect.at(2), rect.at(3), title.size(), title.data(), fg, bg, flag, clear));
   }
   TCODLIB_END_IGNORE_DEPRECATIONS
   #endif  // TCOD_NO_UNICODE
   
   template <typename... T>
   inline std::string stringf(const char* format, T... args) {
     const int str_length = snprintf(nullptr, 0, format, args...);
     if (str_length < 0) throw std::runtime_error("Failed to format string.");
     std::string out(str_length, '\0');
     snprintf(&out[0], str_length + 1, format, args...);
     return out;
   }
   }  // namespace tcod
   #endif  // TCOD_CONSOLE_PRINTING_HPP_