qgscodeeditor.cpp

/***************************************************************************
    qgscodeeditor.cpp - A base code editor for QGIS and plugins.  Provides
                        a base editor using QScintilla for editors
     --------------------------------------
    Date                 : 06-Oct-2013
    Copyright            : (C) 2013 by Salvatore Larosa
    Email                : lrssvtml (at) gmail (dot) com
 ***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#include "qgsapplication.h"
#include "qgscodeeditor.h"
#include "qgssettings.h"
#include "qgssymbollayerutils.h"
#include "qgsgui.h"

#include <QLabel>
#include <QWidget>
#include <QFont>
#include <QFontDatabase>
#include <QDebug>
#include <QFocusEvent>

QMap< QgsCodeEditor::ColorRole, QString > QgsCodeEditor::sColorRoleToSettingsKey
{
  {ColorRole::Default, QStringLiteral( "defaultFontColor" ) },
  {ColorRole::Keyword, QStringLiteral( "keywordFontColor" ) },
  {ColorRole::Class, QStringLiteral( "classFontColor" ) },
  {ColorRole::Method, QStringLiteral( "methodFontColor" ) },
  {ColorRole::Decoration, QStringLiteral( "decoratorFontColor" ) },
  {ColorRole::Number, QStringLiteral( "numberFontColor" ) },
  {ColorRole::Comment, QStringLiteral( "commentFontColor" ) },
  {ColorRole::CommentLine, QStringLiteral( "commentLineFontColor" ) },
  {ColorRole::CommentBlock, QStringLiteral( "commentBlockFontColor" ) },
  {ColorRole::Background, QStringLiteral( "paperBackgroundColor" ) },
  {ColorRole::Cursor, QStringLiteral( "cursorColor" ) },
  {ColorRole::CaretLine, QStringLiteral( "caretLineColor" ) },
  {ColorRole::Operator, QStringLiteral( "operatorFontColor" ) },
  {ColorRole::QuotedOperator, QStringLiteral( "quotedOperatorFontColor" ) },
  {ColorRole::Identifier, QStringLiteral( "identifierFontColor" ) },
  {ColorRole::QuotedIdentifier, QStringLiteral( "quotedIdentifierFontColor" ) },
  {ColorRole::Tag, QStringLiteral( "tagFontColor" ) },
  {ColorRole::UnknownTag, QStringLiteral( "unknownTagFontColor" ) },
  {ColorRole::SingleQuote, QStringLiteral( "singleQuoteFontColor" ) },
  {ColorRole::DoubleQuote, QStringLiteral( "doubleQuoteFontColor" ) },
  {ColorRole::TripleSingleQuote, QStringLiteral( "tripleSingleQuoteFontColor" ) },
  {ColorRole::TripleDoubleQuote, QStringLiteral( "tripleDoubleQuoteFontColor" ) },
  {ColorRole::MarginBackground, QStringLiteral( "marginBackgroundColor" ) },
  {ColorRole::MarginForeground, QStringLiteral( "marginForegroundColor" ) },
  {ColorRole::SelectionBackground, QStringLiteral( "selectionBackgroundColor" ) },
  {ColorRole::SelectionForeground, QStringLiteral( "selectionForegroundColor" ) },
  {ColorRole::MatchedBraceBackground, QStringLiteral( "matchedBraceBackground" ) },
  {ColorRole::MatchedBraceForeground, QStringLiteral( "matchedBraceColor" ) },
  {ColorRole::Edge, QStringLiteral( "edgeColor" ) },
  {ColorRole::Fold, QStringLiteral( "foldColor" ) },
  {ColorRole::Error, QStringLiteral( "stderrFontColor" ) },
};


QgsCodeEditor::QgsCodeEditor( QWidget *parent, const QString &title, bool folding, bool margin )
  : QsciScintilla( parent )
  , mWidgetTitle( title )
  , mFolding( folding )
  , mMargin( margin )
{
  if ( !parent && mWidgetTitle.isEmpty() )
  {
    setWindowTitle( QStringLiteral( "Text Editor" ) );
  }
  else
  {
    setWindowTitle( mWidgetTitle );
  }
  setSciWidget();
  setHorizontalScrollBarPolicy( Qt::ScrollBarAsNeeded );

  SendScintilla( SCI_SETADDITIONALSELECTIONTYPING, 1 );
  SendScintilla( SCI_SETMULTIPASTE, 1 );
  SendScintilla( SCI_SETVIRTUALSPACEOPTIONS, SCVS_RECTANGULARSELECTION );

  connect( QgsGui::instance(), &QgsGui::optionsChanged, this, [ = ]
  {
    setSciWidget();
    initializeLexer();
  } );
}

// Workaround a bug in QScintilla 2.8.X
void QgsCodeEditor::focusOutEvent( QFocusEvent *event )
{
#if QSCINTILLA_VERSION >= 0x020800 && QSCINTILLA_VERSION < 0x020900
  if ( event->reason() != Qt::ActiveWindowFocusReason )
  {
    /* There's a bug in all QScintilla 2.8.X, where
       a focus out event that is not due to ActiveWindowFocusReason doesn't
       lead to the bliking caret being disabled. The hack consists in making
       QsciScintilla::focusOutEvent believe that the event is a ActiveWindowFocusReason
       The bug was fixed in 2.9 per:
        2015-04-14  Phil Thompson  <phil@riverbankcomputing.com>

        * qt/qsciscintillabase.cpp:
        Fixed a problem notifying when focus is lost to another application
        widget.
        [41734678234e]
    */
    QFocusEvent newFocusEvent( QEvent::FocusOut, Qt::ActiveWindowFocusReason );
    QsciScintilla::focusOutEvent( &newFocusEvent );
  }
  else
