sysprof/src/libsysprof-gtk/sysprof-time-span-layer.c

/*
 * sysprof-time-span-layer.c
 *
 * Copyright 2023 Christian Hergert <chergert@redhat.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

#include "config.h"

#include "sysprof-chart-layer-private.h"
#include "sysprof-normalized-series.h"
#include "sysprof-time-series-item.h"
#include "sysprof-time-span-layer.h"

struct _SysprofTimeSpanLayer
{
  SysprofChartLayer parent_instance;

  SysprofAxis *axis;
  SysprofTimeSeries *series;

  SysprofNormalizedSeries *normal_x;
  SysprofNormalizedSeries *normal_x2;

  GdkRGBA color;
  GdkRGBA event_color;

  guint color_set : 1;
  guint event_color_set : 1;
};

G_DEFINE_FINAL_TYPE (SysprofTimeSpanLayer, sysprof_time_span_layer, SYSPROF_TYPE_CHART_LAYER)

enum {
  PROP_0,
  PROP_AXIS,
  PROP_COLOR,
  PROP_EVENT_COLOR,
  PROP_SERIES,
  N_PROPS
};

static GParamSpec *properties [N_PROPS];

SysprofChartLayer *
sysprof_time_span_layer_new (void)
{
  return g_object_new (SYSPROF_TYPE_TIME_SPAN_LAYER, NULL);
}

static inline void
premix_colors (GdkRGBA       *dest,
               const GdkRGBA *fg,
               const GdkRGBA *bg,
               gboolean       bg_set,
               double         alpha)
{
	g_assert (dest != NULL);
	g_assert (fg != NULL);
	g_assert (bg != NULL || bg_set == FALSE);
	g_assert (alpha >= 0.0 && alpha <= 1.0);

  if (bg_set)
    {
      dest->red = ((1 - alpha) * bg->red) + (alpha * fg->red);
      dest->green = ((1 - alpha) * bg->green) + (alpha * fg->green);
      dest->blue = ((1 - alpha) * bg->blue) + (alpha * fg->blue);
      dest->alpha = 1.0;
    }
  else
    {
      *dest = *fg;
      dest->alpha = alpha;
    }
}

static void
sysprof_time_span_layer_snapshot (GtkWidget   *widget,
                                  GtkSnapshot *snapshot)
{
  SysprofTimeSpanLayer *self = (SysprofTimeSpanLayer *)widget;
  const float *x_values;
  const float *x2_values;
  const GdkRGBA *color;
  const GdkRGBA *event_color;
  GdkRGBA mixed;
  graphene_rect_t box_rect;
  float last_end_x = 0;
  guint n_x_values = 0;
  guint n_x2_values = 0;
  guint n_values;
  int width;
  int height;

  g_assert (SYSPROF_IS_TIME_SPAN_LAYER (self));
  g_assert (GTK_IS_SNAPSHOT (snapshot));

  width = gtk_widget_get_width (widget);
  height = gtk_widget_get_height (widget);

  if (self->color_set)
    color = &self->color;
  else
    color = _sysprof_chart_layer_get_accent_bg_color ();

  if (self->event_color_set)
    event_color = &self->event_color;
  else
    {
      premix_colors (&mixed,
                     _sysprof_chart_layer_get_accent_bg_color (),
                     _sysprof_chart_layer_get_accent_fg_color (),
                     TRUE, .5);
      event_color = &mixed;
    }

  if (width == 0 || height == 0)
    return;

  if (!(x_values = sysprof_normalized_series_get_values (self->normal_x, &n_x_values)) ||
      !(x2_values = sysprof_normalized_series_get_values (self->normal_x2, &n_x2_values)) ||
      !(n_values = MIN (n_x_values, n_x2_values)))
    return;

  if (color->alpha > 0)
    {
      const GdkRGBA *label_color = _sysprof_chart_layer_get_accent_fg_color ();
      PangoLayout *layout = gtk_widget_create_pango_layout (GTK_WIDGET (self), NULL);
      int layout_y;
      int layout_h;

      pango_layout_set_single_paragraph_mode (layout, TRUE);
      pango_layout_set_ellipsize (layout, PANGO_ELLIPSIZE_END);
      pango_layout_set_text (layout, "XM0", -1);
      pango_layout_get_pixel_size (layout, NULL, &layout_h);

      layout_y = (height - layout_h) / 2;

      /* First pass, draw our rectangles for duration which we
       * always want in the background compared to "points" which
       * are marks w/o a duration.
       */
      for (guint i = 0; i < n_values; i++)
        {
          float begin = x_values[i];
          float end = x2_values[i];

          if (end < .0)
            continue;

          if (begin > 1.)
            break;

          if (begin != end)
            {
              graphene_rect_t rect;
              float end_x;

              rect = GRAPHENE_RECT_INIT (floorf (begin * width),
                                         0,
                                         ceilf ((end - begin) * width),
                                         height);

              /* Ignore empty draws */
              if (rect.size.width == 0)
                continue;

              /* Cull draw unless it will extend past last rect */
              end_x = rect.origin.x + rect.size.width;
              if (end_x <= last_end_x)
                continue;
              else
                last_end_x = end_x;

              gtk_snapshot_append_color (snapshot, color, &rect);

              if (rect.size.width > 20)
                {
                  g_autofree char *label = sysprof_time_series_dup_label (self->series, i);

                  if (label != NULL)
                    {
                      pango_layout_set_text (layout, label, -1);
                      pango_layout_set_width (layout, (rect.size.width - 6) * PANGO_SCALE);

                      gtk_snapshot_save (snapshot);
                      gtk_snapshot_translate (snapshot, &GRAPHENE_POINT_INIT (rect.origin.x + 3, layout_y));
                      gtk_snapshot_append_layout (snapshot, layout, label_color);
                      gtk_snapshot_restore (snapshot);
                    }
                }
            }
        }

      g_object_unref (layout);
    }

  if (event_color->alpha > 0)
    {
      float last_x = -1;

      box_rect = GRAPHENE_RECT_INIT (-ceil (height / 6.),
                                     -ceil (height / 6.),
                                     ceil (height / 3.),
                                     ceil (height / 3.));

      for (guint i = 0; i < n_values; i++)
        {
          float begin = x_values[i];
          float end = x2_values[i];

          if (begin != end)
            continue;

          if (last_x != begin)
            {
              gtk_snapshot_save (snapshot);
              gtk_snapshot_translate (snapshot,
                                      &GRAPHENE_POINT_INIT (begin * width, height / 2));
              gtk_snapshot_rotate (snapshot, 45.f);
              gtk_snapshot_append_color (snapshot, event_color, &box_rect);
              gtk_snapshot_restore (snapshot);

              last_x = begin;
            }
        }
    }
}

