Merge branch 'dgud/wx/fix-debug/OTP-18512' into maint-25

* dgud/wx/fix-debug/OTP-18512:
  wx: Use temp env for send_msg
  gl: Fix glDebugMessage functionality
  Fix tests
  Fix wx-3.2 macros and OpenGL support
  wx: Add debug printouts for OpenGL
  wx: Improve debug printouts

Author: Erlang/OTP

lib/wx/api_gen/gl_gen.erl

@@ -358,7 +358,10 @@ handle_arg_opt({c_only,Opt},P) -> P#arg{where=c, alt=Opt};
 handle_arg_opt(list_binary, P) -> P#arg{alt=list_binary};
 handle_arg_opt(string,  P=#arg{type=T}) -> P#arg{type=T#type{base=string}};
 handle_arg_opt({string,Max,Sz}, P=#arg{type=T}) ->
-    P#arg{type=T#type{base=string, size={Max,Sz}}}.
+    P#arg{type=T#type{base=string, size={Max,Sz}}};
+handle_arg_opt({size, Sz}, P=#arg{type=T}) ->
+    P#arg{type=T#type{size={Sz,Sz}}}.
+
 
 parse_type([], _Os) -> void;
 parse_type(C, Os) -> 

lib/wx/api_gen/gl_gen_erl.erl

@@ -88,8 +88,8 @@ gl_api(Fs, _GluNifs) ->
 
     w("-on_load(init_nif/0).~n",[]),
     w("~n-export([~s]).~n~n", [args(fun(EF) -> EF end, ",", ExportList, 60)]),
-    w("-export([get_interface/0, rec/1, lookup_func/0]).\n",[]),
-    w("-nifs([lookup_func/0]).\n",[]),
+    w("-export([get_interface/0, rec/1, lookup_func/1]).\n",[]),
+    w("-nifs([lookup_func_nif/1]).\n",[]),
     w("-define(nif_stub,nif_stub_error(?LINE)).~n", []),
     w("%% @hidden~n", []),
     w("nif_stub_error(Line) ->~n"
@@ -118,7 +118,9 @@ gl_api(Fs, _GluNifs) ->
     w("            error_logger:error_report([{gl, error}, {message, lists:flatten(Err)}]),~n", []),
     w("            rec(Op)~n", []),
     w("    end.~n~n", []),
-    w("lookup_func() -> ?nif_stub.\n\n",[]),
+    w("lookup_func(functions) -> lookup_func_nif(1);\n",[]),
+    w("lookup_func(function_names) -> lookup_func_nif(2).\n\n",[]),
+    w("lookup_func_nif(_Func) -> ?nif_stub.\n\n",[]),
     w("~n", []),
     w("~n", []),
 
@@ -380,6 +382,8 @@ spec_arg_type2(T=#type{single={list, _Max}}) ->
     "[" ++ spec_arg_type3(T) ++ "]";
 spec_arg_type2(T=#type{single={list,_,_}}) ->
     "[" ++ spec_arg_type3(T) ++ "]";
+spec_arg_type2(T=#type{single={list,_,_,_}}) ->
+    "[" ++ spec_arg_type3(T) ++ "]";
 spec_arg_type2(T=#type{single={tuple_list,Sz}}) ->
     "[{" ++ args(fun spec_arg_type3/1, ",", lists:duplicate(Sz,T)) ++ "}]".
 

lib/wx/api_gen/gl_gen_nif.erl

@@ -422,8 +422,8 @@ decode_var(P=#arg{name=Name, in=true, alt=Alt,
 
 
 decode_var(P=#arg{name=Name, in=false,
-                  type=#type{name=T, base=Base, size=Szs}}, Argc)
-  when Base =:= binary; Base =:= string ->
+                  type=#type{name=T, base=Base, size=Szs, single=Single}}, Argc)
+  when not is_tuple(Single), (Base =:= binary orelse Base =:= string) ->
     Sz = case Szs of
              {Max,_} when is_integer(Max) -> integer_to_list(Max);
              {Max,_} -> Max;
@@ -454,6 +454,19 @@ decode_var(P=#arg{name=Name, in=false, type=#type{name=T,single={list,Sz,_}}}, A
     w("  std::vector <~s> ~s (~s);\n", [T, Name, Sz]),
     w("  std::vector <ERL_NIF_TERM> ~s_ts (~s);\n", [Name, Sz]),
     {P,Argc};
+decode_var(P=#arg{name=Name, in=false,
+                  type=#type{base=Base, name=T,single={list,Sz,_,_}, size=Size}}, Argc) ->
+    case Base of
+        string ->
+            {BinSize, _} = Size,
+            w("  ~s = (unsigned char *) enif_alloc((int) ~s*sizeof(~s));\n", [Name,BinSize,T]),
+            w("  unsigned char *~s_ptr = ~s;\n", [Name,Name]),
+            store_free(Name ++ "_ptr");
+        _ ->
+            exit({?LINE, Base, P})
+    end,
+    w("  std::vector <ERL_NIF_TERM> ~s_ts (~s);\n", [Name, Sz]),
+    {P,Argc};
 decode_var(P=#arg{name=Name, in=true, type=#type{name="GLUquadric"}}, Argc) ->
     w("  if(!egl_get_ptr(env, argv[~w], (void **) &~s)) Badarg(~w,\"~s\");~n",
       [Argc, Name,?OP,Name]),
@@ -576,10 +589,6 @@ build_ret(Name,_Q,#type{name=T,base=Base,size=Sz,single=true})
        Ptr     -> io_lib:format("     enif_make_uint64(env, (egl_uint64_t) ~s)", [Name]);
        true    -> io_lib:format("     enif_make_int64(env, (egl_int64_t) ~s)", [Name])
     end;
-build_ret(Name,_Q,#type{base=string,single=true}) ->
-    io_lib:format("     enif_make_string(env, (const char *) ~s, ERL_NIF_LATIN1)",[Name]);
-build_ret(Name,_Q,#type{base=string,size={_,_OutSz}}) ->
-    io_lib:format("     enif_make_string(env, (const char *) ~s, ERL_NIF_LATIN1)",[Name]);
 build_ret(Name,_Q,#type{name=_T,base=float,size=Sz,single=true}) ->
     if Sz =< 4 -> io_lib:format("     enif_make_double(env, (double) ~s)", [Name]);
        true    -> io_lib:format("     enif_make_double(env, ~s)", [Name])
@@ -602,6 +611,12 @@ build_ret(Name,false,#type{single={list,Sz}}) when Sz >= 10, is_integer(Sz) ->
     io_lib:format("     enif_make_list_from_array(env, ~s_ts, ~w)",[Name, Sz]);
 build_ret(Name,false,#type{single={list,_,Sz}}) ->
     io_lib:format("     enif_make_list_from_array(env, ~s_ts.data(), ~s)",[Name, Sz]);
+build_ret(Name,false,#type{single={list,_,Sz,_}}) ->
+    io_lib:format("     enif_make_list_from_array(env, ~s_ts.data(), ~s)",[Name, Sz]);
+build_ret(Name,_Q,#type{base=string,single=true}) ->
+    io_lib:format("     enif_make_string(env, (const char *) ~s, ERL_NIF_LATIN1)",[Name]);
+build_ret(Name,_Q,#type{base=string,size={_,_OutSz}}) ->
+    io_lib:format("     enif_make_string(env, (const char *) ~s, ERL_NIF_LATIN1)",[Name]);
 build_ret(Name,_Q,T=#type{}) ->
     io:format("{~p, {~p, {single,{tuple,X}}}}.~n", [get(current_func),Name]),
     io:format(" ~p~n",[T]).
@@ -615,6 +630,12 @@ prepare_ret(#arg{name=Name, type=#type{single={list,_,Sz}}=T}) ->
     Fetch = build_ret(Name ++ "[ri]", false, T#type{single=true}),
     w("  for(int ri=0; ri < (int) ~s; ri++)\n"
       "    ~s_ts[ri] = ~s;\n",[Sz, Name, Fetch]);
+prepare_ret(#arg{name=Name, type=#type{single={list,_,Sz,Lengths}}=T}) ->
+    Fetch = build_ret(Name, false, T#type{single=true}),
+    w("  for(int ri=0; ri < (int) ~s; ri++) {\n"
+      "    ~s_ts[ri] = ~s;\n",[Sz, Name, Fetch]),
+    w("    ~s += ~s[ri];\n"
+      "   }\n", [Name, Lengths]);
 prepare_ret(_) ->
     ok.
 

lib/wx/api_gen/glapi.conf

@@ -483,24 +483,16 @@
 
 {"glDebugMessageControl", [{"count", {c_only, {length, "ids"}}},
  			      {"ids", {single, list}}]}.
-{"glDebugMessageInsertARB", {"length", {c_only, {size, "buf"}}}}.
-
-{"glGetDebugMessageLogARB", [{"sources", {single, {list, "count", "result"}}},
-                          {"types", {single, {list, "count", "result"}}},
-                          {"ids", {single, {list, "count", "result"}}},
-                          {"severities", {single, {list, "count", "result"}}},
-                          {"lengths", [{c_only, undefined}, {single, {list, "count", "result"}}]},
-                          {"messageLog", [{string, "bufSize", "result"}
-                                          %%,{single, {list, "bufsize", "result"}}
-                                         ]}]}.
+{"glDebugMessageInsert", {"length", {c_only, {size, "buf"}}}}.
 
 {"glGetDebugMessageLog", [{"sources", {single, {list, "count", "result"}}},
                           {"types", {single, {list, "count", "result"}}},
                           {"ids", {single, {list, "count", "result"}}},
                           {"severities", {single, {list, "count", "result"}}},
                           {"lengths", [{c_only, undefined}, {single, {list, "count", "result"}}]},
-                          {"messageLog", [{string, "bufSize", "result"}
-                                          %%,{single, {list, "bufsize", "result"}}
+                          {"messageLog", [
+                                          {single, {list, "count", "result", "lengths"}},
+                                          {size, "bufSize"}
                                          ]}]}.
 
 

lib/wx/api_gen/wx_extra/added_func.h

@@ -95,3 +95,9 @@ class wxAuiNotebookEvent : public wxBookCtrlEvent {
   void SetDragSource(wxAuiNotebook* s) { m_dragSource = s; }
   wxAuiNotebook* GetDragSource() const { return m_dragSource; }
 };
+
+class wxGLCanvas : public wxWindow
+{
+public:
+  bool CreateSurface();
+};

lib/wx/api_gen/wx_gen_nif.erl

@@ -1460,7 +1460,9 @@ gen_macros() ->
     w("#if wxUSE_WEBVIEW && wxUSE_WEBVIEW_IE~n"),
     w("#include <wx/msw/webview_ie.h>~n"),
     w("#endif~n"),
-
+    w("#if wxUSE_GLCANVAS_EGL && !wxCHECK_VERSION(3,2,3)~n"),
+    w("#include <EGL/egl.h>~n"),
+    w("#endif~n"),
 
     w("~n~n", []),
     w("#ifndef wxICON_DEFAULT_BITMAP_TYPE~n",[]),

lib/wx/api_gen/wxapi.conf

@@ -109,7 +109,10 @@
   {'WXK_BROWSER', {test_if, "wxCHECK_VERSION(3,1,0)"}},
   {'WXK_VOLUME',  {test_if, "wxCHECK_VERSION(3,1,0)"}},
   {'WXK_MEDIA',   {test_if, "wxCHECK_VERSION(3,1,0)"}},
-  {'WXK_LAUNCH',  {test_if, "wxCHECK_VERSION(3,1,0)"}},
+  {'WXK_LAUNCH',  {test_if, "wxCHECK_VERSION(3,2,0)"}},
+
+  %% Varies in 3.1 and 3.2
+  wxDF_MAX,
 
   {wxTOUCH, {test_if, "wxCHECK_VERSION(3,1,1)"}},
 
@@ -1439,11 +1442,23 @@
                   {pre_hook, [{erl, "{ok, _} = wxe_master:init_opengl(),"}]}
                  ]},
   {'SetCurrent', [{post_hook,[{c, "setActiveGL(memenv, Ecmd.caller, This, context)"}]}]},
+  {'CreateSurface', [{test_if, "wxUSE_GLCANVAS_EGL"},
+                     {pre_hook,
+                      [{c,  %% Workaround for EGL and 3.2.* crashes
+                        "\n#if !wxCHECK_VERSION(3,2,3)\n"
+                        "  if(!This) throw wxe_badarg(0);\n"
+                        "  if(This->GetEGLSurface() != EGL_NO_SURFACE)\n"
+                        "     eglDestroySurface(This->GetEGLDisplay(), This->GetEGLSurface());\n"
+                        "#endif\n"
+                       }]}
+                    ]},
+  'IsDisplaySupported',
   'SwapBuffers']}.
 
 {class, wxGLContext, object, [{ifdef, wxUSE_GLCANVAS}],
  [{'wxGLContext', [{"ctxAttrs", nowhere}]},
-  {'SetCurrent', [{post_hook,[{c, "setActiveGL(memenv, Ecmd.caller, win, This)"}]}]}
+  {'SetCurrent', [{post_hook,[{c, "setActiveGL(memenv, Ecmd.caller, win, This)"}]}]},
+  {'IsOK', [{test_if, "wxCHECK_VERSION(3,1,0)"}]}
  ]}.
 
 {class, wxAuiManager, wxEvtHandler, [{ifdef, wxUSE_AUI}],

lib/wx/c_src/egl_impl.c

@@ -51,7 +51,7 @@ ERL_NIF_TERM EGL_ATOM_BADARG;
 
 static ErlNifFunc egl_funcs[] =
 {
-    {"lookup_func", 0, egl_lookup_func_func}
+    {"lookup_func_nif", 1, egl_lookup_func_func}
 };
 static int egl_init(ErlNifEnv *env, void **priv_data, ERL_NIF_TERM arg)
 {
@@ -142,9 +142,22 @@ void * egl_lookup_func(int op)
     return gl_fns[op-GLE_LIB_START].nif_cb;
 }
 
+const char * egl_lookup_func_desc(int op)
+{
+    return gl_fns[op-GLE_LIB_START].name;
+}
+
+
 ERL_NIF_TERM egl_lookup_func_func(ErlNifEnv* env, int argc, const ERL_NIF_TERM argv[])
 {
-    egl_uword func = (egl_uword) egl_lookup_func;
+    egl_uword func = 0;
+    unsigned int which;
+    if(!(enif_get_uint(env, argv[0], &which)) && !(which == 1 || which == 2))
+        return enif_make_badarg(env);
+    if(which == 1)
+        func = (egl_uword) egl_lookup_func;
+    if(which == 2)
+        func = (egl_uword) egl_lookup_func_desc;
     if(sizeof(void *) == sizeof(unsigned int))
         return enif_make_uint(env, (unsigned int) func);
     else

lib/wx/c_src/gen/gl_nif.cpp

@@ -1,7 +1,7 @@
 /*
  * %CopyrightBegin%
  *
- * Copyright Ericsson AB 2008-2021. All Rights Reserved.
+ * Copyright Ericsson AB 2008-2023. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -11518,15 +11518,13 @@ void ecb_glDebugMessageInsert(ErlNifEnv* env, ErlNifPid *self, ERL_NIF_TERM argv
   GLenum type;
   GLuint id;
   GLenum severity;
-  GLsizei length;
   ErlNifBinary buf;
   if(!enif_get_uint(env, argv[0],  &source)) Badarg(5803,"source");
   if(!enif_get_uint(env, argv[1],  &type)) Badarg(5803,"type");
   if(!enif_get_uint(env, argv[2],  &id)) Badarg(5803,"id");
   if(!enif_get_uint(env, argv[3],  &severity)) Badarg(5803,"severity");
-  if(!enif_get_int(env, argv[4],  &length)) Badarg(5803,"length");
-  if(!enif_inspect_binary(env, argv[5], &buf)) Badarg(5803,"buf");
-  weglDebugMessageInsert(source,type,id,severity,length,(GLchar *) buf.data);
+  if(!enif_inspect_binary(env, argv[4], &buf)) Badarg(5803,"buf");
+  weglDebugMessageInsert(source,type,id,severity,(GLsizei) buf.size,(GLchar *) buf.data);
 }
 
 void ecb_glGetDebugMessageLog(ErlNifEnv* env, ErlNifPid *self, ERL_NIF_TERM argv[])
@@ -11549,6 +11547,8 @@ void ecb_glGetDebugMessageLog(ErlNifEnv* env, ErlNifPid *self, ERL_NIF_TERM argv
   std::vector <GLsizei> lengths (count);
   std::vector <ERL_NIF_TERM> lengths_ts (count);
   messageLog = (unsigned char *) enif_alloc((int) bufSize*sizeof(GLchar));
+  unsigned char *messageLog_ptr = messageLog;
+  std::vector <ERL_NIF_TERM> messageLog_ts (count);
   result = weglGetDebugMessageLog(count,bufSize,sources.data(),types.data(),ids.data(),severities.data(),lengths.data(),(GLchar *) messageLog);
   for(int ri=0; ri < (int) result; ri++)
     sources_ts[ri] =      enif_make_int(env, sources[ri]);
@@ -11558,16 +11558,20 @@ void ecb_glGetDebugMessageLog(ErlNifEnv* env, ErlNifPid *self, ERL_NIF_TERM argv
     ids_ts[ri] =      enif_make_int(env, ids[ri]);
   for(int ri=0; ri < (int) result; ri++)
     severities_ts[ri] =      enif_make_int(env, severities[ri]);
+  for(int ri=0; ri < (int) result; ri++) {
+    messageLog_ts[ri] =      enif_make_string(env, (const char *) messageLog, ERL_NIF_LATIN1);
+    messageLog += lengths[ri];
+   }
   reply = enif_make_tuple6(env,
           enif_make_int(env, result),
      enif_make_list_from_array(env, sources_ts.data(), result),
      enif_make_list_from_array(env, types_ts.data(), result),
      enif_make_list_from_array(env, ids_ts.data(), result),
      enif_make_list_from_array(env, severities_ts.data(), result),
-     enif_make_string(env, (const char *) messageLog, ERL_NIF_LATIN1) );
+     enif_make_list_from_array(env, messageLog_ts.data(), result) );
   enif_send(NULL, self, env,
    enif_make_tuple2(env, EGL_ATOM_REPLY, reply));
- enif_free(messageLog);
+ enif_free(messageLog_ptr);
 }
 
 void ecb_glPushDebugGroup(ErlNifEnv* env, ErlNifPid *self, ERL_NIF_TERM argv[])