aboutsummaryrefslogtreecommitdiff
path: root/pages/projects/codepoint_iterator.md
diff options
context:
space:
mode:
Diffstat (limited to 'pages/projects/codepoint_iterator.md')
-rw-r--r--pages/projects/codepoint_iterator.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/pages/projects/codepoint_iterator.md b/pages/projects/codepoint_iterator.md
index e202571..6da24ea 100644
--- a/pages/projects/codepoint_iterator.md
+++ b/pages/projects/codepoint_iterator.md
@@ -4,6 +4,8 @@
The source code is available on both my [Github] profile and [cgit].
+For readers versed in German a [blog article] describing the implementation in a more detailed manner is available.
+
## Current features
* Bidirectional iteration through unicode codepoints
@@ -11,5 +13,24 @@ The source code is available on both my [Github] profile and [cgit].
* Dereferencing an instance of the iterator yields the codepoint as `char32_t`
* Unit Tests based on GoogleTest
+## Usage example
+
+While all features of this class are demonstrated by Google-Test based [Unit-Tests] we can see a basic `UTF8::CodepointIterator` usage example in the following code snippet. The [example text] is written in Old Norse runes.
+
+
+~~~
+std::string test(u8"ᛖᚴ ᚷᛖᛏ ᛖᛏᛁ ᚧ ᚷᛚᛖᚱ ᛘᚾ ᚦᛖᛋᛋ ᚨᚧ ᚡᛖ ᚱᚧᚨ ᛋᚨᚱ");
+
+for ( UTF8::CodepointIterator iter(test.cbegin());
+ iter != test.cend();
+ ++iter ) {
+ std::wcout << static_cast<wchar_t>(*iter);
+}
+~~~
+{: .language-cpp}
+
[Github]: https://github.com/KnairdA/CodepointIterator
[cgit]: http://code.kummerlaender.eu/CodepointIterator/
+[Unit-Tests]: https://github.com/KnairdA/CodepointIterator/blob/master/test.cc
+[example text]: http://www.columbia.edu/~fdc/utf8/
+[blog article]: /article/notizen_zu_cpp_und_unicode