📐 🤫 👩🏿‍🔬 टीडीओ प्लगइन QtCreator के लिए 🏖️ 😏 👗

इसलिए, एक लंबे समय के लिए, आदरणीय यूजीन ने हमें QtCreator हैक्स के बारे में लिखा , और अपने ब्लॉग में प्लगइन बनाने के लिए विस्तृत निर्देशों के साथ एक दस्तावेज भी दिखाया । और इस सप्ताह के अंत में, एक देश के घर में सभ्यता और इंटरनेट से फाड़ा जा रहा है, मैंने अपना खुद का प्लगइन लिखने की कोशिश करने का फैसला किया। प्लगइन काफी सरल है, यह वर्तमान खुले दस्तावेज़ में सभी TODO, FIXME, आदि टिप्पणियों की एक सूची प्रदर्शित करता है। नीचे मैं बात करूंगा कि यह प्लगइन कैसे लिखा जाता है, और आम तौर पर QtCreator के लिए प्लगइन्स लिखने के बारे में।

TODO Plugin

शुरुआत

प्लगइन बनाने के लिए आपको सबसे पहले जो चीज चाहिए, वह है क्यूटीक्रेटर का सोर्स कोड डाउनलोड करना, आप यहां कर सकते हैं। अब, आपको परिणामी संग्रह को अनज़िप करना होगा और / src / plugins / folder में एक नया खाली प्रोजेक्ट बनाना होगा।

एक प्लगइन बनाएं जो कुछ भी नहीं करता है

ऐसा करने के लिए, आपको प्रोजेक्ट में एक नया वर्ग जोड़ने की आवश्यकता है, जो प्लगइन का मुख्य वर्ग होगा; इसे एक्सटेंशनसिस्टम :: IPlugin इंटरफ़ेस से विरासत में प्राप्त होना चाहिए।

ऐसा करने के लिए, .pro फ़ाइल में निम्न पंक्तियाँ जोड़ें:

शामिल करें (../../ qtcreatorplugin.pri)

शामिल हैं (../../ plugins / coreplugin / coreplugin.pri)

Coreplugin की आवश्यकता है क्योंकि सभी उपयोगकर्ता प्लगइन्स इस पर निर्भर हैं, यह अन्य प्लगइन्स बनाने के लिए बुनियादी इंटरफेस प्रदान करता है।

आपको निम्न प्रारूप में xml फ़ाइल <प्लगइन नाम> .pluginspec बनाने की आवश्यकता होगी

<प्लगइन का नाम = "todo" संस्करण = "0.0.1" कंपेटवर्सन = "2.0.0">

<विक्रेता> vsorokin </ विक्रेता>

<कॉपीराइट> आपका कॉपीराइट </ कॉपीराइट>

<लाइसेंस> आपका लाइसेंस </ लाइसेंस>

<विवरण> प्लगइन विवरण </ वर्णन>

<url> प्रोजेक्ट मुखपृष्ठ </ url>

<DependencyList>

<निर्भरता नाम = "कोर" संस्करण = "2.0.0" />

</ DependencyList>

</ प्लगइन>

उनके नाम से खेतों का अर्थ स्पष्ट होता है।

तो, कुछ नहीं कर रहे प्लगइन के वर्ग में निम्नलिखित संरचना होनी चाहिए:

#include <extensionystem / iplugin.h>

वर्ग टोडोप्लुजिन: सार्वजनिक विस्तार प्रणाली :: आईपीलुगिन

{

Q_OBJECT

जनता :

टोडोप्लुजिन ();

~ टोडोप्लुजिन ();

शून्य एक्सटेंशन

बूल इनिशियलाइज़ ( const QStringList & आर्ग्युमेंट्स, QString * errorString);

शून्य बंद ();

};

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

इसके लिए सेंट्रल इनिशियलाइज़ तरीका है, जो प्लगइन को इनिशियलाइज़ करता है। हालांकि, एक प्लगइन में जो कुछ भी नहीं करता है, सभी विधियां खाली हैं।

एक नया आउटपुट पेन बनाएं

मेरे प्लगइन के लिए, एक नया आउटपुट क्षेत्र आवश्यक था, मौजूदा वाले के बगल में, यह बहुत सरलता से किया जाता है, बस कोर से विरासत में मिला एक नया वर्ग बनाएं : IOutputPane इंटरफ़ेस , यहां इस वर्ग का शीर्षक है:

#include <coreplugin / ioutputpane.h>

# अलग करें <QObject>

#include <QListWidget>

वर्ग टूडूओटप्यूटेन: पब्लिक कोर :: IOutputPane

