caret.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/canvas/canvas.hpp>
#include <pulp/view/geometry.hpp>
 
#include <string>
#include <string_view>
 
namespace pulp::view {

enum class CaretStyle {
    ibeam,      
    underline,  
    block,      
};

const char* caret_style_to_string(CaretStyle style) noexcept;

CaretStyle caret_style_from_string(std::string_view name) noexcept;

struct CaretBlinkConfig {
    float period_seconds = 1.06f;
    float duty = 0.5f;
    float solid_hold_seconds = 0.35f;
    bool enabled = true;
};

CaretStyle default_caret_style() noexcept;
void set_default_caret_style(CaretStyle style) noexcept;
const CaretBlinkConfig& default_caret_blink() noexcept;
void set_default_caret_blink(const CaretBlinkConfig& config) noexcept;

class CaretBlink {
public:
    CaretBlink() noexcept;
 
    void set_config(const CaretBlinkConfig& config) noexcept;
    const CaretBlinkConfig& config() const noexcept { return config_; }

    void keep_solid() noexcept;

    void reset() noexcept;

    void advance(float dt) noexcept;

    bool visible() const noexcept;

    bool holding_solid() const noexcept { return solid_remaining_ > 0.0f; }
 
private:
    CaretBlinkConfig config_{};
    float phase_ = 0.0f;            
    float solid_remaining_ = 0.0f;  
};

struct CaretMetrics {
    float x = 0.0f;                
    float cell_top = 0.0f;         
    float cell_height = 0.0f;      
    float baseline = 0.0f;         
    float advance = 0.0f;          
    float nominal_advance = 0.0f;  
    float stroke = 1.5f;           
};

float caret_advance(const CaretMetrics& metrics) noexcept;

Rect caret_rect_for_style(CaretStyle style, const CaretMetrics& metrics) noexcept;

void paint_caret(canvas::Canvas& canvas, CaretStyle style,
                 const CaretMetrics& metrics, canvas::Color color);

void paint_caret_over_text(canvas::Canvas& canvas, CaretStyle style,
                           const CaretMetrics& metrics, canvas::Color color,
                           canvas::Color text_bg, const std::string& text,
                           float text_x);
 
}  // namespace pulp::view