Addition to the Apple Globe key code to QMK

[ChrisGVE]

The change brings the Apple Globe Key as KC_GLOBE to QMK.

Description

The change is based mainly on @lordpixel23 QMK patch and is being discussed in depth in QMK Apple Fn Key created by @fauxpark.

Importantly, this change does not rely on VID/PID to be set on specific values.

In addition to the patch mentioned above, it introduces a new compilation flag, GLOBE_KEY_ENABLE such that:
(a) the required KEYBOARD_SHARE_EP is enabled when the Globe keycode is used
(b) keyboards or user layouts can make use of this definition for further customizations

The QMK documentation has been amended accordingly.

Certain key combinations are not yet working, though; in particular, 🌐︎+arrow or 🌐︎+FN do not work.

Thanks go to the input of many contributors, as this topic has been long discussed: @fauxpark, @HVR88, @drashna, and @lordpixel23.

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout (addition or update)
• Documentation

Issues Fixed or Closed by This PR

• Add support for globe key (🌐︎) for macOS/iPadOS/iOS #16651 issue was closed without solution

Checklist

• My code follows the code style of this project: C, Python
• I have read the PR Checklist document and have made the appropriate changes.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

[tzarc]

I'll leave the rest of the review for the team -- they know more about the status of this stuff than what I do.

[fauxpark]

Please undo the last merge commit.

[fauxpark]

Now everything else is gone...

[ChrisGVE]

Ok we should be back on track, sorry about the mishap.

[lordpixel23]

Is there anything truly still open or can this land?

[ChrisGVE]

Nothing on my end

[drashna]

Is there anything truly still open or can this land?

I can't speak for others, but I was waiting on @fauxpark, as he has more experience with the USB endpoint stuff, and the apple FN/globe key stuff.

However, develop isn't merged until end of feb

[fauxpark]

To be completely honest, I'm still hesitant to hit approve on this myself simply due to the fact the only known way to make this key fully functional is to spoof the VID/PID.

My initial goal way back when was to figure out how the Fn key worked as it pertained to the F-keys, and as I learned more about that it became clear that their behaviour changes based on the particular Apple keyboard model. So it seems to me that the Globe key in this current implementation will never really be able to do everything it can on a real device - by design.

By all means, if people are happy with this in its current state, go ahead. It's already got two green ticks. Great work and not your fault @ChrisGVE, but to me personally, it doesn't quite close the case, which is a shame.

[lordpixel23]

I use it every day as it is because it is already useful. It is frustrating it cannot be 100% but if we find a way to do that it can always be in some future PR.

[tzarc]

Can we clearly document the full list of shortcomings before merge, then? A single footnote is a bit hard to link to when it the next person who comes along complains that it doesn’t work as per their Apple-branded device.

[ChrisGVE]

To be completely honest, I'm still hesitant to hit approve on this myself simply due to the fact the only known way to make this key fully functional is to spoof the VID/PID.

My initial goal way back when was to figure out how the Fn key worked as it pertained to the F-keys, and as I learned more about that it became clear that their behaviour changes based on the particular Apple keyboard model. So it seems to me that the Globe key in this current implementation will never really be able to do everything it can on a real device - by design.

By all means, if people are happy with this in its current state, go ahead. It's already got two green ticks. Great work and not your fault @ChrisGVE, but to me personally, it doesn't quite close the case, which is a shame.

This is really a shame because I am using this key on all my boards, and I have a few see my userspace repo without any problem. I don't have to change VIP/PID to make it work, whether I tap the key to obtain the emoji picker dialog or when I use it in combination with other keys (either as a single key or when using a hold-esc key + other key on HHKB).

I think I gave a list of cases where it does not work earlier in this PR, and the documentation could be changed to make it more obvious, but I still stand by its usefulness.

(My only challenge will be to port it back to the Keychron board Q60 Max, which is based on an earlier version of QMK...)