src/language/providers/intellisense/attributeItems.ts

/*
 * 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.
 */

// prettier-ignore
export const attributeCompletion = (additionalItems) => {
  return {
    items: [
      {
        item: 'dfdl:defineFormat',
        snippetString: '<dfdl:defineFormat name="$1" >\n\t$2\n</dfdl:defineFormat>\n$0',
        markdownString: 'dfdl format name and configuration',
      },
      {
        item: 'dfdl:defineEscapeScheme',
        snippetString: '<dfdl:defineEscapeScheme name=$1 >\n\t$0,/dfdl:defineEscapeScheme>\n',
        markdownString: 'dfdl escape character definition',
      },
      {
        item: 'minOccurs=',
        snippetString: 'minOccurs="${1|0,1|}"$0',
        markdownString: 'mininum number of times element will occur',
      },
      {
        item: 'maxOccurs=',
        snippetString: 'maxOccurs="${1|0,1,unbounded|}"$0',
        markdownString: 'maximum number of times element will occur',
      },
      {
        item: 'dfdl:occursCount=',
        snippetString: 'dfdl:occursCount="$1"$0',
        markdownString: 'dfdl:occursCount property takes an expression which commonly looks in the Infoset via an expression, to obtain the count from another element.',
      },
      {
        item: 'dfdl:byteOrder=',
        snippetString: 'byteOrder="${1|bigEndian,littleEndian|}"$0',
      },
      {
        item: 'dfdl:occursCountKind=',
        snippetString: 'dfdl:occursCountKind="${1|expression,fixed,implicit,parsed,stopValue|}"$0',
        markdownString: 'occursCountKind can be expression, fixed, implicit, parsed, stopValue',
      },
      {
        item: 'dfdl:length=',
        snippetString: 'dfdl:length="$1"$0',
        markdownString: 'length can be an expression that resolves to an unsigned integer, or a literal unsigned integer',
      },
      {
        item: 'dfdl:lengthKind=',
        snippetString: 'dfdl:lengthKind="${1|delimited,fixed,explicit,implicit,prefixed,pattern,endOfParent|}"$0',
        markdownString: 'lengthKind can be delimited, fixed, explicit, implicit, prefixed,pattern, or endOfParent',
      },
      {
        item: 'dfdl:encoding=',
        snippetString: 'dfdl:encoding="${1|US-ASCII,ASCII,UTF-8,UTF-16,UTF-16BE,UTF-16LE,ISO-8859-1|}"$0',
        markdownString: 'encoding can be US-ASCII, ASCII, UTF-8, UTF-16, UTF-16BE UTF-16LE, or ISO-8859-1',
      },
      {
        item: 'dfdl:alignment=',
        snippetString: 'dfdl:alignment="${1|1,2,implicit|}"$0',
        markdownString: "Alignment required for the beginning of the item.\nCan be non-negative integer or 'implicit'.",
      },
      {
        item: 'dfdl:lengthUnits=',
        snippetString: 'dfdl:lengthUnits="${1|bits,bytes,characters|}"$0',
        markdownString: 'lengthUnits can be specified as bits, bytes, or characters',
      },
      {
        item: 'dfdl:lengthPattern=',
        snippetString: 'dfdl:lengthPattern="$1"$0',
        markdownString: 'lengthPattern takes a regular expression which is used to scan the data stream for matching data',
      },
      {
        item: 'dfdl:inputValueCalc=',
        snippetString: 'dfdl:inputValueCalc="{$1}"$0',
        markdownString: 'An expression that calculates the value of the element when parsing',
      },
      {
        item: 'dfdl:outputValueCalc=',
        snippetString: 'dfdl:outputValueCalc="{$1}"$0',
        markdownString: 'An expression that calculates the value of the current element when unparsing',
      },
      {
        item: 'dfdl:alignmentUnits=',
        snippetString: 'dfdl:alignmentUnits="${1|bits,bytes|}"$0',
        markdownString: "Scales the alignment.\nCan only be used when alignment is bits or bytes.\nValid values are 'bits or 'bytes'.",
      },
      {
        item: 'dfdl:terminator=',
        snippetString: 'dfdl:terminator="$1"$0',
        markdownString: 'charater or bytes found in the input stream that designate termination of an element',
      },
      {
        item: 'dfdl:outputNewLine=',
        snippetString: 'dfdl:outputNewLine="${1|%CR,%LF,%CR%LF,%NEL,%LS|}"$0',
        markdownString: 'Specifies the character or characters that are used to replace the %NL; character class entity during unparse',
      },
      {
        item: 'dfdl:choiceBranchKey=',
        snippetString: 'dfdl:choiceBranchKey="$1"$0',
        markdownString: 'List of DFDL String Literals',
      },
      {
        item: 'dfdl:representation',
        snippetString: 'dfdl:representation="${1|binary,text|}"$0',
      },
      {
        item: 'dfdl:hiddenGroupRef=',
        snippetString: 'dfdl:hiddenGroupRef="$1"$0',
        markdownString: 'Specifies ',
      },
      {
        item: 'dfdl:sequenceKind=',
        snippetString: 'dfdl:SequenceKind ="${1|ordered,unordered|}"$0',
      },
      {
        item: 'dfdl:separator=',
        snippetString: 'dfdl:separator="$1"$0',
      },
      {
        item: 'dfdl:separatorPosition=',
        snippetString: 'dfdl:separatorPosition="${1|infix,postfix.prefix|}$0',
      },
      {
        item: 'dfdl:separatorSuppressionPolicy',
        snippetString: 'dfdl:separatorSuppressionPolicy="${1|anyEmpty,never,trailingEmptytrailingEmptyStrict|}"$0',
      },
      {
        item: 'dfdl:choiceLengthKind=',
        snippetString: 'dfdl:choiceLengthKind="${1|explicit,Implicit|}"$0',
        markdownString: 'Valid values are implicit and explicit',
      },
      {
        item: 'dfdl:choiceLength=',
        snippetString: 'dfdl:choiceLength="$1"$0',
        markdownString: 'Only used when dfdl:choiceLengthKind is explicit',
      },
      {
        item: 'dfdl:intiatedContent=',
        snippetString: 'dfdl:intiatedContent="${1|yes,no}"$0',
        markdownString: 'yes indicates all branches of a choice are initiated\no indicates the branch dfdl:initator property may be ste to empty string',
      },
      {
        item: 'dfdl:choiceDispatchKey=',
        snippetString: 'dfdl:choiceDispatchKey="$1"$0',
        markdownString: 'The expression must evaluate to a string',
      },
      {
        item: 'dfdl:simpleType',
        snippetString: '<xs:annotation>\n\t<xs:appinfo source="http://www.ogf.org/dfdl/">\n\t\trepresentation="${1|binary,|"\n\t</xs:appinfo>\n</xs:annotation>$0',
      },
      {
        item: 'xs:restriction',
        snippetString: '<xs:restriction base="${1|xs:string,xs:decimal,xs:float,xs:double,xs:integer,xs:nonNegativeInteger,xs:int,xs:unsignedInt,xs:short,xs:unsignedShort,xs:long,xs:unsignedLong,xs:byte,xs:unsignedByte,xs:hexBinary,xs:boolean|}"/>$0',
      },
    ],
  }
}