Expose screen dimensions #1519

skamensky · 2022-07-02T17:15:33Z

PR for issue #1518

Status: working for linux
Upcoming changes: macos and windows implementation of get dimensions
Requested feedback before I continue working on this:

api. Should this be different?
Does scale need to be handled or can we just return the height and width as it is from gtk? From the docs it seems this is fine and it also seems to be how it's used for other apis in wails
Did I modify all of the correct places for adding a new window call? If not, is there a comprehensive list of places to change? Are any of these auto-gererated
Should this even be called window or should be add a new "namespace" of screen since technically the api is unrelated to any individual window
Do we have somewhere to add tests?
General feedback (this is my first time using golang)

Some other questions

When do we put c implementation in the /v2/internal/ffenestri/ffenestri_{platform}.c files and when do we put them in the /v2/internal/frontend/desktop/{platform}/window.go files?

When do we need wait groups+invokeOnMainThread?
for example I see a wait group here

wails/v2/internal/frontend/desktop/linux/window.go

Lines 709 to 719 in 41d1bf3

    
           func (w *Window) Size() (int, int) { 
        
           	var width, height C.int 
        
           	var wg sync.WaitGroup 
        
           	wg.Add(1) 
        
           	invokeOnMainThread(func() { 
        
           		C.gtk_window_get_size(w.asGTKWindow(), &width, &height) 
        
           		wg.Done() 
        
           	}) 
        
           	wg.Wait() 
        
           	return int(width), int(height) 
        
           }

But none here

wails/v2/internal/frontend/desktop/linux/window.go

Lines 733 to 737 in 41d1bf3

    
           func (w *Window) SetMaxSize(maxWidth int, maxHeight int) { 
        
           	w.maxHeight = maxHeight 
        
           	w.maxWidth = maxWidth 
        
           	C.SetMinMaxSize(w.asGTKWindow(), C.int(w.minWidth), C.int(w.minHeight), C.int(w.maxWidth), C.int(w.maxHeight)) 
        
           }

When do we need to add to this switch statement?

wails/v2/internal/frontend/dispatcher/systemcalls.go

Lines 23 to 41 in 41d1bf3

    
           func (d *Dispatcher) processSystemCall(payload callMessage, sender frontend.Frontend) (interface{}, error) { 
        
           	// Strip prefix 
        
           	name := strings.TrimPrefix(payload.Name, systemCallPrefix) 
        
           	switch name { 
        
           	case "WindowGetPos": 
        
           		x, y := sender.WindowGetPosition() 
        
           		return &position{x, y}, nil 
        
           	case "WindowGetSize": 
        
           		w, h := sender.WindowGetSize() 
        
           		return &size{w, h}, nil 
        
           	case "Environment": 
        
           		return runtime.Environment(d.ctx), nil 
        
           	default: 
        
           		return nil, fmt.Errorf("unknown systemcall message: %s", payload.Name) 
        
           	} 
        
           }

v2/internal/frontend/runtime/wrapper/runtime.d.ts

leaanthony · 2022-07-03T02:24:15Z

Thanks for this! 🚀

To answer your questions:

api. Should this be different?

I think it's ok. The thing to keep in mind sometimes people have multiple monitors, which will affect the API.

Does scale need to be handled or can we just return the height and width as it is from gtk? From the docs it seems this is fine and it also seems to be how it's used for other apis in wails

Do you mean the DPI of the screens? This is handled behind the scenes for most scenarios. I think it's ok not to report that in this instance.

Did I modify all of the correct places for adding a new window call? If not, is there a comprehensive list of places to change? Are any of these auto-gererated

I'll add more documentation on how to do this and use this as an example for that. The only places you've left out are the darwin+windows implementations of the method but I'm assuming that's deliberate for now. These aren't auto-generated but that's not a bad idea ;-)

Should this even be called window or should be add a new "namespace" of screen since technically the api is unrelated to any individual window

I think I agree with you that it needs to be in a new "namespace". You suggested "Screen" and that's not a bad option.

Do we have somewhere to add tests?

Testing is hard for gui apps, but unit tests can be added using the <filename>_test.go convension. You can find some examples of this in the repo.

General feedback (this is my first time using golang)

You're doing well - keep going! 👍

