containers.hpp

Go to the documentation of this file.

// src/runtime/include/nk/runtime/containers.hpp
//
// Public C++ API for the key–value container objects (`containers.Map`, `dictionary`).
#pragma once
 
#include <nk/value/value.hpp>
 
#include <cstddef>
#include <memory_resource>
 
namespace nk {

 
class Engine;
}
 
namespace nk::runtime {

void registerContainersRuntime(Engine &engine);
 
namespace containers {
 
// ── Constructors ─────────────────────────────────────────────

Value map(std::pmr::memory_resource *mr = nullptr);

Value dictionary(std::pmr::memory_resource *mr = nullptr);
 
// ── Operations (work on either container) ────────────────────

void set(Value &m, const Value &key, const Value &val);

Value get(const Value &m, const Value &key);

bool isKey(const Value &m, const Value &key);

void remove(Value &m, const Value &key);

std::size_t count(const Value &m);

Value keys(const Value &m, std::pmr::memory_resource *mr = nullptr);

Value values(const Value &m, std::pmr::memory_resource *mr = nullptr);
 
} // namespace containers
} // namespace nk::runtime
 
namespace nk::containers {
using namespace ::nk::runtime::containers;

}