Release 2.5.0

Author: rijnb

CMakeLists.txt

@@ -21,36 +21,28 @@ project(mapcode_cpp)
 # export ASAN_OPTIONS=debug=true:strict_string_checks=1:detect_stack_use_after_return=true:detect_invalid_pointer_pairs=99999:
 #   detect_container_overflow=true:detect_odr_violation=2:check_initialization_order=true
 #
-# Compiler directives, only for internal use:
+# Compiler directives (for internal use only):
 #
-# NO_POSIX_THREADS      - No multi-threaded unit testing.
-# NO_FAST_ENCODE        - Drop fast encoding support.
+# NO_POSIX_THREADS      - No multi-threaded unit testing - only effective for unit test.
+# NO_FAST_ENCODE        - Drop fast encoding support - only for internal use.
 
 set(MAPCODE_OPTIONS "")
 set(MAPCODE_WARNING_OPTIONS "-Wall -Werror")
-set(MAPCODE_ADDRESS_SANITIZER_COMPILER_OPTIONS "-fsanitize=address -fno-common -fno-optimize-sibling-calls -fno-omit-frame-pointer")
-set(MAPCODE_ADDRESS_SANITIZER_LINKER_OPTIONS "-fsanitize=address")
+set(MAPCODE_SANITIZER_COMPILER_OPTIONS "-fsanitize=address -fno-common -fno-optimize-sibling-calls -fno-omit-frame-pointer")
+set(MAPCODE_SANITIZER_LINKER_OPTIONS "-fsanitize=address")
 
-set(CMAKE_C_FLAGS_DEBUG "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} ${MAPCODE_ADDRESS_SANITIZER_COMPILER_OPTIONS} -O0 -g -DDEBUG")
-set(CMAKE_C_FLAGS_RELWITHDEBINFO "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} -O2 -g -DDEBUG")
+set(CMAKE_C_FLAGS_DEBUG "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} ${MAPCODE_SANITIZER_COMPILER_OPTIONS} -O0 -g -DDEBUG")
+set(CMAKE_C_FLAGS_RELWITHDEBINFO "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} ${MAPCODE_SANITIZER_COMPILER_OPTIONS} -O2 -g -DNDEBUG")
 set(CMAKE_C_FLAGS_RELEASE "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} -O3 -DNDEBUG")
 
-set(CMAKE_CXX_FLAGS_DEBUG "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} -O0 -g -DDEBUG -std=c++11")
-set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} -O2 -g -DDEBUG -std=c++11")
+set(CMAKE_CXX_FLAGS_DEBUG "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} ${MAPCODE_SANITIZER_COMPILER_OPTIONS} -O0 -g -DDEBUG -std=c++11")
+set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} ${MAPCODE_SANITIZER_COMPILER_OPTIONS} -O2 -g -DNDEBUG -std=c++11")
 set(CMAKE_CXX_FLAGS_RELEASE "${MAPCODE_OPTIONS} ${MAPCODE_WARNING_OPTIONS} -O3 -DNDEBUG -std=c++11")
 
-set(CMAKE_EXE_LINKER_FLAGS_DEBUG "${MAPCODE_ADDRESS_SANITIZER_LINKER_OPTIONS}")
-set(CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "")
+set(CMAKE_EXE_LINKER_FLAGS_DEBUG "${MAPCODE_SANITIZER_LINKER_OPTIONS}")
+set(CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "${MAPCODE_SANITIZER_LINKER_OPTIONS}")
 set(CMAKE_EXE_LINKER_FLAGS_RELEASE "")
 
-set(SOURCE_DOC_FILES
-        README.md
-        utility/README.md
-        unittest/README.md
-        docs/logo_CLion.png
-        docs/mapcode_library_c.docx
-        docs/mapcode_library_c.pdf)
-
 set(SOURCE_FILES_MAPCODELIB
         mapcodelib/internal_data.h
         mapcodelib/internal_alphabet_recognizer.h

README.md

@@ -135,21 +135,15 @@ The Mapcode C/C++ Library has includes a number of fixed data tables, which incr
 You may not require all of this data, so we've added some options for you to be able to reduce its
 footprint, for example for embedded applications. 
 
-### Removing Alphabet Support: NO_SUPPORT_ALPHABETS
-
-By default, support is included for multiple alphabets (or scripts) other than Roman, such as Greek,
-Cyrillic, Hebrew, Arabic, Chinese and many, many more. This means you can encode and decode mapcodes
-in such scripts (in UTF16).
+## Release Notes
 
-You can disabled alphabet support by adding the following compiler directive:
- 
-    -DNO_SUPPORT_ALPHABETS
+### 2.5.0
 
-## Release Notes
+* Added support for getting territory names in English and local alphabets. 
 
 ### 2.4.1
 
-* Renamed .h files to internal_*.h unless they are relevant to the interface.
+* Renamed `.h` files to `internal_*.h` unless they are relevant to the interface.
 
 * Turned territories, alphabets and error codes into enums.