When do we put c implementation in the /v2/internal/ffenestri/ffenestri_{platform}.c files and when do we put them in the /v2/internal/frontend/desktop/{platform}/window.go files?

Always in internal/frontend, never in ffenestri. It's legacy code left over from the alpha days but has been kept around as it has some extra code that hasn't yet made it to v2 proper.

When do we need wait groups+invokeOnMainThread?

All GUI functions should normally happen on the main thread or else they have a habit of going a bit mental. This causes issues when you need to return values as now they are happening on a different thread. The wait groups are there to coordinate this and wait until the call has completed before returning the result. See it as an async to sync mechanism.

skamensky · 2022-07-04T10:37:10Z

Thank you for the feedback. I'm working on this. Will post back when I have something working for Linux with a new 'screen' api.

I was getting the following errors due to some bad casts. Gdk-CRITICAL **: 18:58:51.943: gdk_monitor_get_geometry: assertion 'GDK_IS_MONITOR (monitor)' failed Gdk-CRITICAL **: 18:58:51.943: gdk_display_get_monitor_at_window: assertion 'GDK_IS_DISPLAY (display)' failed This commit fixes these errors

…into expose-dimensions

skamensky · 2022-07-05T18:04:28Z

@leaanthony , This PR now exposes a Screen api. As of now it only exposes a ScreenGetAll function but convenience functions can be added if needed.

Here is some sample go and js on my system (with outputs)

func (a *App) OnDomReady(ctx context.Context) {
	screens, err := runtime.ScreenGetAll(ctx)
	if err != nil {
		fmt.Printf("Error getting screens: %v\n", err)
		return
	}
	for _, screen := range screens {
		fmt.Printf("{height=%v, width=%v IsCurrent=%v, IsPrimary=%v}\n", screen.Height, screen.Width, screen.IsCurrent, screen.IsPrimary)
	}
}

Output

{height=720, width=1280 IsCurrent=true, IsPrimary=true}
{height=540, width=960 IsCurrent=false, IsPrimary=false}

runtime.ScreenGetAll().then(screens=>{
    screens.forEach(screen=>{
        console.log(screen)
    })    
})

Output

{isCurrent: true, isPrimary: true, width: 1280, height: 720}
{isCurrent: false, isPrimary: false, width: 960, height: 540}

Is this API OK now? Should I get started on Windows/MacOS, or are there some changes/a different that you'd like to see?

skamensky · 2022-07-05T18:08:54Z

