SWIG Python wrapper for libavrdude

.github/workflows/build.yml

@@ -248,7 +248,7 @@ jobs:
         include:
           - { arch: x86, platform: Win32 }
           - { arch: x64, platform: x64 }
-          - { arch: arm64, platform: ARM64 }
+          # - { arch: arm64, platform: ARM64 }
     steps:
       - uses: actions/checkout@v3
       - name: Install prerequisites
@@ -315,6 +315,8 @@ jobs:
             base-devel
             mingw-w64-${{matrix.env}}-gcc
             mingw-w64-${{matrix.env}}-cmake
+            mingw-w64-${{matrix.env}}-python            
+            mingw-w64-${{matrix.env}}-swig
             mingw-w64-${{matrix.env}}-libelf
             mingw-w64-${{matrix.env}}-libusb
             mingw-w64-${{matrix.env}}-libusb-compat-git

CMakeLists.txt

@@ -246,6 +246,18 @@ if(HAVE_LINUXGPIO)
     endif()
 endif()
 
+# -------------------------------------
+# Find SWIG
+find_package(SWIG 4.0 COMPONENTS python)
+if(SWIG_FOUND)
+  find_package(Python3 COMPONENTS Interpreter Development)
+  if(PYTHON3_FOUND)
+    set(HAVE_SWIG 1)
+  else()
+    message(STATUS "Found SWIG but no Python3 header/library; cannot use SWIG")
+  endif()
+endif()
+
 # =====================================
 # Use external libraries if requested
 # =====================================
@@ -424,4 +436,10 @@ else()
     message(STATUS "DISABLED   linuxspi")
 endif()
 
+if(HAVE_SWIG)
+    message(STATUS "DO HAVE    swig+Python3")
+else()
+    message(STATUS "DON'T HAVE swig+Python3")
+endif()
+
 message(STATUS "----------------------")

build.sh

@@ -31,6 +31,7 @@ usage()
 	echo "Syntax: build.sh -h -f <flags> -j <num>"
 	echo "Options"
 	echo "-h          Display this usage information and exit"
+	echo "-v          Verbose build"
 	echo "-f <flags>  Extra build flags to pass to cmake"
 	echo "-j <num>    Run num build jobs in parallel"
 	echo
@@ -40,14 +41,19 @@ ostype=$(uname | tr '[A-Z]' '[a-z]')
 
 build_flags=""
 cmake_build="cmake --build ."
+verbose=""
+jopt=""
 
-while getopts :hf:j: OPT; do
+while getopts :hf:j:v OPT; do
   case "$OPT" in
-    f)    
-	   build_flags="$OPTARG" 
+    f)
+	   build_flags="$OPTARG"
 	   ;;
     j)
-	   cmake_build="cmake --build . -- -j$OPTARG";
+	   jopt="-- -j$OPTARG"
+	   ;;
+    v)
+	   verbose="-v"
 	   ;;
     h | *)
 	   usage
@@ -57,6 +63,7 @@ while getopts :hf:j: OPT; do
 done
 shift $((OPTIND-1)) # remove parsed options and args from $@ list
 
+cmake_build="$cmake_build $verbose $jopt"
 
 build_type=RelWithDebInfo
 # build_type=Release # no debug info

src/CMakeLists.txt

@@ -126,6 +126,15 @@ if(WIN32 OR MINGW)
     "${CMAKE_CURRENT_SOURCE_DIR}/windows.rc.in"
     "${CMAKE_CURRENT_BINARY_DIR}/windows.rc"
   )
