[WIP] Copy-paste patch objects using system clipboard text buffer #2086

eeropic · 2023-09-05T06:34:31Z

Opening wip PR for discussion
Related issue #635

Todo

do not use static variables (use gl_privatedata for clipboard length and text)
edit commit history so copy/paste functionality are in separate commits, remove unnecessary
refactor, DRY, etc..
copy: test serialization (escaping special chars in particular) by diffing saved patches and patches serialized to clipboard
memory allocation checks (+error handling)
Validate patch data before attempting paste (regex?)
handle atom width attribute, i.e. ,f 16 in the end of each patch line (atom width in chars)

Maybe

figure out whether to include #N for new canvas. i.e. on copying, should the copied patch include the canvas in order to be saved as a proper patch, and on pasting, the first #N should be then ignored.
Should paste be single action instead of two? Currently there's 2 functional copy buffers (internal and text)

Testing

Test on windows (latest build tested on win10 64bit)
Test on osx (latest build tested on arm64 m1, osx 13.2.1)
Test on linux (latest build tested on arm64 debian 11)

Other

escape clipboard string when sending back from tcl to c when pasting
Text to binbuf chunks - maximum string length is now limited by MAXPDSTRING, which limits the amount of objects you can copy/paste
split lines to handle longer messages (long arrays for example) through pdsend
bug: handle double paste on mac, resulting from menu command keybind declaration running the command twice
handle paste undo

umlaeute

pdgui_vmess already takes care of escaping.
just use it.

src/g_editor.c

umlaeute

better but not there yet

src/g_editor.c

umlaeute · 2023-09-05T22:02:02Z

tcl/pd_bindings.tcl

    bind_capslock all $::modifier-Key a {menu_send %W selectall}
    bind_capslock all $::modifier-Key b {menu_helpbrowser}
    bind_capslock all $::modifier-Key c {menu_send %W copy}
+    bind_capslock all $::modifier-$alt-Key c {menu_send %W copy-to-clipboard-as-text}


the Alt/Option is also handled in ::pd_bindings::global_bindings, i think it should be handled only once (like with $::modifier)

umlaeute · 2023-09-05T22:02:43Z

