forked from eclipse-lemminx/lemminx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Find definition for locally declared entity
Fixes eclipse-lemminx#625 Signed-off-by: azerr <[email protected]>
- Loading branch information
1 parent
c4804f0
commit 41806c8
Showing
7 changed files
with
272 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
...a/org/eclipse/lemminx/extensions/entities/participants/EntitiesDefinitionParticipant.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| /** | ||
| * Copyright (c) 2020 Red Hat, Inc. and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v20.html | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Red Hat Inc. - initial API and implementation | ||
| */ | ||
| package org.eclipse.lemminx.extensions.entities.participants; | ||
|
|
||
| import static org.eclipse.lemminx.utils.StringUtils.findEndWord; | ||
| import static org.eclipse.lemminx.utils.StringUtils.findStartWord; | ||
|
|
||
| import java.util.List; | ||
| import java.util.function.Predicate; | ||
|
|
||
| import org.eclipse.lemminx.dom.DOMDocument; | ||
| import org.eclipse.lemminx.dom.DOMDocumentType; | ||
| import org.eclipse.lemminx.dom.DOMNode; | ||
| import org.eclipse.lemminx.dom.DTDDeclParameter; | ||
| import org.eclipse.lemminx.dom.DTDEntityDecl; | ||
| import org.eclipse.lemminx.extensions.contentmodel.model.CMDocument; | ||
| import org.eclipse.lemminx.extensions.contentmodel.model.ContentModelManager; | ||
| import org.eclipse.lemminx.services.extensions.AbstractDefinitionParticipant; | ||
| import org.eclipse.lemminx.services.extensions.IDefinitionRequest; | ||
| import org.eclipse.lemminx.utils.XMLPositionUtility; | ||
| import org.eclipse.lsp4j.LocationLink; | ||
| import org.eclipse.lsp4j.Range; | ||
| import org.eclipse.lsp4j.jsonrpc.CancelChecker; | ||
| import org.w3c.dom.Entity; | ||
| import org.w3c.dom.NamedNodeMap; | ||
|
|
||
| /** | ||
| * Entities definition used in a text node (ex : &). | ||
| * | ||
| */ | ||
| public class EntitiesDefinitionParticipant extends AbstractDefinitionParticipant { | ||
|
|
||
| private static final Predicate<Character> isValidChar = (c) -> Character.isJavaIdentifierPart(c) || c == '-'; | ||
|
|
||
| @Override | ||
| protected boolean match(DOMDocument document) { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| protected void doFindDefinition(IDefinitionRequest request, List<LocationLink> locations, | ||
| CancelChecker cancelChecker) { | ||
| DOMNode node = request.getNode(); | ||
| if (!node.isText()) { | ||
| return; | ||
| } | ||
| // definition is done in a text node, check if it's a referenced entity | ||
| DOMDocument document = request.getXMLDocument(); | ||
| int offset = request.getOffset(); | ||
| String text = document.getText(); | ||
|
|
||
| int paramStart = findStartWord(text, offset, isValidChar); | ||
| if (paramStart > 0 && text.charAt(paramStart - 1) == '&') { | ||
| int paramEnd = findEndWord(text, offset, isValidChar); | ||
| // Find definition of the entity | ||
| // abcd &loc|al; --> in this case search local entity | ||
| String entityName = text.substring(paramStart, paramEnd); | ||
| Range entityRange = XMLPositionUtility.createRange(paramStart, paramEnd, document); | ||
| searchInInternalEntities(entityName, entityRange, document, locations, cancelChecker); | ||
| searchInExternalEntities(entityName, entityRange, document, locations, request, cancelChecker); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Search the given entity name in the internal entities. | ||
| * | ||
| * @param document the DOM document. | ||
| * @param entityName the entity name. | ||
| * @param entityRange the entity range. | ||
| * @param locations the location links | ||
| * @param cancelChecker the cancel checker. | ||
| */ | ||
| private static void searchInInternalEntities(String entityName, Range entityRange, DOMDocument document, | ||
| List<LocationLink> locations, CancelChecker cancelChecker) { | ||
| DOMDocumentType docType = document.getDoctype(); | ||
| if (docType == null) { | ||
| return; | ||
| } | ||
| cancelChecker.checkCanceled(); | ||
| // Loop for entities declared in the DOCTYPE of the document | ||
| NamedNodeMap entities = docType.getEntities(); | ||
| for (int i = 0; i < entities.getLength(); i++) { | ||
| cancelChecker.checkCanceled(); | ||
| DTDEntityDecl entity = (DTDEntityDecl) entities.item(i); | ||
| if (entityName.equals(entity.getName())) { | ||
| DTDDeclParameter name = entity.getNameParameter(); | ||
| locations.add(XMLPositionUtility.createLocationLink(entityRange, name)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Search the given entity name in the external entities. | ||
| * | ||
| * @param document the DOM document. | ||
| * @param entityName the entity name. | ||
| * @param entityRange the entity range. | ||
| * @param locations the location links | ||
| * @param request the definition request. | ||
| * @param cancelChecker the cancel checker. | ||
| */ | ||
| private static void searchInExternalEntities(String entityName, Range entityRange, DOMDocument document, | ||
| List<LocationLink> locations, IDefinitionRequest request, CancelChecker cancelChecker) { | ||
| ContentModelManager contentModelManager = request.getComponent(ContentModelManager.class); | ||
| CMDocument cmDocument = contentModelManager.findCMDocument(document, null); | ||
| if (cmDocument != null) { | ||
| List<Entity> entities = cmDocument.getEntities(); | ||
| for (Entity entity : entities) { | ||
| if (entityName.equals(entity.getNodeName())) { | ||
| // TODO : retrieve location from the external entity? | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.