Add new function: get_defined_name (#29)

Author: Siyet

excelize.py

@@ -2915,6 +2915,37 @@ def get_default_font(self) -> str:
             return res.val.decode(ENCODE)
         raise RuntimeError(err)
 
+    def get_defined_name(self) -> List[DefinedName]:
+        """
+        Get the defined names of the workbook or worksheet.
+
+        Returns:
+            List[DefinedName]: Return the defined names list if no error
+            occurred, otherwise raise a RuntimeError with the message.
+
+        Example:
+            For example:
+
+            ```python
+            try:
+                names = f.get_defined_name()
+                for dn in names:
+                    print(dn.name, dn.refers_to, dn.scope, dn.comment)
+            except (RuntimeError, TypeError) as err:
+                print(err)
+            ```
+        """
+        lib.GetDefinedName.restype = types_go._GetDefinedNameResult
+        res = lib.GetDefinedName(self.file_index)
+        err = res.Err.decode(ENCODE)
+        if err == "":
+            arr = []
+            if res.DefinedNames:
+                for i in range(res.DefinedNamesLen):
+                    arr.append(c_value_to_py(res.DefinedNames[i], DefinedName()))
+            return arr
+        raise RuntimeError(err)
+
     def get_row_height(self, sheet: str, row: int) -> float:
         """
         Get row height by given worksheet name and row number.

main.go

@@ -1229,6 +1229,27 @@ func GetDefaultFont(idx int) C.struct_StringErrorResult {
 	return C.struct_StringErrorResult{val: C.CString(val), err: C.CString(emptyString)}
 }
 
+// GetDefinedName provides a function to get the defined names of the workbook
+// or worksheet.
+//
+//export GetDefinedName
+func GetDefinedName(idx int) C.struct_GetDefinedNameResult {
+	f, ok := files.Load(idx)
+	if !ok {
+		return C.struct_GetDefinedNameResult{Err: C.CString(errFilePtr)}
+	}
+	definedNames := f.(*excelize.File).GetDefinedName()
+	cArray := C.malloc(C.size_t(len(definedNames)) * C.size_t(unsafe.Sizeof(C.struct_DefinedName{})))
+	for i, dn := range definedNames {
+		cVal, err := goValueToC(reflect.ValueOf(dn), reflect.ValueOf(&C.struct_DefinedName{}))
+		if err != nil {
+			return C.struct_GetDefinedNameResult{Err: C.CString(err.Error())}
+		}
+		*(*C.struct_DefinedName)(unsafe.Pointer(uintptr(unsafe.Pointer(cArray)) + uintptr(i)*unsafe.Sizeof(C.struct_DefinedName{}))) = cVal.Elem().Interface().(C.struct_DefinedName)
+	}
+	return C.struct_GetDefinedNameResult{DefinedNamesLen: C.int(len(definedNames)), DefinedNames: (*C.struct_DefinedName)(cArray), Err: C.CString(emptyString)}
+}
+
 // GetRowHeight provides a function to get row height by given worksheet name
 // and row number.
 //

test_excelize.py

@@ -837,6 +837,9 @@ def test_none_file_pointer(self):
         with self.assertRaises(RuntimeError) as context:
             f.get_default_font()
         self.assertEqual(str(context.exception), expected)
+        with self.assertRaises(RuntimeError) as context:
+            f.get_defined_name()
+        self.assertEqual(str(context.exception), expected)
         with self.assertRaises(RuntimeError) as context:
             f.get_sheet_name(0)
         self.assertEqual(str(context.exception), expected)
@@ -2082,16 +2085,14 @@ def test_add_picture(self):
 
     def test_defined_name(self):
         f = excelize.new_file()
-        self.assertIsNone(
-            f.set_defined_name(
-                excelize.DefinedName(
-                    name="Amount",
-                    refers_to="Sheet1!$A$2:$D$5",
-                    comment="defined name comment",
-                    scope="Sheet1",
-                )
-            )
-        )
+        df = excelize.DefinedName(
+            name="Amount",
+            refers_to="Sheet1!$A$2:$D$5",
+            comment="defined name comment",
+            scope="Sheet1",
+        )
+        self.assertIsNone(f.set_defined_name(df))
+        self.assertEqual(f.get_defined_name(), [df])
         self.assertIsNone(
             f.delete_defined_name(
                 excelize.DefinedName(

types_c.h

@@ -848,3 +848,10 @@ struct GetCommentsResult
     struct Comment *Comments;
     char *Err;
 };
+
+struct GetDefinedNameResult
+{
+    int DefinedNamesLen;
+    struct DefinedName *DefinedNames;
+    char *Err;
+};

types_go.py

@@ -835,3 +835,11 @@ class _GetCommentsResult(Structure):
         ("Comments", POINTER(_Comment)),
         ("Err", c_char_p),
     ]
+
+
+class _GetDefinedNameResult(Structure):
+    _fields_ = [
+        ("DefinedNamesLen", c_int),
+        ("DefinedNames", POINTER(_DefinedName)),
+        ("Err", c_char_p),
+    ]