strtabs

Модуль strtabs реализует эффективную хеш-таблицу, представляющую собой отображение строк на строки. Поддерживает регистрозависимый, регистронезависимый и стилистически-независимый режимы.

Пример:

var t = newStringTable()
t["name"] = "John"
t["city"] = "Monaco"
doAssert t.len == 2
doAssert t.hasKey "name"
doAssert "name" in t

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable

Пример:

var x = newStringTable(modeStyleInsensitive)
x["first_name"] = "John"
x["LastName"] = "Doe"

doAssert x["firstName"] == "John"
doAssert x["last_name"] == "Doe"

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable
doAssert "${name} lives in ${city}" % t == "John lives in Monaco"

• модуль tables для общих хеш-таблиц
• модуль sharedtables для поддержки общих хеш-таблиц
• модуль strutils для общих функций строк
• модуль json для таблично-подобной структуры, которая допускает неоднородные члены

Импорты

since, hashes, strutils, os

Типы

StringTableMode = enum
  modeCaseSensitive,        ## the table is case sensitive
  modeCaseInsensitive,      ## the table is case insensitive
  modeStyleInsensitive       ## the table is style insensitive

Описывает режим работы таблиц. Исходный код Редактировать

StringTableObj = object of RootObj
  counter: int
  data: KeyValuePairSeq
  mode: StringTableMode

Исходный код Редактировать

StringTableRef = ref StringTableObj

Исходный код Редактировать

FormatFlag = enum
  useEnvironment,           ## Use environment variable if the ``$key``
                             ## is not found in the table.
                             ## Does nothing when using `js` target.
  useEmpty,                 ## Use the empty string as a default, thus it
                             ## won't throw an exception if ``$key`` is not
                             ## in the table.
  useKey                     ## Do not replace ``$key`` if it is not found
                             ## in the table (or in the environment).

Флаги для оператора %. Исходный код Редактировать

Процедуры

proc mode(t: StringTableRef): StringTableMode {...}{.inline, raises: [], tags: [].}

Исходный код Редактировать

proc len(t: StringTableRef): int {...}{.gcsafe, extern: "nst$1", raises: [], tags: [].}

Возвращает количество ключей в t. Исходный код Редактировать

proc `[]`(t: StringTableRef; key: string): var string {...}{.gcsafe,
    extern: "nstTake", raises: [KeyError], tags: [].}

Получает значение по t[key].

Если key не содержится в t, то генерируется исключение KeyError. Можно проверить наличие ключа с помощью процедуры hasKey.

См. также:

• процедура getOrDefault
• процедура []= для вставки новой пары (ключ, значение) в таблицу
• процедура hasKey для проверки наличия ключа в таблице

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable
doAssert t["name"] == "John"
doAssertRaises(KeyError):
  echo t["occupation"]

Исходный код Редактировать

proc getOrDefault(t: StringTableRef; key: string; default: string = ""): string {...}{.
    raises: [], tags: [].}

Получает значение по t[key].

Если key не содержится в t, возвращается значение по умолчанию (если не указано, то пустая строка ("")).

См. также:

• процедура [] для получения значения по ключу
• процедура hasKey для проверки наличия ключа в таблице
• процедура []= для вставки новой пары (ключ, значение) в таблицу

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable
doAssert t.getOrDefault("name") == "John"
doAssert t.getOrDefault("occupation") == ""
doAssert t.getOrDefault("occupation", "teacher") == "teacher"
doAssert t.getOrDefault("name", "Paul") == "John"

Исходный код Редактировать

proc hasKey(t: StringTableRef; key: string): bool {...}{.gcsafe, extern: "nst$1",
    raises: [], tags: [].}

Возвращает true, если key находится в таблице t.

См. также:

• процедура getOrDefault
• процедура contains

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable
doAssert t.hasKey("name")
doAssert not t.hasKey("occupation")

Исходный код Редактировать

proc contains(t: StringTableRef; key: string): bool {...}{.raises: [], tags: [].}

Псевдоним процедуры hasKey для использования с оператором in.

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable
doAssert "name" in t
doAssert "occupation" notin t

