convenience; readme

Author: s9w

demos/main.cpp

@@ -31,9 +31,9 @@ int main()
    enable_vt_mode();
    std::cout << oof::cursor_visibility(false) << oof::reset_formatting() << oof::clear_screen();
 
-   std::cout << oof::fg_color({ 255, 100, 100 }) << "This is red\n";
-   std::cout << "Still the same - state was changed!\n";
-   std::cout << oof::reset_formatting() << oof::hposition(10) << "All back to normal\n";
+   //std::cout << oof::fg_color({ 255, 100, 100 }) << "This is red\n";
+   //std::cout << "Still the same - state was changed!\n";
+   //std::cout << oof::reset_formatting() << oof::hposition(10) << "All back to normal\n";
 
    // oof::screen scr(10, 3, 0, 0, ' ');
    // for(uint64_t i=0; ; ++i){
@@ -60,6 +60,20 @@ int main()
    //    fast_print(screen.get_string());
    // }
 
+   // 123 Example
+   //for (int i = 0; i < 10; ++i) {
+   //   std::cout << oof::fg_color(oof::color{ 255 - i * 25 });
+   //   std::cout << oof::hposition(2 * i) << std::to_string(i) << "\n";
+   //}
+
+   // Values example
+   //constexpr double values[]{0.54, 0.88, 0.42, 0.21, 0.33, 0.68, 0.91};
+   //for(int i=0; i<std::size(values); ++i){
+   //   std::cout << oof::underline(true) << std::format("value {}", i) << oof::reset_formatting() << ": ";
+   //   const oof::color color{ 255, static_cast<int>(255 - values[i] * 255), 0 };
+   //   std::cout << oof::fg_color(color) << std::format("{:.2f}\n", values[i]) << oof::reset_formatting();
+   //}
+
 
    int demo_choice = 0;
    print_choice("Bars");

demos/radar_demo.cpp

@@ -14,9 +14,9 @@ namespace
    auto get_faded(const oof::color& col) -> oof::color {
       constexpr int fade_amount = 20;
       return oof::color{
-         static_cast<uint8_t>(std::clamp(col.red - fade_amount, 0, 255)),
-         static_cast<uint8_t>(std::clamp(col.green - fade_amount, 0, 255)),
-         static_cast<uint8_t>(std::clamp(col.blue - fade_amount, 0, 255))
+         std::clamp(col.red - fade_amount, 0, 255),
+         std::clamp(col.green - fade_amount, 0, 255),
+         std::clamp(col.blue - fade_amount, 0, 255)
       };
    };
 

demos/tools.h

@@ -120,9 +120,9 @@ auto remove_from_vector(
 inline auto get_random_color(s9w::rng_state& rng) -> oof::color
 {
    return oof::color{
-      static_cast<uint8_t>(rng.get_int(0, 255)),
-      static_cast<uint8_t>(rng.get_int(0, 255)),
-      static_cast<uint8_t>(rng.get_int(0, 255))
+      rng.get_int(0, 255),
+      rng.get_int(0, 255),
+      rng.get_int(0, 255)
    };
 }
 

oof.h

@@ -11,8 +11,13 @@ namespace oof
    struct color {
       uint8_t red{}, green{}, blue{};
       constexpr color() = default;
-      constexpr color(const uint8_t component);
-      constexpr color(const uint8_t r, const uint8_t g, const uint8_t b);
+
+      template<std::integral component_type>
+      constexpr color(component_type component);
+
+      template<std::integral component_type>
+      constexpr color(component_type r, component_type g, component_type b);
+
       friend constexpr auto operator==(const color&, const color&) -> bool = default;
    };
 
@@ -318,16 +323,26 @@ namespace oof
 
    } // namespace detail
 
-   constexpr color::color(const uint8_t component)
-      : red{ component }, green{ component }, blue{ component }
+
+   template<std::integral component_type>
+   constexpr color::color(component_type r, component_type g, component_type b)
+      : red{ static_cast<uint8_t>(r) }
+      , green{ static_cast<uint8_t>(g) }
+      , blue{ static_cast<uint8_t>(b) }
    {
-      
+      if (r < component_type{ 0 } || r > component_type{255})
+         ::oof::detail::error("red component not in [0, 255]");
+      if (g < component_type{ 0 } || g > component_type{ 255 })
+         ::oof::detail::error("green component not in [0, 255]");
+      if (b < component_type{ 0 } || b > component_type{ 255 })
+         ::oof::detail::error("blue component not in [0, 255]");
    }
 
-   constexpr color::color(const uint8_t r, const uint8_t g, const uint8_t b)
-      : red{ r }, green{ g }, blue{ b }
+   template<std::integral component_type>
+   constexpr color::color(component_type component)
+      : color(component, component, component)
    {
-
+      
    }
 
 

readme.md

@@ -1,7 +1,26 @@
 # Oof (omnipotent output friend)
 It's common for C++ programs to write output to the console. But consoles are far more capable than what they are usually used for. The magic lies in the so-called [Virtual Terminal sequences](https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences) (sometimes also confusingly called ["escape codes"](https://en.wikipedia.org/wiki/ANSI_escape_code)): These cryptic character sequences allow complete control over position, color and other properties of written characters. *Oof* is a single C++20 header that wraps these in a convenient way.
 
-On top of that, *oof* provides two special interfaces that heavily optimize the resulting stream of VT sequences, so that real-time outputs like those below are possible. Everything in these videos are letters in a console window:
+```c++
+for (int i = 0; i < 10; ++i){
+   std::cout << oof::fg_color(oof::color{255 - i * 25});
+   std::cout << oof::hposition(2*i) << std::to_string(i) << "\n";
+}
+```
+![123_example](https://user-images.githubusercontent.com/6044318/142816762-f1167a81-3d11-4b4a-85fc-d4edcdc06bf6.png)
+
+
+```c++
+constexpr double values[]{0.54, 0.88, 0.42, 0.21, 0.33, 0.68, 0.91};
+for(int i=0; i<std::size(values); ++i){
+   std::cout << oof::underline(true) << std::format("value {}", i) << oof::reset_formatting() << ": ";
+   const oof::color color{ 255, static_cast<int>(255 - values[i] * 255), 0 };
+   std::cout << oof::fg_color(color) << std::format("{:.2f}\n", values[i]) << oof::reset_formatting();
+}
+```
+![values_example](https://user-images.githubusercontent.com/6044318/142819817-d1fc16fc-01e7-4a49-a908-33ed4b7a7c37.png)
+
+On top of that, *oof* provides two special interfaces that heavily optimize the resulting stream of VT sequences, so that real-time outputs like those below are possible. The following videos show what's possible with that - everything in these videos are letters in a console window:
 
 https://user-images.githubusercontent.com/6044318/142469815-ce680909-9151-4322-85aa-01dc9ba29c1d.mp4