QBJS - Import code from external .bas files

[dbox]

Hi All,

I wanted to share the latest feature I've been working on for QBJS to solicit some input from the community.  I've implemented the ability to include "modules" from external source files into your program.  This concept is similar to include from c/c++ and import from javascript.  The idea here is to make it easy to create reusable libraries that can be shared between projects.  Here's an example:

Code: QB64: [Select]

1. Import MyLib From "https://raw.githubusercontent.com/boxgaming/qbjs/main/samples/include/test.bas"
2. Import Maths From "https://raw.githubusercontent.com/boxgaming/qbjs/main/samples/include/maths.bas"
3.  
4. MyLib.DoStuff          ' Call exported sub
5. Print MyLib.GetThings  ' Call exported function
6.  
7. Print Maths.Factorial(10)
8. Print Maths.Plus1(11)
9.  

Try it on QBJS-Dev

Any imports must be the first statements in your program.  In this example we've imported functionality from two different external source files.  Any methods exported from those libraries can be accessed in your program by prefixing them with the alias specified after the import statement.

Only the content specified for export will be available in the calling program.  This lets us have "private" shared variables and helper functions in our included modules.

Here's what the library files look like:

test.bas

Code: QB64: [Select]

1. Export GetStuff As GetThings
2. Export DoStuff
3.  
4. Dim foo
5. foo = "somthing"
6.  
7. Function GetStuff
8.     GetStuff = "got the stuff"
9. End Function
10.  
11. Sub DoStuff
12.     Print "do the stuff"
13. End Sub
14.  

maths.bas

Code: QB64: [Select]

1. Export increment As Plus1
2. Export factorial AS Factorial
3.  
4. Function increment (num)
5.     increment = num + 1
6. End Function
7.  
8. Function factorial (num)
9.     Dim res
10.     $If Javascript Then
11.         if (num === 0 || num === 1) {
12.             num = 1;
13.         }
14.         else {
15.             for (var i = num - 1; i >= 1; i--) {
16.                 num *= i;
17.             }
18.        }
19.     $End If
20.     factorial = num
21. End Function
22.  

Export statements must appear at the top of your module code.  If you want to have a different name for the exported method from it's internal name you can use the "As Alias" syntax as shown above.

Import Entire Programs
Another benefit of this feature is that you can import entire programs from an external source file to make it easier to share large programs. Here are a couple of examples:

QBJS Paint

Code: QB64: [Select]

1. Import QBJSPaint From "https://raw.githubusercontent.com/boxgaming/qbjs/main/samples/apps/paint.bas"
2.  

Try it on QBJS-Dev


Terry Ritchie's Excellent Flappy Bird Clone
Ported from QB64

Code: QB64: [Select]

1. Import FlappyBird From "https://raw.githubusercontent.com/boxgaming/qbjs/main/samples/games/trfbird.bas"
2.  

Try it on QBJS-Dev

I'd be very interested to hear your thoughts.

[CharlieJV]

First thought: that is very cool.

Sober second thought: what are the security implications ?  For example, what happens if an imported file from some source is maliciously modified?

It would be good to well-document whatever risks, and how to mitigate risks.  (I'm no web guy, so my security hat is very much of the base-level-amateur kind.)

I would only import into my programs source code in my control (i.e. my web domain), but I think I'd be okay with the mechanism for running, sandboxed, a program that is hosted wherever.

[dbox]

@CharlieJV, thanks for the feedback.  Security is always a good thing to keep in mind.  This feature is modeled to some degree after the standard way JavaScript allows supporting libraries to be included ( https://www.w3schools.com/tags/att_script_src.asp).  Like JS these libraries can be loaded from a relative path or from an external location. Even though the modern browser is sandboxed to a large degree to prevent malicious activity discretion is always required of the developer.

In addition, I’m also working on an Export feature for this release which will allow you to export the compiled JavaScript and supporting html files as a zip.  The compiled version will incorporate content from any included libraries. This can then be run standalone or is ready to be uploaded to a sharing site like itch.io. This is also available on the qbjs-dev site, where the most current dev build is deployed.

[bplus]

This project continues to impress! Good Stuff!