#endif
  {
    QsciScintilla::focusOutEvent( event );
  }
}

// This workaround a likely bug in QScintilla. The ESC key should not be consumned
// by the main entry, so that the default behavior (Dialog closing) can trigger,
// but only is the auto-completion suggestion list isn't displayed
void QgsCodeEditor::keyPressEvent( QKeyEvent *event )
{
  if ( event->key() == Qt::Key_Escape && !isListActive() )
  {
    // Shortcut QScintilla and redirect the event to the QWidget handler
    QWidget::keyPressEvent( event ); // clazy:exclude=skipped-base-method
  }
  else
  {
    QsciScintilla::keyPressEvent( event );
  }
}

void QgsCodeEditor::initializeLexer()
{

}

QColor QgsCodeEditor::lexerColor( QgsCodeEditor::ColorRole role ) const
{
  if ( mUseDefaultSettings )
    return color( role );

  if ( !mOverrideColors )
  {
    return defaultColor( role, mColorScheme );
  }
  else
  {
    const QColor color = mCustomColors.value( role );
    return !color.isValid() ? defaultColor( role ) : color;
  }
}

QFont QgsCodeEditor::lexerFont() const
{
  if ( mUseDefaultSettings )
    return getMonospaceFont();

  QFont font = QFontDatabase::systemFont( QFontDatabase::FixedFont );

  QgsSettings settings;
  if ( !mFontFamily.isEmpty() )
    font.setFamily( mFontFamily );

#ifdef Q_OS_MAC
  if ( mFontSize > 0 )
    font.setPointSize( mFontSize );
  else
  {
    // The font size gotten from getMonospaceFont() is too small on Mac
    font.setPointSize( QLabel().font().pointSize() );
  }
#else
  if ( mFontSize > 0 )
    font.setPointSize( mFontSize );
  else
  {
    int fontSize = settings.value( QStringLiteral( "qgis/stylesheet/fontPointSize" ), 10 ).toInt();
    font.setPointSize( fontSize );
  }
#endif
  font.setBold( false );

  return font;
}

