Add examples

Author: LB--

CMakeLists.txt

@@ -39,3 +39,8 @@ if(BUILD_TESTS)
 	enable_testing()
 	add_subdirectory(test)
 endif()
+
+option(BUILD_EXAMPLES "Whether to build the examples" ON)
+if(BUILD_EXAMPLES)
+	add_subdirectory(example)
+endif()

README.md

@@ -87,9 +87,10 @@ This is a header-only library, so if you don't want to build, install, and link
 Create an empty directory to use with CMake, and run CMake there with the path to this repository.
 You can simply create a `build` subfolder within this repository and run `cmake ..` or the CMake GUI.
 Specify the installation path of your choice with [`-DCMAKE_INSTALL_PREFIX=path`](https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html) if the default on your system is not to your liking.
-The tests are enabled by default, but if you aren't interested in those, set `-DBUILD_TESTS=OFF`.
 Also, be sure to set [`CMAKE_BUILD_TYPE`](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE) appropriately.
 
+The tests and examples are built by default, but if you aren't interested in those, set `-DBUILD_TESTS=OFF` and/or `-DBUILD_EXAMPLES=OFF`.
+
 Then, simply build with the generator of your choice, or ask CMake to do it for you with `cmake --build .`.
 Since this is a header-only library, the build step is only really for building the tests.
 

example/CMakeLists.txt

@@ -0,0 +1,13 @@
+
+macro(simple_example _name)
+	add_executable(example-${_name}
+		"${_name}.cpp"
+	)
+	target_link_libraries(example-${_name}
+		PUBLIC
+			utf
+	)
+endmacro()
+
+simple_example(num_code_points)
+simple_example(encode_all)

example/encode_all.cpp

@@ -0,0 +1,22 @@
+#include "utf.hpp"
+
+#include <cstdint>
+#include <cstdlib>
+#include <fstream>
+
+/**
+ * Outputs a file with all code points up to 10FFFF
+ */
+int main()
+{
+	if(std::ofstream out {"encode_all.txt", std::ios::out|std::ios::binary|std::ios::trunc})
+	{
+		for(std::uint32_t cp = 0; cp <= 0x10FFFF; ++cp)
+		{
+			out << cp << ": \"" << LB::utf::encode_code_point<char>(cp) << "\"\n";
+		}
+
+		return EXIT_SUCCESS;
+	}
+	return EXIT_FAILURE;
+}

example/num_code_points.cpp

@@ -0,0 +1,60 @@
+#include "utf.hpp"
+
+#include <cstdint>
+#include <cstdlib>
+#include <functional>
+#include <fstream>
+#include <iostream>
+#include <iterator>
+#include <string>
+#include <utility>
+
+/**
+ * Give a UTF-8 filename for a count of valid code points and invalid code units
+ */
+int main(int nargs, char const *const *args)
+{
+	if(nargs != 2)
+	{
+		std::cerr << "Please pass the filename as an argument" << std::endl;
+		return EXIT_FAILURE;
+	}
+	std::string const utf_string = [&]
+	{
+		if(std::ifstream in {args[1], std::ios::in|std::ios::binary})
+		{
+			return std::string(std::istreambuf_iterator<char>(in), {});
+		}
+		std::cerr << "Cannot find file: " << args[1] << std::endl;
+		std::exit(EXIT_FAILURE);
+	}();
+
+	std::size_t valid = 0
+	,           invalid = 0;
+	for(auto it = std::cbegin(utf_string), end = std::cend(utf_string); it != end; )
+	{
+		std::uint32_t cp {};
+		std::size_t num_code_units {};
+		auto r = std::make_pair(std::ref(it), std::ref(num_code_units));
+		r = LB::utf::read_code_point(it, end, cp);
+
+		if(num_code_units)
+		{
+			++valid;
+		}
+		else
+		{
+			++invalid;
+			++it;
+		}
+	}
+
+	std::cout
+		<< "Number of original code units: " << utf_string.size()
+		<< '\n'
+		<< "Number of valid code points: " << valid
+		<< '\n'
+		<< "Number of invalid code units: " << invalid
+		<< std::endl;
+	return EXIT_SUCCESS;
+}