Spreadsheet: persistent column storage and data source

A `DataSource` provides columns for the spreadsheet to display.
Every column has a SpreadsheetColumnID as identifier. Columns
are not generated eagerly anymore, instead the main spreadsheet
code can request a column from a data source with an column
identifier. The column identifiers can be stored in DNA and allow us
to store persistent data per column.

On the user level the only thing that changes is that columns are
not shown in alphabetical order anymore. Instead, new columns
are always added on the left. The behavior can be changed,
however I'd prefer not to automate this too much currently. I think
we should just add operators to hide/reorder/resize columns soonish.

Differential Revision: https://developer.blender.org/D10901

1 files changed, 214 insertions, 0 deletions

diff --git a/source/blender/editors/space_spreadsheet/spreadsheet_layout.cc b/source/blender/editors/space_spreadsheet/spreadsheet_layout.cc
new file mode 100644
index 00000000000..bca80cff773
--- /dev/null
+++ b/source/blender/editors/space_spreadsheet/spreadsheet_layout.cc
@@ -0,0 +1,214 @@
+/*
+ * 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 2
+ * 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, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+#include <iomanip>
+#include <sstream>
+
+#include "spreadsheet_layout.hh"
+
+#include "DNA_userdef_types.h"
+
+#include "UI_interface.h"
+#include "UI_resources.h"
+
+#include "BLF_api.h"
+
+namespace blender::ed::spreadsheet {
+
+class SpreadsheetLayoutDrawer : public SpreadsheetDrawer {
+ private:
+  const SpreadsheetLayout &spreadsheet_layout_;
+
+ public:
+  SpreadsheetLayoutDrawer(const SpreadsheetLayout &spreadsheet_layout)
+      : spreadsheet_layout_(spreadsheet_layout)
+  {
+    tot_columns = spreadsheet_layout.columns.size();
+    tot_rows = spreadsheet_layout.row_indices.size();
+    left_column_width = spreadsheet_layout.index_column_width;
+  }
+
+  void draw_top_row_cell(int column_index, const CellDrawParams &params) const final
+  {
+    const StringRefNull name = spreadsheet_layout_.columns[column_index].values->name();
+    uiBut *but = uiDefIconTextBut(params.block,
+                                  UI_BTYPE_LABEL,
+                                  0,
+                                  ICON_NONE,
+                                  name.c_str(),
+                                  params.xmin,
+                                  params.ymin,
+                                  params.width,
+                                  params.height,
+                                  nullptr,
+                                  0,
+                                  0,
+                                  0,
+                                  0,
+                                  nullptr);
+    /* Center-align column headers. */
+    UI_but_drawflag_disable(but, UI_BUT_TEXT_LEFT);
+    UI_but_drawflag_disable(but, UI_BUT_TEXT_RIGHT);
+  }
+
+  void draw_left_column_cell(int row_index, const CellDrawParams &params) const final
+  {
+    const int real_index = spreadsheet_layout_.row_indices[row_index];
+    std::string index_str = std::to_string(real_index);
+    uiBut *but = uiDefIconTextBut(params.block,
+                                  UI_BTYPE_LABEL,
+                                  0,
+                                  ICON_NONE,
+                                  index_str.c_str(),
+                                  params.xmin,
+                                  params.ymin,
+                                  params.width,
+                                  params.height,
+                                  nullptr,
+                                  0,
+                                  0,
+                                  0,
+                                  0,
+                                  nullptr);
+    /* Right-align indices. */
+    UI_but_drawflag_enable(but, UI_BUT_TEXT_RIGHT);
+    UI_but_drawflag_disable(but, UI_BUT_TEXT_LEFT);
+  }
+
+  void draw_content_cell(int row_index, int column_index, const CellDrawParams &params) const final
+  {
+    const int real_index = spreadsheet_layout_.row_indices[row_index];
+    const ColumnValues &column = *spreadsheet_layout_.columns[column_index].values;
+    CellValue cell_value;
+    column.get_value(real_index, cell_value);
+
+    if (cell_value.value_int.has_value()) {
+      const int value = *cell_value.value_int;
+      const std::string value_str = std::to_string(value);
+      uiBut *but = uiDefIconTextBut(params.block,
+                                    UI_BTYPE_LABEL,
+                                    0,
+                                    ICON_NONE,
+                                    value_str.c_str(),
+                                    params.xmin,
+                                    params.ymin,
+                                    params.width,
+                                    params.height,
+                                    nullptr,
+                                    0,
+                                    0,
+                                    0,
+                                    0,
+                                    nullptr);
+      /* Right-align Integers. */
+      UI_but_drawflag_disable(but, UI_BUT_TEXT_LEFT);
+      UI_but_drawflag_enable(but, UI_BUT_TEXT_RIGHT);
+    }
+    else if (cell_value.value_float.has_value()) {
+      const float value = *cell_value.value_float;
+      std::stringstream ss;
+      ss << std::fixed << std::setprecision(3) << value;
+      const std::string value_str = ss.str();
+      uiBut *but = uiDefIconTextBut(params.block,
+                                    UI_BTYPE_LABEL,
+                                    0,
+                                    ICON_NONE,
+                                    value_str.c_str(),
+                                    params.xmin,
+                                    params.ymin,
+                                    params.width,
+                                    params.height,
+                                    nullptr,
+                                    0,
+                                    0,
+                                    0,
+                                    0,
+                                    nullptr);
+      /* Right-align Floats. */
+      UI_but_drawflag_disable(but, UI_BUT_TEXT_LEFT);
+      UI_but_drawflag_enable(but, UI_BUT_TEXT_RIGHT);
+    }
+    else if (cell_value.value_bool.has_value()) {
+      const bool value = *cell_value.value_bool;
+      const int icon = value ? ICON_CHECKBOX_HLT : ICON_CHECKBOX_DEHLT;
+      uiBut *but = uiDefIconTextBut(params.block,
+                                    UI_BTYPE_LABEL,
+                                    0,
+                                    icon,
+                                    "",
+                                    params.xmin,
+                                    params.ymin,
+                                    params.width,
+                                    params.height,
+                                    nullptr,
+                                    0,
+                                    0,
+                                    0,
+                                    0,
+                                    nullptr);
+      UI_but_drawflag_disable(but, UI_BUT_ICON_LEFT);
+    }
+    else if (cell_value.value_object.has_value()) {
+      const ObjectCellValue value = *cell_value.value_object;
+      uiDefIconTextBut(params.block,
+                       UI_BTYPE_LABEL,
+                       0,
+                       ICON_OBJECT_DATA,
+                       reinterpret_cast<const ID *const>(value.object)->name + 2,
+                       params.xmin,
+                       params.ymin,
+                       params.width,
+                       params.height,
+                       nullptr,
+                       0,
+                       0,
+                       0,
+                       0,
+                       nullptr);
+    }
+    else if (cell_value.value_collection.has_value()) {
+      const CollectionCellValue value = *cell_value.value_collection;
+      uiDefIconTextBut(params.block,
+                       UI_BTYPE_LABEL,
+                       0,
+                       ICON_OUTLINER_COLLECTION,
+                       reinterpret_cast<const ID *const>(value.collection)->name + 2,
+                       params.xmin,
+                       params.ymin,
+                       params.width,
+                       params.height,
+                       nullptr,
+                       0,
+                       0,
+                       0,
+                       0,
+                       nullptr);
+    }
+  }
+
+  int column_width(int column_index) const final
+  {
+    return spreadsheet_layout_.columns[column_index].width;
+  }
+};
+
+std::unique_ptr<SpreadsheetDrawer> spreadsheet_drawer_from_layout(
+    const SpreadsheetLayout &spreadsheet_layout)
+{
+  return std::make_unique<SpreadsheetLayoutDrawer>(spreadsheet_layout);
+}
+
+}  // namespace blender::ed::spreadsheet