remove get_ again

Author: andiwand

src/odr/global_params.cpp

@@ -63,11 +63,9 @@ void GlobalParams::set_pdf2htmlex_data_path(const std::string &path) {
 }
 
 GlobalParams::GlobalParams()
-    : m_odr_core_data_path{internal::project_info::get_odr_data_path()},
-      m_fontconfig_data_path{
-          internal::project_info::get_fontconfig_data_path()},
-      m_poppler_data_path{internal::project_info::get_poppler_data_path()},
-      m_pdf2htmlex_data_path{
-          internal::project_info::get_pdf2htmlex_data_path()} {}
+    : m_odr_core_data_path{internal::project_info::odr_data_path()},
+      m_fontconfig_data_path{internal::project_info::fontconfig_data_path()},
+      m_poppler_data_path{internal::project_info::poppler_data_path()},
+      m_pdf2htmlex_data_path{internal::project_info::pdf2htmlex_data_path()} {}
 
 } // namespace odr

src/odr/internal/git_info.cpp.in

@@ -2,7 +2,7 @@
 
 namespace odr::internal {
 
-const char *git_info::get_commit() noexcept { return "@GIT_HEAD_SHA1@"; }
+const char *git_info::commit_hash() noexcept { return "@GIT_HEAD_SHA1@"; }
 
 bool git_info::is_dirty() noexcept { return @GIT_IS_DIRTY@; }
 

src/odr/internal/git_info.hpp

@@ -2,7 +2,7 @@
 
 namespace odr::internal::git_info {
 
-const char *get_commit() noexcept;
+const char *commit_hash() noexcept;
 bool is_dirty() noexcept;
 
 } // namespace odr::internal::git_info

src/odr/internal/project_info.cpp.in

@@ -2,7 +2,7 @@
 
 namespace odr::internal {
 
-const char *project_info::get_version() noexcept { return "${CMAKE_PROJECT_VERSION}"; }
+const char *project_info::version() noexcept { return "${CMAKE_PROJECT_VERSION}"; }
 
 bool project_info::is_debug() noexcept {
 #ifdef NDEBUG
@@ -28,19 +28,19 @@ bool project_info::has_pdf2htmlex() noexcept{
 #endif
 }
 
-const char *project_info::get_odr_data_path() noexcept {
+const char *project_info::odr_data_path() noexcept {
   return "${ODR_DATA_PATH}";
 }
 
-const char *project_info::get_fontconfig_data_path() noexcept {
+const char *project_info::fontconfig_data_path() noexcept {
   return "${FONTCONFIG_PATH}";
 }
 
-const char *project_info::get_poppler_data_path() noexcept {
+const char *project_info::poppler_data_path() noexcept {
         return "${POPPLER_DATA_DIR}";
 }
 
-const char *project_info::get_pdf2htmlex_data_path() noexcept{
+const char *project_info::pdf2htmlex_data_path() noexcept{
         return "${PDF2HTMLEX_DATA_DIR}";
 }
 

src/odr/internal/project_info.hpp

@@ -2,14 +2,14 @@
 
 namespace odr::internal::project_info {
 
-const char *get_version() noexcept;
+const char *version() noexcept;
 bool is_debug() noexcept;
 
 bool has_wvware() noexcept;
 bool has_pdf2htmlex() noexcept;
-const char *get_odr_data_path() noexcept;
-const char *get_fontconfig_data_path() noexcept;
-const char *get_poppler_data_path() noexcept;
-const char *get_pdf2htmlex_data_path() noexcept;
+const char *odr_data_path() noexcept;
+const char *fontconfig_data_path() noexcept;
+const char *poppler_data_path() noexcept;
+const char *pdf2htmlex_data_path() noexcept;
 
 } // namespace odr::internal::project_info

src/odr/odr.cpp

@@ -7,12 +7,22 @@
 #include <odr/internal/git_info.hpp>
 #include <odr/internal/project_info.hpp>
 
-std::string odr::get_version() noexcept {
-  return internal::project_info::get_version();
+std::string odr::version() noexcept {
+  return internal::project_info::version();
 }
 
-std::string odr::get_commit() noexcept {
-  return internal::git_info::get_commit();
+std::string odr::commit_hash() noexcept {
+  return internal::git_info::commit_hash();
+}
+
+bool odr::is_dirty() noexcept { return internal::git_info::is_dirty(); }
+
+bool odr::is_debug() noexcept { return internal::project_info::is_debug(); }
+
+std::string odr::identify() noexcept {
+  return (version().empty() ? "unknown version" : version()) +
+         (commit_hash().empty() ? "" : " (" + commit_hash() + ")") +
+         (is_dirty() ? " [dirty]" : "") + (is_debug() ? " [debug]" : "");
 }
 
 odr::FileType

src/odr/odr.hpp

@@ -12,12 +12,21 @@ struct DecodePreference;
 class DecodedFile;
 enum class DocumentType;
 
-/// @brief Get the version of the Open Document Reader library.
-/// @return The version of the Open Document Reader library.
-[[nodiscard]] std::string get_version() noexcept;
-/// @brief Get the commit hash of the Open Document Reader library.
-/// @return The commit hash of the Open Document Reader library.
-[[nodiscard]] std::string get_commit() noexcept;
+/// @brief Get the version of the library.
+/// @return The version of the library.
+[[nodiscard]] std::string version() noexcept;
+/// @brief Get the commit hash of the library.
+/// @return The commit hash of the library.
+[[nodiscard]] std::string commit_hash() noexcept;
+/// @brief Check if the library is dirty (i.e., has uncommitted changes).
+/// @return True if the library is dirty, false otherwise.
+[[nodiscard]] bool is_dirty() noexcept;
+/// @brief Check if the library is built in debug mode.
+/// @return True if the library is built in debug mode, false otherwise.
+[[nodiscard]] bool is_debug() noexcept;
+/// @brief Get the identification string of the library.
+/// @return The identification string of the library.
+[[nodiscard]] std::string identify() noexcept;
 
 /// @brief Get the file type by the file extension.
 /// @param extension The file extension.

test/src/odr_test.cpp

@@ -8,9 +8,9 @@ using namespace odr;
 using namespace odr::internal;
 using namespace odr::test;
 
-TEST(odr, version) { EXPECT_TRUE(odr::get_version().empty()); }
+TEST(odr, version) { EXPECT_TRUE(odr::version().empty()); }
 
-TEST(odr, commit) { EXPECT_FALSE(odr::get_commit().empty()); }
+TEST(odr, commit) { EXPECT_FALSE(odr::commit_hash().empty()); }
 
 TEST(odr, types_odt) {
   auto path = TestData::test_file_path("odr-public/odt/about.odt");