simple_block_markup_language

(en)Japanese ver is here.
(ja)この解説の日本語版はここにあります。

Overview

This package contains a working implementation of Simple Block Markup Language (SpBML). SpBML is a simple markup language that describes block elements in an easy-to-see format. Files output in this format have the extension .spbml. Character encoding always uses UTF-8. Line feed code always uses LF (Line Feed).

Usage

Description method

The basic form is as follows.

(type, parameter1:value1, parameter2:value2,...)content

The comment line is as follows.

// comment text

new line

Start a new line with a normal line feed code.
Line breaks at the end of the sentence are ignored.

(a, b:ccc, d:eee)abcdef
ghijklmn
opqrstu...

Nested structure

Elements with a + mark at the beginning are nested elements.
Which element is a child element depends on the position of the element and the number of + marks. There are no nesting symbols or anything like that in the content area.

(a, b:ccc, d:eee)abcdef
+(f)ghijklmn
opqrstu
+(g)vwxyz

In the example above, elements of (f) and (g) are child elements of elements of (a).

Escape sequence

Escapes are normally required only within parentheses denoting types and parameters. To write a + sign, parentheses, commas, backslashes, etc. as parameter values, write one backslash in front. Note that if you write directly as text in the code instead of reading the file,
the backslash itself will be you will need one extra to receive the Dart escape. As an exception, if you want to include a line in the content area that begins with a combination of a + sign and parentheses, write (esc) at the beginning. Note that type, parameter keys and parameter values cannot contain line feed.

(a, b:c\\ cc, d:eee)abcdef
+(f)ghijklmn
(esc)+(f2)opqrstu
+(g)vwxyz

Reserved word

Regarding types, esc and root are reserved and cannot be used.

Flutter code sample

The add method automatically assigns a serial number that increases by one. If you want to assign manually, use the set method. Blocks can also be searched using the included utility.

import 'package:flutter/material.dart';
import 'package:simple_block_markup_language/simple_block_markup_language.dart';

void main() {
  // create block
  SpBMLBuilder b1 = SpBMLBuilder();
  b1.add("typeA", {"parameter": "A"}, "Content Text A");
  b1.add("typeB", {"parameter": "B"}, "Content Text B");
  b1.add("typeC", {"parameter": "C"}, "Content Text C", parentSerial: 1);
  SpBMLBuilder b2 = SpBMLBuilder();
  b2.set(0, "typeA", {"parameter": "A"}, "Content Text A");
  b2.set(1, "typeB", {"parameter": "B"}, "Content Text B");
  b2.set(2, "typeC", {"parameter": "C"}, "Content Text C", parentSerial: 1);
  debugPrint(b1.build());
  debugPrint((b1.build() == b2.build()).toString());
  // search block by type.
  List<SpBMLBlock>? s1 = UtilSpBMLSearch.blockType(b1.getBlockList(), ["typeC"]);
  debugPrint((s1![0].type == "typeC").toString());
  // search block by nest level.
  List<SpBMLSearchParam> sp1 = [SpBMLSearchParam(EnumSpBMLOperator.equal, 1)];
  List<SpBMLBlock>? s2 = UtilSpBMLSearch.blockNestLevel(
          b1.getBlockList(),
          [SpBMLSearcher(sp1, EnumSpBMLLogicalOperator.opAnd)],
          EnumSpBMLLogicalOperator.opAnd);
  debugPrint((s2![0].type == "typeC").toString());
  // search block by content
  List<SpBMLSearchParam> sp2 = [
    SpBMLSearchParam(EnumSpBMLOperator.equal, "Content Text C")
  ];
  List<SpBMLBlock>? s3 = UtilSpBMLSearch.blockContent(
          b1.getBlockList(),
          [SpBMLSearcher(sp2, EnumSpBMLLogicalOperator.opAnd)],
          EnumSpBMLLogicalOperator.opAnd);
  debugPrint((s3![0].type == "typeC").toString());
  // search block by parameter
  List<SpBMLSearchParam> sp3 = [SpBMLSearchParam(EnumSpBMLOperator.equal, "C")];
  List<SpBMLBlock>? s4 = UtilSpBMLSearch.blockParams(
          b1.getBlockList(),
          "parameter",
          [SpBMLSearcher(sp3, EnumSpBMLLogicalOperator.opAnd)],
          EnumSpBMLLogicalOperator.opAnd);
  debugPrint((s4![0].type == "typeC").toString());
}

Support

If you need paid support for any reason, please contact my company.
This package is developed by me personally, but may be supported via the company.
SimpleAppli Inc.

Format name

Simple Block Markup Language

Extension

.spbml

MIME Type (Temporary)

text/x.spbml

About version control

The C part will be changed at the time of version upgrade.

  • Changes such as adding variables, structure change that cause problems when reading previous files.
    • C.X.X
  • Adding methods, etc.
    • X.C.X
  • Minor changes and bug fixes.
    • X.X.C

If the version is less than 1, there may be major corrections and changes regardless of the above.

License

This software is released under the MIT License, see LICENSE file.

The “Dart” name and “Flutter” name are trademarks of Google LLC.
*The developer of this package is not Google LLC.

Libraries

simple_block_markup_language