AWK.YAML-tmLanguage

name: AWK

scopeName: source.awk

fileTypes:
- awk

# References
# http://pubs.opengroup.org/onlinepubs/009695399/utilities/awk.html
# http://www.gnu.org/software/gawk/manual/html_node/index.html
# http://www.grymoire.com/Unix/Awk.html
# http://www.cs.mun.ca/~yzchen/bib/nawkUS.pdf
patterns:
- include: '#comment'
- include: '#procedure'
- include: '#pattern'

repository:

  comment:
    match: '#.*'
    name: comment.line.number-sign.awk

  procedure:
    begin: \{
    end: \}
    patterns:
    - include: '#comment'
    - include: '#procedure'
    - include: '#keyword'
    - include: '#expression'

  pattern:
    patterns:
    - include: '#regexp-as-pattern'
    - include: '#function-definition'
    - include: '#builtin-pattern'
    - include: '#expression'

  expression:
    patterns:
    - include: '#command'
    - include: '#function'
    - include: '#constant'
    - include: '#variable'
    - include: '#regexp-in-expression'
    - include: '#operator'
    - include: '#groupings'

  groupings:
    patterns:
    - match: \(
      name: meta.brace.round.awk
    - match: \)
      name: meta.brace.round.awk
    - match: \,
      name: punctuation.separator.parameters.awk

  builtin-pattern:
    match: \b(BEGINFILE|BEGIN|ENDFILE|END)\b
    name: constant.language.awk

  function-definition:
    begin: \b(function)\s+(\w+)(\()
    beginCaptures:
      '1': { name: storage.type.function.awk }
      '2': { name: entity.name.function.awk }
      '3': { name: punctuation.definition.parameters.begin.awk }
    end: \)
    endCaptures:
      '0': { name: punctuation.definition.parameters.end.awk }
    patterns:
    - match: \b(\w+)\b
      name: variable.parameter.function.awk
    - match: \b(,)\b
      name: punctuation.separator.parameters.awk

  constant:
    patterns:
    - include: '#numeric-constant'
    - include: '#string-constant'

  numeric-constant:
    match: \b[0-9]+(?:\.[0-9]+)?(?:e[+-][0-9]+)?\b
    name: constant.numeric.awk
    
  string-constant:
    begin: '"'
    beginCaptures:
      '0': { name: punctuation.definition.string.begin.awk }
    end: '"'
    endCaptures:
      '0': { name: punctuation.definition.string.end.awk }
    name: string.quoted.double.awk
    patterns:
    - include: '#escaped-char'

  escaped-char:
    match: \\(?:[\\abfnrtv/"]|x[0-9A-Fa-f]{2}|[0-7]{3})
    name: constant.character.escape.awk

  regexp-as-pattern:
    begin: /
    beginCaptures:
      '0': { name: punctuation.definition.regex.begin.awk  }
    end: /
    endCaptures:
      '0': { name: punctuation.definition.regex.end.awk }
    contentName: string.regexp
    patterns:
    - include: source.regexp

  # To avoid ambiguity with division operators regexps are only
  # valid in places were division is not.
  regexp-in-expression:
    patterns:
    - include: '#regex-as-assignment'
    - include: '#regex-as-comparison'
    - include: '#regex-as-first-argument'
    - include: '#regex-as-nth-argument'

  regex-as-assignment:
    begin: ([^=<>!+\-*/%^]=)\s*(/)
    beginCaptures:
      '1': { name: keyword.operator.assignment.awk }
      '2': { name: punctuation.definition.regex.begin.awk }
    end: /
    endCaptures:
      '0': { name: punctuation.definition.regex.end.awk }
    contentName: string.regexp
    patterns:
    - include: source.regexp

  regex-as-comparison:
    begin: (!?~)\s*(/)
    beginCaptures:
      '1': { name: keyword.operator.comparison.awk }
      '2': { name: punctuation.definition.regex.begin.awk }
    end: /
    endCaptures:
      '0': { name: punctuation.definition.regex.end.awk }
    contentName: string.regexp
    patterns:
    - include: source.regexp

  regex-as-first-argument:
    begin: (\()\s*(/)
    beginCaptures:
      '1': { name: meta.brace.round.awk }
      '2': { name: punctuation.definition.regex.begin.awk }
    end: /
    endCaptures:
      '0': { name: punctuation.definition.regex.end.awk }
    contentName: string.regexp
    patterns:
    - include: source.regexp

  regex-as-nth-argument:
    begin: (,)\s*(/)
    beginCaptures:
      '1': { name: punctuation.separator.parameters.awk }
      '2': { name: punctuation.definition.regex.begin.awk }
    end: /
    endCaptures:
      '0': { name: punctuation.definition.regex.end.awk }
    contentName: string.regexp
    patterns:
    - include: source.regexp

  variable:
    patterns:
    - match: \$[0-9]+
      name: variable.language.awk
    - match: \b(?:FILENAME|FS|NF|NR|OFMT|OFS|ORS|RS)\b
      name: variable.language.awk
    - match: \b(?:ARGC|ARGV|CONVFMT|ENVIRON|FNR|RLENGTH|RSTART|SUBSEP)\b
      name: variable.language.nawk
    - match: \b(?:ARGIND|ERRNO|FIELDWIDTHS|IGNORECASE|RT)\b
      name: variable.language.gawk
      
  keyword:
    match: \b(?:break|continue|do|while|exit|for|if|else|return)\b
    name: keyword.control.awk

  command:
    patterns:
    - match: \b(?:next|print|printf)\b
      name: keyword.other.command.awk
    - match: \b(?:close|getline|delete|system)\b
      name: keyword.other.command.nawk
    - match: \b(?:fflush|nextfile)\b
      name: keyword.other.command.bell-awk

  function:
    patterns:
    - match: \b(?:exp|int|log|sqrt|index|length|split|sprintf|substr)\b
      name: support.function.awk
    - match: \b(?:atan2|cos|rand|sin|srand|gsub|match|sub|tolower|toupper)\b
      name: support.function.nawk
    - match: \b(?:gensub|strftime|systime)\b
      name: support.function.gawk

  operator:
    patterns:
    - match: (!?~|[=<>!]=|[<>])
      name: keyword.operator.comparison.awk
    - match: \b(in)\b
      name: keyword.operator.comparison.awk
    - match: ([+\-*/%^]=|\+\+|--|>>|=)
      name: keyword.operator.assignment.awk
    - match: (\|\||&&|!)
      name: keyword.operator.boolean.awk
    - match: ([+\-*/%^])
      name: keyword.operator.arithmetic.awk
    - match: ([?:])
      name: keyword.operator.trinary.awk
    - match: (\[|\])
      name: keyword.operator.index.awk

uuid: 67bd1ff0-006b-4c32-8b97-8bc198777582