Fixed defines

Author: rijnb

CMakeLists.txt

@@ -21,9 +21,14 @@ 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
 #
-# And add -DNO_POSIX_THREADS to the compiler options if you do not want to use multi-threaded unit testing.
+# Compiler directives:
+#
+# NO_POSIX_THREADS      - No multi-threaded unit testing.
+# NO_FAST_ENCODE        - Drop fast encoding support.
+# NO_SUPPORT_ALPHABETS  - Drop alphabet support.
+# LIMIT_TO_MICRODEGREES - Limit mapcode utility using microdegrees.
 
-set(CMAKE_C_FLAGS_DEBUG "-O0 -g -DDEBUG -Wall -fsanitize=address -fno-common -fno-optimize-sibling-calls -fno-omit-frame-pointer")
+set(CMAKE_C_FLAGS_DEBUG "-O0 -DNO_FAST_ENCODE -DNO_ALPHABET_SUPPORT -g -DDEBUG -Wall -fsanitize=address -fno-common -fno-optimize-sibling-calls -fno-omit-frame-pointer")
 set(CMAKE_C_FLAGS_RELWITHDEBINFO "-O2 -g -DDEBUG")
 set(CMAKE_C_FLAGS_RELEASE "-O3 -DNDEBUG")
 

README.md

@@ -9,7 +9,7 @@
 
 **Latest stable release: https://github.com/mapcode-foundation/mapcode-cpp/releases**
 
-# The C/C++ Library: `mapcodelib/`
+## The C/C++ Library: `mapcodelib/`
 
 The directory 'mapcodelib' contains the files:
 
@@ -45,7 +45,7 @@ In that case, basics.h will state a version number of the for:
 where "xxx" states the geographical limitation.
 
 
-# A Real-Life Example, The 'mapcode' Codec Tool: `utility/`
+## A Real-Life Example, The 'mapcode' Codec Tool: `utility/`
 
 The directory 'utility' contains a Mapcode encoding/decoding utility, as an example
 of how to use the library.
@@ -121,15 +121,38 @@ This produces the following help text:
            The result code is 0 when no error occurred, 1 if an input error occurred and 2
            if an internal error occurred.
 
-If you use **Microsoft Visual C++**, you may need to add the following defines to your preprocessor
-settings:
+## Compile Options for Microsoft Visual C++
 
-    NO_POSIX_THREADS
-    _CRT_SECURE_NO_WARNINGS
-    _CRT_NONSTDC_NO_DEPRECATE
+If you use **Microsoft Visual C++**, you may need to add the following compiler directives to your build:
 
+    -DNO_POSIX_THREADS
+    -D_CRT_SECURE_NO_WARNINGS
+    -D_CRT_NONSTDC_NO_DEPRECATE
 
-# Release Notes
+## Reducing the Footprint of the Mapcode Library
+
+The Mapcode C/C++ Library has includes a number of fixed data tables, which increase its footprint.
+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).
+
+You can disabled alphabet support by adding the following compiler directive:
+ 
+    -DNO_SUPPORT_ALPHABETS
+
+### Removing Fast Encoding Support: NO_FAST_ENCODE
+
+By default, encoding is optimized by the use of a additional data table (approx. 12K). You can
+remove this table from the library by adding the compiler directive:
+
+    -DNO_FAST_ENCODE
+
+## Release Notes
 
 ### 2.4.1
 

mapcodelib/internal_data.h

@@ -16,6 +16,9 @@
 #ifndef __INTERNAL_DATA_H__
 #define __INTERNAL_DATA_H__
 