void QgsCodeEditor::setSciWidget()
{
  QFont font = lexerFont();
  setFont( font );

  setUtf8( true );
  setCaretLineVisible( true );
  setCaretLineBackgroundColor( lexerColor( ColorRole::CaretLine ) );
  setCaretForegroundColor( lexerColor( ColorRole::Cursor ) );
  setSelectionForegroundColor( lexerColor( ColorRole::SelectionForeground ) );
  setSelectionBackgroundColor( lexerColor( ColorRole::SelectionBackground ) );

  setBraceMatching( QsciScintilla::SloppyBraceMatch );
  setMatchedBraceForegroundColor( lexerColor( ColorRole::MatchedBraceForeground ) );
  setMatchedBraceBackgroundColor( lexerColor( ColorRole::MatchedBraceBackground ) );
  // whether margin will be shown
  setMarginVisible( mMargin );
  setMarginsForegroundColor( lexerColor( ColorRole::MarginForeground ) );
  setMarginsBackgroundColor( lexerColor( ColorRole::MarginBackground ) );
  setIndentationGuidesForegroundColor( lexerColor( ColorRole::MarginForeground ) );
  setIndentationGuidesBackgroundColor( lexerColor( ColorRole::MarginBackground ) );
  // whether margin will be shown
  setFoldingVisible( mFolding );
  QColor foldColor = lexerColor( ColorRole::Fold );
  setFoldMarginColors( foldColor, foldColor );
  // indentation
  setAutoIndent( true );
  setIndentationWidth( 4 );
  setTabIndents( true );
  setBackspaceUnindents( true );
  setTabWidth( 4 );
  // autocomplete
  setAutoCompletionThreshold( 2 );
  setAutoCompletionSource( QsciScintilla::AcsAPIs );
}

void QgsCodeEditor::setTitle( const QString &title )
{
  setWindowTitle( title );
}

void QgsCodeEditor::setMarginVisible( bool margin )
{
  mMargin = margin;
  if ( margin )
  {
    QFont marginFont = lexerFont();
    marginFont.setPointSize( 10 );
    setMarginLineNumbers( 1, true );
    setMarginsFont( marginFont );
    setMarginWidth( 1, QStringLiteral( "00000" ) );
    setMarginsForegroundColor( lexerColor( ColorRole::MarginForeground ) );
    setMarginsBackgroundColor( lexerColor( ColorRole::MarginBackground ) );
  }
  else
  {
    setMarginWidth( 0, 0 );
    setMarginWidth( 1, 0 );
    setMarginWidth( 2, 0 );
  }
}

void QgsCodeEditor::setFoldingVisible( bool folding )
{
  mFolding = folding;
  if ( folding )
  {
    setFolding( QsciScintilla::PlainFoldStyle );
  }
  else
  {
    setFolding( QsciScintilla::NoFoldStyle );
  }
}

void QgsCodeEditor::insertText( const QString &text )
{
  // Insert the text or replace selected text
  if ( hasSelectedText() )
  {
    replaceSelectedText( text );
  }
  else
  {
    int line, index;
    getCursorPosition( &line, &index );
    insertAt( text, line, index );
    setCursorPosition( line, index + text.length() );
  }
}

