std/macrocache

Source Edit

Этот модуль предоставляет API для макросов, позволяющий собирать информацию во время компиляции по границам модулей. Его следует использовать вместо глобальных {.compileTime.} переменных, так как они нарушают инкрементальную компиляцию.

Основная функция этого модуля заключается в том, что если вы создаёте CacheTable или любые другие Cache типы с одинаковым именем в разных модулях, их содержимое будет совместно использоваться. Это означает, что вы можете заполнить CacheTable в одном модуле и перебрать его содержимое в другом.

Пример:

import std/macrocache
import std/macros

const mcTable = CacheTable"myTable"
const mcSeq = CacheSeq"mySeq"
const mcCounter = CacheCounter"myCounter"

static:
  # add new key "val" with the value `myval`
  let myval = newLit("hello ic")
  mcTable["val"] = myval
  assert mcTable["val"].kind == nnkStrLit

# Can access the same cache from different static contexts
# All the information is retained
static:
  # get value from `mcTable` and add it to `mcSeq`
  mcSeq.add(mcTable["val"])
  assert mcSeq.len == 1

static:
  assert mcSeq[0].strVal == "hello ic"

  # increase `mcCounter` by 3
  mcCounter.inc(3)
  assert mcCounter.value == 3

Типы

CacheCounter = distinct string

Счётчик во время компиляции, использует int для хранения счётчика. Source Edit

CacheSeq = distinct string

Последовательность во время компиляции NimNode. Source Edit

CacheTable = distinct string

Таблица во время компиляции пар ключ-значение.

Ключи являются string, а значения — NimNode.

Source Edit

Процедуры

proc `[]`(s: CacheSeq; i: BackwardsIndex): NimNode {....raises: [], tags: [], forbids: [].}: Возвращает i-й последний элемент из s.
Пример:

import std/macros const mySeq = CacheSeq"backTest" static: mySeq &= newLit(42) mySeq &= newLit(7) assert mySeq[^1].intVal == 7 # Last item assert mySeq[^2].intVal == 42 # Second last item
Source Edit
proc `[]`(s: CacheSeq; i: int): NimNode {.magic: "NcsAt", ...raises: [], tags: [], forbids: [].}: Возвращает i-й элемент из s.
Пример:

import std/macros const mySeq = CacheSeq"subTest" static: mySeq.add(newLit(42)) assert mySeq[0].intVal == 42
Source Edit
proc `[]`(t: CacheTable; key: string): NimNode {.magic: "NctGet", ...raises: [], tags: [], forbids: [].}: Извлекает значение NimNode по ключу t[key].
Пример:

import std/macros const mcTable = CacheTable"subTest" static: mcTable["toAdd"] = newStmtList() # get the NimNode back assert mcTable["toAdd"].kind == nnkStmtList
Source Edit
proc `[]=`(t: CacheTable; key: string; value: NimNode) {.magic: "NctPut", ...raises: [], tags: [], forbids: [].}: Вставляет пару (key, value) в t.
Предупреждение: key должен быть уникальным! Присваивание value уже существующему ключу key в таблице приведёт к ошибке компилятора.

Пример:

import std/macros const mcTable = CacheTable"subTest" static: # assign newLit(5) to the key "value" mcTable["value"] = newLit(5) # check that we can get the value back assert mcTable["value"].kind == nnkIntLit
Source Edit
proc add(s: CacheSeq; value: NimNode) {.magic: "NcsAdd", ...raises: [], tags: [], forbids: [].}: Добавляет value в s.
Пример:

import std/macros const mySeq = CacheSeq"addTest" static: mySeq.add(newLit(5)) mySeq.add(newLit("hello ic")) assert mySeq.len == 2 assert mySeq[1].strVal == "hello ic"
Source Edit
proc contains(t: CacheTable; key: string): bool {.inline, ...raises: [], tags: [], forbids: [].}: Псевдоним для hasKey для использования с оператором in.
Пример:

import std/macros const mcTable = CacheTable"containsEx" static: mcTable["foo"] = newEmptyNode() # Will be true since we gave it a value before assert "foo" in mcTable
Source Edit
proc hasKey(t: CacheTable; key: string): bool {....raises: [], tags: [], forbids: [].}: Возвращает true, если key есть в таблице t.

См. также:

процедуру contains для использования с оператором in

Пример:

import std/macros const mcTable = CacheTable"hasKeyEx" static: assert not mcTable.hasKey("foo") mcTable["foo"] = newEmptyNode() # Will now be true since we inserted a value assert mcTable.hasKey("foo")
Source Edit
proc inc(c: CacheCounter; by = 1) {.magic: "NccInc", ...raises: [], tags: [], forbids: [].}: Увеличивает счётчик c на значение by.
Пример:

static: let counter = CacheCounter"incTest" inc counter inc counter, 5 assert counter.value == 6
Source Edit
proc incl(s: CacheSeq; value: NimNode) {.magic: "NcsIncl", ...raises: [], tags: [], forbids: [].}: Добавляет value в s.
Подсказка: Это ничего не делает, если value уже присутствует в s.

Пример:

import std/macros const mySeq = CacheSeq"inclTest" static: mySeq.incl(newLit(5)) mySeq.incl(newLit(5)) # still one element assert mySeq.len == 1
Source Edit
proc len(s: CacheSeq): int {.magic: "NcsLen", ...raises: [], tags: [], forbids: [].}: Возвращает длину s.
Пример:

import std/macros const mySeq = CacheSeq"lenTest" static: let val = newLit("helper") mySeq.add(val) assert mySeq.len == 1 mySeq.add(val) assert mySeq.len == 2
Source Edit
proc len(t: CacheTable): int {.magic: "NctLen", ...raises: [], tags: [], forbids: [].}: Возвращает количество элементов в t.
Пример:

import std/macros const dataTable = CacheTable"lenTest" static: dataTable["key"] = newLit(5) assert dataTable.len == 1
Source Edit
proc value(c: CacheCounter): int {.magic: "NccValue", ...raises: [], tags: [], forbids: [].}: Возвращает значение счётчика c.
Пример:

static: let counter = CacheCounter"valTest" # default value is 0 assert counter.value == 0 inc counter assert counter.value == 1
Source Edit

Итераторы

iterator items(s: CacheSeq): NimNode {....raises: [], tags: [], forbids: [].}: Перебирает каждый элемент в s.
Пример:

import std/macros const myseq = CacheSeq"itemsTest" static: myseq.add(newLit(5)) myseq.add(newLit(42)) for val in myseq: # check that all values in `myseq` are int literals assert val.kind == nnkIntLit
Source Edit
iterator pairs(t: CacheTable): (string, NimNode) {....raises: [], tags: [], forbids: [].}: Перебирает все пары (key, value) в t.
Пример:

import std/macros const mytabl = CacheTable"values" static: mytabl["intVal"] = newLit(5) mytabl["otherVal"] = newLit(6) for key, val in mytabl: # make sure that we actually get the same keys assert key in ["intVal", "otherVal"] # all vals are int literals assert val.kind == nnkIntLit
Source Edit