Datastruct: A simple data structure markup language for prototyping

README.md

Datastruct

Datastruct is a simple markup language for representing data structures as text.

Reference:

+-------------------------------------------------------------------------------------------+
|                                                                                           |
|                                                                                           |
|                                  >>>    REFERENCE    <<<                                  |
|                                                                                           |
|                                                                                           |
|   <type>                      one item of <type> at this position                         |
|   <type>s                     one or multiple items of <type> at this position            |
|   <type>?                     optional item/items of <type> at this position              |
|   *<type>                     reference to item of <type>                                 |
|   <type>|*                    direct or reference to item of type                         |
|   <type1> / <type2> / ...     type alternatives (only one of the types allowed)           |
|   <type1> + <type2> + ...     type alternatives (both types in the same place allowed)    |
|   > <type>: element           types can have functions that generate related elements     |
|                                                                                           |
|                                                                                           |
|   type (comment)              types can be commented                                      |
|                                                                                           |
|   # multiline comment                                                                     |
|   type                        multiline comments should be placed above types             |
|                                                                                           |
+-------------------------------------------------------------------------------------------+

datastruct.sublime-syntax

%YAML 1.2
---
# See http://www.sublimetext.com/docs/3/syntax.html
file_extensions:
  - datastruct.txt
scope: text.datastruct

contexts:
  # The prototype context is prepended to all contexts but those setting
  # meta_include_prototype: false.
  prototype:
    - include: comments

  main:
    # The main context is the initial starting point of our syntax.
    # Include other contexts from here (or specify them directly).
    - include: references
    - include: alternatives
    - include: optionals
    - include: generators

  references:
    - match: '\*'
      scope: keyword.control.import.datastruct
    - match: '\|(?=\*)'
      scope: string.regexp.datastruct

  alternatives:
    - match: '\+|\/'
      scope: string.other.datastruct

  optionals:
    - match: '\?'
      scope: variable.parameter.datastruct

  generators:
    - match: '\>(?= .+?\: \w+)'
      scope: entity.other.inherited-class.datastruct

  comments:
    - match: '#'
      scope: punctuation.definition.comment.datastruct
      push:
        # This is an anonymous context push for brevity.
        - meta_scope: comment.line.double-slash.datastruct
        - match: $\n?
          pop: true
    - match: '\(.+\)'
      scope: punctuation.definition.comment.datastruct

LICENSE

MIT License

Copyright (c) 2018 by shad1w (Michael G.)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.