static gpointer
sysprof_time_span_layer_lookup_item (SysprofChartLayer *layer,
                                     double             x,
                                     double             y)
{
  SysprofTimeSpanLayer *self = (SysprofTimeSpanLayer *)layer;
  const float *x_values;
  const float *x2_values;
  GListModel *model;
  guint n_x_values = 0;
  guint n_x2_values = 0;
  guint n_values;
  int width;
  int height;

  g_assert (SYSPROF_IS_TIME_SPAN_LAYER (self));

  width = gtk_widget_get_width (GTK_WIDGET (self));
  height = gtk_widget_get_height (GTK_WIDGET (self));

  if (width == 0 || height == 0 || self->series == NULL)
    return NULL;

  if (!(model = sysprof_series_get_model (SYSPROF_SERIES (self->series))))
    return NULL;

  if (!(x_values = sysprof_normalized_series_get_values (self->normal_x, &n_x_values)) ||
      !(x2_values = sysprof_normalized_series_get_values (self->normal_x2, &n_x2_values)) ||
      !(n_values = MIN (n_x_values, n_x2_values)))
    return NULL;

  /* First match our non-duration marks (diamonds) */
  for (guint i = 0; i < n_values; i++)
    {
      int begin = x_values[i] * width - 3;
      int end = x2_values[i] * width + 3;

      if (x_values[i] != x2_values[i])
        continue;

      if (x >= begin && x < end)
        return g_list_model_get_item (model, i);
    }

  /* Then match regular duration events */
  for (guint i = 0; i < n_values; i++)
    {
      float begin = x_values[i] * width;
      float end = x2_values[i] * width;

      if (x_values[i] == x2_values[i])
        continue;

      if (x >= begin && x < end)
        return g_list_model_get_item (model, i);
    }

  return NULL;
}

