New feature - code snippets

[LucaMs]

So, my snippet looks like this:

Private Sub Delete$Controller$ (id As Long)
    ' #Version = v2
    ' #Desc = Delete Item in MinimaList
    ' #Elements = [":id"]
    If id < 1 Then
        HRM.ResponseError = "Invalid id value"
        HRM.ResponseCode = 404
    Else
        Dim Index As Int = Main.$MinimaList$.IndexFromId(id)
        If Index < 0 Then
            HRM.ResponseError = "Item not found"
            HRM.ResponseCode = 404
        Else
            Main.$MinimaList$.Remove(Index)
            HRM.ResponseCode = 200
        End If
    End If
  
    If Main.SimpleResponse Then
        WebApiUtils.ReturnSimpleHttpResponse(HRM, "List", Response)
    Else
        WebApiUtils.ReturnHttpResponse(HRM, Response)
    End If
    If Main.KVS_ENABLED Then Main.WriteKVS("$MinimaList$", Main.$MinimaList$)
End Sub

The IDE will highlight the variables. Once I replace the first variable, all other variables (with the same placeholder) will be replaced.

before:
View attachment 146183

after:
View attachment 146184

Don't forget the useful...

Note that the special $end$ marking sets the cursor position after the developer set the placeholders.

 

[aeric]

Don't forget the useful...

Thanks. i just realized there is a tutorial.
I done my snippets without a tutorial. ?

 

[Magma]

Thanks. i just realized there is a tutorial.
I done my snippets without a tutorial. ?

How easy is B4X... ehhh ?

 

[Magma]

Me too... not using tutorials and books anymore... I am using our "forum"

 

[aeric]

I know currently the Snippets feature only available for b4xlib or putting the text file inside the Snippets folder under additional folder,
but a quick wish is: support for jar library

 

[Sandman]

(Same as I have never used the built in Debugger).

To me, that sounds like coding with one hand tied behind your back... I'm really curious, what do you do instead?

 

[aeric]

To me, that sounds like coding with one hand tied behind your back... I'm really curious, what do you do instead?

maybe this is call "single-handedly"

 

[aeric]

[OK]...Now the bad news ... we must re-write all the threads with the snippets and change the "variables" with $variable$ !!!, and preferable at the first post attach a txt file snippet ! ?

There is one issue with the variable placeholder.
The IDE will confuse with the snippet contains Smart String Literals.

 

[Magma]

why ?... will not be a problem... because smart string literal... got following quote or "{"

$"
${

I am sure that Erel... count them all..

 

[aeric]

why ?... will not be a problem... because smart string literal... got following quote or "{"

$"
${

I am sure that Erel... count them all..

For eg.
I have this code:

' Return Web Page
Private Sub ShowPage
    Dim strMain As String = WebApiUtils.ReadTextFile("main.html")
    Dim strView As String = WebApiUtils.ReadTextFile("category.html")
    strMain = WebApiUtils.BuildDocView(strMain, strView)
    strMain = WebApiUtils.BuildHtml(strMain, Main.config)
    Dim strScripts As String = $"<script src="${Main.ROOT_URL}/assets/js/webapicategory.js"></script>"$
    strMain = WebApiUtils.BuildScript(strMain, strScripts)
    WebApiUtils.ReturnHTML(strMain, Response)
End Sub

The snippet highlighted: "<script src="

to solve it, I need to use the old way of concantenation.

Dim strScripts As String = "<script src=""" & Main.ROOT_URL & "/assets/js/controller.js""></script>"

 

[Magma]

For eg.
I have this code:

' Return Web Page
Private Sub ShowPage
    Dim strMain As String = WebApiUtils.ReadTextFile("main.html")
    Dim strView As String = WebApiUtils.ReadTextFile("category.html")
    strMain = WebApiUtils.BuildDocView(strMain, strView)
    strMain = WebApiUtils.BuildHtml(strMain, Main.config)
    Dim strScripts As String = $"<script src="${Main.ROOT_URL}/assets/js/webapicategory.js"></script>"$
    strMain = WebApiUtils.BuildScript(strMain, strScripts)
    WebApiUtils.ReturnHTML(strMain, Response)
End Sub

The snippet highlighted: "<script src="

to solve it, I need to use the old way of concantenation.

Dim strScripts As String = "<script src=""" & Main.ROOT_URL & "/assets/js/controller.js""></script>"

You mean... if you have into a snippet-text file the whole sub ?

I see... well maybe... Erel must have a check after $ for quote or { to be sure what will replace...

 

[Magma]

You can say that at "bugs" thread .... is still a beta... or... just not replace the specific range selected

 

[PaulMeuris]

In code snippet:

dim $var$ as string
dim str as string = $$"this is a string litaral with variable $$${$$var$$}$ in it"$$

For the string literal you can use extra $ signs.
In the B4J IDE:

Dim myvar As String
Dim str As String = $"this is a string litaral with variable ${myvar} in it"$

This not so elegant workaround works...

 

[Sandman]

It does seem somewhat painful when you consider smart string literals. Considering this is a beta, perhaps Erel will change the format from $this$ to @this@ or #this#, or something else that makes more sense.

 

[PaulMeuris]

It does seem somewhat painful when you consider smart string literals. Considering this is a beta, perhaps Erel will change the format from $this$ to @this@ or #this#, or something else that makes more sense.

The choices for a good delimiter character are limited...

 

[Daestrum]

I'm really curious, what do you do instead?

A simple Log(..) and the stacktrace is all I need to correct errors. (Old school mainframe programmer - it's just how I learnt to debug)

 

[Sandman]

A simple Log(..) and the stacktrace is all I need to correct errors. (Old school mainframe programmer - it's just how I learnt to debug)

So basically you're playing the game in hard mode. ? I hear the level endboss is coding without Log() and disabling stacktraces. ?

(I'm clearly still on the tutorial level.)

 

[William Lancee]

@Erel
There are two ways to add new snippets:

1. Inside a b4xlib library. Simply add a folder named Snippets and put the snippets files in that folder. Each snippet in its own text file.
2. Under the Snippets folder in the additional libraries folder. Each snippet in a separate txt file.

I like 2. since I don't have to go through the zip step. Easy to use Notepad++ to create, modify and test snippets.
But, the folder named 'Snippets' should be in the B4X subfolder of the additional libraries folder.

P.S. @Daestrum and @Sandman, I'm so old school that I don't have bugs anymore -> no need to debug, but I understand if some people do

 

[William Lancee]

I started on converting my collection of snippets.
But I realize as @LucaMs pointed out, naming of the text files is super critical.
Especially if Forum members want to share snippets.

I wonder if @Erel has any recommendations?
Or perhaps @LucaMs?

Prefix with object type? Suffix with object type?
Short without articles and prepositions?
Keywords to be avoided, since they conflict?

 

[William Lancee]

@Erel

To help organize and maintain my snippet collection, is it possible to have sub folders in AdditionalLibs\B4X\Snippets ?
The names of these folders could be ignored by the IDE, but would be useful to group hundreds of snippets.