QColor QgsCodeEditor::defaultColor( QgsCodeEditor::ColorRole role, const QString &theme )
{
  static QMap< QString, QMap< ColorRole, QColor > > sColors
  {
    {
      QString(),
      {
        {ColorRole::Default, QColor( "#4d4d4c" ) },
        {ColorRole::Keyword, QColor( "#8959a8" ) },
        {ColorRole::Class, QColor( "#4271ae" ) },
        {ColorRole::Method, QColor( "#4271ae" ) },
        {ColorRole::Decoration, QColor( "#3e999f" ) },
        {ColorRole::Number, QColor( "#c82829" ) },
        {ColorRole::Comment, QColor( "#8e908c" ) },
        {ColorRole::CommentLine, QColor( "#8e908c" ) },
        {ColorRole::CommentBlock, QColor( "#8e908c" ) },
        {ColorRole::Background, QColor( "#ffffff" ) },
        {ColorRole::Operator, QColor( "#8959a8" ) },
        {ColorRole::QuotedOperator, QColor( "#8959a8" ) },
        {ColorRole::Identifier, QColor( "#4271ae" ) },
        {ColorRole::QuotedIdentifier, QColor( "#4271ae" ) },
        {ColorRole::Tag, QColor( "#4271ae" ) },
        {ColorRole::UnknownTag, QColor( "#4271ae" ) },
        {ColorRole::Cursor, QColor( "#636363" ) },
        {ColorRole::CaretLine, QColor( "#efefef" ) },
        {ColorRole::SingleQuote, QColor( "#718c00" ) },
        {ColorRole::DoubleQuote, QColor( "#718c00" ) },
        {ColorRole::TripleSingleQuote, QColor( "#eab700" ) },
        {ColorRole::TripleDoubleQuote, QColor( "#eab700" ) },
        {ColorRole::MarginBackground, QColor( "#efefef" ) },
        {ColorRole::MarginForeground, QColor( "#636363" ) },
        {ColorRole::SelectionBackground, QColor( "#d7d7d7" ) },
        {ColorRole::SelectionForeground, QColor( "#303030" ) },
        {ColorRole::MatchedBraceBackground, QColor( "#b7f907" ) },
        {ColorRole::MatchedBraceForeground, QColor( "#303030" ) },
        {ColorRole::Edge, QColor( "#efefef" ) },
        {ColorRole::Fold, QColor( "#efefef" ) },
        {ColorRole::Error, QColor( "#e31a1c" ) },
      },
    },
    {
      QStringLiteral( "solarized" ),
      {
        {ColorRole::Default, QColor( "#586E75" ) },
        {ColorRole::Keyword, QColor( "#859900" ) },
        {ColorRole::Class, QColor( "#268BD2" ) },
        {ColorRole::Method, QColor( "#268BD2" ) },
        {ColorRole::Decoration, QColor( "#6C71C4" ) },
        {ColorRole::Number, QColor( "#2AA198" ) },
        {ColorRole::Comment, QColor( "#93A1A1" ) },
        {ColorRole::CommentLine, QColor( "#93A1A1" ) },
        {ColorRole::CommentBlock, QColor( "#3D8080" ) },
        {ColorRole::Background, QColor( "#FDF6E3" ) },
        {ColorRole::Cursor, QColor( "#DC322F" ) },
        {ColorRole::CaretLine, QColor( "#EEE8D5" ) },
        {ColorRole::Operator, QColor( "#586E75" ) },
        {ColorRole::QuotedOperator, QColor( "#586E75" ) },
        {ColorRole::Identifier, QColor( "#586E75" ) },
        {ColorRole::QuotedIdentifier, QColor( "#586E75" ) },
        {ColorRole::Tag, QColor( "#2AA198" ) },
        {ColorRole::UnknownTag, QColor( "#2AA198" ) },
        {ColorRole::SingleQuote, QColor( "#3D8080" ) },
        {ColorRole::DoubleQuote, QColor( "#3D8080" ) },
        {ColorRole::TripleSingleQuote, QColor( "#3D8080" ) },
        {ColorRole::TripleDoubleQuote, QColor( "#3D8080" ) },
        {ColorRole::MarginBackground, QColor( "#EEE8D5" ) },
        {ColorRole::MarginForeground, QColor( "#93A1A1" ) },
        {ColorRole::SelectionBackground, QColor( "#839496" ) },
        {ColorRole::SelectionForeground, QColor( "#FDF6E3" ) },
        {ColorRole::MatchedBraceBackground, QColor( "#CBCCA3" ) },
        {ColorRole::MatchedBraceForeground, QColor( "#586E75" ) },
        {ColorRole::Edge, QColor( "#EEE8D5" ) },
        {ColorRole::Fold, QColor( "#FDF6E3" ) },
        {ColorRole::Error, QColor( "#DC322F" ) },
      },
    },
    {
      QStringLiteral( "solarized_dark" ),
      {
        {ColorRole::Default, QColor( "#839496" ) },
        {ColorRole::Keyword, QColor( "#859900" ) },
        {ColorRole::Class, QColor( "#268BD2" ) },
        {ColorRole::Method, QColor( "#268BD2" ) },
        {ColorRole::Decoration, QColor( "#94558D" ) },
        {ColorRole::Number, QColor( "#2AA198" ) },
        {ColorRole::Comment, QColor( "#2AA198" ) },
        {ColorRole::CommentLine, QColor( "#2AA198" ) },
        {ColorRole::CommentBlock, QColor( "#2AA198" ) },
        {ColorRole::Background, QColor( "#002B36" ) },
        {ColorRole::Cursor, QColor( "#DC322F" ) },
        {ColorRole::CaretLine, QColor( "#073642" ) },
        {ColorRole::Operator, QColor( "#839496" ) },
        {ColorRole::QuotedOperator, QColor( "#839496" ) },
        {ColorRole::Identifier, QColor( "#839496" ) },
        {ColorRole::QuotedIdentifier, QColor( "#839496" ) },
        {ColorRole::Tag, QColor( "#268BD2" ) },
        {ColorRole::UnknownTag, QColor( "#268BD2" ) },
        {ColorRole::SingleQuote, QColor( "#3D8080" ) },
        {ColorRole::DoubleQuote, QColor( "#3D8080" ) },
        {ColorRole::TripleSingleQuote, QColor( "#3D8080" ) },
        {ColorRole::TripleDoubleQuote, QColor( "#3D8080" ) },
        {ColorRole::MarginBackground, QColor( "#073642" ) },
        {ColorRole::MarginForeground, QColor( "#586E75" ) },
        {ColorRole::SelectionBackground, QColor( "#073642" ) },
        {ColorRole::SelectionForeground, QColor( "#002B36" ) },
        {ColorRole::MatchedBraceBackground, QColor( "#1F4D2C" ) },
        {ColorRole::MatchedBraceForeground, QColor( "#839496" ) },
        {ColorRole::Edge, QColor( "#586E75" ) },
        {ColorRole::Fold, QColor( "#002B36" ) },
        {ColorRole::Error, QColor( "#DC322F" ) },
      }
    }
  };

  if ( theme.isEmpty() && QgsApplication::instance()->themeName() == QStringLiteral( "default" ) )
  {
    // if using default theme, take certain colors from the palette
    QPalette pal = qApp->palette();

    switch ( role )
    {
      case ColorRole::SelectionBackground:
        return pal.color( QPalette::Highlight );
      case ColorRole::SelectionForeground:
        return pal.color( QPalette::HighlightedText );
      default:
        break;
    }
  }
  else if ( theme.isEmpty() )
  {
    // non default theme (e.g. Blend of Gray). Take colors from theme ini file...
    const QSettings ini( QgsApplication::instance()->uiThemes().value( QgsApplication::instance()->themeName() ) + "/qscintilla.ini", QSettings::IniFormat );

    static QMap< ColorRole, QString > sColorRoleToIniKey
    {
      {ColorRole::Default, QStringLiteral( "python/defaultFontColor" ) },
      {ColorRole::Keyword, QStringLiteral( "python/keywordFontColor" ) },
      {ColorRole::Class, QStringLiteral( "python/classFontColor" ) },
      {ColorRole::Method, QStringLiteral( "python/methodFontColor" ) },
      {ColorRole::Decoration, QStringLiteral( "python/decoratorFontColor" ) },
      {ColorRole::Number, QStringLiteral( "python/numberFontColor" ) },
      {ColorRole::Comment, QStringLiteral( "python/commentFontColor" ) },
      {ColorRole::CommentLine, QStringLiteral( "sql/commentLineFontColor" ) },
      {ColorRole::CommentBlock, QStringLiteral( "python/commentBlockFontColor" ) },
      {ColorRole::Background, QStringLiteral( "python/paperBackgroundColor" ) },
      {ColorRole::Cursor, QStringLiteral( "cursorColor" ) },
      {ColorRole::CaretLine, QStringLiteral( "caretLineColor" ) },
      {ColorRole::Operator, QStringLiteral( "sql/operatorFontColor" ) },
      {ColorRole::QuotedOperator, QStringLiteral( "sql/QuotedOperatorFontColor" ) },
      {ColorRole::Identifier, QStringLiteral( "sql/identifierFontColor" ) },
      {ColorRole::QuotedIdentifier, QStringLiteral( "sql/QuotedIdentifierFontColor" ) },
      {ColorRole::Tag, QStringLiteral( "html/tagFontColor" ) },
      {ColorRole::UnknownTag, QStringLiteral( "html/unknownTagFontColor" ) },
      {ColorRole::SingleQuote, QStringLiteral( "sql/singleQuoteFontColor" ) },
      {ColorRole::DoubleQuote, QStringLiteral( "sql/doubleQuoteFontColor" ) },
      {ColorRole::TripleSingleQuote, QStringLiteral( "python/tripleSingleQuoteFontColor" ) },
      {ColorRole::TripleDoubleQuote, QStringLiteral( "python/tripleDoubleQuoteFontColor" ) },
      {ColorRole::MarginBackground, QStringLiteral( "marginBackgroundColor" ) },
      {ColorRole::MarginForeground, QStringLiteral( "marginForegroundColor" ) },
      {ColorRole::SelectionBackground, QStringLiteral( "selectionBackgroundColor" ) },
      {ColorRole::SelectionForeground, QStringLiteral( "selectionForegroundColor" ) },
      {ColorRole::MatchedBraceBackground, QStringLiteral( "matchedBraceBackground" ) },
      {ColorRole::MatchedBraceForeground, QStringLiteral( "matchedBraceColor" ) },
      {ColorRole::Edge, QStringLiteral( "edgeColor" ) },
      {ColorRole::Fold, QStringLiteral( "foldColor" ) },
      {ColorRole::Error, QStringLiteral( "stderrFontColor" ) },
    };

    return QgsSymbolLayerUtils::decodeColor( ini.value( sColorRoleToIniKey.value( role ), sColors.value( QString() ).value( role ).name() ).toString() );
  }

  return sColors.value( theme ).value( role );
}

