hyperlink.cpp

Go to the documentation of this file.

// Copyright 2023 Arthur Sonzogni. All rights reserved.
// このソースコードの使用は、LICENSEファイルにあるMITライセンスに準拠しています。
#include <cstdint>  // for uint8_t
#include <memory>   // for make_shared
#include <string>   // for string
#include <utility>  // for move
 
#include "ftxui/dom/elements.hpp"        // for Element, Decorator, hyperlink
#include "ftxui/dom/node_decorator.hpp"  // for NodeDecorator
#include "ftxui/screen/box.hpp"          // for Box
#include "ftxui/screen/screen.hpp"       // for Screen, Pixel
 
namespace ftxui {
 
namespace {
class Hyperlink : public NodeDecorator {
 public:
  Hyperlink(Element child, std::string link)
      : NodeDecorator(std::move(child)), link_(std::move(link)) {}
 
  void Render(Screen& screen) override {
    const uint8_t hyperlink_id = screen.RegisterHyperlink(link_);
    for (int y = box_.y_min; y <= box_.y_max; ++y) {
      for (int x = box_.x_min; x <= box_.x_max; ++x) {
        screen.PixelAt(x, y).hyperlink = hyperlink_id;
      }
    }
    NodeDecorator::Render(screen);
  }
 
  std::string link_;
};
}  // namespace
 
/// @brief ウェブブラウザを使用してレンダリングされた領域をクリック可能にします。
///        ユーザーがクリックするとリンクが開きます。
///        これは、限られたターミナルエミュレータでのみサポートされています。
///        リスト: https://github.com/Alhadis/OSC8-Adoption/
/// @param link リンク
/// @param child 入力要素。
/// @return リンクを持つ出力要素。
/// @ingroup dom
///
/// ### 例
///
/// ```cpp
/// Element document =
///   hyperlink("https://github.com/ArthurSonzogni/FTXUI", "link");
/// ```
Element hyperlink(std::string link, Element child) {
  return std::make_shared<Hyperlink>(std::move(child), std::move(link));
}
 
/// @brief ハイパーリンクを使用して装飾します。
///        ユーザーがクリックするとリンクが開きます。
///        これは、限られたターミナルエミュレータでのみサポートされています。
///        リスト: https://github.com/Alhadis/OSC8-Adoption/
/// @param link ユーザーをリダイレクトするリンク。
/// @return ハイパーリンクを適用するデコレータ。
/// @ingroup dom
///
/// ### 例
///
/// ```cpp
/// Element document =
///   text("red") | hyperlink("https://github.com/Arthursonzogni/FTXUI");
/// ```
// NOLINTNEXTLINE
Decorator hyperlink(std::string link) {
  return [link](Element child) { return hyperlink(link, std::move(child)); };
}
 
}  // namespace ftxui