QtCreator TODO प्लगइन। विस्तार

कुछ समय पहले मैंने एक प्लगइन के बारे में लिखा था जिसे मैंने विकसित किया था जो वर्तमान खुले दस्तावेज़ में सभी TODO, FIXME, आदि टिप्पणियों की एक सूची प्रदर्शित करता है। कल मैंने इस प्लगइन का एक नया संस्करण जारी किया, जो काफी बदलावों के साथ निकला, यहाँ प्रमुख हैं:

• सेटिंग्स दिखाई दीं
• अब आप अपने खोज कीवर्ड जोड़ सकते हैं और उनके आउटपुट के लिए रंग और आइकन सेट कर सकते हैं।
• आप यह चुन सकते हैं कि जानकारी कहाँ प्रदर्शित की जाए: मानक में "समस्याएँ बनाएँ" विंडो या एक अलग "TODO आउटपुट" में।
• आप चुन सकते हैं: अभी भी केवल वर्तमान खुली फ़ाइल के बारे में जानकारी प्रदर्शित करें या संपूर्ण वर्तमान परियोजना से जानकारी एकत्र करें।
• अंग्रेजी के अलावा अन्य भाषाओं में टिप्पणियाँ अब सही ढंग से प्रदर्शित की जाती हैं।

विकास के दौरान, मैं कुछ दिलचस्प चीजों को खोदने में कामयाब रहा, जो अन्य प्लगइन डेवलपर्स के लिए उपयोगी हो सकती हैं, जिन्हें मैं बिल्ली के तहत साझा करूंगा।

सेटिंग्स

पहली चीज़ जो मुझे करने की ज़रूरत थी वह यह थी कि QtCreator सेटिंग्स में अपना खुद का टैब कैसे बनाया जाए, यह बहुत आसान लग रहा था, मुझे बस इतना करना था कि कोर से विरासत में मिला एक नया वर्ग जोड़ा गया : IOptionsPage इंटरफ़ेस , इसकी घोषणा इस तरह दिखती है:

class SettingsPage : public Core::IOptionsPage { Q_OBJECT public: SettingsPage(KeywordsList keywords = KeywordsList(), int projectOptions = 0, int paneOptions = 0, QObject *parent = 0); ~SettingsPage(); QString id() const; //    QString trName() const; //    (   ) QString category() const; //        QString trCategory() const; //    (   ) QString displayName() const; //    QIcon categoryIcon() const; //   QString displayCategory() const; //    QWidget *createPage(QWidget *parent); //      void apply(); //       "Apply"  "OK" void finish(); //        - "OK"  "Cancel" public slots: void settingsChanged(); private: SettingsDialog *dialog; //   bool settingsStatus; //  ? int projectOptions; //   int paneOptions; //   KeywordsList keywords; //    }; 

टैब विजेट जो मैंने डिज़ाइनर में बनाया है, मानक QlistWidget, कई QRadioButton और बटनों के एक समूह (छवि देखें) के साथ कुछ भी जटिल नहीं है।
यहां कुंजी लागू () विधि है, यह उस में है कि सेटिंग्स सहेजे गए हैं।

यह इस तरह दिखता है:

 void SettingsPage::apply() { if (settingsStatus) { QSettings *settings = Core::ICore::instance()->settings(); //      settings->beginGroup("TODOPlugin"); //    projectOptions = dialog->currentFileRadioButtonEnabled() ? 0 : 1; //     paneOptions = dialog->todoOutputRadioButtonEnabled() ? 0 : 1; keywords = dialog->keywordsList(); settings->setValue("project_options", projectOptions); //   settings->setValue("pane_options", paneOptions); settings->setValue("keywords", qVariantFromValue(keywords)); settings->endGroup(); settings->sync(); //   (   ) QMessageBox::information(dialog, tr("Information"), tr("The TODO plugin settings change will take effect after a restart of Qt Creator.")); //           settingsStatus = false; } } 

सामान्य तौर पर, कुछ भी जटिल नहीं है, मुझे केवल यह याद होगा कि QVariant को अपने स्वयं के डेटा प्रकारों को स्थानांतरित करने में सक्षम होने के लिए, आपको उनके लिए ऑपरेटरों को परिभाषित करने की आवश्यकता है: << और >>, और उन्हें MOC में पंजीकृत भी करें।

विंडो बनाएँ

कड़ाई से बोलने पर, इसे टास्कविंडो कहा जाता है और किसी भी संदेश के लिए मानक आउटपुट के रूप में काम कर सकता है। मैंने Qt Developer Network समुदाय के लोगों की मजबूत सलाह पर इस विंडो में संदेश प्रदर्शित करने की क्षमता को जोड़ने का फैसला किया, जिसके बारे में मैंने पहले भी लिखा था। आप इस विंडो को इस प्रकार एक्सेस कर सकते हैं, आपको निम्नलिखित हेडर को प्रोजेक्ट से कनेक्ट करना होगा:

 #include <projectexplorer/taskwindow.h> 

और खिड़की से एक संकेतक प्राप्त करें:

 taskWindow = pluginManager->getObject<ProjectExplorer::TaskWindow>(); 

वह सब है। अब आप उसके साथ काम कर सकते हैं, इस तरीके के लिए हैं:

 void addCategory(const QString &categoryId, const QString &displayName); void addTask(const Task &task); void removeTask(const Task &task); void clearTasks(const QString &categoryId = QString()); 

हमारी पोस्ट की पहचान करने के लिए श्रेणियों की आवश्यकता होती है।
कार्य की संरचना सरल है और इस तरह दिखता है:

 struct PROJECTEXPLORER_EXPORT Task { enum TaskType { Unknown, Error, Warning }; Task() : type(Unknown), line(-1) { } Task(TaskType type_, const QString &description_, const QString &file_, int line_, const QString &category_) : type(type_), description(description_), file(file_), line(line_), category(category_) { } Task(const Task &source) : type(source.type), description(source.description), file(source.file), line(source.line), category(source.category), formats(source.formats) { } ~Task() { } TaskType type; QString description; QString file; int line; QString category; QList<QTextLayout::FormatRange> formats; }; 

महत्वपूर्ण: कल्पना में आपको ProjectExplorer पर प्लगइन की निर्भरता को इंगित करने की आवश्यकता है

progressbar

प्रगति पट्टी को लागू करने के लिए, यह थोड़ा जादू और तंत्रिकाओं को ले गया। स्कैन के लिए परियोजना लोडिंग के बाकी हिस्सों को धीमा नहीं करने के लिए, मैंने इसे एक अलग स्ट्रीम में रखा:

  QFuture<void> result = QtConcurrent::run(&TodoPlugin::readCurrentProject, this); 

जैसा कि यह निकला, यह प्यारी ग्रे-ग्रीन प्रगति विशेष रूप से एक अलग धारा के साथ काम करने के लिए सिलवाया गया था।

इसके साथ काम करने के लिए, आपको निम्नलिखित शीर्षलेख जोड़ने होंगे:

 #include <coreplugin/progressmanager/progressmanager.h> #include <qtconcurrent/runextensions.h> 

एक नई प्रगति पट्टी जोड़ना इस तरह होता है:

  Core::ICore::instance()->progressManager()->addTask(result, tr("Todoscan"), "Todo.Plugin.Scanning"); 

इसके साथ काम पहले से ही स्कैन स्ट्रीम से किया जाता है, यह विधि इस प्रकार है:

 void TodoPlugin::readCurrentProject(QFutureInterface<void> &future, TodoPlugin *instance) { QStringList filesList = instance->currentProject->files(ProjectExplorer::Project::ExcludeGeneratedFiles); //    future.setProgressRange(0, filesList.count()-1); //    for (int i = 0; i < filesList.count(); ++i) { instance->readFile(filesList.at(i)); //    future.setProgressValue(i); //    } // SKIPPED } 

आप क्या जादू पूछते हैं? कृपया ध्यान दें, फ़ंक्शन हेडर और इसके कॉल पर, हेडर में दो पैरामीटर घोषित किए जाते हैं, और कॉल में केवल दूसरा पास किया जाता है, पहला छोड़ा गया है। पहले पैरामीटर को दूसरे आवश्यक हेडर (qtconcurrent / runextensions.h) से कोड के साथ प्रतिस्थापित किया जाता है। वह सब जादू है।

निष्कर्ष

अभी के लिए बस इतना ही, आप अभी भी यहाँ से प्लगइन डाउनलोड कर सकते हैं , यह बीएसडी लाइसेंस के तहत वितरित किया जाता है - स्वास्थ्य के साथ प्रयोग। मैं इसे जोड़ूंगा, विंडोज के तहत इसका परीक्षण नहीं किया गया था, एक की कमी के कारण, मैं परीक्षण और बग रिपोर्ट के लिए आभारी रहूंगा।