QColor QgsCodeEditor::color( QgsCodeEditor::ColorRole role )
{
  const QgsSettings settings;
  if ( !settings.value( QStringLiteral( "codeEditor/overrideColors" ), false, QgsSettings::Gui ).toBool() )
  {
    const QString theme = settings.value( QStringLiteral( "codeEditor/colorScheme" ), QString(), QgsSettings::Gui ).toString();
    return defaultColor( role, theme );
  }
  else
  {
    const QString color = settings.value( QStringLiteral( "codeEditor/%1" ).arg( sColorRoleToSettingsKey.value( role ) ), QString(), QgsSettings::Gui ).toString();
    return color.isEmpty() ? defaultColor( role ) : QgsSymbolLayerUtils::decodeColor( color );
  }
}

void QgsCodeEditor::setColor( QgsCodeEditor::ColorRole role, const QColor &color )
{
  QgsSettings settings;
  if ( color.isValid() )
  {
    settings.setValue( QStringLiteral( "codeEditor/%1" ).arg( sColorRoleToSettingsKey.value( role ) ), color.name(), QgsSettings::Gui );
  }
  else
  {
    settings.remove( QStringLiteral( "codeEditor/%1" ).arg( sColorRoleToSettingsKey.value( role ) ), QgsSettings::Gui );
  }
}