Исходный код Редактировать

proc `[]=`(t: StringTableRef; key, val: string) {...}{.gcsafe, extern: "nstPut",
    raises: [], tags: [].}

Вставляет пару (key, value) в t.

См. также:

• процедура [] для получения значения по ключу
• процедура del для удаления ключа из таблицы

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable
t["occupation"] = "teacher"
doAssert t.hasKey("occupation")

Исходный код Редактировать

proc newStringTable(mode: StringTableMode): owned(StringTableRef) {...}{.gcsafe,
    extern: "nst$1", noSideEffect, raises: [], tags: [].}

Создаёт новую пустую таблицу строк.

См. также:

• процедура newStringTable(keyValuePairs)

Исходный код Редактировать

proc newStringTable(keyValuePairs: varargs[string]; mode: StringTableMode): owned(
    StringTableRef) {...}{.gcsafe, extern: "nst$1WithPairs", noSideEffect,
                      raises: [], tags: [].}

Создаёт новую таблицу строк с заданными парами key, value строк.

StringTableMode должен быть указан.

Пример:

var mytab = newStringTable("key1", "val1", "key2", "val2",
                           modeCaseInsensitive)

Исходный код Редактировать

proc newStringTable(keyValuePairs: varargs[tuple[key, val: string]];
                    mode: StringTableMode = modeCaseSensitive): owned(
    StringTableRef) {...}{.gcsafe, extern: "nst$1WithTableConstr", noSideEffect,
                      raises: [], tags: [].}

Создаёт новую таблицу строк с заданными кортежами (key, value) пар.

Режим по умолчанию — регистрозависимый.

Пример:

var
  mytab1 = newStringTable({"key1": "val1", "key2": "val2"}, modeCaseInsensitive)
  mytab2 = newStringTable([("key3", "val3"), ("key4", "val4")])

Исходный код Редактировать

proc clear(s: StringTableRef; mode: StringTableMode) {...}{.gcsafe, extern: "nst$1",
    raises: [], tags: [].}

Сбрасывает таблицу строк в пустое состояние, возможно, изменяя режим.

См. также:

• процедура del для удаления ключа из таблицы

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable
clear(t, modeCaseSensitive)
doAssert len(t) == 0
doAssert "name" notin t
doAssert "city" notin t

Исходный код Редактировать

proc clear(s: StringTableRef) {...}{.raises: [], tags: [].}

Сбрасывает таблицу строк в пустое состояние без изменения режима. Исходный код Редактировать

proc del(t: StringTableRef; key: string) {...}{.raises: [], tags: [].}

Удаляет key из t.

См. также:

• процедура clear для сброса таблицы в пустое состояние
• процедура []= для вставки новой пары (ключ, значение) в таблицу

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable
t.del("name")
doAssert len(t) == 1
doAssert "name" notin t
doAssert "city" in t

Исходный код Редактировать

proc `$`(t: StringTableRef): string {...}{.gcsafe, extern: "nstDollar", raises: [],
                                      tags: [].}

Оператор $ для таблиц строк. Используется внутри при вызове echo для таблицы. Исходный код Редактировать

proc `%`(f: string; t: StringTableRef; flags: set[FormatFlag] = {}): string {...}{.
    gcsafe, extern: "nstFormat", raises: [ValueError], tags: [ReadEnvEffect].}

Оператор % для таблиц строк.

Пример:

var t = {"name": "John", "city": "Monaco"}.newStringTable
doAssert "${name} lives in ${city}" % t == "John lives in Monaco"

Исходный код Редактировать

Итераторы

iterator pairs(t: StringTableRef): tuple[key, value: string] {...}{.raises: [],
    tags: [].}

Перебирает каждую пару (key, value) в таблице t. Исходный код Редактировать

iterator keys(t: StringTableRef): string {...}{.raises: [], tags: [].}

Перебирает каждый ключ в таблице t. Исходный код Редактировать

iterator values(t: StringTableRef): string {...}{.raises: [], tags: [].}

Перебирает каждое значение в таблице t. Исходный код Редактировать