swamp-core 0.1.13

Initializes the Swamp core library module, defining primitive type aliases and registering intrinsic functions.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# Swamp Core

Initializes the foundational "core" module for the [Swamp programming language](https://github.com/swamp/swamp).

## Overview

This crate is responsible for creating the initial `swamp_modules::Module` that represents the built-in core library available to all Swamp programs. It populates this module's symbol table with essential definitions required by the language and runtime.

## Key Functions

*   **Primitive Type Aliases:** Defines standard aliases like `Int`, `Float`, `String`, and `Bool` that map to the underlying primitive types (`swamp_types::Type`).
*   **Intrinsic Function Registration:** Registers numerous *intrinsic* functions. These are functions whose implementation is provided directly by the Swamp runtime/VM (often in Rust, e.g., in `swamp-core-extra`) rather than being written in Swamp code. This includes functions for:
    *   Integer and Float arithmetic/operations (`Int.abs`, `Float.sqrt`, etc.)
    *   String manipulation (`String.len`, etc.)
    *   Collection operations (`Vec.push`, `Map.get`, `Grid.set`, etc.)
*   **Type Generator Registration:** Registers built-in type generators like `Slice` and `SlicePair`.
*   **Module Creation:** Provides the `create_module` function which takes a version and returns the fully populated core `Module`.

## Installation

This crate is primarily a dependency for the Swamp compiler or tools that need to bootstrap the core environment.

```toml
[dependencies]
swamp-core = "0.1.13"
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Copyright

Copyright (c) Peter Bjorklund. All rights reserved. https://github.com/swamp/swamp