Styles.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 WXMAXIMA_STYLES_H
#define WXMAXIMA_STYLES_H
 
#include "cells/TextStyle.h"
#include <utility>
#include <vector>
 
class wxConfigBase;
 
class Styles
{
public:
  Style &operator[](int textStyle) { return active()[textStyle]; }
  const Style &operator[](int textStyle) const { return active()[textStyle]; }
  Style *begin() { return active(); }
  Style *end() { return active() + NUMBEROFSTYLES; }
  const Style *begin() const { return active(); }
  const Style *end() const { return active() + NUMBEROFSTYLES; }
 
  void SetUseDark(bool dark) { m_useDark = dark; }
  bool UsingDark() const { return m_useDark; }
  void ClearCaches();
 
  void SetDefaults();
 
  void SetDarkDefaults();
 
  void Read(wxConfigBase *config);
  void Write(wxConfigBase *config) const;
 
  static const std::vector<std::pair<TextStyle, wxString>> &ConfigKeys();
 
  static const wxString &Name(TextStyle textStyle);
 
  // Defined inline so the lightweight unit tests (which include this header but do
  // not link Styles.cpp) can still construct a Styles / Configuration.
  Styles()
    : m_codeStyles{TS_CODE_VARIABLE, TS_CODE_FUNCTION, TS_CODE_COMMENT,
                   TS_CODE_NUMBER,   TS_CODE_STRING,   TS_CODE_OPERATOR,
                   TS_CODE_LISP,     TS_CODE_ENDOFLINE, TS_EQUALSSELECTION},
      m_2dMathStyles{TS_VARIABLE,    TS_OPERATOR,  TS_NUMBER,
                     TS_FUNCTION,    TS_SPECIAL_CONSTANT, TS_GREEK_CONSTANT,
                     TS_STRING,      TS_MAIN_PROMPT, TS_OTHER_PROMPT,
                     TS_LABEL,       TS_USERLABEL, TS_HIGHLIGHT,
                     TS_WARNING,     TS_ERROR, TS_ASCIIMATHS, TS_TEXT},
      m_colorOnlyStyles{TS_TEXT_BACKGROUND, TS_DOCUMENT_BACKGROUND, TS_CELL_BRACKET,
                        TS_ACTIVE_CELL_BRACKET, TS_CURSOR, TS_SELECTION,
                        TS_EQUALSSELECTION, TS_DIFF_CHANGED, TS_LINK, TS_OUTDATED,
                        TS_IMAGE_BACKDROP, TS_ERROR_STATEMENT, TS_ERROR_SPOT} {}
 
  const std::vector<TextStyle> &CodeStylesList() const { return m_codeStyles; }
  const std::vector<TextStyle> &MathStylesList() const { return m_2dMathStyles; }
  const std::vector<TextStyle> &ColorOnlyStylesList() const { return m_colorOnlyStyles; }
  bool AffectsCode(TextStyle style) const;
  bool AffectsMathOut(TextStyle style) const;
  bool AffectsColorOnly(TextStyle style) const;
  void MakeConsistent();
 
private:
  void MakeConsistent(Style *styles) const;
  Style *active() { return m_useDark ? m_stylesDark : m_styles; }
  const Style *active() const { return m_useDark ? m_stylesDark : m_styles; }
  void SetLightDefaultsInto(Style *styles);
 
  Style m_styles[NUMBEROFSTYLES];
  Style m_stylesDark[NUMBEROFSTYLES];
  bool m_useDark = false;
  std::vector<TextStyle> m_codeStyles;
  std::vector<TextStyle> m_2dMathStyles;
  std::vector<TextStyle> m_colorOnlyStyles;
};
 
#endif // WXMAXIMA_STYLES_H