File indexing completed on 2024-05-12 04:37:47

 /*
     SPDX-FileCopyrightText: 2008 Hamish Rodda <rodda@kde.org>
     SPDX-FileCopyrightText: 2009 Ramon Zarazua <killerfox512 gmail.com>
 
     SPDX-License-Identifier: LGPL-2.0-only
 */
 
 #include "codegenerator.h"
 
 #include "documentchangeset.h"
 #include "duchainchangeset.h"
 
 #include <KLocalizedString>
 
 #include <interfaces/icore.h>
 #include <interfaces/idocumentcontroller.h>
 
 #include <language/duchain/duchainlock.h>
 
 #include "applychangeswidget.h"
 #include <debug.h>
 
 namespace KDevelop {
 class CodeGeneratorBasePrivate
 {
 public:
 
     CodeGeneratorBasePrivate() : autoGen(false)
         , context(0) {}
 
     QMap<IndexedString, DUChainChangeSet*> duchainChanges;
     DocumentChangeSet documentChanges;
 
     bool autoGen;
     DUContext* context;
     DocumentRange range;
     QString error;
 };
 
 CodeGeneratorBase::CodeGeneratorBase()
     : d_ptr(new CodeGeneratorBasePrivate)
 {
 }
 
 CodeGeneratorBase::~CodeGeneratorBase()
 {
     clearChangeSets();
 }
 
 void CodeGeneratorBase::autoGenerate(DUContext* context, const KDevelop::DocumentRange* range)
 {
     Q_D(CodeGeneratorBase);
 
     d->autoGen = true;
     d->context = context;
     d->range = *range;
 }
 
 void CodeGeneratorBase::addChangeSet(DUChainChangeSet* duchainChange)
 {
     Q_D(CodeGeneratorBase);
 
     IndexedString file = duchainChange->topDuContext().data()->url();
 
     QMap<IndexedString, DUChainChangeSet*>::iterator it = d->duchainChanges.find(file);
 
     //if we already have an entry for this file, merge it
     if (it != d->duchainChanges.end()) {
         **it << *duchainChange;
         delete duchainChange;
     } else
         d->duchainChanges.insert(file, duchainChange);
 }
 
 void CodeGeneratorBase::addChangeSet(DocumentChangeSet& docChangeSet)
 {
     Q_D(CodeGeneratorBase);
 
     d->documentChanges << docChangeSet;
 }
 
 DocumentChangeSet& CodeGeneratorBase::documentChangeSet()
 {
     Q_D(CodeGeneratorBase);
 
     return d->documentChanges;
 }
 
 const QString& CodeGeneratorBase::errorText() const
 {
     Q_D(const CodeGeneratorBase);
 
     return d->error;
 }
 
 bool CodeGeneratorBase::autoGeneration() const
 {
     Q_D(const CodeGeneratorBase);
 
     return d->autoGen;
 }
 
 void CodeGeneratorBase::setErrorText(const QString& errorText)
 {
     Q_D(CodeGeneratorBase);
 
     d->error = errorText;
 }
 
 void CodeGeneratorBase::clearChangeSets()
 {
     Q_D(CodeGeneratorBase);
 
     qCDebug(LANGUAGE) << "Cleaning up all the changesets registered by the generator";
     qDeleteAll(d->duchainChanges);
 
     d->duchainChanges.clear();
 
     d->documentChanges = DocumentChangeSet();
 }
 
 bool CodeGeneratorBase::execute()
 {
     Q_D(CodeGeneratorBase);
 
     qCDebug(LANGUAGE) << "Checking Preconditions for the codegenerator";
 
     //Shouldn't there be a method in iDocument to get a DocumentRange as well?
 
     QUrl document;
     if (!d->autoGen) {
         if (!ICore::self()->documentController()->activeDocument()) {
             setErrorText(i18n("Could not find an open document"));
             return false;
         }
 
         document = ICore::self()->documentController()->activeDocument()->url();
 
         if (d->range.isEmpty()) {
             DUChainReadLocker lock(DUChain::lock());
             d->range = DocumentRange(document.url(),
                                      ICore::self()->documentController()->activeDocument()->textSelection());
         }
     }
 
     if (!d->context) {
         DUChainReadLocker lock(DUChain::lock());
         TopDUContext* documentChain = DUChain::self()->chainForDocument(document);
         if (!documentChain) {
             setErrorText(i18n("Could not find the chain for the selected document: %1", document.url()));
             return false;
         }
         d->context = documentChain->findContextIncluding(d->range);
 
         if (!d->context) {
             //Attempt to get the context again
             const QList<TopDUContext*> contexts = DUChain::self()->chainsForDocument(document);
             for (TopDUContext* top : contexts) {
                 qCDebug(LANGUAGE) << "Checking top context with range: " << top->range() << " for a context";
                 if ((d->context = top->findContextIncluding(d->range)))
                     break;
             }
         }
     }
 
     if (!d->context) {
         setErrorText(i18n("Error finding context for selection range"));
         return false;
     }
 
     if (!checkPreconditions(d->context, d->range)) {
         setErrorText(i18n("Error checking conditions to generate code: %1", errorText()));
         return false;
     }
 
     if (!d->autoGen) {
         qCDebug(LANGUAGE) << "Gathering user information for the codegenerator";
         if (!gatherInformation()) {
             setErrorText(i18n("Error Gathering user information: %1", errorText()));
             return false;
         }
     }
 
     qCDebug(LANGUAGE) << "Generating code";
     if (!process()) {
         setErrorText(i18n("Error generating code: %1", errorText()));
         return false;
     }
 
     if (!d->autoGen) {
         qCDebug(LANGUAGE) << "Submitting to the user for review";
         return displayChanges();
     }
 
     //If it is autogenerated, it shouldn't need to apply changes, instead return them to client that my be another generator
     DocumentChangeSet::ChangeResult result(true);
     if (!d->autoGen && !(result = d->documentChanges.applyAllChanges())) {
         setErrorText(result.m_failureReason);
         return false;
     }
 
     return true;
 }
 
 bool CodeGeneratorBase::displayChanges()
 {
     Q_D(CodeGeneratorBase);
 
     DocumentChangeSet::ChangeResult result = d->documentChanges.applyAllToTemp();
     if (!result) {
         setErrorText(result.m_failureReason);
         return false;
     }
 
     ApplyChangesWidget widget;
     //TODO: Find some good information to put
     widget.setInformation("Info?");
 
     QMap<IndexedString, IndexedString> temps = d->documentChanges.tempNamesForAll();
     for (QMap<IndexedString, IndexedString>::iterator it = temps.begin();
          it != temps.end(); ++it)
         widget.addDocuments(it.key(), it.value());
 
     if (widget.exec())
         return widget.applyAllChanges();
     else
         return false;
 }
 }