spelling mistake: GetGategory should be GetCategory

[GrahamAsher]

This affects teascript::runtime_error::GetGategory, which should be renamed GetCategory.

[Florian-Thake]

Thank you very much @GrahamAsher for reporting this issue!

This is a stupid, ugly typo, which slipped through. Sorry for that, it must be fixed for sure.

The problem is, this is not only a cosmetic issue. The function is part of the public API and on top of that, it is also a virtual function.

I need to think about whether a deprecated forwarding function or a temporary opt-in macro for backward compatibility makes sense here, as I did before with other breaking changes.
Also, the fix will then come with an entry in Deprecation_and_Breaking_Changes.txt and in changelog.txt.

I will update this issue when the fix is there. Thanks again for taking the time to report it.

[GrahamAsher]

You're welcome! But I don't think this breaking change is very important in terms of user inconvenience.

There's a high probability that no-one yet uses the function, or at least that no-one has yet derived any classes from it, because to a native English speaker the typo sort of 'jumps out' and it would have been reported to you before. But in any case it's trivial for users to recompile. They won't even have to recompile if they have incorporated the TeaScript headers into their projects, as I have, until they decide to upgrade. And then a simple find-and-replace fixes everything.

I have now incorporated TeaScript into the development branch of CartoType as its official scripting language and I'm in the middle of testing it and the way it connects to the rest of CartoType. I commend your decision to make it a header-only library, which makes everything much easier.

[Florian-Thake]

Yes, maybe the likelihood is small that it will hit somebody, but it is not zero.

I will keep my promise from the README:

[...] usage of the high-level C++ API only. This API will stay backward compatible or a soft migration will be provided – except if major issues are detected or at very rare circumstances. The high-level API consists of the classes teascript::Engine / teascript::EngineBase, all public getters in teascript::ValueObject as well as everything in Exception.hpp / SourceLocation.hpp and version.h (except if otherwise noted).

I will credit you in changelog.txt as the reporter arriving together with the fix commit.

I don't know about CartoType yet. If you like you can provide a link and/or let me know what are the requirements and use cases for a script language from the perspective of CartoType. I am pleased that you decided to incorporate it. Let me know how it is going if you like.

[GrahamAsher]

@Florian-Thake CartoType is a commercial map rendering, routing, geocoding and (in the development branch) location-based offline AI library. I've been developing it and selling it since 2003.

The scripting requirement is because the standard XML-based rules format for importing map data (https://www.cartotype.com/developers/documentation/import-rules-used-by-makemap) is fast and powerful but is not a full programming language because it lacks variables, functions and loops. So if you want greater power you can drop in a <script> ... </script section containing code in a scripting language: ChaiScript up to now, but TeaScript in future.

CartoType's makemap tool runs an import script to create a map file (a .ctm1 file) and needs to run on Windows, Linux and macOS, so as soon as I have got TeaScript working on these three platforms and passing my unit tests I'll be happy. With luck that will be today.

[Florian-Thake]

Thank you for these interesting insides!
That is then basically TeaScript embedded in a custom XML. Would be great if this is working.

I am honored that you replace ChaiScript with TeaScript in your product!
I'll be happy to read the updated documentation with the then used TeaScript variant. Also, if any question arise regarding proper documentation, I will be happy to support you.

[Florian-Thake]

Commit 7bf877c fixed this issue by introducing a new GetCategory and marking the old one as deprecated.
If you like you can check and report.

EDIT: I wanted to credit you as the reporter in the changelog, but I forgot to update the text, sorry. I'll add it next commit.