grammar.yug

meta:
  id: apt_source
  title: Config file used by `apt` tool
  license: Unlicense
  class: LL
doc: A grammar for parsing `apt` config files.


chars:
  - id: WS
    wellknown: whitespace
  - id: PunctuationAllowedInOptionValue
    alt: /.
  - id: OptionsStart
    lit: '['
  - id: OptionsEnd
    lit: ']'
  - id: OptionNameValueSeparator
    lit: '='
  - id: CommentMarker
    lit: '#'
  - id: Plus
    lit: +
  - id: Colon
    lit: ':'
  - id: OptionsSeparator
    lit: ','
  - id: Dash
    lit: '-'
  - id: SingleTick
    lit: "'"
  - id: DoubleTick
    lit: '"'
  - id: WordChar
    alt:
      - wellknown: ascii_lowercase
      - wellknown: ascii_uppercase
      - wellknown: digits
      - lit: _
  - id: NonWhitespaceNonOptionValueNonSquareRightBracketNonEq
    alt:
      - ref: WS
      - ref: WordChar
      - ref: PunctuationAllowedInOptionValue
      - lit: \
      - ref: OptionsStart
      - ref: OptionsEnd
      - ref: CommentMarker
      - ref: Plus
      - ref: Colon
      - ref: OptionNameValueSeparator
      - ref: OptionsSeparator
      - ref: Dash
      - ref: SingleTick
      - ref: DoubleTick
    negative: true
keywords:
  - id: TypeR
    alt:
      - lit: deb
      - lit: deb-src
  - id: OptionName
    alt:
      - lit: arch
      - lit: lang
      - lit: target
      - lit: pdiffs
      - lit: by-hash
      - lit: valid-until-max
      - lit: allow-downgrade-to-insecure
      - lit: allow-weak
      - lit: allow-insecure
      - lit: trusted
      - lit: signed-by
      - lit: check-valid-until
      - lit: valid-until-min
      - lit: check-date
      - lit: inrelease-path
      - lit: date-max-future
  - id: CdromSchema
    lit: 'cdrom:'
tokens:
  - id: Word
    ref: WordChar
    min: 1
    prefer: shift
  - id: WSS
    ref: WS
    min: 1
fragmented:
  - id: wordWithDashSegment
    alt:
      - ref: Word
      - ref: Dash
    
  - id: wordWithDash
    ref: wordWithDashSegment
    min: 1

  - id: optionValueSegment
    alt:
      - ref: Word
      - ref: PunctuationAllowedInOptionValue
      - ref: Dash
      - ref: OptionName
      - ref: CdromSchema
      - ref: TypeR
      - ref: Plus
      - ref: Colon

  - id: nonSquareBracketStringSegment
    alt:
      - ref: NonWhitespaceNonOptionValueNonSquareRightBracketNonEq
      - ref: optionValueSegment
      - ref: OptionNameValueSeparator

  - id: nonSpaceStringSegment
    alt:
      - ref: nonSquareBracketStringSegment
      - ref: OptionsEnd


  - id: optionValue
    ref: optionValueSegment
    min: 1

  - id: nonSquareBracketString
    ref: nonSquareBracketStringSegment
    min: 1

  - id: nonSpaceString
    ref: nonSpaceStringSegment
    min: 1
    
  - spacer: 1
  - id: singleTickEnclosedString
    seq:
      - ref: SingleTick
      - ref: nonSquareBracketString
      - ref: SingleTick

  - id: doubleTickEnclosedString
    seq:
      - ref: DoubleTick
      - ref: nonSquareBracketString
      - ref: DoubleTick
  - id: tickEnclosedString
    alt:
      - ref: singleTickEnclosedString
      - ref: doubleTickEnclosedString
  - id: enclosedString
    seq:
      - ref: OptionsStart
      - ref: tickEnclosedString
      - ref: OptionsEnd
  - id: cdromURI
    seq:
      - ref: CdromSchema
      - ref: Colon
      - ref: enclosedString
      - ref: nonSpaceString

  - id: uriSchema
    seq:
      - ref: Word
        cap: word
      - ref: restSchemaWords
        cap: restWords

  - id: commenterR
    seq:
      - ref: CommentMarker
      - ref: WSS

  - id: wordWithPlus
    seq:
      - ref: Plus
      - ref: Word
        cap: word

  - id: restSchemaWords
    ref: wordWithPlus
    min: 0
  - id: genericURI
    seq:
      - ref: uriSchema
        cap: schema
      - ref: Colon
      - ref: nonSpaceString
        cap: restOfURI

  - id: uriR
    alt:
      - cap: cdrom
        ref: cdromURI
      - cap: generic
        ref: genericURI

prods:
  - id: record
    seq:
      - ref: commenterR_opt_our
        cap: commented
      - cap: rType
        ref: TypeR
      - uncap:
          ref: WSS
      - ref: optionsR_opt_our
        cap: options
      - ref: uriR
        cap: uri
      - uncap:
          ref: WSS
      - ref: wordWithDash
        cap: distribution
      - ref: componentsR
        cap: components
      - uncap:
          opt:
            ref: WSS

  - id: commenterR_opt_our
    opt:
      ref: commenterR

  - id: optionsR_opt_our
    opt:
      ref: optionsR



  - id: component
    seq:
      - ref: WSS
      - ref: wordWithDash
        cap: cId
    
  - id: componentsR
    ref: component
    min: 1
    prefer: shift
  - spacer: 1
  - id: optionsR
    seq:
      - uncap:
          ref: OptionsStart
      - ref: optionsList
        cap: pairs
      - uncap:
          ref: OptionsEnd
      - ref: WSS
    
  - id: optionsList
    seq:
      - ref: optionR
        cap: firstOption
      - ref: additionalOptions
        cap: restOptions
  - id: additionalOptions
    ref: additionalOption
    min: 0
  - id: additionalOption
    seq:
      - ref: OptionsSeparator
        cap: separator
      - ref: optionR
        cap: option
    
  - id: optionR
    seq:
      - ref: OptionName
        cap: key
      - ref: OptionNameValueSeparator
      - ref: optionValue
        cap: value