documentchangeset.h

Go to the documentation of this file.

/*
   Copyright 2008 David Nolden <david.nolden.kdevelop@art-master.de>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library 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 License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
 */

#ifndef KDEVPLATFORM_DOCUMENTCHANGESET_H
#define KDEVPLATFORM_DOCUMENTCHANGESET_H

#include <language/languageexport.h>

#include <serialization/indexedstring.h>

#include <KTextEditor/Range>

#include <QExplicitlySharedDataPointer>
#include <QUrl>

namespace KDevelop {
class DocumentChangeSetPrivate;

class KDEVPLATFORMLANGUAGE_EXPORT DocumentChange
    : public QSharedData
{
public:

    DocumentChange(const IndexedString& document, const KTextEditor::Range& range, const QString& oldText,
                   const QString& newText) :
        m_document(document)
        , m_range(range)
        , m_oldText(oldText)
        , m_newText(newText)
        , m_ignoreOldText(false)
    {
        //Clean the URL, so we don't get the same file be stored as a different one
        QUrl url = m_document.toUrl();
        m_document = IndexedString(url.adjusted(QUrl::NormalizePathSegments));
    }

    IndexedString m_document;
    KTextEditor::Range m_range;
    QString m_oldText;
    QString m_newText;
    bool m_ignoreOldText; //Set this to disable the verification of m_oldText. This can be used to overwrite arbitrary text, but is dangerous!
};

using DocumentChangePointer = QExplicitlySharedDataPointer<DocumentChange>;

class KDEVPLATFORMLANGUAGE_EXPORT DocumentChangeSet
{
public:
    DocumentChangeSet();
    ~DocumentChangeSet();
    DocumentChangeSet(const DocumentChangeSet& rhs);
    DocumentChangeSet& operator=(const DocumentChangeSet& rhs);

    //Returns true on success
    class ChangeResult
    {
public:
        explicit ChangeResult(const QString& failureReason,
                              const DocumentChangePointer& reasonChange = DocumentChangePointer())
            : ChangeResult(failureReason, reasonChange, false) {}

        static ChangeResult successfulResult()
        {
            return ChangeResult({}, {}, true);
        }

        operator bool() const
        {
            return m_success;
        }

        QString m_failureReason;
        DocumentChangePointer m_reasonChange;

        bool m_success;

private:
        explicit ChangeResult(const QString& failureReason, const DocumentChangePointer& reasonChange, bool success)
            : m_failureReason(failureReason)
            , m_reasonChange(reasonChange)
            , m_success(success)
        {}
    };

    ChangeResult addChange(const DocumentChange& change);
    ChangeResult addChange(const DocumentChangePointer& change);

    ChangeResult addDocumentRenameChange(const IndexedString& oldFile, const IndexedString& newname);

    enum ReplacementPolicy {
        IgnoreFailedChange,
        WarnOnFailedChange,
        StopOnFailedChange 
    };

    void setReplacementPolicy(ReplacementPolicy policy);

    enum FormatPolicy {
        NoAutoFormat, 
        AutoFormatChanges,      
        AutoFormatChangesKeepIndentation      
    };

    void setFormatPolicy(FormatPolicy policy);

    enum DUChainUpdateHandling {
        NoUpdate,       
        SimpleUpdate 
        //FullUpdate       ///All documents in all open projects that recursively import any of the changed documents will be updated
    };

    void setUpdateHandling(DUChainUpdateHandling policy);

    enum ActivationPolicy {
        Activate,           
        DoNotActivate  
    };

    void setActivationPolicy(ActivationPolicy policy);

    ChangeResult applyAllChanges();

private:
    const QScopedPointer<class DocumentChangeSetPrivate> d_ptr;
    Q_DECLARE_PRIVATE(DocumentChangeSet)
};
}

#endif