final fixes for libnice and gtksourceview5 for gtk4

examples/gtk3/simple_example.nim

@@ -68,11 +68,11 @@ proc printLocalData(agent: nice.Agent; streamId: int; componentId: int): int =
     cands = getLocalCandidates(agent, streamId, componentId)
     if cands.len == 0:
       break gotoEnd
-    stdout.write(localUfrag, localPassword)
+    stdout.write(localUfrag, ' ', localPassword)
     for el in cands:
       toString(el.impl.`addr`, ipaddr)
       ##  (foundation),(prio),(addr),(port),(type)
-      stdout.write(' ', cast[cstring](addr el.impl.foundation), ',', el.impl.priority, ',', ipaddr, ' ', getPort(el.impl.`addr`),
+      stdout.write(' ', cast[cstring](addr el.impl.foundation), ',', el.impl.priority, ',', ipaddr, ',', getPort(el.impl.`addr`),
           ',', candidateTypeName[el.impl.`type`.ord])
     echo ""
   # end label
@@ -101,6 +101,7 @@ proc parseCandidate(scand: string; streamId: int): nice.Candidate =
     while i < candidateTypeName.len:
       if tokens[4] == candidateTypeName[i]:
         ntype = CandidateType(i)
+        break # missing in initial release!
       inc(i)
     if i == candidateTypeName.len:
       break gotoEnd
@@ -138,9 +139,9 @@ proc parseRemoteData(agent: Agent; streamId: int; componentId: int; line: string
         passwd = x
       else:
         ##  Remaining args are serialized canidates (at least one is required)
-        var c: nice.Candidate = parseCandidate(lineArgv[i], streamId)
+        var c: nice.Candidate = parseCandidate(x, streamId)
         if c == nil:
-          gMsg("failed to parse candidate: " & lineArgv[i])
+          gMsg("failed to parse candidate: " & x)
           break gotoEnd
         remoteCandidates.add(c) # caution prepend in C code!
     if ufrag == "" or passwd == "" or remoteCandidates.len == 0:
@@ -181,12 +182,12 @@ proc cbCandidateGatheringDone(agent: nice.Agent; streamId: int) =
   gDebug("SIGNAL candidate gathering done\n")
   ##  Candidate gathering is done. Send our local candidates on stdout
   echo("Copy this line to remote client:")
-  echo("  ")
+  stdout.write("\n  ")
   discard printLocalData(agent, streamId, 1)
   echo("")
   ##  Listen on stdin for the remote candidate list
   echo("Enter remote data (single line, no wrapping):")
-  addWatch(ioStdin, glib.PRIORITY_DEFAULT, IOCondition.in , stdinRemoteInfoCb, agent)
+  discard addWatch(ioStdin, glib.PRIORITY_DEFAULT, {IOCFlag.`in`} , stdinRemoteInfoCb, agent)
   stdout.write("> ")
   flushFile(stdout)
 
@@ -215,12 +216,12 @@ proc cbComponentStateChanged(agent: nice.Agent; streamId: int; componentId: int;
     if getSelectedPair(agent, streamId, componentId, local, remote):
       var ipaddr = newString(INET6_ADDRSTRLEN).cstring
       toString(local.impl.`addr`, ipaddr)
-      echo("\nNegotiation complete: ([$1]:$2,", [$ipaddr, $getPort(local.impl.`addr`)])
+      echo("\nNegotiation complete: ([$1]:$2," % [$ipaddr, $getPort(local.impl.`addr`)])
       toString(remote.impl.`addr`, ipaddr)
       echo(" [$1]:$2)" % [$ipaddr, $getPort(remote.impl.`addr`)])
     ## Listen to stdin and send data written to it
     echo("\nSend lines to remote (Ctrl-D to quit):")
-    addWatch(ioStdin, glib.PRIORITY_DEFAULT, IOCondition.in , stdinSendDataCb, agent)
+    discard addWatch(ioStdin, glib.PRIORITY_DEFAULT, {IOCFlag.`in`} , stdinSendDataCb, agent)
     stdout.write("> ")
     flushFile(stdout)
   elif state == ComponentState.failed.ord:

gintro/gimplglib.nim

@@ -7,6 +7,12 @@ macro mAddWatch(ch: IOChannel; pri: cint; cond: IOCondition; p: untyped; arg: ty
   let ats = $getTypeInst(arg).toStrLit
   let procName = "giofunc_" & $IdleID
   let procNameCdecl = "giofunc_cdecl_" & $IdleID
+  #var fixedCond = "{IOCFlag.in}"
+  var fixedCond = $(cond.toStrLit)
+  #echo getTypeInst(cond)[0].toStrLit
+  #echo getTypeInst(cond)[1].toStrLit
+  fixedCond.insert($(getTypeInst(cond)[1].toStrLit) & ".", 1)
+
   var r1s = """
 
 proc $1(self: ptr IOChannel00; cond: IOCondition; userData: pointer): gboolean {.cdecl.} =
@@ -16,14 +22,14 @@ proc $1(self: ptr IOChannel00; cond: IOCondition; userData: pointer): gboolean {
     GC_ref(ch1) # never call destroy/finalizer on this global variable
     ch1.ignoreFinalizer = true
   ch1.impl = self
-  discard $2(ch1, cond"""
+  $2(ch1, cond"""
 
   if not ignoreArg.boolVal:
     if getTypeInst(arg).typeKind == ntyRef:
       r1s.add(", cast[$3](userdata)")
     else:
       r1s.add(", cast[$3](userdata)")
-  r1s.add(")\n")
+  r1s.add(").gboolean\n")
 
   r1s = r1s % [$procNameCdecl, $p, ats]
 
@@ -31,7 +37,7 @@ proc $1(self: ptr IOChannel00; cond: IOCondition; userData: pointer): gboolean {
     if ignoreArg.boolVal:
 
       """
-proc $1(self: IOChannel; pri: cint; cond: IOCondition) =
+proc $1(self: IOChannel; pri: cint; cond: IOCondition): cuint {.discardable.} =
     g_io_add_watch_full(cast[ptr IOChannel00](self.impl), pri, cond, $5, nil, nil)
 
 $1($5, $3, $4)
@@ -40,20 +46,22 @@ $1($5, $3, $4)
     else:
 
       """
-proc $1(self: IOChannel; pri: cint; cond: IOCondition; a: $2) =
+proc $1(self: IOChannel; pri: cint; cond: IOCondition; a: $2): cuint {.discardable.} =
   when (a is ref object):
     GC_ref(a)
-    discard g_io_add_watch_full(cast[ptr IOChannel00](self.impl), pri, cond, $5, cast[pointer](a), nil)
+    #discard g_io_add_watch_full(cast[ptr IOChannel00](self.impl), pri, cond, $5, cast[pointer](a), nil)
+    return g_io_add_watch_full(cast[ptr IOChannel00](self.impl), pri, cond, $5, cast[pointer](a), nil)
   else:
     var ar: ref $2
     new(ar)
     #deepCopy(ar[], a)
     ar[] = a
     GC_ref(ar)
-    discard g_io_add_watch_full(cast[ptr IOChannel00](self.impl), pri, cond, $5, cast[pointer](ar[]), nil)
+    #discard g_io_add_watch_full(cast[ptr IOChannel00](self.impl), pri, cond, $5, cast[pointer](ar[]), nil)
-$1($7, $3, $8.$4, $6)
+    return g_io_add_watch_full(cast[ptr IOChannel00](self.impl), pri, cond, $5, cast[pointer](ar[]), nil)
-""" % [$procName, ats, $(pri.toStrLit), $(cond.toStrLit), $procNameCdecl, $(arg.toStrLit), $(ch.toStrLit), $(getTypeInst(
+$1($7, $3, $4, $6)
-          cond).toStrLit)]
+#$1($7, $3, $8.$4, $6)
+""" % [$procName, ats, $(pri.toStrLit), fixedCond, $procNameCdecl, $(arg.toStrLit), $(ch.toStrLit), $(getTypeInst(cond).toStrLit)]
   #echo r1s
   #echo r2s
   result = parseStmt(r1s & r2s)

tests/gen.nim

@@ -1,6 +1,6 @@
 # High level gobject-introspection based GTK3/GTK4 bindings for the Nim programming language
 # nimpretty --maxLineLen:130 gen.nim
-# v 0.8.4 2020-DEC-02
+# v 0.8.4 2020-DEC-06
 # (c) S. Salewski 2018
 
 # usefull for finding death code:
@@ -275,6 +275,8 @@ proc fixedModName(s: string): string =
   result = s
   if not ISGTK3 and (s == "gdk" or s == "gtk" or s == "gdkX11"):
     result &= "4"
+  if not ISGTK3 and (s == "gtksource"):
+    result &= "5"
 
 proc gBaseInfoGetName(info: GIBaseInfo): string =
   result = $(gir.gBaseInfoGetName(info))
@@ -1336,6 +1338,8 @@ proc writeMethod(info: GIBaseInfo; minfo: GIFunctionInfo) =
   if sym == "gst_structure_from_string": return # constructor with out param, not supported yet.
   if sym == "gst_structure_take": return # first parameter is var but can be nil? See trouble at the bottom of this file.
 
+  if sym == "nice_agent_get_selected_pair": return #  was very wrong, fixed manually
+
   try:
     pars = genPars(mInfo, false, info)
     processedFunctions.incl(sym)
@@ -1825,8 +1829,13 @@ proc writeMethod(info: GIBaseInfo; minfo: GIFunctionInfo) =
                 methodBuffer.writeLine("  g_strfreev(resul0)")
               else:
                 methodBuffer.writeLine("  " & doCt3nt(ngrRet.name, ngrRet) & '(' & "resul0" & ')')
+            else:
+              if pars.tempResFree != "": # ugly, do we have a better test for this case
+              #if ngrRet.name != "void":
+                methodBuffer.writeLine("  result = " & doCt3nt(ngrRet.name, ngrRet) & '(' & sym & pars.arglist & ')')
               else:
                 methodBuffer.writeLine("  " & doCt3nt(ngrRet.name, ngrRet) & '(' & sym & pars.arglist & ')')
+              checkForGerror() # i.e. for nice_agent_set_remote_candidates, free GSList
           else:
             if gCallableInfoCanThrowGerror(minfo) and ngrRet.name != "void":
               assert false
@@ -2109,8 +2118,8 @@ proc writeStruct(info: GIStructInfo) =
     mangleName(gBaseInfoGetName(info)) == "TargetEntry" or
       ["gst.Message", "gst.MiniObject", "glib.List", "pango.Attribute", "nice.Address", "nice.Candidate"].contains((
           $gBaseInfoGetNamespace(info)).toLowerAscii & '.' & mangleName(gBaseInfoGetName(info))):
-    if gBaseInfoGetName(info) == "Address":
+    #if gBaseInfoGetName(info) == "Address":
-      echo "kkk", info.gStructInfoGetNFields()
+    #  echo "kkk", info.gStructInfoGetNFields()
     for j in 0.cint ..< info.gStructInfoGetNFields():
       let field = info.gStructInfoGetField(j)
       let name = manglename(gBaseInfoGetName(field)) & EM
@@ -2171,7 +2180,7 @@ template writeSignal() =
     memo.add(plist)
     memo = memo.replace("\n    ", " ")
     memo = memo.replace("\"", "\\\"")
-    if moduleNamespace == "gtk" or moduleNamespace == "gdk" or moduleNamespace == "gdkX11":
+    if moduleNamespace == "gtk" or moduleNamespace == "gdk" or moduleNamespace == "gdkX11" or moduleNamespace == "gtksource":
       if ISGTK3:
         supmod3.writeLine("    \"" & ($gBaseInfoGetName(signalInfo)).replace("-", "_") & RecSep & $gBaseInfoGetName(info) &
             RecSep & memo & "\",")
@@ -2201,9 +2210,6 @@ template writeSignal() =
   signalbuffer.write("  g_signal_connect_data(self.impl, \"")
   signalbuffer.write($gBaseInfoGetName(signalInfo))
   signalbuffer.writeLine("\", cast[GCallback](p), xdata, nil, cf)")
-  if false: #gBaseInfoGetName(signalInfo) == "invalidate-size":
-    echo "aha"
-    signalbuffer.writeLine("aha")
 
 proc writeInterface(info: GIInterfaceInfo) =
   if not suppressType:
@@ -2228,7 +2234,7 @@ proc writeInterface(info: GIInterfaceInfo) =
 # write a few of the strange enum sets
 proc writeModifierType(info: GIEnumInfo) =
   let we = gBaseInfoGetName(info)
-  assert(we in ["ModifierType", "EventMask", "AccelFlags", "AttachOptions", "MessageType", "WindowHints"])
+  assert(we in ["ModifierType", "EventMask", "AccelFlags", "AttachOptions", "MessageType", "WindowHints", "IOCondition"])
   type T = tuple[v: int64; n: string]
   var s: seq[T]
   var alias: seq[string]
@@ -2247,6 +2253,8 @@ proc writeModifierType(info: GIEnumInfo) =
   var tname = mangleName(gBaseInfoGetName(info))
   if tname != "WindowHints":
     firstPart(tname)
+  if we == "IOCondition":
+    tname = "IOC" # as glib already has an IOFlags enum type
   output.writeLine("  ", tname & "Flag" & EM, " {.size: sizeof(cint), pure.} = enum")
   if s[0].v != 0 and s[0].v != 1: # flags may start with none = 0 or with flag1 = 1
     output.writeLine("    ignoreThisDummyValue = 0") # Nim needs start with 0 for these low level sets
@@ -2278,7 +2286,8 @@ proc writeModifierType(info: GIEnumInfo) =
     writeMethod(info, minfo)
 
 proc writeEnum(info: GIEnumInfo) =
-  if mangleName(gBaseInfoGetName(info)) in ["ModifierType", "EventMask", "AccelFlags", "AttachOptions", "WindowHints"] or
+  if mangleName(gBaseInfoGetName(info)) in ["ModifierType", "EventMask", "AccelFlags", "AttachOptions", "WindowHints",
+      "IOCondition"] or
     (moduleNameSpace == "gst" and mangleName(gBaseInfoGetName(info)) == "MessageType"):
     writeModifierType(info)
     return
@@ -2401,7 +2410,8 @@ proc writeObj(info: GIObjectInfo) =
   assert not callerAlloc.contains(ns & '.' & manglename(gBaseInfoGetName(info)))
 
   if callerAlloc.contains(($gBaseInfoGetNamespace(info)).toLowerAscii & '.' & mangleName(gBaseInfoGetName(info))):
-    echo ($gBaseInfoGetNamespace(info)).toLowerAscii & '.' & mangleName(gBaseInfoGetName(info))
+    assert false
+    # echo ($gBaseInfoGetNamespace(info)).toLowerAscii & '.' & mangleName(gBaseInfoGetName(info))
 
   assert not callerAlloc.contains(($gBaseInfoGetNamespace(info)).toLowerAscii & '.' & mangleName(gBaseInfoGetName(info)))
   when WriteFields:
@@ -2640,8 +2650,6 @@ proc seq2cstringArray*(s: openarray[string]; a: var cstringArray): ptr cstring =
 const GTK_SOURCE_EPI = """
 
 proc getView*(builder: Builder; name: string): View =
-  #let gt = g_type_from_name("Gtk$1") # this worked also!
-  #let gt = $2
   let gt = g_type_from_name("GSource")
   assert(gt != g_type_invalid_get_type())
   let gobj = gtk_builder_get_object(cast[ptr Builder00](builder.impl), name)
@@ -2650,7 +2658,7 @@ proc getView*(builder: Builder; name: string): View =
     result = cast[type(result)](g_object_get_qdata(gobj, Quark))
     assert(result.impl == gobj)
   else:
-    fnew(result, gtksource.finalizeGObject)
+    fnew(result, $1.finalizeGObject)
     result.impl = gobj
     result.ignoreFinalizer = true
     g_object_add_toggle_ref(result.impl, toggleNotify, addr(result[]))
@@ -2843,21 +2851,21 @@ proc gslistStructs2seq*[T](l: ptr glib.SList; igFin: bool): seq[T] =
     result.add(r)
     el = el.next
 
-#proc seq2GList*[T](s: seq[T]): ptr glib.List =
+# Not much tested, but in use for libnice simple_example.nim
-#  return nil
-
-# Fully untested. We don't know is someone really will use this.
 # Some other modules may need a similar local proc, ie for pango.Item
 proc seq2GList*[T](s: seq[T]): ptr glib.List =
   var l: ptr glib.List
   var i = s.len
   while i > 0:
     dec(i)
-    when T is gobject.Object: # or T is pango.Item:
+    when T is gobject.Object or compiles(T.impl): # https://github.com/StefanSalewski/gintro/issues/99#issuecomment-739435944
+    # when compiles(s[i].impl == nil):
+    # when T is gobject.Object: # or T is pango.Item:
       l = g_list_prepend(l, s[i].impl)
     elif T is cstring:
       l = g_list_prepend(l, s[i]) # cstring
     else:
+      # {.error: "seq2GList was called with unsupported type".} # that would break compiling the modules currently
       discard # make it compile for these cases, of course will not work
   return l
 
@@ -2866,11 +2874,14 @@ proc seq2GSList*[T](s: seq[T]): ptr glib.SList =
   var i = s.len
   while i > 0:
     dec(i)
-    when T is gobject.Object: # or T is pango.Item:
+    when T is gobject.Object or compiles(T.impl):
+    # when compiles(s[i].impl == nil): # NiceCandidate
+    # when T is gobject.Object: # or T is pango.Item:
       l = g_slist_prepend(l, s[i].impl)
     elif T is cstring:
       l = g_slist_prepend(l, s[i]) # cstring
     else:
+      # {.error: "seq2GSList was called with unsupported type".}
       discard # make it compile for these cases, of course will not work
   return l
 
@@ -2931,6 +2942,16 @@ proc `indices=`*(a: Attribute; se: tuple[start: uint32; `end`: uint32]) =
 
 const Nice_EPI = """
 
+proc nice_agent_get_selected_pair(self: ptr Agent00; streamId: uint32; componentId: uint32;
+    local: var ptr Candidate00; remote: var ptr Candidate00): gboolean {.importc, libprag.}
+
+proc getSelectedPair*(self: Agent; streamId: int; componentId: int; local: var Candidate; remote: var Candidate): bool =
+  fnew(local, gBoxedFreeNiceCandidate)
+  local.ignoreFinalizer = true
+  fnew(remote, gBoxedFreeNiceCandidate)
+  remote.ignoreFinalizer = true
+  toBool(nice_agent_get_selected_pair(cast[ptr Agent00](self.impl), uint32(streamId), uint32(componentId), local.impl, remote.impl))
+
 include gimplnice
 
 """
@@ -3593,11 +3614,13 @@ proc get$1*(builder: Builder; name: string): $1 =
       output.write(GDK3_EPI.replace("SomeEvent", "Event"))
     output.write(GDK_EPI.replace("SomeEvent", "Event"))
   if namespace == "GtkSource":
-    output.write(GTK_SOURCE_EPI)
+    output.write(GTK_SOURCE_EPI % fixedModName("gtksource"))
   output.flush
   var suff = ""
   if version == "4.0":
     suff = "4"
+  if namespace == "GtkSource" and version == nil:
+    suff = "5"
   var o = open("nim_gi" / (namespace.toLowerAscii) & suff & ".nim", fmWrite)
   o.write(output.data)
   o.close()
@@ -3643,7 +3666,7 @@ proc launch() =
       main("Gio")
       main("GdkPixbuf")
       main("GModule")
-      main("GtkSource")
+      main("GtkSource", "4")
       main("Atk")
       main("Pango")
       main("PangoCairo")
@@ -3672,7 +3695,7 @@ proc launch() =
     main("Gio")
     main("GdkPixbuf")
     main("GModule")
-    # main("GtkSource") # not yet available for GTK4
+    main("GtkSource") # not yet available for GTK4
     main("Atk")
     main("Pango")
     main("PangoCairo")
@@ -3715,7 +3738,7 @@ launch()
 #  if not xcallerAlloc.contains(el):
 #    echo el
 
-# 3717 lines
+# 3741 lines
 # gtk_icon_view_get_tooltip_context bug Candidate
 # gtk_tree_view_get_cursor bug
 #