+#ifdef __cplusplus
+extern "C" {
+#endif
 
 // *** GENERATED FILE (coords.cpp), DO NOT CHANGE OR PRETTIFY ***
 
@@ -16541,5 +16544,9 @@ static const TerritoryBoundary territoryBoundaries[MAPCODE_BOUNDARY_MAX + 1] = {
 
 #endif // MAKE_SOURCE_DIGITAL
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif // __INTERNAL_DATA_H__
 

mapcodelib/internal_iso3166_data.h

@@ -17,6 +17,10 @@
 #ifndef __INTERNAL_ISO3166_DATA_H__
 #define __INTERNAL_ISO3166_DATA_H__
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #include "mapcode_territories.h"
 
 // *** GENERATED FILE (dividemaps/fast_territories), DO NOT CHANGE OR PRETTIFY ***
@@ -987,4 +991,8 @@ static const alphaRec alphaSearch[NRTERREC] = {
 };
 
 // produced by dividemaps.cpp : fast_territories.cpp
+#ifdef __cplusplus
+}
+#endif
+
 #endif // __INTERNAL_ISO3166_DATA_H__

mapcodelib/internal_territory_alphabets.h

@@ -23,6 +23,10 @@
 extern "C" {
 #endif
 
+#ifdef NO_SUPPORT_ALPHABETS
+#error "NO_SUPPORT_ALPHABETS cannot be specified in this file"
+#endif
+
 #include "mapcoder.h"
 
 static const TerritoryAlphabets alphabetsForTerritory[_TERRITORY_MAX - _TERRITORY_MIN - 1] = {

mapcodelib/internal_territory_names_english.h

@@ -16,6 +16,10 @@
 #ifndef __INTERNAL_TERRITORY_NAMES_ENGLISH_H__
 #define __INTERNAL_TERRITORY_NAMES_ENGLISH_H__
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 // *** GENERATED FILE (coords.cpp), DO NOT CHANGE OR PRETTIFY ***
 static const char *isofullname[] = {
         "Vatican (Holy See)",
@@ -553,4 +557,8 @@ static const char *isofullname[] = {
         "International (Worldwide) (Earth)",
         "?"};
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif // __INTERNAL_TERRITORY_NAMES_ENGLISH_H__

mapcodelib/internal_territory_names_english_full.h

@@ -16,6 +16,10 @@
 #ifndef __INTERNAL_TERRITORY_NAMES_ENGLISH_H__
 #define __INTERNAL_TERRITORY_NAMES_ENGLISH_H__
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 // *** GENERATED FILE (coords.cpp), DO NOT CHANGE OR PRETTIFY ***
 static const char *isofullname[] = {
         "Vatican (Holy See)",
@@ -553,4 +557,8 @@ static const char *isofullname[] = {
         "International (Worldwide) (Earth)",
         "?"};
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif // __INTERNAL_TERRITORY_NAMES_ENGLISH_H__

mapcodelib/internal_territory_names_local.h

@@ -15,8 +15,15 @@
  */
 #ifndef __INTERNAL_TERRITORY_NAMES_LOCAL_H__
 #define __INTERNAL_TERRITORY_NAMES_LOCAL_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
 // *** GENERATED FILE (coords.cpp), DO NOT CHANGE OR PRETTIFY ***
 
+#ifdef NO_SUPPORT_ALPHABETS
+#error "NO_SUPPORT_ALPHABETS cannot be specified in this file"
+#endif
 
 /*
  * The first N names are precisely in the alphabets
@@ -560,4 +567,8 @@ static const char *localname_utf8[] = {
         "Earth",
         "?"};
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif // __INTERNAL_TERRITORY_NAMES_LOCAL_H__

mapcodelib/internal_territory_search.h

@@ -17,8 +17,17 @@
 #ifndef __INTERNAL_TERRITORY_SEARCH_H__
 #define __INTERNAL_TERRITORY_SEARCH_H__
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 // *** GENERATED FILE (dividemaps.cpp), DO NOT CHANGE OR PRETTIFY ***
 
+#ifdef NO_FAST_ENCODE
+#error
+#error "NO_FAST_ENCODE cannot be specified in this file"
+#endif
+
 static int redivar[] = {
         27984500, 1383,
         2537718, 676,
@@ -810,4 +819,9 @@ static int redivar[] = {
         TERRITORY_RU_SA, TERRITORY_RUS,
         0
 }; // 2924 records, data version 2.3.0
+
+#ifdef __cplusplus
+}
+#endif
+
 #endif // __INTERNAL_TERRITORY_SEARCH_H__

mapcodelib/mapcode_alphabets.h

@@ -16,11 +16,21 @@
 #ifndef __MAPCODE_ALPHABETS_H__
 #define __MAPCODE_ALPHABETS_H__
 
-
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+#ifdef NO_SUPPORT_ALPHABETS
+#error "NO_SUPPORT_ALPHABETS cannot be specified in this file"
+#endif
+
+/**
+ * Mapcodes are suppored in a variety of alphabets, using UTF16. The following
+ * enum specifies the alphabets (or scripts, as they are also called).
+ * The 'default' alphabet is Roman, which is always supported. Other
+ * alphabets may not be supported by every application that accepts
+ * mapcodes.
+ */
 enum Alphabet {
     _ALPHABET_MIN = -1,
     ALPHABET_ROMAN,