clonkk / nim-cppstl Goto Github PK

View Code? Open in Web Editor NEW

51.0 5.0 8.0 226 KB

Nim Bindings for C++ STL stuff

Home Page: https://clonkk.github.io/nim-cppstl/

License: MIT License

Nim 100.00%

nim cpp11 hacktoberfest

nim-cppstl's Introduction

Nim bindings for the C++ STL

Introduction

This library is a Nim wrapper for C++ Standard Template Library (STL) class. This library is obviously only compatible with the C++ backend

I recommand using this bindings only in two cases:

When wrapping a C++ library (But make sure to offer a Nim idomatic API that does not expose the STL to the user if possible).
In some performance critical code where the cost of converting Nim types to c++ types is problematic (like embeded devices).

Installation

nimble install cppstl

Add the following lines to your .nimble:

backend = "cpp"
requires "cppstl"

Limitations

cppstl currently wraps :

std::string
std::basic_string
std::vector
std::complex
std::pair
Smart pointers are partially supported:
- std::unique_ptr
- std::shared_ptr

Contributions

All contributions are welcome!

If there is a missing function or class, that you need, don't be shy to open an issue or a PR.

Running Tests

nimble test

testament p "tests/t*.nim"

Usage

The documentation is here : https://clonkk.github.io/nim-cppstl/cppstl.html

You can find more use-case in the tests folder.

License

This code is licensed under MIT license (see LICENSE.txt for details)

nim-cppstl's People

Contributors

Stargazers

Watchers

Forkers

stephenwithav yssource kaushalmodi timotheecour vindaar z------------- mantielero dseeni

nim-cppstl's Issues

Examples of using the VecIterator and VecConstIterator

Hello,

Can you please add some examples/tests on how to use the *Iterator based procs like begin, end, insert, etc?

Collaborate on the std::vector wrapper?

Hello,

I started wrapping the std::vector in Nim with doc strings and tests in https://github.com/kaushalmodi/std_vector.

Would you like to merge the two libraries into yours? If so, I can send a PR that merges my comments and tests into your repo?

Ref: kaushalmodi/std_vector#3

Error: static assertion failed

Hi there, I'm getting multiples errors while compiling a dll

my ffi.nim files only contains an import:

import cppstl/std_string

compile:

nim c --cpu:i386 -d:release --app:lib --nomain ffi.nim

D:\nim\lib/nimbase.h:550:30: error: static assertion failed
550 | NIM_STATIC_ASSERT(sizeof(NI) == sizeof(void*) && NIM_INTBITS == sizeof(NI)*8, "");
D:\nim\lib/nimbase.h:278:50: note: in definition of macro 'NIM_STATIC_ASSERT'
278 | #define NIM_STATIC_ASSERT(x, msg) static_assert((x), msg)
|

Nim Compiler Version 1.6.6 [Windows: i386]

../src/cppstl/vector.nim(10, 14) Error: invalid indentation

I cloned the repo and updated cppstl.nim to try this with 0.19.6.

The file is indented correctly, but fails. Do you have any idea why?

doesn't work with destructors

continuing of kaushalmodi/std_vector#4 since the other repo was merged here

example

when defined case2:
  import cppstl/std_vector
  type Foo = object
    x: int
  proc `=destroy`*(a: var Foo) {.inline.} =
    echo ("in destroy", a.x)
  proc main =
    var v1 = initCppVector[Foo]()
    echo v1
    var v = initCppVector[Foo]()
    v.add Foo(x: 10)
    v.add Foo(x: 11)
    v.add Foo(x: 12)
    echo "ok0"
    echo v
    echo "ok1"
    echo v
    echo "ok2"
  main()

gives:

[]
ok0
("in destroy", 10)
("in destroy", 11)
("in destroy", 12)
[(x: 10), (x: 11), (x: 12)]
ok1
("in destroy", 10)
("in destroy", 11)
("in destroy", 12)
[(x: 10), (x: 11), (x: 12)]
ok2

(with both gc:arc|refc)

expected result

same as for here, with seq instead of vector:

when defined case3:
  import cppstl/std_vector
  type Foo = object
    x: int
  proc `=destroy`*(a: var Foo) {.inline.} =
    echo ("in destroy", a.x)
  proc main =
    var v: seq[Foo]
    v.add Foo(x: 10)
    v.add Foo(x: 11)
    v.add Foo(x: 12)
    echo "ok0"
    echo v
    echo "ok1"
    echo v
    echo "ok2"
  main()

with --gc:arc and --gc:refc, this gives:

ok0
@[(x: 10), (x: 11), (x: 12)]
ok1
@[(x: 10), (x: 11), (x: 12)]
ok2
("in destroy", 10)
("in destroy", 11)
("in destroy", 12)

as it should