+  configure_file(
+    "${CMAKE_CURRENT_SOURCE_DIR}/python/adgui.bat.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/avrdude-gui.bat"
+  )
+else()
+  configure_file(
+    "${CMAKE_CURRENT_SOURCE_DIR}/python/adgui.sh.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/avrdude-gui"
+  )
 endif()
 
 add_custom_command(
@@ -150,7 +159,7 @@ add_custom_target(conf ALL DEPENDS avrdude.conf)
 # Project
 # =====================================
 
-add_library(libavrdude
+set(SOURCES
     ${CMAKE_CURRENT_BINARY_DIR}/ac_cfg.h
     arduino.h
     arduino.c
@@ -285,6 +294,10 @@ add_library(libavrdude
     ${EXTRA_WINDOWS_SOURCES}
     )
 
+add_library(libavrdude
+    ${SOURCES}
+    )
+
 set_target_properties(libavrdude PROPERTIES
     PREFIX ""
     PUBLIC_HEADER "libavrdude.h;libavrdude-avrintel.h"
@@ -335,6 +348,37 @@ if(MINGW)
     target_link_options(avrdude PRIVATE -static)
 endif()
 
+if(HAVE_SWIG)
+  include (UseSWIG)
+  swig_add_library(swig_avrdude LANGUAGE Python SOURCES libavrdude.i ${SOURCES})
+  target_include_directories(swig_avrdude
+    PUBLIC
+    "${Python3_INCLUDE_DIRS}"
+    "${PROJECT_SOURCE_DIR}"
+    "${PROJECT_BINARY_DIR}"
+    "${CMAKE_CURRENT_SOURCE_DIR}"
+    "${LIBUSB_COMPAT_DIR}"
+    ${EXTRA_WINDOWS_INCLUDES}
+  )
+  target_link_libraries(swig_avrdude
+    PRIVATE
+    ${LIB_MATH}
+    ${LIB_LIBELF}
+    ${LIB_LIBUSB}
+    ${LIB_LIBUSB_1_0}
+    ${LIB_LIBHID}
+    ${LIB_LIBHIDAPI}
+    ${LIB_LIBFTDI}
+    ${LIB_LIBFTDI1}
+    ${LIB_LIBREADLINE}
+    ${LIB_LIBSERIALPORT}
+    ${LIB_NCURSES}
+    ${LIB_LIBGPIOD}
+    ${Python3_LIBRARIES}
+    ${EXTRA_WINDOWS_LIBRARIES}
+    )
+endif()
+
 # =====================================
 # Install
 # =====================================
@@ -349,3 +393,17 @@ install(FILES "${CMAKE_CURRENT_BINARY_DIR}/avrdude.conf" TYPE SYSCONF)
 install(FILES "avrdude.1"
 	DESTINATION "${CMAKE_INSTALL_MANDIR}/man1"
 	)
+
+if(HAVE_SWIG)
+    execute_process(COMMAND ${Python3_EXECUTABLE} -c "import site; print(site.getsitepackages()[0])"
+                    OUTPUT_VARIABLE PYTHON_SITE_PACKAGES OUTPUT_STRIP_TRAILING_WHITESPACE)
+    install(TARGETS swig_avrdude DESTINATION ${PYTHON_SITE_PACKAGES})
+    install(FILES ${CMAKE_BINARY_DIR}/src/swig_avrdude.py DESTINATION ${PYTHON_SITE_PACKAGES})
+    install(DIRECTORY python/ DESTINATION ${CMAKE_INSTALL_DATADIR}/avrdude FILES_MATCHING PATTERN "*.ui")
+    install(DIRECTORY python/ DESTINATION ${CMAKE_INSTALL_DATADIR}/avrdude FILES_MATCHING PATTERN "*.py")
+  if(WIN32 OR MINGW)
+    install(PROGRAMS ${CMAKE_BINARY_DIR}/src/avrdude-gui.bat TYPE BIN)
+  else()
+    install(PROGRAMS ${CMAKE_BINARY_DIR}/src/avrdude-gui TYPE BIN)
+  endif()
+endif()

src/avrdude.h

@@ -42,25 +42,6 @@ extern const char *pgmid;    // Programmer -c string
 
 int avrdude_message2(FILE *fp, int lno, const char *file, const char *func, int msgmode, int msglvl, const char *format, ...);
 
-#define MSG_EXT_ERROR   (-3) // OS-type error, no -v option, can be suppressed with -qqqqq
-#define MSG_ERROR       (-2) // Avrdude error, no -v option, can be suppressed with -qqqq
-#define MSG_WARNING     (-1) // Warning, no -v option, can be suppressed with -qqq
-#define MSG_INFO           0 // Commentary, no -v option, can be suppressed with -qq
-#define MSG_NOTICE         1 // Displayed with -v
-#define MSG_NOTICE2        2 // Displayed with -vv
-#define MSG_DEBUG          3 // Displayed with -vvv
-#define MSG_TRACE          4 // Displayed with -vvvv, show trace communication
-#define MSG_TRACE2         5 // Displayed with -vvvvv
-
-#define MSG2_PROGNAME      1 // Start by printing progname
-#define MSG2_FUNCTION      2 // Print calling function (1st arg) after progname if >= notice
-#define MSG2_FILELINE      4 // Print source file and line number after function if >= debug
-#define MSG2_TYPE          8 // Print message type after function or progname
-#define MSG2_INDENT1      16 // Start by printing indentation of progname+1 blanks
-#define MSG2_INDENT2      32 // Start by printing indentation of progname+2 blanks
-#define MSG2_FLUSH        64 // Flush before and after printing
-#define MSG2_LEFT_MARGIN 128 // Print \n unless last character printed was \n
-
 // Shortcuts
 #define msg_ext_error(...)  avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_EXT_ERROR, __VA_ARGS__)
 #define msg_error(...)      avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_ERROR, __VA_ARGS__)

src/jtag3.c

@@ -211,14 +211,14 @@ static void jtag3_print_data(unsigned char *b, size_t s)
     return;
 
   for (i = 0; i < s; i++) {
-    msg_info("0x%02x", b[i]);
+    msg_debug("0x%02x", b[i]);
     if (i % 16 == 15)
-      msg_info("\n");
+      msg_debug("\n");
     else
-      msg_info(" ");
+      msg_debug(" ");
   }
   if (i % 16 != 0)
-    msg_info("\n");
+    msg_debug("\n");
 }
 
 static void jtag3_prmsg(const PROGRAMMER *pgm, unsigned char *data, size_t len) {

src/libavrdude.h

@@ -60,6 +60,35 @@ typedef uint32_t pinmask_t;
 #define LIBAVRDUDE_SOFTFAIL (-3) // returned, eg, by avr_signature() if caller
                                  // might proceed with chip erase
 
+/* Message system */
+/* These 2 functions are supposed to be supplied by the application */
+
+int avrdude_message(int msglvl, const char *format, ...);
+int avrdude_message2(FILE *fp, int lno, const char *file, const char *func, int msgmode, int msglvl, const char *format, ...);
+
+enum msglvl {
+  MSG_EXT_ERROR = (-3), // OS-type error, no -v option, can be suppressed with -qqqqq
+  MSG_ERROR = (-2),     // Avrdude error, no -v option, can be suppressed with -qqqq
+  MSG_WARNING = (-1),   // Warning, no -v option, can be suppressed with -qqq
+  MSG_INFO = 0,         // Commentary, no -v option, can be suppressed with -qq
+  MSG_NOTICE = 1,       // Displayed with -v
+  MSG_NOTICE2 = 2,      // Displayed with -vv
+  MSG_DEBUG = 3,        // Displayed with -vvv
+  MSG_TRACE = 4,        // Displayed with -vvvv, show trace communication
+  MSG_TRACE2 = 5,       // Displayed with -vvvvv
+};
+
+enum msgmode {
+  MSG2_PROGNAME = 1,    // Start by printing progname
+  MSG2_FUNCTION = 2,    // Print calling function (1st arg) after progname if >= notice
+  MSG2_FILELINE = 4,    // Print source file and line number after function if >= debug
+  MSG2_TYPE = 8,        // Print message type after function or progname
+  MSG2_INDENT1 = 16,    // Start by printing indentation of progname+1 blanks
+  MSG2_INDENT2 = 32,    // Start by printing indentation of progname+2 blanks
+  MSG2_FLUSH = 64,      // Flush before and after printing
+  MSG2_LEFT_MARGIN = 128, // Print \n unless last character printed was \n
+};
+
 /* formerly lists.h */
 
 /*----------------------------------------------------------------------