wx inspection

[gswifort]

@CEXT-Dan
For my needs I quickly created something like this.
You open some frame, press Ctrl+Alt+I and an inspection frame opens. Do you think it can be done better? Maybe add PYRX_WX_DEBUG in the configuration?

The best option would be to use wx.lib.mixins.inspection.InspectableApp to initialize the object returned by .wxApp()

@command
def init_wx_inspection():
    from pyrx import Ap
    from wx.lib.mixins.inspection import InspectionMixin, InspectionTool

    wxapp = Ap.Application.wxApp()

    InspectionTool().Init(app=wxapp)  # initialize the inspection tool (singleton)

    wxapp.ShowInspectionTool = InspectionMixin.ShowInspectionTool.__get__(wxapp, wxapp.__class__)
    wxapp._OnKeyPress = InspectionMixin._OnKeyPress.__get__(wxapp, wxapp.__class__)
    InspectionMixin.InitInspection(wxapp)

[CEXT-Dan]

I have not heard of this tool before, I don’t see this tool in wxWidgets (C++)
Normally when I pass back to wxPython, I just pass the C++ instance using wxPyConstructObject.
otherwise it's best to create it in Python

If you need to watch for messages and events, maybe you can use registerWatchWinMsg

import traceback
from pyrx_imp import Rx, Ge, Gs, Gi, Db, Ap, Ed
 
#WatchWinMsg
print("command = startWatch")
print("command = endWatch")
 
WM_MOUSEMOVE = 512
 
#messageId, hwnd, lParam, wParam, pt.x, pt.y,time;
def winMessage(msg):
        if msg[0] == WM_MOUSEMOVE:
            print(msg[4],msg[5])
            
 
def PyRxCmd_startWatch():
    try:
        Ap.Application.registerWatchWinMsg(winMessage)
    except Exception as err:
        print(err)
        
def PyRxCmd_endWatch():
    try:
        Ap.Application.removeWatchWinMsg(winMessage)
    except Exception as err:
        print(err)

[gswifort]

It looks like this:

[gswifort]

You can view the frame structure and modify its properties via the console.

[CEXT-Dan]

Looks like a pretty useful tool! It missed some of the controls in palettes, but picked up all the controls in other dialogs I tested.
I don’t see a way to do this in C++, so yeah maybe a setting in the new user config and initialized somewhere in _host_init.py?

[gswifort]

Yes, _host_init is the best place. I'll take care of that after #289

[gswifort]

A bit off topic, but maybe it's not worth starting a new discussion.
wx.GetApp() should return the current application, which is what Ap.Application.wxApp() returns, currently it creates a new application object. Do you think this can be fixed?

[CEXT-Dan]

It’s the same.
Try print(wx.GetApp().AppName)
The difference is wx.GetApp() returns wxAppConsole which does not have access to top window
Ap.Application.wxApp() returns wxApp with access to top window

I’ve thought about modifying WX so it’s more tightly coupled with this project. I really would like to see the experimental darkmode stuff added in. However, it’s a huge task and I would risk breaking compatibility with other modules that can use wx, I.e matplotlib

[gswifort]

The solution seems to be to call wx.App first, then wx.GetApp() will return exactly the same object.

>>> import wx
>>> wx.GetApp()
<wx._core.AppConsole object at 0x000001A185A0B1D0>

>>> wx.CallAfter(lambda: print("This won't work"))
>>> app = wx.App()
>>> app
<wx.core.App object at 0x000001A18BDB75C0>

>>> app2 = wx.GetApp()
>>> app2
<wx.core.App object at 0x000001A18BDB75C0>

>>> app2 is app
True

>>> wx.CallAfter(lambda: print("This will print to the host command line (not to the console since it will execute after that python line has finished executing)"))

This is useful for wx.GetApp to return the correct application object because wx (and probably other libraries) use it internally, e.g. to call wx.CallAfter (I think it works the same as registerOnIdleWinMsg), but it is more intuitive because it is only done once, you don't need to call removeOnIdleWinMsg.

I wonder if this could have any negative consequences, if not it would be nice to call wx.App() in _host_init.py.

