src/guiTable.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20
  21 #include "guiTable.h"
  22 #include <queue>
  23 #include <sstream>
  24 #include <utility>
  25 #include <string.h>
  26 #include <IGUISkin.h>
  27 #include <IGUIFont.h>
  28 #include <IGUIScrollBar.h>
  29 #include "debug.h"
  30 #include "log.h"
  31 #include "client/tile.h"
  32 #include "gettime.h"
  33 #include "util/string.h"
  34 #include "util/numeric.h"
  35 #include "util/string.h" // for parseColorString()
  36 #include "settings.h" // for settings
  37 #include "porting.h" // for dpi
  38 #include "guiscalingfilter.h"
  39
  40 /*
  41         GUITable
  42 */
  43
  44 GUITable::GUITable(gui::IGUIEnvironment *env,
  45                 gui::IGUIElement* parent, s32 id,
  46                 core::rect<s32> rectangle,
  47                 ISimpleTextureSource *tsrc
  48 ):
  49         gui::IGUIElement(gui::EGUIET_ELEMENT, env, parent, id, rectangle),
  50         m_tsrc(tsrc),
  51         m_is_textlist(false),
  52         m_has_tree_column(false),
  53         m_selected(-1),
  54         m_sel_column(0),
  55         m_sel_doubleclick(false),
  56         m_keynav_time(0),
  57         m_keynav_buffer(L""),
  58         m_border(true),
  59         m_color(255, 255, 255, 255),
  60         m_background(255, 0, 0, 0),
  61         m_highlight(255, 70, 100, 50),
  62         m_highlight_text(255, 255, 255, 255),
  63         m_rowheight(1),
  64         m_font(NULL),
  65         m_scrollbar(NULL)
  66 {
  67         assert(tsrc != NULL);
  68
  69         gui::IGUISkin* skin = Environment->getSkin();
  70
  71         m_font = skin->getFont();
  72         if (m_font) {
  73                 m_font->grab();
  74                 m_rowheight = m_font->getDimension(L"A").Height + 4;
  75                 m_rowheight = MYMAX(m_rowheight, 1);
  76         }
  77
  78         const s32 s = skin->getSize(gui::EGDS_SCROLLBAR_SIZE);
  79         m_scrollbar = Environment->addScrollBar(false,
  80                         core::rect<s32>(RelativeRect.getWidth() - s,
  81                                         0,
  82                                         RelativeRect.getWidth(),
  83                                         RelativeRect.getHeight()),
  84                         this, -1);
  85         m_scrollbar->setSubElement(true);
  86         m_scrollbar->setTabStop(false);
  87         m_scrollbar->setAlignment(gui::EGUIA_LOWERRIGHT, gui::EGUIA_LOWERRIGHT,
  88                         gui::EGUIA_UPPERLEFT, gui::EGUIA_LOWERRIGHT);
  89         m_scrollbar->setVisible(false);
  90         m_scrollbar->setPos(0);
  91
  92         setTabStop(true);
  93         setTabOrder(-1);
  94         updateAbsolutePosition();
  95
  96         core::rect<s32> relative_rect = m_scrollbar->getRelativePosition();
  97         s32 width = (relative_rect.getWidth()/(2.0/3.0)) * porting::getDisplayDensity() *
  98                         g_settings->getFloat("gui_scaling");
  99         m_scrollbar->setRelativePosition(core::rect<s32>(
 100                         relative_rect.LowerRightCorner.X-width,relative_rect.UpperLeftCorner.Y,
 101                         relative_rect.LowerRightCorner.X,relative_rect.LowerRightCorner.Y
 102                         ));
 103 }
 104
 105 GUITable::~GUITable()
 106 {
 107         for (size_t i = 0; i < m_rows.size(); ++i)
 108                 delete[] m_rows[i].cells;
 109
 110         if (m_font)
 111                 m_font->drop();
 112
 113         m_scrollbar->remove();
 114 }
 115
 116 GUITable::Option GUITable::splitOption(const std::string &str)
 117 {
 118         size_t equal_pos = str.find('=');
 119         if (equal_pos == std::string::npos)
 120                 return GUITable::Option(str, "");
 121         else
 122                 return GUITable::Option(str.substr(0, equal_pos),
 123                                 str.substr(equal_pos + 1));
 124 }
 125
 126 void GUITable::setTextList(const std::vector<std::string> &content,
 127                 bool transparent)
 128 {
 129         clear();
 130
 131         if (transparent) {
 132                 m_background.setAlpha(0);
 133                 m_border = false;
 134         }
 135
 136         m_is_textlist = true;
 137
 138         s32 empty_string_index = allocString("");
 139
 140         m_rows.resize(content.size());
 141         for (s32 i = 0; i < (s32) content.size(); ++i) {
 142                 Row *row = &m_rows[i];
 143                 row->cells = new Cell[1];
 144                 row->cellcount = 1;
 145                 row->indent = 0;
 146                 row->visible_index = i;
 147                 m_visible_rows.push_back(i);
 148
 149                 Cell *cell = row->cells;
 150                 cell->xmin = 0;
 151                 cell->xmax = 0x7fff;  // something large enough
 152                 cell->xpos = 6;
 153                 cell->content_type = COLUMN_TYPE_TEXT;
 154                 cell->content_index = empty_string_index;
 155                 cell->tooltip_index = empty_string_index;
 156                 cell->color.set(255, 255, 255, 255);
 157                 cell->color_defined = false;
 158                 cell->reported_column = 1;
 159
 160                 // parse row content (color)
 161                 const std::string &s = content[i];
 162                 if (s[0] == '#' && s[1] == '#') {
 163                         // double # to escape
 164                         cell->content_index = allocString(s.substr(2));
 165                 }
 166                 else if (s[0] == '#' && s.size() >= 7 &&
 167                                 parseColorString(
 168                                         s.substr(0,7), cell->color, false)) {
 169                         // single # for color
 170                         cell->color_defined = true;
 171                         cell->content_index = allocString(s.substr(7));
 172                 }
 173                 else {
 174                         // no #, just text
 175                         cell->content_index = allocString(s);
 176                 }
 177
 178         }
 179
 180         allocationComplete();
 181
 182         // Clamp scroll bar position
 183         updateScrollBar();
 184 }
 185
 186 void GUITable::setTable(const TableOptions &options,
 187                 const TableColumns &columns,
 188                 std::vector<std::string> &content)
 189 {
 190         clear();
 191
 192         // Naming conventions:
 193         // i is always a row index, 0-based
 194         // j is always a column index, 0-based
 195         // k is another index, for example an option index
 196
 197         // Handle a stupid error case... (issue #1187)
 198         if (columns.empty()) {
 199                 TableColumn text_column;
 200                 text_column.type = "text";
 201                 TableColumns new_columns;
 202                 new_columns.push_back(text_column);
 203                 setTable(options, new_columns, content);
 204                 return;
 205         }
 206
 207         // Handle table options
 208         video::SColor default_color(255, 255, 255, 255);
 209         s32 opendepth = 0;
 210         for (size_t k = 0; k < options.size(); ++k) {
 211                 const std::string &name = options[k].name;
 212                 const std::string &value = options[k].value;
 213                 if (name == "color")
 214                         parseColorString(value, m_color, false);
 215                 else if (name == "background")
 216                         parseColorString(value, m_background, false);
 217                 else if (name == "border")
 218                         m_border = is_yes(value);
 219                 else if (name == "highlight")
 220                         parseColorString(value, m_highlight, false);
 221                 else if (name == "highlight_text")
 222                         parseColorString(value, m_highlight_text, false);
 223                 else if (name == "opendepth")
 224                         opendepth = stoi(value);
 225                 else
 226                         errorstream<<"Invalid table option: \""<<name<<"\""
 227                                 <<" (value=\""<<value<<"\")"<<std::endl;
 228         }
 229
 230         // Get number of columns and rows
 231         // note: error case columns.size() == 0 was handled above
 232         s32 colcount = columns.size();
 233         assert(colcount >= 1);
 234         // rowcount = ceil(cellcount / colcount) but use integer arithmetic
 235         s32 rowcount = (content.size() + colcount - 1) / colcount;
 236         assert(rowcount >= 0);
 237         // Append empty strings to content if there is an incomplete row
 238         s32 cellcount = rowcount * colcount;
 239         while (content.size() < (u32) cellcount)
 240                 content.push_back("");
 241
 242         // Create temporary rows (for processing columns)
 243         struct TempRow {
 244                 // Current horizontal position (may different between rows due
 245                 // to indent/tree columns, or text/image columns with width<0)
 246                 s32 x;
 247                 // Tree indentation level
 248                 s32 indent;
 249                 // Next cell: Index into m_strings or m_images
 250                 s32 content_index;
 251                 // Next cell: Width in pixels
 252                 s32 content_width;
 253                 // Vector of completed cells in this row
 254                 std::vector<Cell> cells;
 255                 // Stores colors and how long they last (maximum column index)
 256                 std::vector<std::pair<video::SColor, s32> > colors;
 257
 258                 TempRow(): x(0), indent(0), content_index(0), content_width(0) {}
 259         };
 260         TempRow *rows = new TempRow[rowcount];
 261
 262         // Get em width. Pedantically speaking, the width of "M" is not
 263         // necessarily the same as the em width, but whatever, close enough.
 264         s32 em = 6;
 265         if (m_font)
 266                 em = m_font->getDimension(L"M").Width;
 267
 268         s32 default_tooltip_index = allocString("");
 269
 270         std::map<s32, s32> active_image_indices;
 271
 272         // Process content in column-major order
 273         for (s32 j = 0; j < colcount; ++j) {
 274                 // Check column type
 275                 ColumnType columntype = COLUMN_TYPE_TEXT;
 276                 if (columns[j].type == "text")
 277                         columntype = COLUMN_TYPE_TEXT;
 278                 else if (columns[j].type == "image")
 279                         columntype = COLUMN_TYPE_IMAGE;
 280                 else if (columns[j].type == "color")
 281                         columntype = COLUMN_TYPE_COLOR;
 282                 else if (columns[j].type == "indent")
 283                         columntype = COLUMN_TYPE_INDENT;
 284                 else if (columns[j].type == "tree")
 285                         columntype = COLUMN_TYPE_TREE;
 286                 else
 287                         errorstream<<"Invalid table column type: \""
 288                                 <<columns[j].type<<"\""<<std::endl;
 289
 290                 // Process column options
 291                 s32 padding = myround(0.5 * em);
 292                 s32 tooltip_index = default_tooltip_index;
 293                 s32 align = 0;
 294                 s32 width = 0;
 295                 s32 span = colcount;
 296
 297                 if (columntype == COLUMN_TYPE_INDENT) {
 298                         padding = 0; // default indent padding
 299                 }
 300                 if (columntype == COLUMN_TYPE_INDENT ||
 301                                 columntype == COLUMN_TYPE_TREE) {
 302                         width = myround(em * 1.5); // default indent width
 303                 }
 304
 305                 for (size_t k = 0; k < columns[j].options.size(); ++k) {
 306                         const std::string &name = columns[j].options[k].name;
 307                         const std::string &value = columns[j].options[k].value;
 308                         if (name == "padding")
 309                                 padding = myround(stof(value) * em);
 310                         else if (name == "tooltip")
 311                                 tooltip_index = allocString(value);
 312                         else if (name == "align" && value == "left")
 313                                 align = 0;
 314                         else if (name == "align" && value == "center")
 315                                 align = 1;
 316                         else if (name == "align" && value == "right")
 317                                 align = 2;
 318                         else if (name == "align" && value == "inline")
 319                                 align = 3;
 320                         else if (name == "width")
 321                                 width = myround(stof(value) * em);
 322                         else if (name == "span" && columntype == COLUMN_TYPE_COLOR)
 323                                 span = stoi(value);
 324                         else if (columntype == COLUMN_TYPE_IMAGE &&
 325                                         !name.empty() &&
 326                                         string_allowed(name, "0123456789")) {
 327                                 s32 content_index = allocImage(value);
 328                                 active_image_indices.insert(std::make_pair(
 329                                                         stoi(name),
 330                                                         content_index));
 331                         }
 332                         else {
 333                                 errorstream<<"Invalid table column option: \""<<name<<"\""
 334                                         <<" (value=\""<<value<<"\")"<<std::endl;
 335                         }
 336                 }
 337
 338                 // If current column type can use information from "color" columns,
 339                 // find out which of those is currently active
 340                 if (columntype == COLUMN_TYPE_TEXT) {
 341                         for (s32 i = 0; i < rowcount; ++i) {
 342                                 TempRow *row = &rows[i];
 343                                 while (!row->colors.empty() && row->colors.back().second < j)
 344                                         row->colors.pop_back();
 345                         }
 346                 }
 347
 348                 // Make template for new cells
 349                 Cell newcell;
 350                 memset(&newcell, 0, sizeof newcell);
 351                 newcell.content_type = columntype;
 352                 newcell.tooltip_index = tooltip_index;
 353                 newcell.reported_column = j+1;
 354
 355                 if (columntype == COLUMN_TYPE_TEXT) {
 356                         // Find right edge of column
 357                         s32 xmax = 0;
 358                         for (s32 i = 0; i < rowcount; ++i) {
 359                                 TempRow *row = &rows[i];
 360                                 row->content_index = allocString(content[i * colcount + j]);
 361                                 const core::stringw &text = m_strings[row->content_index];
 362                                 row->content_width = m_font ?
 363                                         m_font->getDimension(text.c_str()).Width : 0;
 364                                 row->content_width = MYMAX(row->content_width, width);
 365                                 s32 row_xmax = row->x + padding + row->content_width;
 366                                 xmax = MYMAX(xmax, row_xmax);
 367                         }
 368                         // Add a new cell (of text type) to each row
 369                         for (s32 i = 0; i < rowcount; ++i) {
 370                                 newcell.xmin = rows[i].x + padding;
 371                                 alignContent(&newcell, xmax, rows[i].content_width, align);
 372                                 newcell.content_index = rows[i].content_index;
 373                                 newcell.color_defined = !rows[i].colors.empty();
 374                                 if (newcell.color_defined)
 375                                         newcell.color = rows[i].colors.back().first;
 376                                 rows[i].cells.push_back(newcell);
 377                                 rows[i].x = newcell.xmax;
 378                         }
 379                 }
 380                 else if (columntype == COLUMN_TYPE_IMAGE) {
 381                         // Find right edge of column
 382                         s32 xmax = 0;
 383                         for (s32 i = 0; i < rowcount; ++i) {
 384                                 TempRow *row = &rows[i];
 385                                 row->content_index = -1;
 386
 387                                 // Find content_index. Image indices are defined in
 388                                 // column options so check active_image_indices.
 389                                 s32 image_index = stoi(content[i * colcount + j]);
 390                                 std::map<s32, s32>::iterator image_iter =
 391                                         active_image_indices.find(image_index);
 392                                 if (image_iter != active_image_indices.end())
 393                                         row->content_index = image_iter->second;
 394
 395                                 // Get texture object (might be NULL)
 396                                 video::ITexture *image = NULL;
 397                                 if (row->content_index >= 0)
 398                                         image = m_images[row->content_index];
 399
 400                                 // Get content width and update xmax
 401                                 row->content_width = image ? image->getOriginalSize().Width : 0;
 402                                 row->content_width = MYMAX(row->content_width, width);
 403                                 s32 row_xmax = row->x + padding + row->content_width;
 404                                 xmax = MYMAX(xmax, row_xmax);
 405                         }
 406                         // Add a new cell (of image type) to each row
 407                         for (s32 i = 0; i < rowcount; ++i) {
 408                                 newcell.xmin = rows[i].x + padding;
 409                                 alignContent(&newcell, xmax, rows[i].content_width, align);
 410                                 newcell.content_index = rows[i].content_index;
 411                                 rows[i].cells.push_back(newcell);
 412                                 rows[i].x = newcell.xmax;
 413                         }
 414                         active_image_indices.clear();
 415                 }
 416                 else if (columntype == COLUMN_TYPE_COLOR) {
 417                         for (s32 i = 0; i < rowcount; ++i) {
 418                                 video::SColor cellcolor(255, 255, 255, 255);
 419                                 if (parseColorString(content[i * colcount + j], cellcolor, true))
 420                                         rows[i].colors.push_back(std::make_pair(cellcolor, j+span));
 421                         }
 422                 }
 423                 else if (columntype == COLUMN_TYPE_INDENT ||
 424                                 columntype == COLUMN_TYPE_TREE) {
 425                         // For column type "tree", reserve additional space for +/-
 426                         // Also enable special processing for treeview-type tables
 427                         s32 content_width = 0;
 428                         if (columntype == COLUMN_TYPE_TREE) {
 429                                 content_width = m_font ? m_font->getDimension(L"+").Width : 0;
 430                                 m_has_tree_column = true;
 431                         }
 432                         // Add a new cell (of indent or tree type) to each row
 433                         for (s32 i = 0; i < rowcount; ++i) {
 434                                 TempRow *row = &rows[i];
 435
 436                                 s32 indentlevel = stoi(content[i * colcount + j]);
 437                                 indentlevel = MYMAX(indentlevel, 0);
 438                                 if (columntype == COLUMN_TYPE_TREE)
 439                                         row->indent = indentlevel;
 440
 441                                 newcell.xmin = row->x + padding;
 442                                 newcell.xpos = newcell.xmin + indentlevel * width;
 443                                 newcell.xmax = newcell.xpos + content_width;
 444                                 newcell.content_index = 0;
 445                                 newcell.color_defined = !rows[i].colors.empty();
 446                                 if (newcell.color_defined)
 447                                         newcell.color = rows[i].colors.back().first;
 448                                 row->cells.push_back(newcell);
 449                                 row->x = newcell.xmax;
 450                         }
 451                 }
 452         }
 453
 454         // Copy temporary rows to not so temporary rows
 455         if (rowcount >= 1) {
 456                 m_rows.resize(rowcount);
 457                 for (s32 i = 0; i < rowcount; ++i) {
 458                         Row *row = &m_rows[i];
 459                         row->cellcount = rows[i].cells.size();
 460                         row->cells = new Cell[row->cellcount];
 461                         memcpy((void*) row->cells, (void*) &rows[i].cells[0],
 462                                         row->cellcount * sizeof(Cell));
 463                         row->indent = rows[i].indent;
 464                         row->visible_index = i;
 465                         m_visible_rows.push_back(i);
 466                 }
 467         }
 468
 469         if (m_has_tree_column) {
 470                 // Treeview: convert tree to indent cells on leaf rows
 471                 for (s32 i = 0; i < rowcount; ++i) {
 472                         if (i == rowcount-1 || m_rows[i].indent >= m_rows[i+1].indent)
 473                                 for (s32 j = 0; j < m_rows[i].cellcount; ++j)
 474                                         if (m_rows[i].cells[j].content_type == COLUMN_TYPE_TREE)
 475                                                 m_rows[i].cells[j].content_type = COLUMN_TYPE_INDENT;
 476                 }
 477
 478                 // Treeview: close rows according to opendepth option
 479                 std::set<s32> opened_trees;
 480                 for (s32 i = 0; i < rowcount; ++i)
 481                         if (m_rows[i].indent < opendepth)
 482                                 opened_trees.insert(i);
 483                 setOpenedTrees(opened_trees);
 484         }
 485
 486         // Delete temporary information used only during setTable()
 487         delete[] rows;
 488         allocationComplete();
 489
 490         // Clamp scroll bar position
 491         updateScrollBar();
 492 }
 493
 494 void GUITable::clear()
 495 {
 496         // Clean up cells and rows
 497         for (size_t i = 0; i < m_rows.size(); ++i)
 498                 delete[] m_rows[i].cells;
 499         m_rows.clear();
 500         m_visible_rows.clear();
 501
 502         // Get colors from skin
 503         gui::IGUISkin *skin = Environment->getSkin();
 504         m_color          = skin->getColor(gui::EGDC_BUTTON_TEXT);
 505         m_background     = skin->getColor(gui::EGDC_3D_HIGH_LIGHT);
 506         m_highlight      = skin->getColor(gui::EGDC_HIGH_LIGHT);
 507         m_highlight_text = skin->getColor(gui::EGDC_HIGH_LIGHT_TEXT);
 508
 509         // Reset members
 510         m_is_textlist = false;
 511         m_has_tree_column = false;
 512         m_selected = -1;
 513         m_sel_column = 0;
 514         m_sel_doubleclick = false;
 515         m_keynav_time = 0;
 516         m_keynav_buffer = L"";
 517         m_border = true;
 518         m_strings.clear();
 519         m_images.clear();
 520         m_alloc_strings.clear();
 521         m_alloc_images.clear();
 522 }
 523
 524 std::string GUITable::checkEvent()
 525 {
 526         s32 sel = getSelected();
 527         assert(sel >= 0);
 528
 529         if (sel == 0) {
 530                 return "INV";
 531         }
 532
 533         std::ostringstream os(std::ios::binary);
 534         if (m_sel_doubleclick) {
 535                 os<<"DCL:";
 536                 m_sel_doubleclick = false;
 537         }
 538         else {
 539                 os<<"CHG:";
 540         }
 541         os<<sel;
 542         if (!m_is_textlist) {
 543                 os<<":"<<m_sel_column;
 544         }
 545         return os.str();
 546 }
 547
 548 s32 GUITable::getSelected() const
 549 {
 550         if (m_selected < 0)
 551                 return 0;
 552
 553         assert(m_selected >= 0 && m_selected < (s32) m_visible_rows.size());
 554         return m_visible_rows[m_selected] + 1;
 555 }
 556
 557 void GUITable::setSelected(s32 index)
 558 {
 559         m_selected = -1;
 560         m_sel_column = 0;
 561         m_sel_doubleclick = false;
 562
 563         --index; // Switch from 1-based indexing to 0-based indexing
 564
 565         s32 rowcount = m_rows.size();
 566         if (rowcount == 0) {
 567                 return;
 568         } else if (index < 0) {
 569                 index = 0;
 570         } else if (index >= rowcount) {
 571                 index = rowcount - 1;
 572         }
 573
 574         // If the selected row is not visible, open its ancestors to make it visible
 575         if (m_rows[index].visible_index < 0) {
 576                 std::set<s32> opened_trees;
 577                 getOpenedTrees(opened_trees);
 578                 s32 indent = m_rows[index].indent;
 579                 for (s32 j = index - 1; j >= 0; --j) {
 580                         if (m_rows[j].indent < indent) {
 581                                 opened_trees.insert(j);
 582                                 indent = m_rows[j].indent;
 583                         }
 584                 }
 585                 setOpenedTrees(opened_trees);
 586         }
 587
 588         if (index >= 0) {
 589                 m_selected = m_rows[index].visible_index;
 590                 assert(m_selected >= 0 && m_selected < (s32) m_visible_rows.size());
 591         }
 592
 593         autoScroll();
 594 }
 595
 596 GUITable::DynamicData GUITable::getDynamicData() const
 597 {
 598         DynamicData dyndata;
 599         dyndata.selected = getSelected();
 600         dyndata.scrollpos = m_scrollbar->getPos();
 601         dyndata.keynav_time = m_keynav_time;
 602         dyndata.keynav_buffer = m_keynav_buffer;
 603         if (m_has_tree_column)
 604                 getOpenedTrees(dyndata.opened_trees);
 605         return dyndata;
 606 }
 607
 608 void GUITable::setDynamicData(const DynamicData &dyndata)
 609 {
 610         if (m_has_tree_column)
 611                 setOpenedTrees(dyndata.opened_trees);
 612
 613         m_keynav_time = dyndata.keynav_time;
 614         m_keynav_buffer = dyndata.keynav_buffer;
 615
 616         setSelected(dyndata.selected);
 617         m_sel_column = 0;
 618         m_sel_doubleclick = false;
 619
 620         m_scrollbar->setPos(dyndata.scrollpos);
 621 }
 622
 623 const c8* GUITable::getTypeName() const
 624 {
 625         return "GUITable";
 626 }
 627
 628 void GUITable::updateAbsolutePosition()
 629 {
 630         IGUIElement::updateAbsolutePosition();
 631         updateScrollBar();
 632 }
 633
 634 void GUITable::draw()
 635 {
 636         if (!IsVisible)
 637                 return;
 638
 639         gui::IGUISkin *skin = Environment->getSkin();
 640
 641         // draw background
 642
 643         bool draw_background = m_background.getAlpha() > 0;
 644         if (m_border)
 645                 skin->draw3DSunkenPane(this, m_background,
 646                                 true, draw_background,
 647                                 AbsoluteRect, &AbsoluteClippingRect);
 648         else if (draw_background)
 649                 skin->draw2DRectangle(this, m_background,
 650                                 AbsoluteRect, &AbsoluteClippingRect);
 651
 652         // get clipping rect
 653
 654         core::rect<s32> client_clip(AbsoluteRect);
 655         client_clip.UpperLeftCorner.Y += 1;
 656         client_clip.UpperLeftCorner.X += 1;
 657         client_clip.LowerRightCorner.Y -= 1;
 658         client_clip.LowerRightCorner.X -= 1;
 659         if (m_scrollbar->isVisible()) {
 660                 client_clip.LowerRightCorner.X =
 661                                 m_scrollbar->getAbsolutePosition().UpperLeftCorner.X;
 662         }
 663         client_clip.clipAgainst(AbsoluteClippingRect);
 664
 665         // draw visible rows
 666
 667         s32 scrollpos = m_scrollbar->getPos();
 668         s32 row_min = scrollpos / m_rowheight;
 669         s32 row_max = (scrollpos + AbsoluteRect.getHeight() - 1)
 670                         / m_rowheight + 1;
 671         row_max = MYMIN(row_max, (s32) m_visible_rows.size());
 672
 673         core::rect<s32> row_rect(AbsoluteRect);
 674         if (m_scrollbar->isVisible())
 675                 row_rect.LowerRightCorner.X -=
 676                         skin->getSize(gui::EGDS_SCROLLBAR_SIZE);
 677         row_rect.UpperLeftCorner.Y += row_min * m_rowheight - scrollpos;
 678         row_rect.LowerRightCorner.Y = row_rect.UpperLeftCorner.Y + m_rowheight;
 679
 680         for (s32 i = row_min; i < row_max; ++i) {
 681                 Row *row = &m_rows[m_visible_rows[i]];
 682                 bool is_sel = i == m_selected;
 683                 video::SColor color = m_color;
 684
 685                 if (is_sel) {
 686                         skin->draw2DRectangle(this, m_highlight, row_rect, &client_clip);
 687                         color = m_highlight_text;
 688                 }
 689
 690                 for (s32 j = 0; j < row->cellcount; ++j)
 691                         drawCell(&row->cells[j], color, row_rect, client_clip);
 692
 693                 row_rect.UpperLeftCorner.Y += m_rowheight;
 694                 row_rect.LowerRightCorner.Y += m_rowheight;
 695         }
 696
 697         // Draw children
 698         IGUIElement::draw();
 699 }
 700
 701 void GUITable::drawCell(const Cell *cell, video::SColor color,
 702                 const core::rect<s32> &row_rect,
 703                 const core::rect<s32> &client_clip)
 704 {
 705         if ((cell->content_type == COLUMN_TYPE_TEXT)
 706                         || (cell->content_type == COLUMN_TYPE_TREE)) {
 707
 708                 core::rect<s32> text_rect = row_rect;
 709                 text_rect.UpperLeftCorner.X = row_rect.UpperLeftCorner.X
 710                                 + cell->xpos;
 711                 text_rect.LowerRightCorner.X = row_rect.UpperLeftCorner.X
 712                                 + cell->xmax;
 713
 714                 if (cell->color_defined)
 715                         color = cell->color;
 716
 717                 if (m_font) {
 718                         if (cell->content_type == COLUMN_TYPE_TEXT)
 719                                 m_font->draw(m_strings[cell->content_index],
 720                                                 text_rect, color,
 721                                                 false, true, &client_clip);
 722                         else // tree
 723                                 m_font->draw(cell->content_index ? L"+" : L"-",
 724                                                 text_rect, color,
 725                                                 false, true, &client_clip);
 726                 }
 727         }
 728         else if (cell->content_type == COLUMN_TYPE_IMAGE) {
 729
 730                 if (cell->content_index < 0)
 731                         return;
 732
 733                 video::IVideoDriver *driver = Environment->getVideoDriver();
 734                 video::ITexture *image = m_images[cell->content_index];
 735
 736                 if (image) {
 737                         core::position2d<s32> dest_pos =
 738                                         row_rect.UpperLeftCorner;
 739                         dest_pos.X += cell->xpos;
 740                         core::rect<s32> source_rect(
 741                                         core::position2d<s32>(0, 0),
 742                                         image->getOriginalSize());
 743                         s32 imgh = source_rect.LowerRightCorner.Y;
 744                         s32 rowh = row_rect.getHeight();
 745                         if (imgh < rowh)
 746                                 dest_pos.Y += (rowh - imgh) / 2;
 747                         else
 748                                 source_rect.LowerRightCorner.Y = rowh;
 749
 750                         video::SColor color(255, 255, 255, 255);
 751
 752                         driver->draw2DImage(image, dest_pos, source_rect,
 753                                         &client_clip, color, true);
 754                 }
 755         }
 756 }
 757
 758 bool GUITable::OnEvent(const SEvent &event)
 759 {
 760         if (!isEnabled())
 761                 return IGUIElement::OnEvent(event);
 762
 763         if (event.EventType == EET_KEY_INPUT_EVENT) {
 764                 if (event.KeyInput.PressedDown && (
 765                                 event.KeyInput.Key == KEY_DOWN ||
 766                                 event.KeyInput.Key == KEY_UP   ||
 767                                 event.KeyInput.Key == KEY_HOME ||
 768                                 event.KeyInput.Key == KEY_END  ||
 769                                 event.KeyInput.Key == KEY_NEXT ||
 770                                 event.KeyInput.Key == KEY_PRIOR)) {
 771                         s32 offset = 0;
 772                         switch (event.KeyInput.Key) {
 773                                 case KEY_DOWN:
 774                                         offset = 1;
 775                                         break;
 776                                 case KEY_UP:
 777                                         offset = -1;
 778                                         break;
 779                                 case KEY_HOME:
 780                                         offset = - (s32) m_visible_rows.size();
 781                                         break;
 782                                 case KEY_END:
 783                                         offset = m_visible_rows.size();
 784                                         break;
 785                                 case KEY_NEXT:
 786                                         offset = AbsoluteRect.getHeight() / m_rowheight;
 787                                         break;
 788                                 case KEY_PRIOR:
 789                                         offset = - (s32) (AbsoluteRect.getHeight() / m_rowheight);
 790                                         break;
 791                                 default:
 792                                         break;
 793                         }
 794                         s32 old_selected = m_selected;
 795                         s32 rowcount = m_visible_rows.size();
 796                         if (rowcount != 0) {
 797                                 m_selected = rangelim(m_selected + offset, 0, rowcount-1);
 798                                 autoScroll();
 799                         }
 800
 801                         if (m_selected != old_selected)
 802                                 sendTableEvent(0, false);
 803
 804                         return true;
 805                 }
 806                 else if (event.KeyInput.PressedDown && (
 807                                 event.KeyInput.Key == KEY_LEFT ||
 808                                 event.KeyInput.Key == KEY_RIGHT)) {
 809                         // Open/close subtree via keyboard
 810                         if (m_selected >= 0) {
 811                                 int dir = event.KeyInput.Key == KEY_LEFT ? -1 : 1;
 812                                 toggleVisibleTree(m_selected, dir, true);
 813                         }
 814                         return true;
 815                 }
 816                 else if (!event.KeyInput.PressedDown && (
 817                                 event.KeyInput.Key == KEY_RETURN ||
 818                                 event.KeyInput.Key == KEY_SPACE)) {
 819                         sendTableEvent(0, true);
 820                         return true;
 821                 }
 822                 else if (event.KeyInput.Key == KEY_ESCAPE ||
 823                                 event.KeyInput.Key == KEY_SPACE) {
 824                         // pass to parent
 825                 }
 826                 else if (event.KeyInput.PressedDown && event.KeyInput.Char) {
 827                         // change selection based on text as it is typed
 828                         s32 now = getTimeMs();
 829                         if (now - m_keynav_time >= 500)
 830                                 m_keynav_buffer = L"";
 831                         m_keynav_time = now;
 832
 833                         // add to key buffer if not a key repeat
 834                         if (!(m_keynav_buffer.size() == 1 &&
 835                                         m_keynav_buffer[0] == event.KeyInput.Char)) {
 836                                 m_keynav_buffer.append(event.KeyInput.Char);
 837                         }
 838
 839                         // find the selected item, starting at the current selection
 840                         // don't change selection if the key buffer matches the current item
 841                         s32 old_selected = m_selected;
 842                         s32 start = MYMAX(m_selected, 0);
 843                         s32 rowcount = m_visible_rows.size();
 844                         for (s32 k = 1; k < rowcount; ++k) {
 845                                 s32 current = start + k;
 846                                 if (current >= rowcount)
 847                                         current -= rowcount;
 848                                 if (doesRowStartWith(getRow(current), m_keynav_buffer)) {
 849                                         m_selected = current;
 850                                         break;
 851                                 }
 852                         }
 853                         autoScroll();
 854                         if (m_selected != old_selected)
 855                                 sendTableEvent(0, false);
 856
 857                         return true;
 858                 }
 859         }
 860         if (event.EventType == EET_MOUSE_INPUT_EVENT) {
 861                 core::position2d<s32> p(event.MouseInput.X, event.MouseInput.Y);
 862
 863                 if (event.MouseInput.Event == EMIE_MOUSE_WHEEL) {
 864                         m_scrollbar->setPos(m_scrollbar->getPos() +
 865                                         (event.MouseInput.Wheel < 0 ? -3 : 3) *
 866                                         - (s32) m_rowheight / 2);
 867                         return true;
 868                 }
 869
 870                 // Find hovered row and cell
 871                 bool really_hovering = false;
 872                 s32 row_i = getRowAt(p.Y, really_hovering);
 873                 const Cell *cell = NULL;
 874                 if (really_hovering) {
 875                         s32 cell_j = getCellAt(p.X, row_i);
 876                         if (cell_j >= 0)
 877                                 cell = &(getRow(row_i)->cells[cell_j]);
 878                 }
 879
 880                 // Update tooltip
 881                 setToolTipText(cell ? m_strings[cell->tooltip_index].c_str() : L"");
 882
 883                 // Fix for #1567/#1806:
 884                 // IGUIScrollBar passes double click events to its parent,
 885                 // which we don't want. Detect this case and discard the event
 886                 if (event.MouseInput.Event != EMIE_MOUSE_MOVED &&
 887                                 m_scrollbar->isVisible() &&
 888                                 m_scrollbar->isPointInside(p))
 889                         return true;
 890
 891                 if (event.MouseInput.isLeftPressed() &&
 892                                 (isPointInside(p) ||
 893                                  event.MouseInput.Event == EMIE_MOUSE_MOVED)) {
 894                         s32 sel_column = 0;
 895                         bool sel_doubleclick = (event.MouseInput.Event
 896                                         == EMIE_LMOUSE_DOUBLE_CLICK);
 897                         bool plusminus_clicked = false;
 898
 899                         // For certain events (left click), report column
 900                         // Also open/close subtrees when the +/- is clicked
 901                         if (cell && (
 902                                         event.MouseInput.Event == EMIE_LMOUSE_PRESSED_DOWN ||
 903                                         event.MouseInput.Event == EMIE_LMOUSE_DOUBLE_CLICK ||
 904                                         event.MouseInput.Event == EMIE_LMOUSE_TRIPLE_CLICK)) {
 905                                 sel_column = cell->reported_column;
 906                                 if (cell->content_type == COLUMN_TYPE_TREE)
 907                                         plusminus_clicked = true;
 908                         }
 909
 910                         if (plusminus_clicked) {
 911                                 if (event.MouseInput.Event == EMIE_LMOUSE_PRESSED_DOWN) {
 912                                         toggleVisibleTree(row_i, 0, false);
 913                                 }
 914                         }
 915                         else {
 916                                 // Normal selection
 917                                 s32 old_selected = m_selected;
 918                                 m_selected = row_i;
 919                                 autoScroll();
 920
 921                                 if (m_selected != old_selected ||
 922                                                 sel_column >= 1 ||
 923                                                 sel_doubleclick) {
 924                                         sendTableEvent(sel_column, sel_doubleclick);
 925                                 }
 926                         }
 927                 }
 928                 return true;
 929         }
 930         if (event.EventType == EET_GUI_EVENT &&
 931                         event.GUIEvent.EventType == gui::EGET_SCROLL_BAR_CHANGED &&
 932                         event.GUIEvent.Caller == m_scrollbar) {
 933                 // Don't pass events from our scrollbar to the parent
 934                 return true;
 935         }
 936
 937         return IGUIElement::OnEvent(event);
 938 }
 939
 940 /******************************************************************************/
 941 /* GUITable helper functions                                                  */
 942 /******************************************************************************/
 943
 944 s32 GUITable::allocString(const std::string &text)
 945 {
 946         std::map<std::string, s32>::iterator it = m_alloc_strings.find(text);
 947         if (it == m_alloc_strings.end()) {
 948                 s32 id = m_strings.size();
 949                 std::wstring wtext = utf8_to_wide(text);
 950                 m_strings.push_back(core::stringw(wtext.c_str()));
 951                 m_alloc_strings.insert(std::make_pair(text, id));
 952                 return id;
 953         }
 954         else {
 955                 return it->second;
 956         }
 957 }
 958
 959 s32 GUITable::allocImage(const std::string &imagename)
 960 {
 961         std::map<std::string, s32>::iterator it = m_alloc_images.find(imagename);
 962         if (it == m_alloc_images.end()) {
 963                 s32 id = m_images.size();
 964                 m_images.push_back(m_tsrc->getTexture(imagename));
 965                 m_alloc_images.insert(std::make_pair(imagename, id));
 966                 return id;
 967         }
 968         else {
 969                 return it->second;
 970         }
 971 }
 972
 973 void GUITable::allocationComplete()
 974 {
 975         // Called when done with creating rows and cells from table data,
 976         // i.e. when allocString and allocImage won't be called anymore
 977         m_alloc_strings.clear();
 978         m_alloc_images.clear();
 979 }
 980
 981 const GUITable::Row* GUITable::getRow(s32 i) const
 982 {
 983         if (i >= 0 && i < (s32) m_visible_rows.size())
 984                 return &m_rows[m_visible_rows[i]];
 985         else
 986                 return NULL;
 987 }
 988
 989 bool GUITable::doesRowStartWith(const Row *row, const core::stringw &str) const
 990 {
 991         if (row == NULL)
 992                 return false;
 993
 994         for (s32 j = 0; j < row->cellcount; ++j) {
 995                 Cell *cell = &row->cells[j];
 996                 if (cell->content_type == COLUMN_TYPE_TEXT) {
 997                         const core::stringw &cellstr = m_strings[cell->content_index];
 998                         if (cellstr.size() >= str.size() &&
 999                                         str.equals_ignore_case(cellstr.subString(0, str.size())))
1000                                 return true;
1001                 }
1002         }
1003         return false;
1004 }
1005
1006 s32 GUITable::getRowAt(s32 y, bool &really_hovering) const
1007 {
1008         really_hovering = false;
1009
1010         s32 rowcount = m_visible_rows.size();
1011         if (rowcount == 0)
1012                 return -1;
1013
1014         // Use arithmetic to find row
1015         s32 rel_y = y - AbsoluteRect.UpperLeftCorner.Y - 1;
1016         s32 i = (rel_y + m_scrollbar->getPos()) / m_rowheight;
1017
1018         if (i >= 0 && i < rowcount) {
1019                 really_hovering = true;
1020                 return i;
1021         }
1022         else if (i < 0)
1023                 return 0;
1024         else
1025                 return rowcount - 1;
1026
1027 }
1028
1029 s32 GUITable::getCellAt(s32 x, s32 row_i) const
1030 {
1031         const Row *row = getRow(row_i);
1032         if (row == NULL)
1033                 return -1;
1034
1035         // Use binary search to find cell in row
1036         s32 rel_x = x - AbsoluteRect.UpperLeftCorner.X - 1;
1037         s32 jmin = 0;
1038         s32 jmax = row->cellcount - 1;
1039         while (jmin < jmax) {
1040                 s32 pivot = jmin + (jmax - jmin) / 2;
1041                 assert(pivot >= 0 && pivot < row->cellcount);
1042                 const Cell *cell = &row->cells[pivot];
1043
1044                 if (rel_x >= cell->xmin && rel_x <= cell->xmax)
1045                         return pivot;
1046                 else if (rel_x < cell->xmin)
1047                         jmax = pivot - 1;
1048                 else
1049                         jmin = pivot + 1;
1050         }
1051
1052         if (jmin >= 0 && jmin < row->cellcount &&
1053                         rel_x >= row->cells[jmin].xmin &&
1054                         rel_x <= row->cells[jmin].xmax)
1055                 return jmin;
1056         else
1057                 return -1;
1058 }
1059
1060 void GUITable::autoScroll()
1061 {
1062         if (m_selected >= 0) {
1063                 s32 pos = m_scrollbar->getPos();
1064                 s32 maxpos = m_selected * m_rowheight;
1065                 s32 minpos = maxpos - (AbsoluteRect.getHeight() - m_rowheight);
1066                 if (pos > maxpos)
1067                         m_scrollbar->setPos(maxpos);
1068                 else if (pos < minpos)
1069                         m_scrollbar->setPos(minpos);
1070         }
1071 }
1072
1073 void GUITable::updateScrollBar()
1074 {
1075         s32 totalheight = m_rowheight * m_visible_rows.size();
1076         s32 scrollmax = MYMAX(0, totalheight - AbsoluteRect.getHeight());
1077         m_scrollbar->setVisible(scrollmax > 0);
1078         m_scrollbar->setMax(scrollmax);
1079         m_scrollbar->setSmallStep(m_rowheight);
1080         m_scrollbar->setLargeStep(2 * m_rowheight);
1081 }
1082
1083 void GUITable::sendTableEvent(s32 column, bool doubleclick)
1084 {
1085         m_sel_column = column;
1086         m_sel_doubleclick = doubleclick;
1087         if (Parent) {
1088                 SEvent e;
1089                 memset(&e, 0, sizeof e);
1090                 e.EventType = EET_GUI_EVENT;
1091                 e.GUIEvent.Caller = this;
1092                 e.GUIEvent.Element = 0;
1093                 e.GUIEvent.EventType = gui::EGET_TABLE_CHANGED;
1094                 Parent->OnEvent(e);
1095         }
1096 }
1097
1098 void GUITable::getOpenedTrees(std::set<s32> &opened_trees) const
1099 {
1100         opened_trees.clear();
1101         s32 rowcount = m_rows.size();
1102         for (s32 i = 0; i < rowcount - 1; ++i) {
1103                 if (m_rows[i].indent < m_rows[i+1].indent &&
1104                                 m_rows[i+1].visible_index != -2)
1105                         opened_trees.insert(i);
1106         }
1107 }
1108
1109 void GUITable::setOpenedTrees(const std::set<s32> &opened_trees)
1110 {
1111         s32 old_selected = -1;
1112         if (m_selected >= 0)
1113                 old_selected = m_visible_rows[m_selected];
1114
1115         std::vector<s32> parents;
1116         std::vector<s32> closed_parents;
1117
1118         m_visible_rows.clear();
1119
1120         for (size_t i = 0; i < m_rows.size(); ++i) {
1121                 Row *row = &m_rows[i];
1122
1123                 // Update list of ancestors
1124                 while (!parents.empty() && m_rows[parents.back()].indent >= row->indent)
1125                         parents.pop_back();
1126                 while (!closed_parents.empty() &&
1127                                 m_rows[closed_parents.back()].indent >= row->indent)
1128                         closed_parents.pop_back();
1129
1130                 assert(closed_parents.size() <= parents.size());
1131
1132                 if (closed_parents.empty()) {
1133                         // Visible row
1134                         row->visible_index = m_visible_rows.size();
1135                         m_visible_rows.push_back(i);
1136                 }
1137                 else if (parents.back() == closed_parents.back()) {
1138                         // Invisible row, direct parent is closed
1139                         row->visible_index = -2;
1140                 }
1141                 else {
1142                         // Invisible row, direct parent is open, some ancestor is closed
1143                         row->visible_index = -1;
1144                 }
1145
1146                 // If not a leaf, add to parents list
1147                 if (i < m_rows.size()-1 && row->indent < m_rows[i+1].indent) {
1148                         parents.push_back(i);
1149
1150                         s32 content_index = 0; // "-", open
1151                         if (opened_trees.count(i) == 0) {
1152                                 closed_parents.push_back(i);
1153                                 content_index = 1; // "+", closed
1154                         }
1155
1156                         // Update all cells of type "tree"
1157                         for (s32 j = 0; j < row->cellcount; ++j)
1158                                 if (row->cells[j].content_type == COLUMN_TYPE_TREE)
1159                                         row->cells[j].content_index = content_index;
1160                 }
1161         }
1162
1163         updateScrollBar();
1164
1165         // m_selected must be updated since it is a visible row index
1166         if (old_selected >= 0)
1167                 m_selected = m_rows[old_selected].visible_index;
1168 }
1169
1170 void GUITable::openTree(s32 to_open)
1171 {
1172         std::set<s32> opened_trees;
1173         getOpenedTrees(opened_trees);
1174         opened_trees.insert(to_open);
1175         setOpenedTrees(opened_trees);
1176 }
1177
1178 void GUITable::closeTree(s32 to_close)
1179 {
1180         std::set<s32> opened_trees;
1181         getOpenedTrees(opened_trees);
1182         opened_trees.erase(to_close);
1183         setOpenedTrees(opened_trees);
1184 }
1185
1186 // The following function takes a visible row index (hidden rows skipped)
1187 // dir: -1 = left (close), 0 = auto (toggle), 1 = right (open)
1188 void GUITable::toggleVisibleTree(s32 row_i, int dir, bool move_selection)
1189 {
1190         // Check if the chosen tree is currently open
1191         const Row *row = getRow(row_i);
1192         if (row == NULL)
1193                 return;
1194
1195         bool was_open = false;
1196         for (s32 j = 0; j < row->cellcount; ++j) {
1197                 if (row->cells[j].content_type == COLUMN_TYPE_TREE) {
1198                         was_open = row->cells[j].content_index == 0;
1199                         break;
1200                 }
1201         }
1202
1203         // Check if the chosen tree should be opened
1204         bool do_open = !was_open;
1205         if (dir < 0)
1206                 do_open = false;
1207         else if (dir > 0)
1208                 do_open = true;
1209
1210         // Close or open the tree; the heavy lifting is done by setOpenedTrees
1211         if (was_open && !do_open)
1212                 closeTree(m_visible_rows[row_i]);
1213         else if (!was_open && do_open)
1214                 openTree(m_visible_rows[row_i]);
1215
1216         // Change selected row if requested by caller,
1217         // this is useful for keyboard navigation
1218         if (move_selection) {
1219                 s32 sel = row_i;
1220                 if (was_open && do_open) {
1221                         // Move selection to first child
1222                         const Row *maybe_child = getRow(sel + 1);
1223                         if (maybe_child && maybe_child->indent > row->indent)
1224                                 sel++;
1225                 }
1226                 else if (!was_open && !do_open) {
1227                         // Move selection to parent
1228                         assert(getRow(sel) != NULL);
1229                         while (sel > 0 && getRow(sel - 1)->indent >= row->indent)
1230                                 sel--;
1231                         sel--;
1232                         if (sel < 0)  // was root already selected?
1233                                 sel = row_i;
1234                 }
1235                 if (sel != m_selected) {
1236                         m_selected = sel;
1237                         autoScroll();
1238                         sendTableEvent(0, false);
1239                 }
1240         }
1241 }
1242
1243 void GUITable::alignContent(Cell *cell, s32 xmax, s32 content_width, s32 align)
1244 {
1245         // requires that cell.xmin, cell.xmax are properly set
1246         // align = 0: left aligned, 1: centered, 2: right aligned, 3: inline
1247         if (align == 0) {
1248                 cell->xpos = cell->xmin;
1249                 cell->xmax = xmax;
1250         }
1251         else if (align == 1) {
1252                 cell->xpos = (cell->xmin + xmax - content_width) / 2;
1253                 cell->xmax = xmax;
1254         }
1255         else if (align == 2) {
1256                 cell->xpos = xmax - content_width;
1257                 cell->xmax = xmax;
1258         }
1259         else {
1260                 // inline alignment: the cells of the column don't have an aligned
1261                 // right border, the right border of each cell depends on the content
1262                 cell->xpos = cell->xmin;
1263                 cell->xmax = cell->xmin + content_width;
1264         }
1265 }