/*--------------------------------------------------------------------------------------------- * Copyright (c) Red Hat, Inc. All rights reserved. * Copyright (c) Adam Voss. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ 'use strict'; import * as nls from 'vscode-nls'; const localize = nls.loadMessageBundle(); import * as Yaml from '../../yaml-ast-parser/index' import { getLineStartPositions } from '../utils/documentPositionCalculator' import { parseYamlBoolean } from './scalar-type'; import { ObjectASTNodeImpl, StringASTNodeImpl, PropertyASTNodeImpl, NullASTNodeImpl, ArrayASTNodeImpl, BooleanASTNodeImpl, NumberASTNodeImpl } from './jsonParser'; import { ASTNode, PropertyASTNode, ErrorCode } from '../jsonLanguageTypes'; import { SingleYAMLDocument, YAMLDocument } from '../yamlLanguageTypes'; import { Schema } from '../../yaml-ast-parser/schema'; import { Type } from '../../yaml-ast-parser/type'; function recursivelyBuildAst(parent: ASTNode, node: Yaml.YAMLNode): ASTNode { if (!node) { return; } switch (node.kind) { case Yaml.Kind.MAP: { const instance = node; const result = new ObjectASTNodeImpl(parent, node.startPosition, node.endPosition - node.startPosition) for (const mapping of instance.mappings) { result.properties.push(recursivelyBuildAst(result, mapping)); } return result; } case Yaml.Kind.MAPPING: { const instance = node; const key = instance.key; const result = new PropertyASTNodeImpl(parent, key.startPosition, instance.endPosition - key.startPosition); // Technically, this is an arbitrary node in YAML // I doubt we would get a better string representation by parsing it const keyNode = new StringASTNodeImpl(result, key.startPosition, key.endPosition - key.startPosition); keyNode.value = key.value; // TODO: calculate the correct NULL range. const valueNode = (instance.value) ? recursivelyBuildAst(result, instance.value) : new NullASTNodeImpl(parent, instance.endPosition); result.keyNode = keyNode; result.valueNode = valueNode; return result; } case Yaml.Kind.SEQ: { const instance = node; const result = new ArrayASTNodeImpl(parent, instance.startPosition, instance.endPosition - instance.startPosition); let count = 0; for (const item of instance.items) { if (item === null && count === instance.items.length - 1) { break; } // Be aware of https://github.com/nodeca/js-yaml/issues/321 // Cannot simply work around it here because we need to know if we are in Flow or Block var itemNode = (item === null) ? new NullASTNodeImpl(parent, instance.startPosition, instance.endPosition - instance.startPosition) : recursivelyBuildAst(result, item); result.items.push(itemNode); } return result; } case Yaml.Kind.SCALAR: { const instance = node; const type = Yaml.determineScalarType(instance) // The name is set either by the sequence or the mapping case. const name = null; const value = instance.value; //This is a patch for redirecting values with these strings to be boolean nodes because its not supported in the parser. let possibleBooleanValues = ['y', 'Y', 'yes', 'Yes', 'YES', 'n', 'N', 'no', 'No', 'NO', 'on', 'On', 'ON', 'off', 'Off', 'OFF']; if (instance.plainScalar && possibleBooleanValues.indexOf(value.toString()) !== -1) { return new BooleanASTNodeImpl(parent, parseYamlBoolean(value), node.startPosition, node.endPosition - node.startPosition) } switch (type) { case Yaml.ScalarType.null: { return new NullASTNodeImpl(parent, instance.startPosition, instance.endPosition - instance.startPosition); } case Yaml.ScalarType.bool: { return new BooleanASTNodeImpl(parent, Yaml.parseYamlBoolean(value), node.startPosition, node.endPosition - node.startPosition) } case Yaml.ScalarType.int: { const result = new NumberASTNodeImpl(parent, node.startPosition, node.endPosition - node.startPosition); result.value = Yaml.parseYamlInteger(value); result.isInteger = true; return result; } case Yaml.ScalarType.float: { const result = new NumberASTNodeImpl(parent, node.startPosition, node.endPosition - node.startPosition); result.value = Yaml.parseYamlFloat(value); result.isInteger = false; return result; } case Yaml.ScalarType.string: { const result = new StringASTNodeImpl(parent, node.startPosition, node.endPosition - node.startPosition); result.value = node.value; return result; } } break; } case Yaml.Kind.ANCHOR_REF: { const instance = (node).value return recursivelyBuildAst(parent, instance) || new NullASTNodeImpl(parent, node.startPosition, node.endPosition - node.startPosition); } case Yaml.Kind.INCLUDE_REF: { const result = new StringASTNodeImpl(parent, node.startPosition, node.endPosition - node.startPosition); result.value = node.value; return result; } } } function convertError(e: Yaml.Error) { return { message: `${e.reason}`, location: { start: e.mark.position - e.mark.column, end: e.mark.position, code: ErrorCode.Undefined } } } function createJSONDocument(yamlDoc: Yaml.YAMLNode, startPositions: number[], text: string) { let _doc = new SingleYAMLDocument(startPositions); _doc.root = recursivelyBuildAst(null, yamlDoc) if (!_doc.root) { // TODO: When this is true, consider not pushing the other errors. _doc.errors.push({ message: localize('Invalid symbol', 'Expected a YAML object, array or literal'), code: ErrorCode.Undefined, location: { start: yamlDoc.startPosition, end: yamlDoc.endPosition } }); } const duplicateKeyReason = 'duplicate key' //Patch ontop of yaml-ast-parser to disable duplicate key message on merge key let isDuplicateAndNotMergeKey = function (error: Yaml.Error, yamlText: string) { let errorConverted = convertError(error); let errorStart = errorConverted.location.start; let errorEnd = errorConverted.location.end; if (error.reason === duplicateKeyReason && yamlText.substring(errorStart, errorEnd).startsWith("<<")) { return false; } return true; }; const errors = yamlDoc.errors.filter(e => e.reason !== duplicateKeyReason && !e.isWarning).map(e => convertError(e)) const warnings = yamlDoc.errors.filter(e => (e.reason === duplicateKeyReason && isDuplicateAndNotMergeKey(e, text)) || e.isWarning).map(e => convertError(e)) errors.forEach(e => _doc.errors.push(e)); warnings.forEach(e => _doc.warnings.push(e)); return _doc; } export function parse(text: string, customTags = []): YAMLDocument { const startPositions = getLineStartPositions(text) // This is documented to return a YAMLNode even though the // typing only returns a YAMLDocument const yamlDocs: Yaml.YAMLNode[] = [] let schemaWithAdditionalTags = Schema.create(customTags.map((tag) => { const typeInfo = tag.split(' '); return new Type(typeInfo[0], { kind: typeInfo[1] || 'scalar' }); })); //We need compiledTypeMap to be available from schemaWithAdditionalTags before we add the new custom properties customTags.map((tag) => { const typeInfo = tag.split(' '); schemaWithAdditionalTags.compiledTypeMap[typeInfo[0]] = new Type(typeInfo[0], { kind: typeInfo[1] || 'scalar' }); }); let additionalOptions: Yaml.LoadOptions = { schema: schemaWithAdditionalTags } Yaml.loadAll(text, doc => yamlDocs.push(doc), additionalOptions); return new YAMLDocument(yamlDocs.map(doc => createJSONDocument(doc, startPositions, text))); }