I don't understand, for example, this:

>>> app.AppName
'ld'

but this works well:

>>> app.TopWindow.Hide()
True

>>> app.TopWindow.Show()
True

[CEXT-Dan]

Yeah, I had issues with this, wxPython seems to have some additional wrappers, wxApp, wxPyApp
https://discuss.wxpython.org/t/wxpyconstructobject-with-wxapp/36664
https://discuss.wxpython.org/t/instance-of-wx-app/36663

Generally, this is not needed, using None for parent arguments works fine because wxTheApp is defined in C++
I would feel safer if samples showed Ap.Application.wxApp() as it directly returns the C++ counterpart, I know it’s not an invalid cast
but if you need to use wx.GetApp() for some internal code, and it works, its fine

[gswifort]

Although it's probably worth considering why it works on 2.2.6

[CEXT-Dan]

Interesting, I’ll look

[CEXT-Dan]

The only thing I can see that has changed is going from wxPython 4.2.2 to wxPython 4.2.3
The access violation is in wxPython’s DLL, I don't compile this

Let’s stick to using any one of these, since wx.App() is really just a constructor to create new app

@Ap.Command()
def doit():
    try:
        print(wx.App.Get())
        print(wx.GetApp())
        print(wx.App.GetInstance())
        print(Ap.Application.wxApp()) #GuiApp
    except Exception as err:
        traceback.print_exception(err)

[gswifort]

It seems that all you need to do is initialize wxApp with PyRxCore at the very beginning and everything works.

import wx
from pyrx import Ap, command

rxapp = None


@command
def doit():
    global rxapp
    rxapp = Ap.Application.wxApp()  # init wxApp
    wx.CallAfter(print, "wx CallAfter called")
    wx.CallLater(500, print, ".")
    wx.CallLater(1000, print, ".")
    wx.CallLater(1500, print, ".")
    wx.CallLater(2000, print, "wx CallLater called")

    print(f"{rxapp=}")
    print(f"{wx.GetApp()=}")
    print(f"{wx.App.Get()=}")
    print(f"{wx.App.GetInstance()=}")

Polecenie: PYLOAD
Success module DEMO is loaded: 
Polecenie: DOIT
rxapp=<wx._core.PyApp object at 0x00000251074A1B50>
wx.GetApp()=<wx._core.PyApp object at 0x00000251074A1B50>
wx.App.Get()=<wx._core.PyApp object at 0x00000251074A1B50>
wx.App.GetInstance()=<wx._core.PyApp object at 0x00000251074A1B50>
Polecenie: wx CallAfter called
.
.
.
wx CallLater called
PYRELOAD
Success module DEMO is reloaded: 
Polecenie: DOIT
rxapp=<wx._core.PyApp object at 0x00000251074A1B50>
wx.GetApp()=<wx._core.PyApp object at 0x00000251074A1B50>
wx.App.Get()=<wx._core.PyApp object at 0x00000251074A1B50>
wx.App.GetInstance()=<wx._core.PyApp object at 0x00000251074A1B50>
Polecenie: wx CallAfter called
.
.
.
wx CallLater called

[CEXT-Dan]

I added it to _host_init.py works perfect

[CEXT-Dan]

Its weird, I would expect it to hit WxRxApp’s destructor

PyRx/PyRxCore/PyRxApp.h

Lines 77 to 90 in 14a8e78

	class WxRxApp : public wxApp
	{
	public:
	WxRxApp() = default;
	virtual ~WxRxApp() override = default;
	virtual bool OnInit() override;
	virtual int OnExit() override;
	virtual void WakeUpIdle() override;
	virtual void ExitMainLoop() override;
	bool Init_wxPython();
	static WxRxApp& instance();
	public:
	std::unique_ptr<WinFrame> frame;
	};

[CEXT-Dan]

so this is resolved?

[gswifort]

Yes, the problem is solved, I still need to add a feature to enable wx inspection

[CEXT-Dan]

This line causes GstarCAD to crash on exit
_ = wx.App() # if wx.App() is not called,

[CEXT-Dan]

