From 1968a11754b02b6b86822c98a04bcd08a540923b Mon Sep 17 00:00:00 2001
From: Joerg Wunsch <j@uriah.heep.sax.de>
Date: Wed, 13 Mar 2024 12:53:30 +0100
Subject: [PATCH] Combine the various cast_* functions with ldata()

All these typecast helpers are supposed to operate on LNODEID elements,
in order to convert them to the desired target type. As such, it makes
sense to include the ldata() LNODEID access itself.

Add docstrings for them as well, also for the entire module.
---
 src/libavrdude.i | 31 ++++++++++++++++++-------------
 src/swigtest.py  |  2 +-
 2 files changed, 19 insertions(+), 14 deletions(-)

diff --git a/src/libavrdude.i b/src/libavrdude.i
index 53fbba92..a7bddf37 100644
--- a/src/libavrdude.i
+++ b/src/libavrdude.i
@@ -1,4 +1,5 @@
-%module swig_avrdude
+%module (docstring="SWIG wrapper and helper around libavrdude") swig_avrdude
+%feature("autodoc", "1");
 %{
 #include "ac_cfg.h"
 #include "libavrdude.h"
@@ -130,20 +131,20 @@ int avrdude_message2(FILE *fp, int lno, const char *file,
     return rc;
 }
 
-PROGRAMMER *cast_programmer(LNODEID p) {
-  return (PROGRAMMER *)p;
+PROGRAMMER *ldata_programmer(LNODEID p) {
+  return (PROGRAMMER *)ldata(p);
 }
 
-AVRPART *cast_avrpart(LNODEID p) {
-  return (AVRPART *)p;
+AVRPART *ldata_avrpart(LNODEID p) {
+  return (AVRPART *)ldata(p);
 }
 
-AVRMEM *cast_avrmem(LNODEID p) {
-  return (AVRMEM *)p;
+AVRMEM *ldata_avrmem(LNODEID p) {
+  return (AVRMEM *)ldata(p);
 }
 
-const char *cast_string(LNODEID p) {
-  return (const char *)p;
+const char *ldata_string(LNODEID p) {
+  return (const char *)ldata(p);
 }
 
 %}
@@ -215,13 +216,17 @@ void     * ldata  ( LNODEID ); /* data at the current position */
 int        lsize  ( LISTID  ); /* number of elements in the list */
 
 // Typecast helpers to interpret LNODEID
-PROGRAMMER *cast_programmer(LNODEID);
+%feature("autodoc", "LNODEID -> PROGRAMMER*") ldata_programmer;
+PROGRAMMER *ldata_programmer(LNODEID);
 
-AVRPART *cast_avrpart(LNODEID);
+%feature("autodoc", "LNODEID -> AVRPART*") ldata_avrpart;
+AVRPART *ldata_avrpart(LNODEID);
 
-AVRMEM *cast_avrmem(LNODEID);
+%feature("autodoc", "LNODEID -> AVRMEM*") ldata_avrmem;
+AVRMEM *ldata_avrmem(LNODEID);
 
-const char *cast_string(LNODEID);
+%feature("autodoc", "LNODEID -> str") ldata_string;
+const char *ldata_string(LNODEID);
 
 // AVRMEM and AVRPART handling
 AVRMEM * avr_locate_mem(const AVRPART *p, const char *desc);
diff --git a/src/swigtest.py b/src/swigtest.py
index adae0408..c99ad62f 100644
--- a/src/swigtest.py
+++ b/src/swigtest.py
@@ -84,7 +84,7 @@ def avrpart_to_mem(avrpart):
     res = []
     m = ad.lfirst(avrpart.mem)
     while m:
-        mm = ad.cast_avrmem(ad.ldata(m))
+        mm = ad.ldata_avrmem((m))
         res.append(avrmem_to_dict(mm))
         m = ad.lnext(m)