adds basic legv8 snippets #8

JoaoLira-br · 2022-11-22T23:09:01Z

Trying to add PR to issue patrickdemers6/legv8-vscode#2

patrickdemers6

There are great! This is not specific to LSP; therefore, it belongs in the vscode extension repository.

https://github.com/patrickdemers6/legv8-vscode/

Ideas for other snippets that would be nice to have:

call a procedure
for loop
return (it could just be an alias for BR LR)

snippets/legv8.json

patrickdemers6 · 2022-11-23T02:44:37Z

snippets/legv8.json

+    "body": ["EOR ${1:target reg}, $1, $1", "$2"],
+    "description": "equivalent of CLEAR. It clears the content of a target register"
+  },
+  "increment offset by 8 bits": {


What about adding a command for incrementing by immediate?

Something like:

"increment by immediate": { "prefix": "inci", "body": ["ADDI ${1:reg}, ${1}, #${2:amount}"], "description": "..." }

Implemented!

I'm not finding this in the PR.

patrickdemers6 · 2022-11-23T02:49:47Z

snippets/legv8.json

+    "body": ["ADD ${1:dest reg}, XZR, $2", "$3"]
+  },
+  "increment register": {
+    "prefix": "increg",


Since it is only incrementing by one, would a prefix of reg++ or inc_1 make more sense?

I removed that snippet also

snippets/legv8.json

patrickdemers6 · 2022-11-23T02:52:22Z

snippets/legv8.json

+  "set register to": {
+    "prefix": "sreg",
+    "body": ["ADD ${1:dest reg}, XZR, $2", "$3"]
+  },


Add description for all of them. Also try to make it easy to realize what the command does.

So if the code inserted is something to the effect of ADDI reg, reg, #1, show how to think of it in basic math terms, like reg = reg + 1

Good comment! It`s implemented

Awesome! In addition to the math part, could you add a small text description? Also, having the description and placeholder text be the same may be useful. Such as:

"set register": { "prefix": "sreg", "body": ["ADD ${1:Rd}, XZR, ${2:Rm}", "$3"], "description": "Rd = Rm. Set one register (Rd) to the value of another (Rm)." }

Thoughts?

patrickdemers6 · 2022-11-23T03:01:21Z

I transferred the issue to the proper repository. If you could create a PR using these comments to the proper repo, that would be great!

patrickdemers6 · 2022-11-23T03:02:27Z

The issue: patrickdemers6/legv8-vscode#2

JoaoLira-br · 2022-11-23T03:54:26Z

Hey, thank you for the detailed comments and feedback! I will be taking a better look at them and also implement some of the necessary changes, which you rightly pointed out, by tomorrow Best, Joao Em ter., 22 de nov. de 2022 às 20:58, Patrick Demers < ***@***.***> escreveu:

…

***@***.**** requested changes on this pull request. There are great! This is not specific to LSP; therefore, it belongs in the vscode extension repository. https://github.com/patrickdemers6/legv8-vscode/ Ideas for other snippets that would be nice to have: - call a procedure - for loop - return (it could just be an alias for BR LR) ------------------------------ In snippets/legv8.json <#8 (comment)> : > @@ -0,0 +1,185 @@ +{ + "set register to": { + "prefix": "sreg", + "body": ["ADD ${1:dest reg}, XZR, $2", "$3"] Consistent use of placeholders <https://code.visualstudio.com/docs/editor/userdefinedsnippets#_placeholders> would make these more useful. Also, having consistent and short placeholder, where possible. My proposal for this one: "body": ["ADD ${1:dest} XZR, ${2:src}"] ------------------------------ In snippets/legv8.json <#8 (comment)> : > @@ -0,0 +1,185 @@ +{ + "set register to": { + "prefix": "sreg", + "body": ["ADD ${1:dest reg}, XZR, $2", "$3"] + }, + "increment register": { + "prefix": "increg", + "body": ["ADDI ${1:dest reg}, ${1}, #1", "$2"] + }, + "decrement register": { + "prefix": "decreg", + "body": ["SUBI ${1:dest reg}, ${1}, #1", "$2"] + }, + "copy register content to another register": { Is this different than the "set register to" snippet? ------------------------------ In snippets/legv8.json <#8 (comment)> : > + }, + "clear register content": { + "prefix": "clearReg", + "body": ["EOR ${1:target reg}, $1, $1", "$2"], + "description": "equivalent of CLEAR. It clears the content of a target register" + }, + "increment offset by 8 bits": { + "prefix": "inc8", + "body": ["ADDI ${1:offset to increment}, $1, #8"], + "description": "incrementing according to offset allignment standard, in order to properly traverse through an array" + }, + + "store 2 registers to save on stack": { + "prefix": "st2", + "body": [ + "//storing registers in stack before changing them", all comments should have a space after them. //text should change to // text ------------------------------ In snippets/legv8.json <#8 (comment)> : > + "clear register content": { + "prefix": "clearReg", + "body": ["EOR ${1:target reg}, $1, $1", "$2"], + "description": "equivalent of CLEAR. It clears the content of a target register" + }, + "increment offset by 8 bits": { + "prefix": "inc8", + "body": ["ADDI ${1:offset to increment}, $1, #8"], + "description": "incrementing according to offset allignment standard, in order to properly traverse through an array" + }, + + "store 2 registers to save on stack": { + "prefix": "st2", + "body": [ + "//storing registers in stack before changing them", + "SUBI X28, X28, #16 //make room on stack (X28) for 2 registers", Can SP be used instead of X28? Or is that specific to the emulator being used at ISU? ------------------------------ In snippets/legv8.json <#8 (comment)> : > + "STUR $reg6, [X28, #8] //store register 6", + "STUR $reg7, [X28, #0] //store register 7", + "//body of the procedure", + "$body", + "//restoring saved registers from stack before function return (in a LIFO manner)", + "LDUR $reg7, [X28, #0] //restore $reg7", + "LDUR $reg6, [X28, #8] //restore $reg6", + "LDUR $reg5, [X28, #16] //restore $reg5", + "LDUR $reg4, [X28, #24] //restore $reg4", + "LDUR $reg3, [X28, #32] //restore $reg3", + "LDUR $reg2, [X28, #40] //restore $reg2", + "LDUR $reg1, [X28, #48] //restore $reg1", + "LDUR X30, [X28, #56] //restore X30", + "ADDI X28, X28, #64 //restore previous space on stack" + ], + "description": "use this to save 8 registers in the stack pointer, including the return address of the function/procedure (where the function was called)" We aren't saving registers in the stack pointer since the SP is just a reference to a specific position in memory. It would be better to state "use this to store 8 registers to the stack..." ------------------------------ In snippets/legv8.json <#8 (comment)> : > + "STUR $reg3, [X28, #32] //store register 3", + "STUR $reg4, [X28, #24] //store register 4", + "STUR $reg5, [X28, #16] //store register 5", + "STUR $reg6, [X28, #8] //store register 6", + "STUR $reg7, [X28, #0] //store register 7", + "//body of the procedure", + "$body", + "//restoring saved registers from stack before function return (in a LIFO manner)", + "LDUR $reg7, [X28, #0] //restore $reg7", + "LDUR $reg6, [X28, #8] //restore $reg6", + "LDUR $reg5, [X28, #16] //restore $reg5", + "LDUR $reg4, [X28, #24] //restore $reg4", + "LDUR $reg3, [X28, #32] //restore $reg3", + "LDUR $reg2, [X28, #40] //restore $reg2", + "LDUR $reg1, [X28, #48] //restore $reg1", + "LDUR X30, [X28, #56] //restore X30", What is X30? Could we say LR? ------------------------------ In snippets/legv8.json <#8 (comment)> : > + "store 8 registers to save on stack": { + "prefix": "st8", + "body": [ + "//storing registers in stack before changing them", + "SUBI X28, X28, #64 //make room on stack (X28) for 2 registers", + "STUR X30, [X28, #56] //store Return adress (X30) of procedure", + "STUR $reg1, [X28, #48] //store register 1", + "STUR $reg2, [X28, #40] //store register 2", + "STUR $reg3, [X28, #32] //store register 3", + "STUR $reg4, [X28, #24] //store register 4", + "STUR $reg5, [X28, #16] //store register 5", + "STUR $reg6, [X28, #8] //store register 6", + "STUR $reg7, [X28, #0] //store register 7", + "//body of the procedure", + "$body", + "//restoring saved registers from stack before function return (in a LIFO manner)", In Legv8, there are not functions. They are procedures. ------------------------------ In snippets/legv8.json <#8 (comment)> : > + "LDUR $reg4, [X28, #16] //restore $reg4", + "LDUR $reg3, [X28, #24] //restore $reg3", + "LDUR $reg2, [X28, #32] //restore $reg2", + "LDUR $reg1, [X28, #40] //restore $reg1", + "LDUR X30, [X28, #48] //restore X30", + "ADDI X28, X28, #56 //restore previous space on stack" + ], + "description": "use this to save 7 registers in the stack pointer, including the return address of the function/procedure (where the function was called)" + }, + "store 8 registers to save on stack": { + "prefix": "st8", + "body": [ + "//storing registers in stack before changing them", + "SUBI X28, X28, #64 //make room on stack (X28) for 2 registers", + "STUR X30, [X28, #56] //store Return adress (X30) of procedure", + "STUR $reg1, [X28, #48] //store register 1", Can you make the comment use a placeholder to say the actual register name? ------------------------------ In snippets/legv8.json <#8 (comment)> : > + }, + "decrement register": { + "prefix": "decreg", + "body": ["SUBI ${1:dest reg}, ${1}, #1", "$2"] + }, + "copy register content to another register": { + "prefix": "copy", + "body": ["ORR ${1:dest reg}, XZR, ${2:reg to copy from}", "$3"], + "description": "equivalent to 'MOV Xd, Xm'" + }, + "clear register content": { + "prefix": "clearReg", + "body": ["EOR ${1:target reg}, $1, $1", "$2"], + "description": "equivalent of CLEAR. It clears the content of a target register" + }, + "increment offset by 8 bits": { What about adding a command for incrementing by immediate? Something like: "increment by immediate": { "prefix": "inci", "body": ["ADDI ${1:reg}, ${1}, #${2:amount}"], "description": "..." } ------------------------------ In snippets/legv8.json <#8 (comment)> : > @@ -0,0 +1,185 @@ +{ + "set register to": { + "prefix": "sreg", + "body": ["ADD ${1:dest reg}, XZR, $2", "$3"] + }, + "increment register": { + "prefix": "increg", Since it is only incrementing by one, would a prefix of reg++ or inc_1 make more sense? ------------------------------ In snippets/legv8.json <#8 (comment)> : > @@ -0,0 +1,185 @@ +{ + "set register to": { + "prefix": "sreg", + "body": ["ADD ${1:dest reg}, XZR, $2", "$3"] + }, + "increment register": { + "prefix": "increg", + "body": ["ADDI ${1:dest reg}, ${1}, #1", "$2"] + }, + "decrement register": { + "prefix": "decreg", + "body": ["SUBI ${1:dest reg}, ${1}, #1", "$2"] Why do your "body" arrays have the parameter at the end? To put the cursor to the next line? ------------------------------ In snippets/legv8.json <#8 (comment)> : > @@ -0,0 +1,185 @@ +{ + "set register to": { + "prefix": "sreg", + "body": ["ADD ${1:dest reg}, XZR, $2", "$3"] + }, Add description for all of them. Also try to make it easy to realize what the command does. So if the code inserted is something to the effect of ADDI reg, reg, #1, show how to think of it in basic math terms, like reg = reg + 1 — Reply to this email directly, view it on GitHub <#8 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AZM2N4OH265FD4D5ZE4U3ADWJWB4JANCNFSM6AAAAAASIK76U4> . You are receiving this because you authored the thread.Message ID: ***@***.***>

patrickdemers6 · 2022-11-23T03:55:32Z

No rush. Happy Thanksgiving!

JoaoLira-br · 2022-11-24T00:03:32Z

No rush. Happy Thanksgiving!
Thank you, you too!

I transferred the issue to the proper repository. If you could create a PR using these comments to the proper repo, that would be great!

I`m not sure how and where to do this. Do you know?

patrickdemers6

Great work! A few more suggestions with the modifications.

patrickdemers6 · 2022-11-25T01:34:48Z

snippets/legv8.json

+  "set register to": {
+    "prefix": "sreg",
+    "body": ["ADD ${1:dest reg}, XZR, $2", "$3"]
+  },


Awesome! In addition to the math part, could you add a small text description? Also, having the description and placeholder text be the same may be useful. Such as:

"set register": { "prefix": "sreg", "body": ["ADD ${1:Rd}, XZR, ${2:Rm}", "$3"], "description": "Rd = Rm. Set one register (Rd) to the value of another (Rm)." }

Thoughts?

patrickdemers6 · 2022-11-25T01:38:16Z

snippets/legv8.json

+    "description": "R[1] = R[1] - R[2]"
+  },
+
+  "stack manipulation with 2 registers": {


If I were to use this, I would expect to be able to to manipulate two registers when using st2. I completely get that there are two being manipulated here since it automatically includes LR. Do you think st2 would be more intuitive if it deals with LR and one custom register or LR and two custom registers?

I was thinking the same thing, but like you said I was stuck on the technicality of it since LR is also a register. But I think that being more intuitive is more important!

patrickdemers6 · 2022-11-25T02:09:13Z

snippets/legv8.json

+    ],
+    "description": "use this to save 8 registers in the Stack, including the return address of the procedure (where the procedure was called)"
+  },
+  "incremental for loop": {


A few suggestions for the loop.

ifl isn't immediately understandable so being a bit more explicit makes it easier to grasp and remember.

The use of a temporary register is annoying when writing legv8 code as it requires use of another register. Using flags, this can be simplified.

Also not using the term arr_len and using a generic upper limit makes it clearer that this can be used for any need, not just arrays.

I've also modified the description to include the equivalent C code.

"increasing for loop": { "prefix": "for_increasing", "body": [ "${1:loop name}_loop:", "// if counter ($2) greater than or equal to limit ($3), then exit", "SUBS XZR, ${2:counter}, ${3:upper_limit}", "B.GE ${1}_loop_done", "// loop body", "", "// increment counter ($2) by $4", "ADDI $2, $2, #${4:increment_amount}", "B $1_loop", "$1_loop_done:" ], "description": "Creates a for loop from counter to upper_limit. for (; counter < upper_limit; counter += increment_amount); Note: the counter and array size must be initialized before the loop." },

I agree, It`s Implemented

patrickdemers6 · 2022-11-25T02:09:45Z

snippets/legv8.json

+  "return statement": {
+    "prefix": "rtn",
+    "body": ["BR LR"],
+    "description": ""


Return from this procedure to the calling procedure.

For the description you mean? I was thinking of putting a bit more compact phrase like "return to the caller". What do you think?

patrickdemers6 · 2022-11-25T02:10:28Z

snippets/legv8.json

+    "description": "creates an incremental for loop. Obs: the register for the loop counter is not created with the snippet, so they must be set"
+  },
+  "return statement": {
+    "prefix": "rtn",


Any reason to not say the full return?

No, it`s just that i have a tendency to abbreviate things, but I changed to "return"

patrickdemers6 · 2022-11-25T04:36:52Z

No rush. Happy Thanksgiving!
Thank you, you too!

I transferred the issue to the proper repository. If you could create a PR using these comments to the proper repo, that would be great!

I`m not sure how and where to do this. Do you know?

Yep, in the other VS Code extension's repository, create a pull request. You will need to:

Fork the repository https://github.com/patrickdemers6/legv8-vscode/
Clone the repository to your machine.
Create a branch, such as 2-snippets
Make your changes. I would create a folder called snippets, then a file named legv8.snippets.json. Then, add the below to contributes in package.json. This tells the extension that there are snippets found in this file.

    "snippets": [
      {
        "language": "legv8",
        "path": "./snippets/legv8.snippets.json"
      }

Next, test your changes. In VS Code, launch the extension and make sure it all looks as you expect when in use.
Commit your changes.
Open a Pull Request to my VS Code extension repository.

By "with these comments", I just meant to still work on my suggestions - just like you have been doing! Thanks for all your hard work!

JoaoLira-br · 2022-11-27T21:12:53Z

I`m a bit undecided on the names for these two procedures. Do you think that these prefixes would be good for it, or are they too literal?

…nippets

adds basic legv8 snippets

f2ac751

patrickdemers6 requested changes Nov 23, 2022

View reviewed changes

improves formatting, adds new snippets and adjusts the previous snippets

6a4fcfb

patrickdemers6 requested changes Nov 25, 2022

View reviewed changes

Adds and Refactors more snippets

f7ac2f6

JoaoLira-br and others added 2 commits January 12, 2023 15:51

Reformats loop snippets

48bf018

Reformats add, addi, sub, subi, for_incremental and for_decremental s…

13a395b

…nippets

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adds basic legv8 snippets #8

adds basic legv8 snippets #8

JoaoLira-br commented Nov 22, 2022

patrickdemers6 left a comment

patrickdemers6 Nov 23, 2022

JoaoLira-br Nov 23, 2022

patrickdemers6 Nov 25, 2022

patrickdemers6 Nov 23, 2022

JoaoLira-br Nov 23, 2022

patrickdemers6 Nov 23, 2022

JoaoLira-br Nov 23, 2022

patrickdemers6 Nov 25, 2022

patrickdemers6 commented Nov 23, 2022

patrickdemers6 commented Nov 23, 2022

JoaoLira-br commented Nov 23, 2022 via email

patrickdemers6 commented Nov 23, 2022

JoaoLira-br commented Nov 24, 2022

patrickdemers6 left a comment

patrickdemers6 Nov 25, 2022

patrickdemers6 Nov 25, 2022

JoaoLira-br Nov 27, 2022

patrickdemers6 Nov 25, 2022

JoaoLira-br Nov 27, 2022

patrickdemers6 Nov 25, 2022

JoaoLira-br Nov 27, 2022

patrickdemers6 Nov 25, 2022

JoaoLira-br Nov 27, 2022

patrickdemers6 commented Nov 25, 2022

JoaoLira-br commented Nov 27, 2022

adds basic legv8 snippets #8

Are you sure you want to change the base?

adds basic legv8 snippets #8

Conversation

JoaoLira-br commented Nov 22, 2022

patrickdemers6 left a comment

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

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

Choose a reason for hiding this comment

patrickdemers6 commented Nov 23, 2022

patrickdemers6 commented Nov 23, 2022

JoaoLira-br commented Nov 23, 2022 via email

patrickdemers6 commented Nov 23, 2022

JoaoLira-br commented Nov 24, 2022

patrickdemers6 left a comment

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patrickdemers6 commented Nov 25, 2022

JoaoLira-br commented Nov 27, 2022