एक उदाहरण के रूप में Vala का उपयोग करके Netbeans के लिए एक प्लगइन बनाएं

वेला एक प्रोग्रामिंग भाषा है जिसे ग्नोम के लिए एप्लिकेशन विकसित करते समय सी भाषा के प्रतिस्थापन के रूप में बनाया गया था। उसी समय, मेरी राय में, भाषा एक सफलता थी; अपने वाक्यविन्यास में, इसने बहुत सी # और जावा लिया। आप इसके बारे में Habré या सूक्ति वेबसाइट पर अधिक पढ़ सकते हैं। इस परियोजना को व्यवहार में आजमाना चाहते हैं, मुझे इस तथ्य का सामना करना पड़ रहा था कि फिलहाल आईडीई के लिए कोई उच्च गुणवत्ता वाला आईडीई या प्लग-इन नहीं है जो आपको इसे आराम से विकसित करने की अनुमति देगा।

नतीजतन, NetBeans IDE के लिए एक प्लगइन बनाया गया था, जो कि मेरी राय में सबसे अच्छा ओपन सोर्स IDE (ग्रहण के साथ) में से एक है। फिर भी, NetBeans Plaform के लिए मॉड्यूल और प्लग-इन को कैसे विकसित किया जाए, इस पर जानकारी बिखरी हुई है, और रूसी में व्यावहारिक रूप से कुछ भी नहीं है।

भाषा के लिए पार्सर

NetBeans में एक नई भाषा का समर्थन करने के लिए आपको पहली चीज़ जो उस भाषा के लिए एक शाब्दिक और पार्सर लिखना है। आप उन्हें स्वयं लिख सकते हैं, या ऐसा करने में मदद करने के लिए कुछ प्रकार के उपकरणों का उपयोग कर सकते हैं। उपकरण उदाहरण के लिए हो सकते हैं:

• जावासीसी - जावा भाषा के लिए पार्सर जनरेटर;
• ANTLR कई भाषाओं के लिए एक पार्सर जनरेटर है;
• बाइसन - एक पार्सर जनरेटर;
• याक - पार्सर जनरेटर;
• कई अन्य पार्सर्स

प्लगइन को लागू करने के लिए, मैंने ANTLR को सबसे लोकप्रिय में से एक के रूप में चुना, अर्थात् ANTLRv3 । यह जावा कोड उत्पन्न कर सकता है, जो नेटबीन्स प्लेटफॉर्म के लिए प्लगइन में एकीकृत करना अपेक्षाकृत आसान बनाता है।
ANTLR के लिए, आपको LL व्याकरण का उपयोग करके भाषा का विवरण लिखना होगा। यह भाषा RBNF के करीब है और काफी हद तक सहज है।

सरल करने के लिए, ANTLR व्याकरण के विवरण में दो प्रकार के नियम होते हैं - लेक्सर और व्याकरण। लेक्सर नियम उन टोकन का वर्णन करते हैं जिनका विश्लेषण लेक्सिकल पार्सिंग के चरण में किया जाता है। लेक्सर नियम के नाम अपरकेस और व्याकरण के नियम कम हैं।

उदाहरण लेसर नियम:
ID : ('a'..'z'|'A'..'Z'|'_') ('a'..'z'|'A'..'Z'|'0'..'9'|'_')* ;
यह नियम स्रोत कोड में पहचानकर्ताओं को उजागर करता है, अर्थात् ऐसे शब्द जो लैटिन अक्षर या अंडरस्कोर से शुरू होते हैं और क्रमशः संख्या, लैटिन वर्ण या अंडरस्कोर नहीं होते हैं। चरित्र अनुक्रमों के मिलान के सभी लेसर नियम टोकन को आवंटित किए जाएंगे।

टोकनों को पार्स करने के बाद, पार्सिंग किया जाता है, जो एक सार वाक्यविन्यास पेड़ या एएसटी उत्पन्न करता है। एएसटी उत्पन्न करने के लिए व्याकरण के नियमों का उपयोग किया जाता है।