tcl/pd_menus.tcl

    } else {
        set accelerator "Ctrl"
+        set alt "Alt"


eeropic · 2023-09-06T05:36:20Z

Also still need to properly escape brackets, commas, etc when sending back from Tcl.

Im looking at

pure-data/tcl/wheredoesthisgo.tcl

Line 153 in c0a7c16

proc unspace_text {x} {

and pdtk_text.tcl, but not sure if theres already a proc that does this non-destructive (i.e. not removing commas altogether)

canvas_copy_to_clipboard_as_text() performs canvas_docopy and gets the binary object buffer as text, and passes it to TCL to copy to system clipboard canvas_paste_from_clipboard_text() calls TCL to send system clipboard text, tcl then calls canvas_got_clipboard_content() which transforms the text back to binary buffer and performs canvas_dopaste TODO: split clipboard append to chunks

src/g_editor.c

umlaeute · 2023-09-26T07:19:43Z

src/g_editor.c

-{
-    pdgui_vmess("pdtk_get_clipboard_text", "^", x);
-}
+static t_binbuf *clipboard_patch_bb = NULL;


this should go into (t_glist*)->gl_privatedata

src/g_editor.c

tcl/pdtk_canvas.tcl

umlaeute · 2023-09-26T08:11:20Z

i think i discovered a bug in pdgui_vmess() where A_COMMA and a comma.symbol ( gensym(",")) are both sent as ,.

this needs to be fixed before this PR can properly handle appendicles (, f ...)

eeropic · 2023-09-26T19:56:33Z

i think i discovered a bug in pdgui_vmess() where A_COMMA and a comma.symbol ( gensym(",")) are both sent as ,.

this needs to be fixed before this PR can properly handle appendicles (, f ...)

Ok, I was wondering about this before.
Now tried printing out on save, and on copy, and can verify.
Saving: (printing binbuf before free at canvas_savetofile)

#X
text
34
25
look
\,
setting
width
,
f
12
;

Copying (pdgui_vmess()):

#X
text
34
25
look
,
setting
width
,
f
12
;

eeropic · 2023-09-27T16:27:28Z

i think i discovered a bug in pdgui_vmess() where A_COMMA and a comma.symbol ( gensym(",")) are both sent as ,.

this needs to be fixed before this PR can properly handle appendicles (, f ...)

Even if I have the , f ... correctly in text clipboard, it needs to be handled separately (thinking of another flag) as pdsend will split the message / interpret it as 2 messages delimited by comma

…escaping

umlaeute · 2023-09-28T13:27:39Z

src/g_editor.c

        case CLIPBOARD_PATCH_TEXT_LINE_PARTIAL:
        case CLIPBOARD_PATCH_TEXT_LINE_END:
-            if (clipboard_patch_bb) {
+        case CLIPBOARD_PATCH_TEXT_LINE_END_APPENDIX:


i'm not exactly sure about this.
since a Pd-file can be properly parsed by binbuf_text(), even if it contains message delimiting commas ([foo, bar() and gobj attributes (, f 10), I do not see why need special handling here.
ideally, the canvas_got_clipboard_contents() should get the raw text (as in the clipboard), and that's it (and all the necessary escaping happens in the GUI)

#X msg 78 108 foo \, bar, f 30;

(and sorry for not saying that before you started to implement it)

Heh no worries. I'm just having trouble transmitting the comma with pdsend, i.e. something, f32 gets interpreted as 2 messages. So perhaps a special escape sequence for the comma would suffice? So \, gets transmitted as-is, but , gets handled somehow differently (tcl->pd)

void canvas_got_clipboard_contents(t_canvas *x, t_floatarg flagf, t_symbol *s) { const char *debug_str = "#X msg 78 108 foo \\, bar\, f 30;"; t_binbuf *temp_bb = binbuf_new(); binbuf_text(temp_bb, debug_str, strlen(debug_str)); canvas_dopaste(x, temp_bb); binbuf_free(temp_bb); }

Works just fine, but I can't get it transmitted via pdsend properly

that's because a plain comma in a message is a message separator in Pd lingo.
also, a line in a patch file might not be terminated by a semicolon, in which case it is continued on the next line:

#X obj 79 136 print hello;

is really equivalent to

#X obj 79 136 print hello;

~~i think this is currently not handled correctly (but haven't actually checked)~~

this is currently not handled correctly, and i get:

bad arguments for message 'got-clipboard-contents' to object 'canvas' bad arguments for message 'got-clipboard-contents' to object 'canvas' #: no such object ob: no such object prin: no such object hello: no such object

iirc, miller's suggestion was:

send a start-message to initiate the binbuf build (aka got-clipboard-contents 0)

send the text string

send an end-message to stop the binbuf build (aka got-clipboard-contents 2)

after that, the text buffer is complete, and can be converted into a binbuf and copied into the patch

here's a super stupid (and simple idea):
do not attempt to send the data as a symbol (it's going to pollute the symbol table anyhow), but as a list of numbers (UTF-8-encoded).
This is trivial to reconstruct on the receiving side.

I don't think it's stupid :-) it's like, stream of pure data... (eh) will try. Would love this to take as few lines as possible and maximize utilizing existing functionality.

see eeropic-forks#1

Great stuff!! Just need to implement the chunking, so it doesn't cut off the data in pdsend

Sure. It's just a poc.

I'm pretty sure there is some memory overallocation and what not.
On rethinking, I also would prefer "reset" and "submit" instead of "begin" and "end".

easier to read than numbers (or looooong defines). also easier to understand when watching the core<->gui communication.

…-clipboard

Improvement/text clipboard

porres · 2024-04-10T00:43:20Z

really hoping this gets done :)

umlaeute requested changes Sep 5, 2023

View reviewed changes

src/g_editor.c Outdated Show resolved Hide resolved

eeropic force-pushed the copy-paste-clipboard-text-buffer branch 2 times, most recently from 7060e56 to f41f9e2 Compare September 5, 2023 19:45

eeropic marked this pull request as draft September 5, 2023 19:47

eeropic force-pushed the copy-paste-clipboard-text-buffer branch from f41f9e2 to 6b1c7f8 Compare September 5, 2023 19:51

umlaeute requested changes Sep 5, 2023

View reviewed changes

eeropic force-pushed the copy-paste-clipboard-text-buffer branch from 2d3492a to de783d1 Compare September 8, 2023 06:29

Fix duplicate pasting on mac

7df8951

umlaeute reviewed Sep 25, 2023

View reviewed changes

src/g_editor.c Outdated Show resolved Hide resolved

eeropic added 2 commits September 25, 2023 19:39

Implement chunking lines when pasting

4b7099c

Remove unnecessary roundtrip tcl->c->tcl when pasting

ebc00a1

umlaeute reviewed Sep 26, 2023

View reviewed changes

src/g_editor.c Outdated Show resolved Hide resolved

umlaeute reviewed Sep 26, 2023

View reviewed changes

src/g_editor.c Outdated Show resolved Hide resolved

umlaeute reviewed Sep 26, 2023

View reviewed changes

tcl/pdtk_canvas.tcl Show resolved Hide resolved

umlaeute mentioned this pull request Sep 26, 2023

pdgui_vmess() does not properly handle commas #2094

Open

Refactor, less verbose pasting functions

7b58595

Handle appendix (for example setting obj width), fix dollar argument …

5ba626b

…escaping

umlaeute reviewed Sep 28, 2023

View reviewed changes

umlaeute and others added 6 commits September 28, 2023 16:53

transmit clipboard from Gui->core as as UTF-8 raw bytes

c6ebf7e

use symbols for the different got-clipboard-content states

d3f3799

easier to read than numbers (or looooong defines). also easier to understand when watching the core<->gui communication.

Merge branch 'copy-paste-clipboard-text-buffer' into improvement/text…

bdfaf68

…-clipboard

Merge pull request #1 from umlaeute/improvement/text-clipboard

8424fb7

Improvement/text clipboard

Re-enable chunking for larger patches, refactor

7f9e4e3

Fix dollar escaping (argument number out of range errors)

f4b6395

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Copy-paste patch objects using system clipboard text buffer #2086

[WIP] Copy-paste patch objects using system clipboard text buffer #2086

eeropic commented Sep 5, 2023 •

edited

umlaeute left a comment

umlaeute left a comment

umlaeute Sep 5, 2023 •

edited

umlaeute Sep 5, 2023

eeropic commented Sep 6, 2023 •

edited

umlaeute Sep 26, 2023

umlaeute commented Sep 26, 2023

eeropic commented Sep 26, 2023

eeropic commented Sep 27, 2023

umlaeute Sep 28, 2023 •

edited

umlaeute Sep 28, 2023

eeropic Sep 28, 2023 •

edited

eeropic Sep 28, 2023

umlaeute Sep 28, 2023 •

edited

umlaeute Sep 28, 2023

eeropic Sep 28, 2023 •

edited

umlaeute Sep 28, 2023

eeropic Sep 28, 2023

umlaeute Sep 28, 2023

porres commented Apr 10, 2024

[WIP] Copy-paste patch objects using system clipboard text buffer #2086

Are you sure you want to change the base?

[WIP] Copy-paste patch objects using system clipboard text buffer #2086

Conversation

eeropic commented Sep 5, 2023 • edited

umlaeute left a comment

Choose a reason for hiding this comment

umlaeute left a comment

Choose a reason for hiding this comment

umlaeute Sep 5, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eeropic commented Sep 6, 2023 • edited

Choose a reason for hiding this comment

umlaeute commented Sep 26, 2023

eeropic commented Sep 26, 2023

eeropic commented Sep 27, 2023

umlaeute Sep 28, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eeropic Sep 28, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

umlaeute Sep 28, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eeropic Sep 28, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

porres commented Apr 10, 2024

eeropic commented Sep 5, 2023 •

edited

umlaeute Sep 5, 2023 •

edited

eeropic commented Sep 6, 2023 •

edited

umlaeute Sep 28, 2023 •

edited

eeropic Sep 28, 2023 •

edited

umlaeute Sep 28, 2023 •

edited

eeropic Sep 28, 2023 •

edited