{

जनता :

टोडोउपुतपाने (QObject * जनक);

~ टोडोओपुतपाने ();

QWidget * outputWidget (QWidget * जनक); // क्लास का मुख्य विजेट लौटाता है, यहाँ यह QListWidget है

QList <QWidget *> toolBarWidgets () कास्ट; // टूलबार विजेट की सूची लौटाता है, वे इस प्लगइन में नहीं हैं

QString नाम () कास्ट ; // बस पैनल का शाब्दिक नाम

int प्राथमिकताइन्स्टैटबसर () कास्ट ; // एक से एक सौ तक की संख्या लौटाता है, जितनी बड़ी संख्या, उतनी ही उच्च स्थिति हमारी फलक

शून्य समाशोधन (); // मुख्य विजेट की सफाई करता है

शून्य दृश्यता परिवर्तित ( बूल दिखाई);

शून्य सेटफोकस ();

बूल हैफोकस ();

बूल कैनफोकस ();

बूल कैनवेट ();

बूल कैनेक्स्ट ();

बूल

शून्य goToNext ();

शून्य goToPrev ();

शून्य addItem (QString पाठ, QString फ़ाइल, int rowNumber); // विधि जो सूची में एक नई प्रविष्टि सम्मिलित करती है

QListWidget * getTodoList () कास्ट; // एक सूची को इंगित करता है

निजी :

QListWidget * टूडलिस्ट;

};

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

अब हमें किसी तरह से सिस्टम में अपने नए बनाए गए टूडूपन को पंजीकृत करने की आवश्यकता है, इसके लिए हम प्रारंभिक विधि में निम्नलिखित कोड लिखते हैं:

outPane = new TodoOutputPane ( यह );

addAutoReleasedObject (outPane);

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

सब कुछ बहुत सरल है, अब हमारा आउटपेन बाकी के बीच दिखाई देगा, लेकिन अभी तक यह कुछ भी नहीं कर सकता है।

हमें खुली फ़ाइल के बारे में जानकारी मिलती है और उसे पार्स किया जाता है

यह जानने के लिए कि संपादक में अब कौन सी फ़ाइल खुली है, आपको किसी तरह संपादक तक पहुंचने की जरूरत है ...

ऐसा करने के लिए, निम्न शीर्ष लेख जोड़ें:

#include <coreplugin / editormanager / editormanager.h>

#include <coreplugin / editormanager / ieditor.h>

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

और आरंभिक विधि में निम्नलिखित पंक्ति जोड़ें:

कनेक्ट (कोर :: EditorManager :: उदाहरण) (), SIGNAL (currentEditorChanged (कोर :: IEditor *)), यह , SLOT (currentEditorChanged (कोर :: IEditor *));

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

और निश्चित रूप से, स्लॉट को चालू करेंअनुकूलित घोषित करें (कोर :: IEditor *)

हर बार वर्तमान संपादक के बदलाव के बाद इस स्लॉट को कॉल किया जाएगा, यानी उपयोगकर्ता ने फ़ाइल को खोला / बंद किया, या किसी दूसरे को खोला हुआ स्विच किया।

इसका कार्यान्वयन इस प्रकार है:

शून्य टोडप्लगिन :: currentEditorChanged (कोर :: IEditor * संपादक)

{

outPane-> clearContents (); // साफ़

अगर (संपादक) // चेक करें कि क्या कोई संपादक है? सामान्य तौर पर

{

वापसी;

}

/ * पतला बिंदु, हम वर्तमान संपादक से जुड़ी फ़ाइल के वर्ग को बदलने के संकेत को कनेक्ट करते हैं, ताकि बाद में उपयोगकर्ता Ctrl + S * / दबाए जाने के बाद आप फ़ाइल को फिर से पढ़ सकें

कनेक्ट (संपादक-> फ़ाइल (), SIGNAL (परिवर्तित) (), यह , SLOT (fileChanged ()));

QString fileName = editor-> file () -> fileName (); // फ़ाइल नाम प्राप्त करें

readFile (fileName); // फ़ाइल को पढ़ने और पार्स करें।

}

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

पार्सिंग विधि को यहां कहा जाता है, यह सरल है:

शून्य टोडप्लगिन :: readFile (QString फ़ाइलनाम)

{

QFile फ़ाइल (fileName);

अगर (file.open (QFile :: ReadOnly | QFile :: Text))

वापसी;

int i = 1;

जबकि (file.atEnd ())

{

QString currentLine = file.readLine ();

अगर (currentLine.contains (QRegExp (patternString, Qt :: CaseInsensitive)))

{

outPane-> addItem (currentLine, fileName, i);

}

++ मैं;

}

}

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

आपको एक नए स्लॉट का वर्णन करने की भी आवश्यकता है जिसे फ़ाइल सहेजे जाने पर कॉल किया जाएगा, यहाँ यह है:

शून्य टोडप्लुगिन :: फ़ाइल परिवर्तित ()

{

outPane-> clearContents ();

कोर :: IFile * फ़ाइल = (Core :: IFile *) प्रेषक (); // यह कुछ हद तक गैर-रूढ़िवादी तरीका है, लेकिन यह काफी सुरक्षित रूप से काम करेगा, क्योंकि कोई भी संकेत इस स्लॉट से जुड़ा नहीं है।

अगर (फ़ाइल)

{

readFile (फ़ाइल-> fileName ());

}

}

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

पंक्तियाँ जोड़ना

अब आपको लाइनों को जोड़ने की आवश्यकता है, अर्थात विधि:

