clipboard() helper function to copy and paste from clipboard - implemented

[kensoh]

Raising an issue to implement clipboard() helper function, since this may be something commonly used. In normal user workflows, it would be using keyboard [ctrl]c and keyboard [ctrl]v (or [cmd] for macOS) to copy and paste text from the clipboard.

However, in some situations, getting the value store in clipboard directly to a variable in TagUI for usage, or setting the clipboard directly from a variable in TagUI would be very helpful. For eg, select all and copy to clipboard a PDF document, and then using clipboard() to access the value for data extraction / string-parsing etc.

[kensoh]

Draft syntax -

• clipboard('value') to store text value in clipboard
• result = clipboard() to return text value stored in clipboard

[kensoh]

This idea was initially considered in #547, however a helper function would be a more intuitive implementation than doing it as a new step which seems clumsy (#547 (comment))

Implementation checkpoints -

• 1. create a clipboard() helper function with logic below (expand out vision step)

// copy variable to clipboard
vision_step('clipboard = "' + value '"')
vision App.setClipboard(clipboard)

// paste clipboard to variable
vision output_sikuli_text(App.getClipboard())
clipboard = fetch_sikuli_text()

• 2. ensure that this is detected to trigger SikuliX engine
• 3. generate and validate new positive test case signature
• 4. verify to work with \r \n characters, single/double quotes
• 5. consider including clipboard() in multi-language support
• 6. enable clipboard() to be invoked in different languages

For 5, yes clipboard() should be enabled in multi-language, for consistency with other helper functions which have support for multi-language. To be implemented later on.

https://github.com/kelaberetiv/TagUI/tree/master/src/languages

[kensoh]

Above commit implements this feature. Documentation to be updated on the next packaged release to avoid confusion. Prior to packaged release, feature available from cutting edge version here -

https://github.com/kelaberetiv/TagUI#set-up

[kensoh]

Usage in TagUI script -

get clipboard text

echo clipboard()
key_info = clipboard()

put clipboard text

clipboard('123\n456\789');
js clipboard('abc\ndef\ghi')

(without the js step, the ; is required at the end of the JavaScript code, for TagUI to know that this is a JavaScript statement and not throw error on unrecognised statement in script)

[kensoh]

@ck81 fyi on this new helper function - I think it can open up interesting new use possibilities!