static void
sysprof_time_span_layer_finalize (GObject *object)
{
  SysprofTimeSpanLayer *self = (SysprofTimeSpanLayer *)object;

  g_clear_object (&self->axis);
  g_clear_object (&self->series);
  g_clear_object (&self->normal_x);
  g_clear_object (&self->normal_x2);

  G_OBJECT_CLASS (sysprof_time_span_layer_parent_class)->finalize (object);
}

static void
sysprof_time_span_layer_get_property (GObject    *object,
                                      guint       prop_id,
                                      GValue     *value,
                                      GParamSpec *pspec)
{
  SysprofTimeSpanLayer *self = SYSPROF_TIME_SPAN_LAYER (object);

  switch (prop_id)
    {
    case PROP_AXIS:
      g_value_set_object (value, sysprof_time_span_layer_get_axis (self));
      break;

    case PROP_COLOR:
      g_value_set_boxed (value, sysprof_time_span_layer_get_color (self));
      break;

    case PROP_EVENT_COLOR:
      g_value_set_boxed (value, sysprof_time_span_layer_get_event_color (self));
      break;

    case PROP_SERIES:
      g_value_set_object (value, sysprof_time_span_layer_get_series (self));
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
sysprof_time_span_layer_set_property (GObject      *object,
                                      guint         prop_id,
                                      const GValue *value,
                                      GParamSpec   *pspec)
{
  SysprofTimeSpanLayer *self = SYSPROF_TIME_SPAN_LAYER (object);

  switch (prop_id)
    {
    case PROP_AXIS:
      sysprof_time_span_layer_set_axis (self, g_value_get_object (value));
      break;

    case PROP_COLOR:
      sysprof_time_span_layer_set_color (self, g_value_get_boxed (value));
      break;

    case PROP_EVENT_COLOR:
      sysprof_time_span_layer_set_event_color (self, g_value_get_boxed (value));
      break;

    case PROP_SERIES:
      sysprof_time_span_layer_set_series (self, g_value_get_object (value));
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
sysprof_time_span_layer_class_init (SysprofTimeSpanLayerClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
  SysprofChartLayerClass *chart_layer_class = SYSPROF_CHART_LAYER_CLASS (klass);

  object_class->finalize = sysprof_time_span_layer_finalize;
  object_class->get_property = sysprof_time_span_layer_get_property;
  object_class->set_property = sysprof_time_span_layer_set_property;

  widget_class->snapshot = sysprof_time_span_layer_snapshot;

  chart_layer_class->lookup_item = sysprof_time_span_layer_lookup_item;

  properties[PROP_AXIS] =
    g_param_spec_object ("axis", NULL, NULL,
                         SYSPROF_TYPE_AXIS,
                         (G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS));

  properties[PROP_COLOR] =
    g_param_spec_boxed ("color", NULL, NULL,
                        GDK_TYPE_RGBA,
                        (G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS));

  properties[PROP_EVENT_COLOR] =
    g_param_spec_boxed ("event-color", NULL, NULL,
                        GDK_TYPE_RGBA,
                        (G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS));

  properties[PROP_SERIES] =
    g_param_spec_object ("series", NULL, NULL,
                         SYSPROF_TYPE_TIME_SERIES,
                         (G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS));

  g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
sysprof_time_span_layer_init (SysprofTimeSpanLayer *self)
{
  g_autoptr(GtkExpression) begin_expression = NULL;
  g_autoptr(GtkExpression) end_expression = NULL;

  begin_expression = gtk_property_expression_new (SYSPROF_TYPE_TIME_SERIES_ITEM, NULL, "time");
  end_expression = gtk_property_expression_new (SYSPROF_TYPE_TIME_SERIES_ITEM, NULL, "end-time");

  self->normal_x = g_object_new (SYSPROF_TYPE_NORMALIZED_SERIES,
                                 "expression", begin_expression,
                                 NULL);
  self->normal_x2 = g_object_new (SYSPROF_TYPE_NORMALIZED_SERIES,
                                  "expression", end_expression,
                                  NULL);

  g_signal_connect_object (self->normal_x,
                           "items-changed",
                           G_CALLBACK (gtk_widget_queue_draw),
                           self,
                           G_CONNECT_SWAPPED);
  g_signal_connect_object (self->normal_x2,
                           "items-changed",
                           G_CALLBACK (gtk_widget_queue_draw),
                           self,
                           G_CONNECT_SWAPPED);
}

const GdkRGBA *
sysprof_time_span_layer_get_color (SysprofTimeSpanLayer *self)
{
  g_return_val_if_fail (SYSPROF_IS_TIME_SPAN_LAYER (self), NULL);

  return &self->color;
}

void
sysprof_time_span_layer_set_color (SysprofTimeSpanLayer *self,
                                   const GdkRGBA        *color)
{
  static const GdkRGBA black = {0,0,0,1};

  g_return_if_fail (SYSPROF_IS_TIME_SPAN_LAYER (self));

  if (color == NULL)
    color = &black;

  if (!gdk_rgba_equal (&self->color, color))
    {
      self->color = *color;
      self->color_set = color != &black;
      g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_COLOR]);
      gtk_widget_queue_draw (GTK_WIDGET (self));
    }
}

const GdkRGBA *
sysprof_time_span_layer_get_event_color (SysprofTimeSpanLayer *self)
{
  g_return_val_if_fail (SYSPROF_IS_TIME_SPAN_LAYER (self), NULL);

  return &self->event_color;
}

void
sysprof_time_span_layer_set_event_color (SysprofTimeSpanLayer *self,
                                         const GdkRGBA        *event_color)
{
  static const GdkRGBA black = {0,0,0,1};

  g_return_if_fail (SYSPROF_IS_TIME_SPAN_LAYER (self));

  if (event_color == NULL)
    event_color = &black;

  if (!gdk_rgba_equal (&self->event_color, event_color))
    {
      self->event_color = *event_color;
      self->color_set = event_color != &black;
      g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_EVENT_COLOR]);
      gtk_widget_queue_draw (GTK_WIDGET (self));
    }
}

/**
 * sysprof_time_span_layer_get_series:
 * @self: a #SysprofTimeSpanLayer
 *
 * Returns: (transfer none) (nullable): a #SysprofTimeSeries or %NULL
 */
SysprofTimeSeries *
sysprof_time_span_layer_get_series (SysprofTimeSpanLayer *self)
{
  g_return_val_if_fail (SYSPROF_IS_TIME_SPAN_LAYER (self), NULL);

  return self->series;
}

void
sysprof_time_span_layer_set_series (SysprofTimeSpanLayer *self,
                                    SysprofTimeSeries    *series)
{
  g_return_if_fail (SYSPROF_IS_TIME_SPAN_LAYER (self));

  if (!g_set_object (&self->series, series))
    return;

  sysprof_normalized_series_set_series (self->normal_x, SYSPROF_SERIES (series));
  sysprof_normalized_series_set_series (self->normal_x2, SYSPROF_SERIES (series));

  g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_SERIES]);
}

/**
 * sysprof_time_span_layer_get_axis:
 * @self: a #SysprofTimeSpanLayer
 *
 * Returns: (transfer none) (nullable): a #SysprofAxis or %NULL
 */
SysprofAxis *
sysprof_time_span_layer_get_axis (SysprofTimeSpanLayer *self)
{
  g_return_val_if_fail (SYSPROF_IS_TIME_SPAN_LAYER (self), NULL);

  return self->axis;
}

void
sysprof_time_span_layer_set_axis (SysprofTimeSpanLayer *self,
                                  SysprofAxis          *axis)
{
  g_return_if_fail (SYSPROF_IS_TIME_SPAN_LAYER (self));
  g_return_if_fail (!axis || SYSPROF_IS_AXIS (axis));

  if (!g_set_object (&self->axis, axis))
    return;

  sysprof_normalized_series_set_axis (self->normal_x, axis);
  sysprof_normalized_series_set_axis (self->normal_x2, axis);

  g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_AXIS]);
}