// Settings for font and fontsize
bool QgsCodeEditor::isFixedPitch( const QFont &font )
{
  return font.fixedPitch();
}

QFont QgsCodeEditor::getMonospaceFont()
{
  QFont font = QFontDatabase::systemFont( QFontDatabase::FixedFont );

  QgsSettings settings;
  if ( !settings.value( QStringLiteral( "codeEditor/fontfamily" ), QString(), QgsSettings::Gui ).toString().isEmpty() )
    font.setFamily( settings.value( QStringLiteral( "codeEditor/fontfamily" ), QString(), QgsSettings::Gui ).toString() );

  const int fontSize = settings.value( QStringLiteral( "codeEditor/fontsize" ), 0, QgsSettings::Gui ).toInt();

#ifdef Q_OS_MAC
  if ( fontSize > 0 )
    font.setPointSize( fontSize );
  else
  {
    // The font size gotten from getMonospaceFont() is too small on Mac
    font.setPointSize( QLabel().font().pointSize() );
  }
#else
  if ( fontSize > 0 )
    font.setPointSize( fontSize );
  else
  {
    int fontSize = settings.value( QStringLiteral( "qgis/stylesheet/fontPointSize" ), 10 ).toInt();
    font.setPointSize( fontSize );
  }
#endif
  font.setBold( false );

  return font;
}

void QgsCodeEditor::setCustomAppearance( const QString &scheme, const QMap<QgsCodeEditor::ColorRole, QColor> &customColors, const QString &fontFamily, int fontSize )
{
  mUseDefaultSettings = false;
  mOverrideColors = !customColors.isEmpty();
  mColorScheme = scheme;
  mCustomColors = customColors;
  mFontFamily = fontFamily;
  mFontSize = fontSize;

  setSciWidget();
  initializeLexer();
}