एक उदाहरण व्याकरण नियम:
try_statement : TRY block (catch_clause)* (finally_clause)?;
इस नियम में कोशिश ... कैच ब्लॉक का वर्णन है। एक नियम में टोकन और / या अन्य व्याकरण नियम के नाम शामिल हैं। इस मामले में प्रतीक '*' का अर्थ है कि पकड़_क्लॉज ब्रैकेट्स में ब्लॉक को कई बार दोहराया जाना चाहिए या अनुपस्थित होना चाहिए। चरित्र '?' - अंततः_क्लॉज ब्लॉक केवल एक बार मौजूद हो सकता है या यह नहीं हो सकता है।

शायद यह ANTLR भाषा के साथ समाप्त होता है, साइट में प्रलेखन और कई उदाहरण हैं। उसी स्थान पर आप ANTLRWorks पा सकते हैं जो डिबगिंग नियमों के साथ मदद करेगा। यह एक चित्रमय और काफी दृश्य तरीके से असंतुष्ट पेड़ को प्रदर्शित करता है।
एलीटआर का वर्णन वाल्टा भाषा के वाक्य-विन्यास का वर्णन करें जो गीथब पर प्लगइन के लिए लिखा गया था

नेटबीन्स के लिए मॉड्यूल

1) एक परियोजना बनाएँ

सबसे पहले आपको New Project के माध्यम से एक NetBeans मॉड्यूल प्रोजेक्ट बनाने की आवश्यकता है नेटबींस मॉड्यूल | मॉड्यूल। "स्टैंडअलोन मॉड्यूल" चेकबॉक्स की जांच करें। प्रोजेक्ट का सही नाम, मॉड्यूल का नाम और "जेनरेट XML लेयर" बॉक्स को चेक करना आवश्यक है। अंतिम क्रिया एक लेयर .xml फ़ाइल बनाएगी जिसमें उन वर्गों के नाम होंगे जो प्लग-इन व्यवहार और आपके मॉड्यूल के अन्य मापदंडों को लागू करते हैं।

2) .vala और .vapi फ़ाइलों के लिए मॉड्यूल में समर्थन जोड़ें

NetBeans Datasystems API और Filesystems API के माध्यम से प्रोजेक्ट फ़ाइलों के साथ काम करता है । आप परियोजना के मूल तत्व का चयन करके नए एक्सटेंशन के लिए समर्थन जोड़ सकते हैं, फिर नया | अन्य | मॉड्यूल विकास | फ़ाइल प्रकार।

इन कार्रवाइयों से DataObject के साथ काम करने के लिए एक साधारण वर्ग का निर्माण होगा, हमारे मामले में यह ValaDataObject है , और इस वर्ग को एक .vala फ़ाइल हैंडलर के रूप में layer.xml में भी पंजीकृत किया जाएगा:

< filesystem >
< folder name ="Loaders" >
< folder name ="text" >
< folder name ="x-vala" >
< folder name ="Actions" >
...
</ folder >
< folder name ="Factories" >
< file name ="ValaDataLoader.instance" >
< attr name ="SystemFileSystem.icon" urlvalue ="nbresloc:/org/carbonfx/valaproject/vala.png" />
< attr name ="dataObjectClass" stringvalue ="org.carbonfx.valaproject.ValaDataObject" />
< attr name ="instanceCreate" methodvalue ="org.openide.loaders.DataLoaderPool.factory" />
< attr name ="mimeType" stringvalue ="text/x-vala" />
</ file >
</ folder >
</ folder >
...

* This source code was highlighted with Source Code Highlighter .

सिंटेक्स हाइलाइटिंग

अब हमारे पास नई भाषा के लिए मॉड्यूल में हाइलाइटिंग सिंटैक्स जोड़ने के लिए सब कुछ है।

1) हम ANTLR द्वारा उत्पन्न पार्सर फ़ाइलों को मॉड्यूल से जोड़ते हैं

अब हमारे पास ANTLR में लिखा गया एक पार्सर है, और हम इसे नेटबीन के लिए मॉड्यूल से जोड़ सकते हैं। ऐसा करने के लिए, ANTLRWorks में लेक्सर और पार्सर फ़ाइलों को जनरेट करें और उन्हें प्रोजेक्ट में जोड़ें। आप उत्पन्न फ़ाइलों के लिए पैकेज निर्दिष्ट कर सकते हैं:

@header { package org.carbonfx.valaproject.antlr; }
@lexer::header { package org.carbonfx.valaproject.antlr; }

* This source code was highlighted with Source Code Highlighter .

