OutputNavigation.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2026 Gunter Königsmann <wxMaxima@physikbuch.de>
//
//  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
//
//  SPDX-License-Identifier: GPL-2.0+
 
#ifndef OUTPUTNAVIGATION_H
#define OUTPUTNAVIGATION_H
 
#include "cells/MatrixBlock.h"
#include <vector>
 
class Cell;
class GroupCell;
class MatrCell;
 
namespace OutputNavigation {
 
struct Item
{
  Cell *first = nullptr;
  Cell *last = nullptr;
  MatrCell *matrix = nullptr;
  MatrixEntry entry;
 
  bool IsMatrixEntry() const { return matrix != nullptr; }
  bool operator==(const Item &other) const;
};
 
Item Run(Cell *first, Cell *last);
Item Entry(MatrCell *matrix, MatrixEntry entry);
 
std::vector<Item> Results(const GroupCell *group);
 
std::vector<Item> Children(const Item &item);
 
struct Location
{
  bool found = false;
  std::vector<Item> path;
  std::vector<Item> siblings;
  std::size_t index = 0;
};
Location Locate(const GroupCell *group, const Item &item);
 
struct RunLocation
{
  bool found = false;
  std::vector<Item> path; 
  std::vector<Item> siblings;
  std::size_t firstIndex = 0;
  std::size_t lastIndex = 0;
};
RunLocation LocateRun(const GroupCell *group, const Cell *first, const Cell *last);
 
} // namespace OutputNavigation
 
#endif // OUTPUTNAVIGATION_H