Merge pull request #125 from hahn-kev/main

Allow void elements to be specified in data provider

Author: aeschli

src/htmlLanguageService.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { createScanner } from './parser/htmlScanner';
-import { parse } from './parser/htmlParser';
+import { HTMLParser } from './parser/htmlParser';
 import { HTMLCompletion } from './services/htmlCompletion';
 import { HTMLHover } from './services/htmlHover';
 import { format } from './services/htmlFormatter';
@@ -19,8 +19,8 @@ import {
 	IHTMLDataProvider, HTMLDataV1, LanguageServiceOptions, TextDocument, SelectionRange, WorkspaceEdit,
 	Position, CompletionList, Hover, Range, SymbolInformation, TextEdit, DocumentHighlight, DocumentLink, FoldingRange, HoverSettings
 } from './htmlLanguageTypes';
-import { getFoldingRanges } from './services/htmlFolding';
-import { getSelectionRanges } from './services/htmlSelectionRange';
+import { HTMLFolding } from './services/htmlFolding';
+import { HTMLSelectionRange } from './services/htmlSelectionRange';
 import { HTMLDataProvider } from './languageFacts/dataProvider';
 import { HTMLDataManager } from './languageFacts/dataManager';
 import { htmlData } from './languageFacts/data/webCustomData';
@@ -57,11 +57,14 @@ export function getLanguageService(options: LanguageServiceOptions = defaultLang
 
 	const htmlHover = new HTMLHover(options, dataManager);
 	const htmlCompletion = new HTMLCompletion(options, dataManager);
+	const htmlParser = new HTMLParser(dataManager);
+	const htmlSelectionRange = new HTMLSelectionRange(htmlParser);
+	const htmlFolding = new HTMLFolding(dataManager);
 
 	return {
 		setDataProviders: dataManager.setDataProviders.bind(dataManager),
 		createScanner,
-		parseHTMLDocument: document => parse(document.getText()),
+		parseHTMLDocument: htmlParser.parseDocument.bind(htmlParser),
 		doComplete: htmlCompletion.doComplete.bind(htmlCompletion),
 		doComplete2: htmlCompletion.doComplete2.bind(htmlCompletion),
 		setCompletionParticipants: htmlCompletion.setCompletionParticipants.bind(htmlCompletion),
@@ -70,8 +73,8 @@ export function getLanguageService(options: LanguageServiceOptions = defaultLang
 		findDocumentHighlights,
 		findDocumentLinks,
 		findDocumentSymbols,
-		getFoldingRanges,
-		getSelectionRanges,
+		getFoldingRanges: htmlFolding.getFoldingRanges.bind(htmlFolding),
+		getSelectionRanges: htmlSelectionRange.getSelectionRanges.bind(htmlSelectionRange),
 		doQuoteComplete: htmlCompletion.doQuoteComplete.bind(htmlCompletion),
 		doTagComplete: htmlCompletion.doTagComplete.bind(htmlCompletion),
 		doRename,

src/htmlLanguageTypes.ts

@@ -160,6 +160,7 @@ export interface ITagData {
 	description?: string | MarkupContent;
 	attributes: IAttributeData[];
 	references?: IReference[];
+	void?: boolean
 }
 
 export interface IAttributeData {

src/languageFacts/data/webCustomData.ts

@@ -78,6 +78,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The base element allows authors to specify the document base URL for the purposes of resolving relative URLs, and the name of the default browsing context for the purposes of following hyperlinks. The element does not represent any content beyond this information."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "href",
@@ -108,6 +109,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The link element allows authors to link their document to other resources."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "href",
@@ -197,6 +199,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The meta element represents various kinds of metadata that cannot be expressed using the title, base, link, style, and script elements."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "name",
@@ -650,6 +653,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The hr element represents a paragraph-level thematic break, e.g. a scene change in a story, or a transition to another topic within a section of a reference book."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "align",
@@ -1378,6 +1382,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The br element represents a line break."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "clear",
@@ -1397,6 +1402,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The wbr element represents a line break opportunity."
 			},
+			"void": true,
 			"attributes": [],
 			"references": [
 				{
@@ -1477,6 +1483,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "An img element represents an image."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "alt",
@@ -1672,6 +1679,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The embed element provides an integration point for an external (typically non-HTML) application or interactive content."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "src",
@@ -1819,6 +1827,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The param element defines parameters for plugins invoked by object elements. It does not represent anything on its own."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "name",
@@ -1987,6 +1996,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The source element allows authors to specify multiple alternative media resources for media elements. It does not represent anything on its own."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "src",
@@ -2028,6 +2038,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The track element allows authors to specify explicit external timed text tracks for media elements. It does not represent anything on its own."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "default",
@@ -2102,6 +2113,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The area element represents either a hyperlink with some text and a corresponding area on an image map, or a dead area on an image map."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "alt"
@@ -2216,6 +2228,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "If a col element has a parent and that is a colgroup element that itself has a parent that is a table element, then the col element represents one or more columns in the column group represented by that colgroup."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "span"
@@ -2517,6 +2530,7 @@ export const htmlData : HTMLDataV1 = {
 				"kind": "markdown",
 				"value": "The input element represents a typed data field, usually with a form control to allow the user to edit the data."
 			},
+			"void": true,
 			"attributes": [
 				{
 					"name": "accept"
@@ -6049,4 +6063,4 @@ export const htmlData : HTMLDataV1 = {
 			]
 		}
 	]
-};
+};

src/languageFacts/dataManager.ts

@@ -6,6 +6,7 @@
 import { IHTMLDataProvider } from '../htmlLanguageTypes';
 import { HTMLDataProvider } from './dataProvider';
 import { htmlData } from './data/webCustomData';
+import * as arrays from '../utils/arrays';
 
 export class HTMLDataManager {
 	private dataProviders: IHTMLDataProvider[] = [];
@@ -24,4 +25,19 @@ export class HTMLDataManager {
 	getDataProviders() {
 		return this.dataProviders;
 	}
-}
+
+	isVoidElement(e: string, voidElements: string[]) {
+		return !!e && arrays.binarySearch(voidElements, e.toLowerCase(), (s1: string, s2: string) => s1.localeCompare(s2)) >= 0;
+	}
+
+	getVoidElements(languageId: string):string[];
+	getVoidElements(dataProviders: IHTMLDataProvider[]): string[];
+	getVoidElements(languageOrProviders: string| IHTMLDataProvider[]): string[] {
+		const dataProviders = Array.isArray(languageOrProviders) ? languageOrProviders : this.getDataProviders().filter(p => p.isApplicable(languageOrProviders!));
+		const voidTags: string[] = [];
+		dataProviders.forEach((provider) => {
+			provider.provideTags().filter(tag => tag.void).forEach(tag => voidTags.push(tag.name));
+		});
+		return voidTags.sort();
+	}
+}