I’m considering removing this, according to the docs, this is to create a new wx.App.
why cant we just use Ap.Application.wxApp()?

[gswifort]

wx.CallAfter doesn't work if wx.GetApp() returns PyApp, it works for wx.App. CallAfter is used during InspectionFrame initialization (and elsewhere inside wx).
Maybe we need to create a context manager that sets wx.App() for the duration of a given function execution?

[CEXT-Dan]

the way I see it, we can't call wx.App() we'll have to find another way

[CEXT-Dan]

As I mentioned here it appears to call wxApp::SetInstance and replaces my instance, when it’s garbage collected, it’s set to null, we can’t allow this, it's UB

wxPyApp derives from wxApp. Unfortunately, I cannot subclass it as it’s not in in a header. Next question is, why doesn’t wx.CallAfter work with WxRxApp, I don’t see anything special in wxPyApp

[CEXT-Dan]

that was added to mute this assert

[CEXT-Dan]

maybe it's not needed anymore with the wx.YieldIfNeeded() fix

[CEXT-Dan]

uploaded a fresh build to test

[CEXT-Dan]

I also added a test, but, maybe you can improve it. that way I won't do dumb stuff anymore 😁

[gswifort]

Thanks, this test is probably enough :)

[gswifort]

You can also watch for events. My current goal is to have the host frame send events to wx, so that the Bind method can be called on it. I have no idea how to do this, but I guess we should somehow replace WNDPROC with wxWndProc and pass to wxWndProc all events not handled by the host's WNDPROC.

[CEXT-Dan]

Did you look at Ap.Application.registerWatchWinMsg in PySamples\PyAp\testWatchWinMsg?
you can get every win32 event. If you try, you should immediately filter WM_PAINT or you will be flooded.

[gswifort]

yes, but it's inconvenient. Bind would be much better.

[CEXT-Dan]

how about binding to toplevelwindow?

[gswifort]

doesn't work. I think the reason is that TopWindow (host frame) has WNDPROC of the host and not wxWndProc

[CEXT-Dan]

It should be the same, there’s only one message pump. I will try to bind and return wxWindow instances for the main frame, and the document tomorrow

[CEXT-Dan]

Added Document.getwxWindow. I could not bind events to it.
I noticed the inspection tool does pickup all wxPython controls.

[CEXT-Dan]

palette structure is
In C++
wxTopLevelWindow

• wxWindow
• • wxPanel

Then in python
wx.Panel

• .XRC

BTW, DialogBlocks is free now
Its for C++, it generates XRC and C++ event bodies. Its super easy to port the C++, mostly changing wxEvent to wx.Event
it's awesome for creating complex GUIs

[gswifort]

I use wxFormBuilder. It generates ready-to-use python classes.

[gswifort]

I could not bind events to it.

@CEXT-Dan, could you please ask a question about this on the wxpython forum?

[CEXT-Dan]

It’s not a python issue; I could not bind or connect in C++ wxWidgets. All of the MFC + wxWidgets samples show forwarding messages from the message map, this is the approach I took in palettes

I think the only way to do this is with a hook

[CEXT-Dan]

I could not bind events to it.

@CEXT-Dan, could you please ask a question about this on the wxpython forum?

I asked in the wxWidgets forum (waiting for moderator approval)
https://forums.wxwidgets.org/viewtopic.php?f=1&t=52054

[CEXT-Dan]

I played around with this. This sample is interesting because it forwards messages from PreTranslateMessage to evtLoop->PreProcessMessage(msg). I tried with AcedFilterWinMsgFn, but I could tell it bogged down performance. There’s no reason to pound on wxWidgets for messages it’s never going to handle, so I removed it.

I still think the best approach for the inspector, if it needs MFC messages, is for it to use Ap.Application.registerWatchWinMsg and forward the events to the inspector. I don't know how HWNDs are mapped to wxWidget IDs though

Another item that may throw things off is, I use CAcModuleResourceOverride everywhere (basically a resource switcher)

side note, watchWinMsg is handy when doing stuff like trying to detect a right click, or scroll action while using AcedJig