v2/internal/frontend/desktop/linux/window.go

 GdkMonitor* getCurrentMonitor(GtkWindow *window) {
 	// Get the monitor that the window is currently on
 	GdkDisplay *display = gtk_widget_get_display(GTK_WIDGET(window));
-	GdkWindow *gdk_window = gtk_widget_get_window(GTK_WIDGET(window));


This should be removed from this PR and put into a different PR and a different commit. In fact, this isn't even the change I meant to introduce (however, there is a bug in this code that I have a fix for).

…tions, and formatting

leaanthony · 2022-07-06T09:27:13Z

Looking good so far 👍

…ction

skamensky · 2022-07-09T11:07:31Z

Glad to report that the windows implementation is working!

As an aside @leaanthony how have you debugged on windows? I couldn't get the windows commant prompt or powershell to output to stdout, it simply opens the windows which is another process. I attmpeted to use procmon and windows debugger but I couldn't figure out how to view simple fmt.Printf outputs.

leaanthony · 2022-07-09T11:08:59Z

I just use the -ide goland flag when generating the project and use the ide debugger

skamensky · 2022-07-12T14:00:41Z

@leaanthony , all three platforms have been implemented. What should the next steps be?

leaanthony · 2022-07-12T21:31:45Z

Need to find time to review it 👍

leaanthony

This is looking and working great! My only comment is that on MacOS, the screen height looks to be affected if the task bar is there. If I'm on a screen with a taskbar, it reports 64 pixels less than when the taskbar is hidden. I think this is because the code is using visibleFrame instead of frame. So we could either return both, or keep it consistent between the platforms (report full screen size for all platforms). Thoughts?

leaanthony · 2022-07-14T11:47:45Z

v2/internal/frontend/runtime/desktop/screen.js

+ * // Gets the all screens. Call this anew each time you want to refresh data from the underlying windowing system.
+ *
+ * @export
+ * @return {Promise<{isCurrent: boolean; isPrimary: boolean; width : number  height : number}>} The screens


Does this return an array of objects?

Yes, this is a mistake. In fact, my IDE complains about this syntax anyway. BTW, what syntax is this documentation written in?

JSDoc, though I think you can use typescript syntax.

leaanthony · 2022-07-14T11:49:24Z

v2/internal/frontend/desktop/windows/screen.go

+		first.RcWork.Bottom == second.RcWork.Bottom &&
+		first.RcWork.Right == second.RcWork.Right &&
+		first.RcWork.Left == second.RcWork.Left &&
+		first.DwFlags == second.DwFlags


This looks like a duplicate comparison

I didn't know if comparing RcMonitor only instead of also comparing RcWork was enough to guarantee uniqueness of a monitor. Does RcMonitor carry enough uniqueness to drop the comparison with RcWork

Sorry, I meant you have first.DwFlags == second.DwFlags twice

Ah, I missed that. Yes, I'll remove that.

skamensky · 2022-07-14T15:57:30Z

#1519 (review)
Yes, I wasn't sure what the difference was, now that I understand currectly, we should use frame instead of viewframe. I agree, the meaning of Screen should stay consistent across platforms.

Overall I would like to get your feedback on the rest of the questions I left i response and clean the code up a bit (I think I have a typo in a function name somewhere, I need to find it).

Should squash the commits that I think don't contribute anything? Or would you prefer I leave the history as is?

…into expose-dimensions

To use frame instead of visibleframe to keep into account the space the the dock takes up We want to include that space in the calculation in order to keep the sizes of screens consistent across platforms

It used to say it returned a single screen object. Now it says that it returns an array of screen objects

skamensky · 2022-07-15T13:08:17Z

@leaanthony ,

I've taken care of all of the changes requested.

Anything else you'd like me to do here?

BTW, this question still stands:

Should squash the commits that I think don't contribute anything? Or would you prefer I leave the history as is?

leaanthony · 2022-07-15T13:27:28Z

I'll check it out over the weekend. We'll squash merge so all good 👍

leaanthony · 2022-07-16T00:19:35Z

@all-contributors please add @skamensky for code, ideas and docs 👍

allcontributors · 2022-07-16T00:19:44Z

@leaanthony

I've put up a pull request to add @skamensky! 🎉

leaanthony · 2022-07-16T02:33:46Z

Nice one! This is a fantastic contribution 🎉

skamensky · 2022-07-16T09:12:20Z

Yay thank you for guiding me through my first open source contribution!

leaanthony · 2022-07-16T10:55:45Z

First? Really? You did a fantastic job! 👏

get dimensions working for linux

9df652e

skamensky mentioned this pull request Jul 2, 2022

Expose screen dimensions #1518

Closed

leaanthony reviewed Jul 3, 2022

View reviewed changes

v2/internal/frontend/runtime/wrapper/runtime.d.ts Outdated Show resolved Hide resolved

Merge branch 'master' into expose-dimensions

2ff0901

leaanthony and others added 5 commits July 4, 2022 22:35

Merge branch 'master' into expose-dimensions

5589495

Merge branch 'master' into expose-dimensions

4f976c3

Adding Screen namespace along with linux implementation

8c43ad0

Merge branch 'expose-dimensions' of https://github.com/skamensky/wails …

d4e2d9a

…into expose-dimensions

skamensky commented Jul 5, 2022

View reviewed changes

skamensky added 2 commits July 5, 2022 21:11

moving ScreenGetAll into a more appropriate place

933da6b

Fixing typescript definition mistake, documentation, ordering of func…

6c8c802

…tions, and formatting

skamensky added 5 commits July 9, 2022 13:56

add ScreenGetAll to more templates

ee4bf21

moving screen into its own javascript file

422c6e9

fixing bug where screen objects are not returned from the runtime fun…

7bb0722

…ction

rebuilding frontend wrapper package

bb26a72

adding windows implementation of ScreenGetAll

fcfb622

adding screen get all implementation for darwin

ba4decb

Merge branch 'master' into expose-dimensions

750c83c

leaanthony requested changes Jul 14, 2022

View reviewed changes

reverting a change that is unrelated to the work on expose-dimensions

e1aadba

skamensky added 8 commits July 15, 2022 15:20

removing duplicate comparison

78ed369

Merge branch 'expose-dimensions' of https://github.com/skamensky/wails …

6393b8c

…into expose-dimensions

Merge branch 'master' into expose-dimensions

c4a5680

changing GetNthScreen in screen API on macos

c4441f7

To use frame instead of visibleframe to keep into account the space the the dock takes up We want to include that space in the calculation in order to keep the sizes of screens consistent across platforms

Correcting screen jsdoc

f54cd7e

It used to say it returned a single screen object. Now it says that it returns an array of screen objects

Fixing typo in function name

6f7ed02

reverting pointless spacing change

cf0f94a

reverting pointless spacing change

2565beb

allcontributors bot mentioned this pull request Jul 16, 2022

docs: add skamensky as a contributor for code, ideas, doc #1574

Merged

Merge branch 'master' into expose-dimensions

fd43b7f

leaanthony merged commit 04d3541 into wailsapp:master Jul 16, 2022

	func (w *Window) Size() (int, int) {
	var width, height C.int
	var wg sync.WaitGroup
	wg.Add(1)
	invokeOnMainThread(func() {
	C.gtk_window_get_size(w.asGTKWindow(), &width, &height)
	wg.Done()
	})
	wg.Wait()
	return int(width), int(height)
	}

	func (w *Window) SetMaxSize(maxWidth int, maxHeight int) {
	w.maxHeight = maxHeight
	w.maxWidth = maxWidth
	C.SetMinMaxSize(w.asGTKWindow(), C.int(w.minWidth), C.int(w.minHeight), C.int(w.maxWidth), C.int(w.maxHeight))
	}

	func (d *Dispatcher) processSystemCall(payload callMessage, sender frontend.Frontend) (interface{}, error) {

	// Strip prefix
	name := strings.TrimPrefix(payload.Name, systemCallPrefix)

	switch name {
	case "WindowGetPos":
	x, y := sender.WindowGetPosition()
	return &position{x, y}, nil
	case "WindowGetSize":
	w, h := sender.WindowGetSize()
	return &size{w, h}, nil
	case "Environment":
	return runtime.Environment(d.ctx), nil
	default:
	return nil, fmt.Errorf("unknown systemcall message: %s", payload.Name)
	}

	}

Uh oh!

Expose screen dimensions #1519

Expose screen dimensions #1519

Uh oh!

Conversation

skamensky commented Jul 2, 2022

Uh oh!

Uh oh!

leaanthony commented Jul 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

skamensky commented Jul 4, 2022

Uh oh!

skamensky commented Jul 5, 2022

Uh oh!

skamensky Jul 5, 2022

Choose a reason for hiding this comment

Uh oh!

leaanthony commented Jul 6, 2022

Uh oh!

skamensky commented Jul 9, 2022

Uh oh!

leaanthony commented Jul 9, 2022

Uh oh!

skamensky commented Jul 12, 2022

Uh oh!

leaanthony commented Jul 12, 2022

Uh oh!

leaanthony left a comment

Choose a reason for hiding this comment

Uh oh!

leaanthony Jul 14, 2022

Choose a reason for hiding this comment

Uh oh!

skamensky Jul 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leaanthony Jul 14, 2022

Choose a reason for hiding this comment

Uh oh!

leaanthony Jul 14, 2022

Choose a reason for hiding this comment

Uh oh!

skamensky Jul 14, 2022

Choose a reason for hiding this comment

Uh oh!

leaanthony Jul 14, 2022

Choose a reason for hiding this comment

Uh oh!

skamensky Jul 15, 2022

Choose a reason for hiding this comment

Uh oh!

skamensky commented Jul 14, 2022

Uh oh!

skamensky commented Jul 15, 2022

Uh oh!

leaanthony commented Jul 15, 2022

Uh oh!

leaanthony commented Jul 16, 2022

Uh oh!

allcontributors bot commented Jul 16, 2022

Uh oh!

leaanthony commented Jul 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

skamensky commented Jul 16, 2022

Uh oh!

leaanthony commented Jul 16, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

leaanthony commented Jul 3, 2022 •

edited

Loading

skamensky Jul 14, 2022 •

edited

Loading

leaanthony commented Jul 16, 2022 •

edited

Loading