FEAT: Unify DDBC Bindings - Common Code Consolidation Across Windows/macOS

[gargsaumya]

This pull request refines cross-platform compatibility for the mssql_python bindings, improves logging, and simplifies driver loading and function handling. Key changes include replacing Windows-specific code with platform-agnostic alternatives, adding detailed logging for debugging, and introducing macOS-specific handling for wide character conversions.

Cross-platform compatibility improvements:

• Replaced Windows-specific headers (<shlwapi.h>) with <filesystem> for path handling and removed direct LoadLibraryW calls in favor of platform-agnostic dynamic library loading (LoadDriverLibrary). [1] [2] [3]

• Added macOS-specific handling for wide character conversions (SQLWCHAR to wchar_t) in various methods such as SQLExecDirect_wrap, SQLExecute_wrap, and SQLGetData_wrap. This ensures proper functionality on macOS and Linux platforms. [1] [2] [3]

Enhanced logging:

• Introduced detailed logging throughout the BindParameters method to debug parameter binding, including character code points and buffer sizes. Added logs for macOS-specific SQLWCHAR buffer creation. [1] [2] [3]

• Added logging for driver loading, including paths and error messages, and improved error reporting with platform-specific implementations of GetLastErrorMessage. [1] [2]

Driver loading simplifications:

• Refactored the driver loading process to use <filesystem> for path construction and introduced platform-agnostic functions to load dynamic libraries and retrieve function pointers. Simplified handling of driver function pointers by consolidating repetitive code. [1] [2]

Wide character handling improvements:

• Unified wide character string handling across platforms by introducing helper functions (SQLWCHARToWString, WStringToSQLWCHAR) for macOS/Linux compatibility in methods like SQLDescribeCol_wrap and SQLGetData_wrap. [1] [2] [3]

Code cleanup:

• Removed unused methods such as WideToUTF8 and legacy Windows-specific driver loading code, reducing clutter and improving maintainability. [1] [2]

Issue Reference

AB#37626

[Copilot]

Pull Request Overview

This PR centralizes and unifies DDBC bindings for Windows and macOS, enhances logging for debugging, and refactors driver loading and wide-character handling.

• Introduce platform-agnostic driver loading and GetFunctionPointer helper
• Add detailed debug logs throughout parameter binding and driver initialization
• Implement macOS/Linux wide-character utilities and refactor Windows-specific code

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
mac_utils.h	Add header comment and licensing, introduce utility purpose
mac_utils.cpp	Update header and licensing comments
ddbc_bindings.h	Add platform checks, DriverHandle typedef, string converters, and remove legacy Windows includes
ddbc_bindings.cpp	Refactor driver load with std::filesystem, replace Windows-only code, enhance logging, and unify wide-char handling

Comments suppressed due to low confidence (3)

mssql_python/pybind/ddbc_bindings.h:25

• The inline functions SQLWCHARToWString and WStringToSQLWCHAR use std::vector but there is no #include <vector> in this header. Add the <vector> include to avoid compilation errors.

#include <sql.h>

mssql_python/pybind/ddbc_bindings.cpp:785

• In SQLCheckError_Wrap, only Windows (_WIN32) and macOS (__APPLE__) paths are handled. On Linux (non-Windows, non-Apple), the conversion falls through to the Windows branch. Consider using #if !defined(_WIN32) to cover all non-Windows platforms consistently.

#if defined(_WIN32)

mssql_python/pybind/ddbc_bindings.cpp:193

• [nitpick] These DEBUG-level logs inside tight loops (per-param and per-char) may introduce runtime overhead during bulk operations. Consider reducing verbosity or gating them behind a more specific debug flag.

    LOG("Starting parameter binding. Number of parameters: {}", params.size());

[gargsaumya]

Thanks for the suggestions @Ramudaykumar. The comments were related to existing functions in removed files, not newly added in this PR. However, the issues have now been addressed - including proper UTF-8 handling, cleaner logging, and return value checks. Let me know if anything else needs changes.

[Ramudaykumar]

Looks good to me.