completionobject.h

Go to the documentation of this file.

/*
    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.

    ---
    Copyright (C) 2009 Alexander Rieder <alexanderrieder@gmail.com>
 */

#ifndef _COMPLETIONOBJECT_H
#define _COMPLETIONOBJECT_H

#include <kcompletion.h>

#include "cantor_export.h"

namespace Cantor
{
class CompletionObjectPrivate;
class Session;

class CANTOR_EXPORT CompletionObject : public KCompletion
{
  Q_OBJECT
  public:
    CompletionObject(Session* parent);
    ~CompletionObject();

    enum LineCompletionMode {
    PreliminaryCompletion, 
    FinalCompletion        
    };

    QStringList completions() const;
    QString completion() const;
    QString command() const;
    Session* session() const;

    void setLine(const QString& line, int index);
    void updateLine(const QString& line, int index);
    void completeLine(const QString& comp, LineCompletionMode mode);

  protected:

    enum IdentifierType {
    VariableType,   
    FunctionWithArguments,   
    FunctionType = FunctionWithArguments, 
    FunctionWithoutArguments, 
    KeywordType,  
    UnknownType   
    };
    QString identifier() const;

    void setCompletions(const QStringList& completions);
    void setCommand(const QString& cmd);
    virtual int locateIdentifier(const QString& cmd, int index) const;
    virtual bool mayIdentifierContain(QChar c) const;
    virtual bool mayIdentifierBeginWith(QChar c) const;
    void completeFunctionLine(IdentifierType type = FunctionWithArguments);
    void completeKeywordLine();
    void completeVariableLine();
    void completeUnknownLine();
  protected Q_SLOTS:
    virtual void fetchCompletions() = 0;
    virtual void fetchIdentifierType();
    void findCompletion();
    void completeLineWithType(IdentifierType type);
    void handleParenCompletionWithType(IdentifierType type);
  Q_SIGNALS:
    void fetchingDone();
    void fetchingTypeDone(IdentifierType type);
    void done();
    void lineDone(QString line, int index);
  private:
    CompletionObjectPrivate* d;
};

}

#endif /* _COMPLETIONOBJECT_H */