2) हम नेटबीन्स एपीआई के लिए एएनटीएलआर विश्लेषक का अनुकूलन करते हैं

सबसे पहले, आपको सार वर्ग org.netbeans.spi.lexer.LanguageHierarchy को लागू करने की आवश्यकता है। वास्तव में, यह वर्ग भाषा को टोकन के रूप में परिभाषित करता है, टोकन को श्रेणियों में विभाजित किया जाता है। सिंटैक्स हाइलाइटिंग को लागू करने के लिए श्रेणियों की आवश्यकता है।

public class ValaLanguageHierarchy extends LanguageHierarchy<ValaTokenId> {

@Override
protected Collection<ValaTokenId> createTokenIds() {
return Arrays.asList(tokens);
}

@Override
protected Lexer<ValaTokenId> createLexer(LexerRestartInfo<ValaTokenId> lri) {
return new org.carbonfx.valaproject.lexer.ValaLexer(lri);
}

@Override
protected String mimeType() {
return "text/x-vala" ;
}

static synchronized ValaTokenId getToken( int id) {
return idToToken. get (id);
}

private static final Map<Integer, ValaTokenId> idToToken = new HashMap<Integer, ValaTokenId>();
private static final ValaTokenId[] tokens = new ValaTokenId[] {
token(ValaLexer.AND, "operator" ),
token(ValaLexer.AND_ASSIGN, "operator" ),
token(ValaLexer.BACKSLASH, "operator" ),
// ...
token(ValaLexer.UNICODE_CHAR, "error" ),
token(ValaLexer.OTHER_CHAR, "error" ),
token(ValaLexer.UNKNOWN_CHAIN, "error" ),
};

static {
for (ValaTokenId token : tokens) {
idToToken.put(token.ordinal(), token);
}
}

private static ValaTokenId token( int antlrToken, String category) {
return new ValaTokenId (ValaParser.tokenNames[antlrToken], category, antlrToken);
}
}

* This source code was highlighted with Source Code Highlighter .

मुझे यहां ValaTokenId का कार्यान्वयन याद आया, यह काफी सरल है
यह एक वर्ग बनाने के लिए बनी हुई है ValaLexer ValaLexer , जो Lexer<ValaTokenId> इंटरफ़ेस को लागू करता है।

ValaLexer वर्ग का मुख्य उद्देश्य इनपुट पर वर्णों का अनुक्रम प्राप्त करना और टोकन के अनुक्रम को वापस करना है। सबसे सरल कार्यान्वयन में, यह निर्माणकर्ता के पात्रों के अनुक्रम को बचाने और nextToken() पद्धति में बदले में टोकन की वापसी को लागू करने के लिए nextToken() ।

यहां एक और बिंदु यह है कि आपको उन पात्रों की धारा को अनुकूलित करने की आवश्यकता है जो NetBeans प्लेटफ़ॉर्म हमें स्ट्रीम में देता है जो ANTLR क्लासेस को स्वीकार करेगा, अर्थात्, CharStream इंटरफ़ेस। सौभाग्य से, एक समान परियोजना में इस वर्ग का पहले से ही तैयार कार्यान्वयन है ।

3) बैकलाइट कॉन्फ़िगरेशन

हम FontAndColors.xml फ़ाइल बनाते हैं, जिसमें हम तत्वों के विभिन्न रंगों के साथ हाइलाइट की गई श्रेणियों के अनुसार टोकन की श्रेणियों के पत्राचार का वर्णन करते हैं। विशेष रूप से, हमारी फ़ाइल इस प्रकार है:

<? xml version ="1.0" encoding ="UTF-8" ? >
<! DOCTYPE fontscolors PUBLIC "-//NetBeans//DTD Editor Fonts and Colors settings 1.1//EN" "http://www.netbeans.org/dtds/EditorFontsColors-1_1.dtd" >
< fontscolors >
< fontcolor name ="character" default ="character" />
< fontcolor name ="error" default ="error" />
< fontcolor name ="identifier" default ="identifier" />
< fontcolor name ="keyword" default ="keyword" />
< fontcolor name ="comment" default ="comment" />
< fontcolor name ="number" default ="number" />
< fontcolor name ="operator" default ="operator" />
< fontcolor name ="string" default ="string" />
< fontcolor name ="separator" default ="separator" />
< fontcolor name ="whitespace" default ="whitespace" />
< fontcolor name ="method" default ="method" />
< fontcolor name ="javadoc" default ="javadoc" foreColor ="ff006666" />
< fontcolor name ="regex" default ="regex" foreColor ="ff660066" />
< fontcolor name ="command" default ="command" foreColor ="ff006633" />
</ fontscolors >

