std/parsejson

Этот модуль реализует парсер JSON. Он используется и экспортируется модулем json стандартной библиотеки, но также может быть использован самостоятельно.

Импорты

strutils, lexbase, streams, unicode, decode_helpers

Типы

JsonError = enum
  errNone,                  ## no error
  errInvalidToken,          ## invalid token
  errStringExpected,        ## string expected
  errColonExpected,         ## `:` expected
  errCommaExpected,         ## `,` expected
  errBracketRiExpected,     ## `]` expected
  errCurlyRiExpected,       ## `}` expected
  errQuoteExpected,         ## `"` or `'` expected
  errEOC_Expected,          ## `*/` expected
  errEofExpected,           ## EOF expected
  errExprExpected            ## expr expected

перечисление, которое перечисляет все возможные ошибки Source Edit

JsonEventKind = enum
  jsonError,                ## an error occurred during parsing
  jsonEof,                  ## end of file reached
  jsonString,               ## a string literal
  jsonInt,                  ## an integer literal
  jsonFloat,                ## a float literal
  jsonTrue,                 ## the value `true`
  jsonFalse,                ## the value `false`
  jsonNull,                 ## the value `null`
  jsonObjectStart,          ## start of an object: the `{` token
  jsonObjectEnd,            ## end of an object: the `}` token
  jsonArrayStart,           ## start of an array: the `[` token
  jsonArrayEnd               ## end of an array: the `]` token

перечисление всех событий, которые могут произойти во время разбора Source Edit

JsonKindError = object of ValueError

генерируется макросом to в случае, если тип JSON неверный. Source Edit

JsonParser = object of BaseLexer
  a*: string
  tok*: TokKind

объект парсера. Source Edit

JsonParsingError = object of ValueError

генерируется при ошибке JSON Source Edit

TokKind = enum
  tkError, tkEof, tkString, tkInt, tkFloat, tkTrue, tkFalse, tkNull, tkCurlyLe,
  tkCurlyRi, tkBracketLe, tkBracketRi, tkColon, tkComma

Source Edit

Константы

errorMessages: array[JsonError, string] = ["no error", "invalid token",
    "string expected", "\':\' expected", "\',\' expected", "\']\' expected",
    "\'}\' expected", "\'\"\' or \"\'\" expected", "\'*/\' expected",
    "EOF expected", "expression expected"]

Source Edit

Процедуры

proc close(my: var JsonParser) {.inline, ...raises: [IOError, OSError],
                                 tags: [WriteIOEffect], forbids: [].}

закрывает парсер my и связанный с ним входной поток. Source Edit

proc eat(p: var JsonParser; tok: TokKind) {.
    ...raises: [IOError, OSError, JsonParsingError, ValueError],
    tags: [ReadIOEffect], forbids: [].}

Source Edit

proc errorMsg(my: JsonParser): string {....raises: [ValueError], tags: [],
                                        forbids: [].}

возвращает полезное сообщение об ошибке для события jsonError Source Edit

proc errorMsgExpected(my: JsonParser; e: string): string {....raises: [ValueError],
    tags: [], forbids: [].}

возвращает сообщение об ошибке "e ожидается" в том же формате, что и другие сообщения об ошибках Source Edit

proc getColumn(my: JsonParser): int {.inline, ...raises: [], tags: [], forbids: [].}

получить текущую колонку, до которой дошел парсер. Source Edit

proc getFilename(my: JsonParser): string {.inline, ...raises: [], tags: [],
    forbids: [].}

получить имя файла, который обрабатывает парсер. Source Edit

proc getFloat(my: JsonParser): float {.inline, ...raises: [ValueError], tags: [],
                                       forbids: [].}

возвращает число для события: jsonFloat Source Edit

proc getInt(my: JsonParser): BiggestInt {.inline, ...raises: [ValueError],
    tags: [], forbids: [].}

возвращает число для события: jsonInt Source Edit

proc getLine(my: JsonParser): int {.inline, ...raises: [], tags: [], forbids: [].}

получить текущую строку, до которой дошел парсер. Source Edit

proc getTok(my: var JsonParser): TokKind {....raises: [IOError, OSError],
    tags: [ReadIOEffect], forbids: [].}

Source Edit

proc kind(my: JsonParser): JsonEventKind {.inline, ...raises: [], tags: [],
    forbids: [].}

возвращает текущий тип события для парсера JSON Source Edit

proc next(my: var JsonParser) {....raises: [IOError, OSError],
                                tags: [ReadIOEffect], forbids: [].}

извлекает первое/следующее событие. Это управляет парсером. Source Edit

proc open(my: var JsonParser; input: Stream; filename: string;
          rawStringLiterals = false) {....raises: [IOError, OSError],
                                       tags: [ReadIOEffect], forbids: [].}

инициализирует парсер с входным потоком. Filename используется только для красивых сообщений об ошибках. Если rawStringLiterals равно true, строковые литералы сохраняются с окружающими кавычками, а последовательности escape в них также остаются нетронутыми. Source Edit

proc parseEscapedUTF16(buf: cstring; pos: var int): int {....raises: [], tags: [],
    forbids: [].}

Source Edit

proc raiseParseErr(p: JsonParser; msg: string) {.noinline, noreturn,
    ...raises: [JsonParsingError, ValueError], tags: [], forbids: [].}

генерирует исключение EJsonParsingError Source Edit

proc str(my: JsonParser): string {.inline, ...raises: [], tags: [], forbids: [].}

возвращает данные символьной строки для событий: jsonInt, jsonFloat, jsonString Source Edit