Do not vendor inih

The C++ part of the library is still kept as we made changes to it.

Author: Ghabry

.github/workflows/stable-compilation.yml

@@ -36,7 +36,7 @@ jobs:
           apt-get update
           apt-get install -y --no-install-recommends --no-install-suggests \
             ca-certificates build-essential cmake ninja-build git \
-            libicu-dev libexpat1-dev
+            libicu-dev libexpat1-dev libinih-dev
 
       - name: Clone Repository
         uses: actions/checkout@v4

.gitignore

@@ -50,6 +50,11 @@ build/
 # IntelliJ / CLion
 .idea/
 
+# VS Code
+.vscode/
+.cache/
+compile_commands.json
+
 # doxygen generated files
 /doc/
 
@@ -72,3 +77,4 @@ test_runner*
 
 # distribution archives
 liblcf-*.tar.*
+

CMakeLists.txt

@@ -27,7 +27,6 @@ set(LCF_SOURCES
 	src/dbarray.cpp
 	src/dbstring_struct.cpp
 	src/encoder.cpp
-	src/ini.cpp
 	src/inireader.cpp
 	src/ldb_equipment.cpp
 	src/ldb_eventcommand.cpp
@@ -201,7 +200,6 @@ set(LCF_HEADERS
 	src/lcf/encoder.h
 	src/lcf/enum_tags.h
 	src/lcf/flag_set.h
-	src/lcf/ini.h
 	src/lcf/inireader.h
 	src/lcf/ldb/reader.h
 	src/lcf/lmt/reader.h
@@ -343,6 +341,10 @@ set_property(TARGET lcf PROPERTY WINDOWS_EXPORT_ALL_SYMBOLS ON)
 # Name of the exported library
 set_property(TARGET lcf PROPERTY EXPORT_NAME liblcf)
 
+# inih
+find_package(inih REQUIRED)
+target_link_libraries(lcf inih::inih)
+
 # icu
 set(LCF_SUPPORT_ICU 0)
 if(LIBLCF_WITH_ICU)
@@ -380,7 +382,6 @@ set_property(TARGET lcf PROPERTY SOVERSION 0)
 
 # installation
 if(LIBLCF_ENABLE_INSTALL)
-
 	# pkg-config file generation
 	set(LCF_LIBDIR ${CMAKE_INSTALL_LIBDIR})
 	if(IS_ABSOLUTE ${LCF_LIBDIR})
@@ -441,6 +442,7 @@ if(LIBLCF_ENABLE_INSTALL)
 	install(FILES
 		${CMAKE_CURRENT_BINARY_DIR}/liblcf-config.cmake
 		${CMAKE_CURRENT_BINARY_DIR}/liblcf-config-version.cmake
+		${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/Modules/Findinih.cmake
 		DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/liblcf
 	)
 

Makefile.am

@@ -34,9 +34,11 @@ liblcf_la_CXXFLAGS = \
 	-std=gnu++17 \
 	-fno-math-errno \
 	$(AM_CXXFLAGS) \
+	$(INIH_CFLAGS) \
 	$(EXPAT_CFLAGS) \
 	$(ICU_CFLAGS)
 liblcf_la_LIBADD = \
+	$(INIH_LIBS) \
 	$(EXPAT_LIBS) \
 	$(ICU_LIBS)
 liblcf_la_LDFLAGS = \
@@ -46,7 +48,6 @@ liblcf_la_SOURCES = \
 	src/dbarray.cpp \
 	src/dbstring_struct.cpp \
 	src/encoder.cpp \
-	src/ini.cpp \
 	src/inireader.cpp \
 	src/ldb_equipment.cpp \
 	src/ldb_eventcommand.cpp \
@@ -219,7 +220,6 @@ lcfinclude_HEADERS = \
 	src/lcf/encoder.h \
 	src/lcf/enum_tags.h \
 	src/lcf/flag_set.h \
-	src/lcf/ini.h \
 	src/lcf/inireader.h \
 	src/lcf/log_handler.h \
 	src/lcf/reader_lcf.h \
@@ -347,10 +347,12 @@ test_runner_CPPFLAGS = \
 test_runner_CXXFLAGS = \
 	-std=gnu++17 \
 	-DDOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING=1 \
+	$(INIH_CXXFLAGS) \
 	$(EXPAT_CXXFLAGS) \
 	$(ICU_CXXFLAGS)
 test_runner_LDADD = \
 	liblcf.la \
+	$(INIH_LIBS) \
 	$(EXPAT_LIBS) \
 	$(ICU_LIBS)
 test_runner_LDFLAGS = -no-install

README.md

@@ -14,6 +14,7 @@ Documentation is available at the documentation wiki: https://wiki.easyrpg.org
 
 ## Requirements
 
+- [inih] for INI file reading. (required)
 - [Expat] for XML reading support.
 - [ICU] for character encoding detection and conversion (recommended).
 

builds/cmake/Modules/Findinih.cmake

@@ -0,0 +1,63 @@
+#.rst:
+# Findinih
+# --------
+#
+# Find the inih Library
+#
+# Imported Targets
+# ^^^^^^^^^^^^^^^^
+#
+# This module defines the following :prop_tgt:`IMPORTED` targets:
+#
+# ``inih::inih``
+#   The ``inih`` library, if found.
+#
+# Result Variables
+# ^^^^^^^^^^^^^^^^
+#
+# This module will set the following variables in your project:
+#
+# ``INIH_INCLUDE_DIRS``
+#   where to find inih headers.
+# ``INIH_LIBRARIES``
+#   the libraries to link against to use inih.
+# ``INIH_FOUND``
+#   true if the inih headers and libraries were found.
+
+find_package(PkgConfig QUIET)
+
+pkg_check_modules(PC_INIH QUIET libinih)
+
+# Look for the header file.
+find_path(INIH_INCLUDE_DIR
+	NAMES ini.h
+	HINTS ${PC_INIH_INCLUDE_DIRS})
+
+# Look for the library.
+# Allow INIH_LIBRARY to be set manually, as the location of the inih library
+if(NOT INIH_LIBRARY)
+	find_library(INIH_LIBRARY
+		NAMES libinih inih
+		HINTS ${PC_INIH_LIBRARY_DIRS})
+endif()
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(inih
+	REQUIRED_VARS INIH_LIBRARY INIH_INCLUDE_DIR)
+
+if(INIH_FOUND)
+	set(INIH_INCLUDE_DIRS ${INIH_INCLUDE_DIR})
+
+	if(NOT INIH_LIBRARIES)
+		set(INIH_LIBRARIES ${INIH_LIBRARIES})
+	endif()
+
+	if(NOT TARGET inih::inih)
+		add_library(inih::inih UNKNOWN IMPORTED)
+		set_target_properties(inih::inih PROPERTIES
+			INTERFACE_INCLUDE_DIRECTORIES "${INIH_INCLUDE_DIRS}"
+			IMPORTED_LOCATION "${INIH_LIBRARY}")
+	endif()
+endif()
+
+mark_as_advanced(INIH_INCLUDE_DIR INIH_LIBRARY)

builds/cmake/liblcf-config.cmake.in

@@ -2,6 +2,11 @@
 
 include(CMakeFindDependencyMacro)
 
+# Required to find our installed Findinih.cmake
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}")
+
+find_dependency(inih REQUIRED)
+
 if(@LCF_SUPPORT_ICU@)
 	find_dependency(ICU COMPONENTS i18n uc data REQUIRED)
 endif()

configure.ac

@@ -21,6 +21,8 @@ LT_INIT([win32-dll])
 AM_CONDITIONAL(CROSS_COMPILING,[test "x$cross_compiling" = "xyes"])
 
 # Checks for libraries.
+AX_PKG_CHECK_MODULES([INIH],[],[inih],[])
+
 AC_SUBST([LCF_SUPPORT_ICU],[0])
 AC_ARG_ENABLE([icu],[AS_HELP_STRING([--disable-icu],[Disable ICU encoding handling (only windows-1252 supported) [default=no]])])
 AS_IF([test "x$enable_icu" != "xno"],[

src/ini.cpp

@@ -34,7 +34,7 @@
 #include <cstdlib>
 #include <cstring>
 #include <istream>
-#include "lcf/ini.h"
+#include <ini.h>
 #include "lcf/inireader.h"
 
 namespace lcf {