WorksheetSearch.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 WORKSHEETSEARCH_H
#define WORKSHEETSEARCH_H
 
#include <wx/regex.h>
#include <wx/string.h>
 
class Cell;
class EditorCell;
class GroupCell;
 
namespace WorksheetSearch {
 
class Matcher {
public:
  virtual ~Matcher() = default;
  virtual bool Matches(wxString text) const = 0;
  virtual bool FindInEditor(EditorCell *editor, bool down) const = 0;
};
 
class StringMatcher final : public Matcher {
public:
  StringMatcher(const wxString &str, bool ignoreCase)
    : m_str(str), m_ignoreCase(ignoreCase) {}
  bool Matches(wxString text) const override;
  bool FindInEditor(EditorCell *editor, bool down) const override;
 
private:
  wxString m_str;
  bool m_ignoreCase;
};
 
class RegexMatcher final : public Matcher {
public:
  explicit RegexMatcher(const wxString &pattern)
    : m_pattern(pattern), m_regex(pattern) {}
  bool IsValid() const { return m_regex.IsValid(); }
  bool Matches(wxString text) const override;
  bool FindInEditor(EditorCell *editor, bool down) const override;
 
private:
  wxString m_pattern;
  wxRegEx m_regex;
};
 
enum class MatchPart { Prompt, Editor, Output };
 
struct SearchTarget {
  GroupCell *m_group = nullptr;
  MatchPart m_part = MatchPart::Prompt;
  Cell *m_cell = nullptr;
  bool m_wrapped = false;
  bool Found() const { return m_group != nullptr; }
};
 
struct SearchStart {
  GroupCell *m_group = nullptr;
  bool m_inEditor = false;
  Cell *m_atCell = nullptr;
};
 
SearchTarget FindNextTarget(GroupCell *tree, GroupCell *last,
                            const SearchStart &start, bool down,
                            const Matcher &matcher, bool searchInInput,
                            bool searchInOutput);
 
} // namespace WorksheetSearch
 
#endif // WORKSHEETSEARCH_H