Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Navigator Support for HCL Files #5954

Merged
merged 6 commits into from
May 21, 2023
Merged

Navigator Support for HCL Files #5954

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2a3dc3a
Improve HCL AST to block and attribute level.
lkishalmi May 13, 2023
edbed50
Do not generate HCLExpressionParser, use HCLParser.expression instead
lkishalmi May 15, 2023
f6c7635
Added basic Navigator support for HCL
lkishalmi May 15, 2023
4eed8a2
Fixed attribute offset, added structure tests
lkishalmi May 19, 2023
ff4cf24
Template and interpolation nesting in HereDoc
lkishalmi May 20, 2023
875f5ea
Do not mark HCL template tokens as error
lkishalmi May 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ide/languages.hcl/build.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
<arg value="org.netbeans.modules.languages.hcl.grammar"/>
<arg value="HCLLexer.g4"/>
<arg value="TerraformLexer.g4"/>
<arg value="HCLExpressionParser.g4"/>
<arg value="HCLParser.g4"/>
</java>

Expand Down
44 changes: 43 additions & 1 deletion ide/languages.hcl/nbproject/project.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,49 @@
<code-name-base>org.netbeans.libs.junit4</code-name-base>
<compile-dependency/>
</test-dependency>
</test-type>
<test-dependency>
<code-name-base>org.netbeans.modules.csl.api</code-name-base>
<recursive/>
<compile-dependency/>
<test/>
</test-dependency>
<test-dependency>
<code-name-base>org.netbeans.modules.editor.mimelookup</code-name-base>
<compile-dependency/>
</test-dependency>
<test-dependency>
<code-name-base>org.netbeans.modules.editor.mimelookup.impl</code-name-base>
</test-dependency>
<test-dependency>
<code-name-base>org.netbeans.modules.editor.util</code-name-base>
<recursive/>
<compile-dependency/>
</test-dependency>
<test-dependency>
<code-name-base>org.netbeans.modules.lexer</code-name-base>
<compile-dependency/>
<test/>
</test-dependency>
<test-dependency>
<code-name-base>org.netbeans.modules.masterfs</code-name-base>
</test-dependency>
<test-dependency>
<code-name-base>org.netbeans.modules.nbjunit</code-name-base>
<recursive/>
<compile-dependency/>
</test-dependency>
<test-dependency>
<code-name-base>org.netbeans.modules.parsing.nb</code-name-base>
</test-dependency>
<test-dependency>
<code-name-base>org.netbeans.modules.projectapi.nb</code-name-base>
</test-dependency>
<test-dependency>
<code-name-base>org.openide.util.lookup</code-name-base>
<compile-dependency/>
<test/>
</test-dependency>
</test-type>
</test-dependencies>
<public-packages/>
</data>
Expand Down
17 changes: 14 additions & 3 deletions ide/languages.hcl/src/org/netbeans/modules/languages/hcl/HCLParserResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import org.netbeans.modules.csl.spi.ParserResult;
import org.netbeans.modules.languages.hcl.ast.ASTBuilderListener;
import org.netbeans.modules.languages.hcl.ast.HCLDocument;
import org.netbeans.modules.languages.hcl.ast.SourceRef;
import org.netbeans.modules.languages.hcl.grammar.HCLLexer;
import org.netbeans.modules.languages.hcl.grammar.HCLParser;
import org.netbeans.modules.languages.hcl.grammar.HCLParserBaseListener;
Expand All @@ -59,6 +60,7 @@ public class HCLParserResult extends ParserResult {
public final Map<String,List<OffsetRange>> folds = new HashMap<>();

private HCLDocument document;
private SourceRef references;

public HCLParserResult(Snapshot snapshot) {
super(snapshot);
Expand All @@ -84,7 +86,7 @@ public void compute() {
lexer.reset();

}
processDocument(document);
processDocument(document, references);

finished = true;
}
Expand Down Expand Up @@ -116,6 +118,14 @@ public List<? extends Error> getDiagnostics() {
return errors;
}

public final HCLDocument getDocument() {
return document;
}

public final SourceRef getReferences() {
return references;
}

@Override
protected void invalidate() {
}
Expand All @@ -126,13 +136,14 @@ protected void configureParser(HCLParser parser) {

parser.addParseListener(createFoldListener());

ASTBuilderListener astListener = new ASTBuilderListener();
ASTBuilderListener astListener = new ASTBuilderListener(getSnapshot());
parser.addParseListener(astListener);

document = astListener.getDocument();
references = astListener.getReferences();
}

protected void processDocument(HCLDocument doc) {
protected void processDocument(HCLDocument doc, SourceRef references) {
}

private void addFold(FoldType ft, Token token) {
Expand Down
152 changes: 152 additions & 0 deletions ide/languages.hcl/src/org/netbeans/modules/languages/hcl/HCLStructureItem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.modules.languages.hcl;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import javax.swing.ImageIcon;
import org.netbeans.modules.csl.api.ElementHandle;
import org.netbeans.modules.csl.api.ElementKind;
import org.netbeans.modules.csl.api.HtmlFormatter;
import org.netbeans.modules.csl.api.Modifier;
import org.netbeans.modules.csl.api.OffsetRange;
import org.netbeans.modules.csl.api.StructureItem;
import org.netbeans.modules.csl.spi.ParserResult;
import org.netbeans.modules.languages.hcl.ast.HCLAttribute;
import org.netbeans.modules.languages.hcl.ast.HCLBlock;
import org.netbeans.modules.languages.hcl.ast.HCLContainer;
import org.netbeans.modules.languages.hcl.ast.HCLElement;
import org.netbeans.modules.languages.hcl.ast.SourceRef;
import org.openide.filesystems.FileObject;

/**
*
* @author lkishalmi
*/
public class HCLStructureItem implements ElementHandle, StructureItem {

final HCLElement element;
final SourceRef references;
private List<? extends StructureItem> nestedCache;

public HCLStructureItem(HCLElement element, SourceRef references) {
this.element = element;
this.references = references;
}

@Override
public FileObject getFileObject() {
return references.getFileObject();
}

@Override
public String getMimeType() {
return getFileObject().getMIMEType();
}

@Override
public String getName() {
return element.id();
}

@Override
public String getIn() {
return null;
}


@Override
public Set<Modifier> getModifiers() {
return Collections.emptySet();
}

@Override
public boolean signatureEquals(ElementHandle handle) {
return false;
}

@Override
public OffsetRange getOffsetRange(ParserResult result) {
return references.getOffsetRange(element).orElse(OffsetRange.NONE);
}

@Override
public String getSortText() {
return getName();
}

@Override
public String getHtml(HtmlFormatter formatter) {
return getName();
}

@Override
public ElementHandle getElementHandle() {
return this;
}

@Override
public boolean isLeaf() {
return element instanceof HCLAttribute;
}

@Override
public List<? extends StructureItem> getNestedItems() {
if (nestedCache == null) {
if (element instanceof HCLContainer) {
HCLContainer c = (HCLContainer) element;
List<HCLStructureItem> nested = new ArrayList<>();
for (HCLBlock block : c.getBlocks()) {
nested.add(new HCLStructureItem(block, references));
}
for (HCLAttribute attribute : c.getAttributes()) {
nested.add(new HCLStructureItem(attribute, references));
}
nestedCache = nested;
} else {
nestedCache = Collections.emptyList();
}
}
return nestedCache;
}

@Override
public long getPosition() {
return getOffsetRange(null).getStart();
}

@Override
public long getEndPosition() {
return getOffsetRange(null).getEnd();
}

@Override
public ImageIcon getCustomIcon() {
return null;
}

@Override
public ElementKind getKind() {
return element instanceof HCLAttribute ? ElementKind.ATTRIBUTE : ElementKind.TAG;
}


}
13 changes: 5 additions & 8 deletions ide/languages.hcl/src/org/netbeans/modules/languages/hcl/HCLStructureScanner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,25 @@
*/
package org.netbeans.modules.languages.hcl;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import org.netbeans.api.editor.fold.FoldType;
import org.netbeans.api.editor.mimelookup.MimeRegistration;
import org.netbeans.modules.csl.api.OffsetRange;
import org.netbeans.modules.csl.api.StructureItem;
import org.netbeans.modules.csl.api.StructureScanner;
import org.netbeans.modules.csl.spi.ParserResult;
import org.netbeans.modules.languages.hcl.HCLParserResult;
import org.netbeans.spi.editor.fold.FoldTypeProvider;

/**
*
* @author Laszlo Kishalmi
*/
public class HCLStructureScanner implements StructureScanner{
public class HCLStructureScanner implements StructureScanner {
@Override
public List<? extends StructureItem> scan(ParserResult info) {
return Collections.emptyList();
HCLParserResult hclInfo = (HCLParserResult) info;

HCLStructureItem root = new HCLStructureItem(hclInfo.getDocument(), hclInfo.getReferences());
return root.getNestedItems();
}

@Override
Expand Down
Loading