From f7b91cec4cc37f809fa985e49ef95ed732811f70 Mon Sep 17 00:00:00 2001 From: Member1221 Date: Mon, 16 Nov 2020 21:54:25 +0100 Subject: [PATCH] Update readme --- README.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9c9f41c..77a1604 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ Do note this is still work in progress and there's currently issues with D calli This library also depends on a patched C binding to angelscript that you will need to compile first, you can find that [here](https://github.com/KitsunebiGames/angelscriptc) you will also need the [patched AngelScript with D ABI support](https://github.com/KitsunebiGames/angelscript-ddecl) (GCC only right now!) # Using the binding -First compile AngelScript, the patched [AngelScript with D ABI support](https://github.com/KitsunebiGames/angelscript-ddecl) the [patched c bindings](https://github.com/KitsunebiGames/angelscriptc) **AS DYNAMIC LIBRARIES** and install the libraries to your system's library path (or whatever the heck you do on Windows) +First compile the patched [AngelScript with D ABI support](https://github.com/KitsunebiGames/angelscript-ddecl) and the [patched c bindings](https://github.com/KitsunebiGames/angelscriptc) **AS DYNAMIC LIBRARIES** and install the libraries to your system's library path (or whatever the heck you do on Windows) Then put the libraries somewhere that the D linker will be able to find them, in my case that's `/usr/lib` and `/usr/include`. You may want to ship the libraries with your application. -Once you have that sorted, just compile your application with dub and it _should_ link to the libraries, hopefully... +Once you have that sorted, just compile your application with `dub` and it _should_ link to the libraries, hopefully... # Using D strings To enable D string support register the D string subsystem in angelscript like this: @@ -22,6 +22,20 @@ To enable D string support register the D string subsystem in angelscript like t // Register all your other stuff and execute your scripts. ``` +## Returning strings from D functions to the AngelScript VM +The strings handled by angelscript are outside the garbage collector's reach, when you pass a string to AngelScript it will be copied in to non-GC memory +To return a string from a global method use the `StringPtr` helper method to get a pointer to the GC memory containing the string, from there it will be copied out of GC memory. +```d +// Returns Hello World in 3 languages (English, Japanese and Danish) +engine.registerGlobalFunction("string &getHelloString()", + () { + return StringPtr("Hello, world!\nこんにちは世界！\nHej verden!"); + } +); +``` + +Note: strings in the AngelScript VM are UTF-8 and D UTF-8 text should be compatible. + # Registering D types Currently DAngel supports registering a few D types automatically, one being **integer** enums. To register a D integer enum do the following: ```d @@ -37,9 +51,9 @@ Currently DAngel supports registering a few D types automatically, one being **i There's experimental and buggy support for registering D structs in `as.addons.dwrap`. I don't recommend using it currently, though. -# There's parts of the API missing! -I know, there's also a lot of places where I haven't done any error handling yet that will just fail silently. It will be fixed with time. - # Why does everything assert? This binding is meant to be used for gamedev so I'd prefer to avoid having a bunch of exceptions thrown and checking status IDs is imho pretty ugly. -Therefore this library prefers if you fix bugs during debug builds and have minimal error checking in release builds. \ No newline at end of file +Therefore this library prefers if you fix bugs during debug builds and have minimal error checking in release builds. + +# Where's the documentation? +I plan to write proper documentation with examples at some point when I get time. That might take a while to happen though. I highly recommend checking the [C++ documentation](https://www.angelcode.com/angelscript/sdk/docs/manual/index.html) as the APIs should be decently similar as well as the [Auto-generated documentation](http://dangel.dpldocs.info/as.html) \ No newline at end of file