pyDocstringGenerator.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2020, Institut für Technische Optik (ITO),
    Universität Stuttgart, Germany
 
    This file is part of itom.
 
    itom is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public Licence as published by
    the Free Software Foundation; either version 2 of the Licence, or (at
    your option) any later version.
 
    itom 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 Library
    General Public Licence for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.
 
    Further hints:
    ------------------------
 
    This file belongs to the code editor of itom. The code editor is
    in major parts a fork / rewritten version of the python-based source
    code editor PyQode from Colin Duquesnoy and others
    (see https://github.com/pyQode). PyQode itself is licensed under
    the MIT License (MIT).
 
    Some parts of the code editor of itom are also inspired by the
    source code editor of the Spyder IDE (https://github.com/spyder-ide),
    also licensed under the MIT License and developed by the Spyder Project
    Contributors.
 
*********************************************************************** */
 
#ifndef PYDOCSTRINGGENERATOR_H
#define PYDOCSTRINGGENERATOR_H
 
#include "../utils/utils.h"
#include "../mode.h"
#include "../../models/outlineItem.h"
#include <qevent.h>
#include <qobject.h>
#include <qtextcursor.h>
#include <qstring.h>
#include <qlist.h>
#include <qsharedpointer.h>
#include <qmenu.h>
#include <qaction.h>
 
namespace ito {
 
/*
Contains a generator for a template of a docstring of the current method or class.
*/
 
class PyDocstringGeneratorMode : public QObject, public Mode
{
    Q_OBJECT
public:
    enum Style
    {
        GoogleStyle = 0,
        NumpyStyle = 1
    };
 
    PyDocstringGeneratorMode(const QString &name, const QString &description = "", QObject *parent = nullptr);
    virtual ~PyDocstringGeneratorMode();
 
    virtual void onStateChanged(bool state);
 
    void insertDocstring(const QTextCursor &cursor, const QString &quotes = "\"\"\"", bool insertOpeningQuotes = true, int overwriteEndLineIdx = -1) const;
    QSharedPointer<OutlineItem> getOutlineOfLineIdx(int lineIdx) const;
 
    Style docstringStyle() const { return m_docstringStyle; }
    void setDocstringStyle(const Style &style) { m_docstringStyle = style; }
 
protected:
 
    struct ArgInfo
    {
        ArgInfo(
            const QString& name = "",
            const QString& type = "",
            const QString& defaultValue = "", bool isOptional = false) :
            m_name(name),
            m_type(type),
            m_defaultValue(defaultValue),
            m_isOptional(isOptional)
        {
 
        }
 
        QString m_name;
        QString m_type;
        QString m_defaultValue;
        bool m_isOptional;
    };
 
    struct FunctionInfo
    {
        FunctionInfo() :
            m_hasYield(false)
        {
 
        }
 
        QList<ArgInfo> m_args;
        QList<QString> m_returnTypes;
        bool m_hasYield;
        QList<QString> m_raises;
    };
 
    int lastLineIdxOfDefinition(const QSharedPointer<OutlineItem> &item) const;
    FunctionInfo parseFunctionInfo(const QSharedPointer<OutlineItem> &item, int lastLineIdxOfDefinition) const;
    void parseArgList(const QSharedPointer<OutlineItem> &item, FunctionInfo &info) const;
    QString generateGoogleDoc(const QSharedPointer<OutlineItem> &item, const FunctionInfo &info, int &cursorPos) const;
    QString generateNumpyDoc(const QSharedPointer<OutlineItem> &item, const FunctionInfo &info, int &cursorPos) const;
 
    QSharedPointer<QMenu> m_popupMenu;
    Style m_docstringStyle;
    int m_overwriteEndLineIndex;
 
private slots:
    void onKeyPressed(QKeyEvent *e);
    void mnuInsertDocstring();
};
 
} //end namespace ito
 
#endif