* This source code was highlighted with Source Code Highlighter .

Bund.properties फ़ाइल में, हम श्रेणियों के लिए मानव नामों का वर्णन करते हैं:

operator=Operator
string=String
separator=Separator
whitespace=Whitespace
method=Method
regex=Regular Expression
command=Command
...

* This source code was highlighted with Source Code Highlighter .

इसके बाद, प्रोजेक्ट में स्रोत कोड ValaExample.vala के साथ एक नमूना फ़ाइल जोड़ें। यह नेटबींस टोकन के लिए रंग सेटिंग्स संवाद में प्रदर्शित किया जाएगा। और अंतिम चरण - हाइलाइटिंग के लिए layer.xml फ़ाइल में लाइनें जोड़ें:

< filesystem >
< folder name ="Editors" >
< folder name ="text" >
< folder name ="x-vala" >
< file name ="language.instance" >
< attr name ="instanceCreate" methodvalue ="org.carbonfx.valaproject.lexer.ValaTokenId.getLanguage" />
< attr name ="instanceOf" stringvalue ="org.netbeans.api.lexer.Language" />
</ file >
< attr name ="SystemFileSystem.localizingBundle" stringvalue ="org.carbonfx.valaproject.Bundle" />
< folder name ="FontsColors" >
< folder name ="NetBeans" >
< folder name ="Defaults" >
< file name ="FontAndColors.xml" url ="FontAndColors.xml" >
< attr name ="SystemFileSystem.localizingBundle" stringvalue ="org.carbonfx.valaproject.Bundle" />
</ file >
</ folder >
</ folder >
</ folder >
</ folder >
</ folder >
</ folder >
< folder name ="OptionsDialog" >
< folder name ="PreviewExamples" >
< folder name ="text" >
< file name ="x-vala" url ="ValaExample.vala" />
</ folder >
</ folder >
</ folder >
</ filesystem >

* This source code was highlighted with Source Code Highlighter .

यदि आपने सब कुछ सही किया है, और मुझे कुछ भी याद नहीं है, तो आप परियोजना को संकलित और चला सकते हैं। .Vala एक्सटेंशन के साथ फाइलें खोलते समय, हम देखते हैं कि कीवर्ड वांछित रंग में हाइलाइट किए गए हैं। Vala भाषा सेटिंग डायलॉग में दिखाई देनी चाहिए, जिसे आप ValaExample.vala फ़ाइल की हाइलाइट की गई सामग्री का चयन और देख सकते हैं

निष्कर्ष

आखिरकार, हम बस वाक्यविन्यास पर प्रकाश डाला गया है। लेकिन विश्लेषक जो ANTLR का उपयोग करके लिखा गया था, उसका उपयोग अन्य कार्यों के लिए किया जा सकता है, अर्थात्:

1. कोड सत्यापन और गलत निर्माणों को उजागर करना;
2. स्वचालित इंडेंटेशन;
3. टूलटिप विधि के नाम, फ़ंक्शन तर्क के लिए।

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

ANTLR का उपयोग न करके Vala कोड को पार्स करने की कोशिश करने का भी एक विचार था, लेकिन एक पार्सर के साथ, जो खुद Vala में लिखा गया है। विशेष रूप से, यह इसके कार्यान्वयन के साथ है, जिसका उपयोग वेला कंपाइलर - लिबवाला में किया जाता है। अगर किसी को प्लगइन शोधन से जुड़ने में दिलचस्पी है, तो लिखें!

संदर्भ

1. गिथब पर परियोजना का स्रोत कोड , आप वहां संकलित मॉड्यूल भी डाउनलोड कर सकते हैं
2. ANTLR और ANTLRWorks वेबसाइट
3. NetBeans + ANTLR के लिए एक प्लगइन लिखने के लिए निर्देश
4. नेटबीन + जावासीसी के लिए प्लगइन लेखन निर्देश