void TodoOutputPane :: addItem (QString टेक्स्ट, QString फ़ाइल, int rowNumber)

{

QListWidgetItem * newItem = new QListWidgetItem (); // एक नई प्रविष्टि बनाएँ

QRegExp todoExp ( "// \\ s * TODO (:। \\ s)" , Qt :: CaseInsensitive); // रेगेक्स तैयार करें

QRegExp noteExp ( "// \\ s * NOTE (: | \\ s)" , Qt: CaseInsintitive);

QRegExp fixmeExp ( "// \\ s * FIXME ( : | \\ s)" , Qt :: CaseInsensitive);

QRegExp BugExp ( "// \\ s * BUG (: | \\ s)" , Qt :: CaseInsensitive);

QRegExp hackExp ( "// \\ s * HACK (: | \\ s)" , Qt :: CaseInsensitive);

text = text.replace ( "\ n" , "" );

text = text.replace ( "\ r" , "" );

newItem-> setTextColor (QColor ( "# 2F2F2F" ));

if (text.contains (todoExp)) // Regexps की तलाश में

{

newItem-> setBackgroundColor (QColor ( "# BFFFC8" )); // रिकॉर्ड रंग सेट करें

text = text.replace (todoExp, "TODO :;); // बदलें "संभवतः कुटिल" लेबल की वर्तनी सही है

newItem-> setIcon (QIcon ( ": / चेतावनी" )); // आइकन सेट करें

}

और अगर (text.contains (noteExp))

{

newItem-> setBackgroundColor (QColor ( "# E2DFFF" ));

text = text.replace (noteExp, “NOTE :;);

newItem-> setIcon (QIcon ( ": / info" ));

}

और अगर (text.contains (bugExp))

{

newItem-> setBackgroundColor (QColor ( "# FFFBFBF" ));

text = text.replace (BugExp, “BUG :;);

newItem-> setIcon (QIcon ( ": / error" ));

}

और अगर (text.contains (FixmeExp))

{

newItem-> setBackgroundColor (QColor ( "# FFFDFDF" ));

पाठ = text.replace (FixmeExp, " FIXME:;);

newItem-> setIcon (QIcon ( ": / error" ));

}

और अगर (text.contains (hackExp))

{

newItem-> setBackgroundColor (QColor ( "# FFFFAA" ));

पाठ = text.replace (hackExp, "हैक: place);

newItem-> setIcon (QIcon ( ": / info" ));

}

newItem-> setText (text.trimmed () + "(" + tr ( "लाइन„ ) + QString :: संख्या (rowNumber) + ")" ); // रिकॉर्ड पाठ सेट करें

newItem-> setToolTip (फ़ाइल + ":" + QString :: संख्या (rowNumber)); // टूलटिप फ़ाइल नाम और लाइन नंबर को संग्रहीत करेगा, यह सिर्फ उसी तरह नहीं है, मैं आपको नीचे बताऊंगा।

todoList-> addItem (newItem); // सूची में एक प्रविष्टि जोड़ें

}

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

रिकॉर्ड पर क्लिक करके वांछित लाइन पर जाएं

हमारे लिए केवल एक चीज बची है जो वांछित रेखा पर संक्रमण को लागू करना है।

ऐसा करने के लिए, आपको एक और स्लॉट की आवश्यकता होगी, जिसे सूची आइटम के चयन के बाद निष्पादित किया जाएगा:

शून्य टोडप्लगिन :: gotoToRowInFile (QListWidgetItem * आइटम)

{

int पंक्ति = 0; // लाइन नंबर

QString फ़ाइल = "" ; // फ़ाइल नाम

/ * प्रॉम्प्ट से जानकारी प्राप्त करें * /

QStringList tmpList = आइटम-> टूलटिप ()। स्प्लिट ( ":" );

अगर (tmpList.size () == 2)

{

फ़ाइल = tmpList.at (0);

बूल ठीक;

row = tmpList.at (1) .toInt (& ok);

अगर (ठीक है)

{

पंक्ति = 0;

}

}

अगर (QFileInfo (फ़ाइल) .exists ()) // जाँच करें कि क्या फ़ाइल मौजूद है।

{

TextEditor :: BaseTextEditor :: openEditorAt (फ़ाइल, पंक्ति); // पंक्ति संख्या पंक्ति में कर्सर रखकर जबरन फ़ाइल दिखाएं। इस पंक्ति को काम करने के लिए, आपको निर्भरता में TextEditor प्लगइन को निर्दिष्ट करने और उचित हेडर जोड़ने की आवश्यकता है

कोर :: EditorManager :: उदाहरण () -> सुनिश्चित करेंटाइज़रमैनेजरविज़न ();

}

}

* इस सोर्स कोड को सोर्स कोड हाइलाइटर के साथ हाइलाइट किया गया था।

निष्कर्ष

खैर, यह सब, प्लगइन तैयार है, इसे पढ़ने वालों के लिए धन्यवाद।

आप यहाँ से प्लगइन डाउनलोड कर सकते हैं ।

टीडीओ प्लगइन QtCreator के लिए