qgscodeeditorpython.h

Go to the documentation of this file.

/***************************************************************************
    qgscodeeditorpython.h - A Python editor based on QScintilla
     --------------------------------------
    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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSCODEEDITORPYTHON_H
#define QGSCODEEDITORPYTHON_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgscodeeditor.h"
 
#include <QString>
#include <Qsci/qscilexerpython.h>
 
using namespace Qt::StringLiterals;
 
class QgsSettingsEntryInteger;
class QgsSettingsEntryBool;
template<class T> class QgsSettingsEntryEnumFlag;
 
SIP_IF_MODULE( HAVE_QSCI_SIP )
 
#ifndef SIP_RUN
class QgsQsciLexerPython : public QsciLexerPython
{
    Q_OBJECT
  public:
    QgsQsciLexerPython( QObject *parent = nullptr );
 
    const char *keywords( int set ) const override;
};
#endif

class GUI_EXPORT QgsCodeEditorPython : public QgsCodeEditor
{
    Q_OBJECT
 
  public:
#ifndef SIP_RUN
    static inline QgsSettingsTreeNode *sTreePythonCodeEditor = QgsCodeEditor::sTreeCodeEditor->createChildNode( u"python"_s );
    static const QgsSettingsEntryString *settingCodeFormatter;
    static const QgsSettingsEntryInteger *settingMaxLineLength;
    static const QgsSettingsEntryBool *settingSortImports;
    static const QgsSettingsEntryInteger *settingAutopep8Level;
    static const QgsSettingsEntryBool *settingBlackNormalizeQuotes;
    static const QgsSettingsEntryString *settingExternalPythonEditorCommand;
    static const QgsSettingsEntryEnumFlag<Qgis::DocumentationBrowser> *settingContextHelpBrowser;
#endif

    QgsCodeEditorPython( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QList<QString> &filenames = QList<QString>(), QgsCodeEditor::Mode mode = QgsCodeEditor::Mode::ScriptEditor, QgsCodeEditor::Flags flags = QgsCodeEditor::Flag::CodeFolding );
 
    Qgis::ScriptLanguage language() const override;
    Qgis::ScriptLanguageCapabilities languageCapabilities() const override;

    void loadAPIs( const QList<QString> &filenames );

    bool loadScript( const QString &script );

    bool isCursorInsideStringLiteralOrComment() const;

    QString characterBeforeCursor() const;

    QString characterAfterCursor() const;

    void updateCapabilities();
 
    bool checkSyntax() override;
 
  public slots:

    void searchSelectedTextInPyQGISDocs();

    virtual void showApiDocumentation( const QString &item );

    void toggleComment() override;
 
  protected:
    void initializeLexer() override;
    void keyPressEvent( QKeyEvent *event ) override;
    QString reformatCodeString( const QString &string ) override;
    void populateContextMenu( QMenu *menu ) override;
 
  protected slots:

    void autoComplete();
 
  private:
    QList<QString> mAPISFilesList;
    QString mPapFile;
 
    Qgis::ScriptLanguageCapabilities mCapabilities;
 
    static const QMap<QString, QString> sCompletionPairs;
 
    // Only used for selected text
    static const QStringList sCompletionSingleCharacters;
};
 
#endif