Getting a list of openscad and BOSL2 function/module signatures
Hello all,
I was fed up yesterday with having to look up module signatures (exact
names of arguments etc) so often, so I looked into setting up auto complete
(or at least completion suggestions and inline documentation) inside Vim.
This turned out to be quite a rabbit hole and a reminder of why I no longer
like to mess with convoluted setups, but after reminding myself a few times
to just get back to the basics and look for a MVP only I now have a way
where completion suggestions are read from a simple text file (using
vim-complete). So now all I need is a list of openscad and BOSL2 modules
and functions with their arguments in a flat text file.
For openscad itself I can get away with just copy/pasting the cheatsheet
and fixing up manually as that pretty much covers my needs for this
specific use case, and that's a 10 minute job. For BOSL2 this is obviously
not an option because of the sheer amount of functionality. So now my
question is whether there is someone who's already done something similar
that I can leverage. BOSL2 seems to be documented very cleanly and using a
very strict format, so I could just make a simple program to search for all
lines that start with 'Usage:' and then read the next indented lines. Even
if there would be some issues in the formatting here or there, a 90%
solution would be fine with me. But still, maybe there are already more
robust and elaborate solutions to this issue that I could either use,
re-use or contribute to? Thanks.
(I seem to remember this topic having come up on this list some years ago
but I can't seem to find it? Maybe I'm just not remembering right)
regards
Roel
This, maybe?
https://github.com/BelfrySCAD/BOSL2/wiki/CheatSheet
On Tue, Feb 18, 2025 at 5:01 AM Roel Vanhout via Discuss <
discuss@lists.openscad.org> wrote:
Hello all,
I was fed up yesterday with having to look up module signatures (exact
names of arguments etc) so often, so I looked into setting up auto complete
(or at least completion suggestions and inline documentation) inside Vim.
This turned out to be quite a rabbit hole and a reminder of why I no longer
like to mess with convoluted setups, but after reminding myself a few times
to just get back to the basics and look for a MVP only I now have a way
where completion suggestions are read from a simple text file (using
vim-complete). So now all I need is a list of openscad and BOSL2 modules
and functions with their arguments in a flat text file.
For openscad itself I can get away with just copy/pasting the cheatsheet
and fixing up manually as that pretty much covers my needs for this
specific use case, and that's a 10 minute job. For BOSL2 this is obviously
not an option because of the sheer amount of functionality. So now my
question is whether there is someone who's already done something similar
that I can leverage. BOSL2 seems to be documented very cleanly and using a
very strict format, so I could just make a simple program to search for all
lines that start with 'Usage:' and then read the next indented lines. Even
if there would be some issues in the formatting here or there, a 90%
solution would be fine with me. But still, maybe there are already more
robust and elaborate solutions to this issue that I could either use,
re-use or contribute to? Thanks.
(I seem to remember this topic having come up on this list some years ago
but I can't seem to find it? Maybe I'm just not remembering right)
regards
Roel
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.org
I use the built-in OpenSCAD editor, which has a kind of auto-complete.
Would it be possible to add BOSL2 features to that?
Jon
On 2/18/2025 5:00 AM, Roel Vanhout via Discuss wrote:
Hello all,
I was fed up yesterday with having to look up module signatures (exact
names of arguments etc) so often, so I looked into setting up auto
complete (or at least completion suggestions and inline documentation)
inside Vim. This turned out to be quite a rabbit hole and a reminder
of why I no longer like to mess with convoluted setups, but after
reminding myself a few times to just get back to the basics and look
for a MVP only I now have a way where completion suggestions are read
from a simple text file (using vim-complete). So now all I need is a
list of openscad and BOSL2 modules and functions with their arguments
in a flat text file.
For openscad itself I can get away with just copy/pasting the
cheatsheet and fixing up manually as that pretty much covers my needs
for this specific use case, and that's a 10 minute job. For BOSL2 this
is obviously not an option because of the sheer amount of
functionality. So now my question is whether there is someone who's
already done something similar that I can leverage. BOSL2 seems to be
documented very cleanly and using a very strict format, so I could
just make a simple program to search for all lines that start with
'Usage:' and then read the next indented lines. Even if there would be
some issues in the formatting here or there, a 90% solution would be
fine with me. But still, maybe there are already more robust and
elaborate solutions to this issue that I could either use, re-use or
contribute to? Thanks.
(I seem to remember this topic having come up on this list some years
ago but I can't seem to find it? Maybe I'm just not remembering right)
regards
Roel
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.org
--
This email has been checked for viruses by AVG antivirus software.
www.avg.com
I think all you need is an openscad LSP (language server) and an editor
with LSP support.
I use https://github.com/Leathong/openscad-LSP with emacs.
On Tue, Feb 18, 2025, 06:43 Jon Bondy via Discuss <
discuss@lists.openscad.org> wrote:
I use the built-in OpenSCAD editor, which has a kind of auto-complete.
Would it be possible to add BOSL2 features to that?
Jon
On 2/18/2025 5:00 AM, Roel Vanhout via Discuss wrote:
Hello all,
I was fed up yesterday with having to look up module signatures (exact
names of arguments etc) so often, so I looked into setting up auto
complete (or at least completion suggestions and inline documentation)
inside Vim. This turned out to be quite a rabbit hole and a reminder
of why I no longer like to mess with convoluted setups, but after
reminding myself a few times to just get back to the basics and look
for a MVP only I now have a way where completion suggestions are read
from a simple text file (using vim-complete). So now all I need is a
list of openscad and BOSL2 modules and functions with their arguments
in a flat text file.
For openscad itself I can get away with just copy/pasting the
cheatsheet and fixing up manually as that pretty much covers my needs
for this specific use case, and that's a 10 minute job. For BOSL2 this
is obviously not an option because of the sheer amount of
functionality. So now my question is whether there is someone who's
already done something similar that I can leverage. BOSL2 seems to be
documented very cleanly and using a very strict format, so I could
just make a simple program to search for all lines that start with
'Usage:' and then read the next indented lines. Even if there would be
some issues in the formatting here or there, a 90% solution would be
fine with me. But still, maybe there are already more robust and
elaborate solutions to this issue that I could either use, re-use or
contribute to? Thanks.
(I seem to remember this topic having come up on this list some years
ago but I can't seem to find it? Maybe I'm just not remembering right)
regards
Roel
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.org
--
This email has been checked for viruses by AVG antivirus software.
www.avg.com
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.org
Hmm. It wouldn't be silly to have a command-line mode that would parse
an OpenSCAD program and emit a list of function and module signatures.
James:
Does this really apply to the editor that is built into OpenSCAD?
Thanks!
Jon
On 2/18/2025 11:19 AM, James Larkby-Lahet wrote:
I think all you need is an openscad LSP (language server) and an editor with LSP support.
I use https://github.com/Leathong/openscad-LSP with emacs.
On Tue, Feb 18, 2025, 06:43 Jon Bondy via Discuss <discuss@lists.openscad.orgmailto:discuss@lists.openscad.org> wrote:
I use the built-in OpenSCAD editor, which has a kind of auto-complete.
Would it be possible to add BOSL2 features to that?
Jon
On 2/18/2025 5:00 AM, Roel Vanhout via Discuss wrote:
Hello all,
I was fed up yesterday with having to look up module signatures (exact
names of arguments etc) so often, so I looked into setting up auto
complete (or at least completion suggestions and inline documentation)
inside Vim. This turned out to be quite a rabbit hole and a reminder
of why I no longer like to mess with convoluted setups, but after
reminding myself a few times to just get back to the basics and look
for a MVP only I now have a way where completion suggestions are read
from a simple text file (using vim-complete). So now all I need is a
list of openscad and BOSL2 modules and functions with their arguments
in a flat text file.
For openscad itself I can get away with just copy/pasting the
cheatsheet and fixing up manually as that pretty much covers my needs
for this specific use case, and that's a 10 minute job. For BOSL2 this
is obviously not an option because of the sheer amount of
functionality. So now my question is whether there is someone who's
already done something similar that I can leverage. BOSL2 seems to be
documented very cleanly and using a very strict format, so I could
just make a simple program to search for all lines that start with
'Usage:' and then read the next indented lines. Even if there would be
some issues in the formatting here or there, a 90% solution would be
fine with me. But still, maybe there are already more robust and
elaborate solutions to this issue that I could either use, re-use or
contribute to? Thanks.
(I seem to remember this topic having come up on this list some years
ago but I can't seem to find it? Maybe I'm just not remembering right)
regards
Roel
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.orgmailto:discuss-leave@lists.openscad.org
--
This email has been checked for viruses by AVG antivirus software.
www.avg.comhttp://www.avg.com
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.orgmailto:discuss-leave@lists.openscad.org
If I’m given a syntax for the auto-complete file, I can tweak my docsgen code to generate it. That way you’ll get more than the subset of arguments that the cheatsheet shows.
-Revar
no, although the original poster is using vim. for the openscad editor i
think adding LSP support could be a reasonable way to get support for
arbitrary included files, not just BOSL.
although, I'm not a fan of the way emacs autopopulates parameter names
(with their default arguments) since it is common to ignore arguments in
scad. but I don't think that is inherent to the Language Server Protocol.
On Tue, Feb 18, 2025, 13:35 jon jonbondy.com jon@jonbondy.com wrote:
James:
Does this really apply to the editor that is built into OpenSCAD?
Thanks!
Jon
On 2/18/2025 11:19 AM, James Larkby-Lahet wrote:
I think all you need is an openscad LSP (language server) and an editor
with LSP support.
I use https://github.com/Leathong/openscad-LSP with emacs.
On Tue, Feb 18, 2025, 06:43 Jon Bondy via Discuss <
discuss@lists.openscad.org> wrote:
I use the built-in OpenSCAD editor, which has a kind of auto-complete.
Would it be possible to add BOSL2 features to that?
Jon
On 2/18/2025 5:00 AM, Roel Vanhout via Discuss wrote:
Hello all,
I was fed up yesterday with having to look up module signatures (exact
names of arguments etc) so often, so I looked into setting up auto
complete (or at least completion suggestions and inline documentation)
inside Vim. This turned out to be quite a rabbit hole and a reminder
of why I no longer like to mess with convoluted setups, but after
reminding myself a few times to just get back to the basics and look
for a MVP only I now have a way where completion suggestions are read
from a simple text file (using vim-complete). So now all I need is a
list of openscad and BOSL2 modules and functions with their arguments
in a flat text file.
For openscad itself I can get away with just copy/pasting the
cheatsheet and fixing up manually as that pretty much covers my needs
for this specific use case, and that's a 10 minute job. For BOSL2 this
is obviously not an option because of the sheer amount of
functionality. So now my question is whether there is someone who's
already done something similar that I can leverage. BOSL2 seems to be
documented very cleanly and using a very strict format, so I could
just make a simple program to search for all lines that start with
'Usage:' and then read the next indented lines. Even if there would be
some issues in the formatting here or there, a 90% solution would be
fine with me. But still, maybe there are already more robust and
elaborate solutions to this issue that I could either use, re-use or
contribute to? Thanks.
(I seem to remember this topic having come up on this list some years
ago but I can't seem to find it? Maybe I'm just not remembering right)
regards
Roel
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.org
--
This email has been checked for viruses by AVG antivirus software.
www.avg.com
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.org
On 2/18/25 11:48, Jordan Brown via Discuss wrote:
Hmm. It wouldn't be silly to have a command-line mode that would parse
an OpenSCAD program and emit a list of function and module signatures.
I might find that useful, as I tend to have multiple modules in a .scad
file because of the general scope of some arguments. So so I usually
wind up with 50k of .scad code, that I "save as" that particular module
name. And ATM I am not having a problem generating .3mf files for
prusaslicer, but my prusaslicer is an older AppImage, prusa having
changed away from AppImage about 2 releases ago. I'm probably going to
have to bite that bullet and learn how to deal with flatpaxks before too
long... firefox is also jumping on that wagon. Its working on the
arm64's, but not so well on wintel stuffs here. OTOH I consider bookworm
partially broken. I hope upcoming trixie is better.
Cheers, Gene Heskett, CET.
"There are four boxes to be used in defense of liberty:
soap, ballot, jury, and ammo. Please use in that order."
-Ed Howdershelt (Author, 1940)
If we desire respect for the law, we must first make the law respectable.
- Louis D. Brandeis
Thanks all. I guess going the proper LSP based way is the 'real' fix after
all. But after spending almost the entire day yesterday getting the lsp vim
plugin to work with the openscad-lsp server, to the point where I installed
a Rust toolchain and the dev versions of all tools involved just so I could
add trace statements to understand what was going on and still coming up
short, I was reminded of those times the past where I tried to make vim do
things beyond what can be reasonably expected from it. Installing VS Code
and installing the vim mode and openscad LSP extensions took less than 10
minutes and worked out of the box (including library completions), so I
guess switching editors is the pragmatic solution.
James: I assume you're using openscad-lsp as the server from Emacs? Maybe
you already know, but you can pass --ignore-default to it to not auto
complete default arguments. Of course then you lose all arguments with
default values, i.e. you'll hardly get any arguments suggested any more.
regards
On Tue, Feb 18, 2025 at 8:51 PM James Larkby-Lahet jamesbuyacar@gmail.com
wrote:
no, although the original poster is using vim. for the openscad editor i
think adding LSP support could be a reasonable way to get support for
arbitrary included files, not just BOSL.
although, I'm not a fan of the way emacs autopopulates parameter names
(with their default arguments) since it is common to ignore arguments in
scad. but I don't think that is inherent to the Language Server Protocol.
On Tue, Feb 18, 2025, 13:35 jon jonbondy.com jon@jonbondy.com wrote:
James:
Does this really apply to the editor that is built into OpenSCAD?
Thanks!
Jon
On 2/18/2025 11:19 AM, James Larkby-Lahet wrote:
I think all you need is an openscad LSP (language server) and an editor
with LSP support.
I use https://github.com/Leathong/openscad-LSP with emacs.
On Tue, Feb 18, 2025, 06:43 Jon Bondy via Discuss <
discuss@lists.openscad.org> wrote:
I use the built-in OpenSCAD editor, which has a kind of auto-complete.
Would it be possible to add BOSL2 features to that?
Jon
On 2/18/2025 5:00 AM, Roel Vanhout via Discuss wrote:
Hello all,
I was fed up yesterday with having to look up module signatures (exact
names of arguments etc) so often, so I looked into setting up auto
complete (or at least completion suggestions and inline documentation)
inside Vim. This turned out to be quite a rabbit hole and a reminder
of why I no longer like to mess with convoluted setups, but after
reminding myself a few times to just get back to the basics and look
for a MVP only I now have a way where completion suggestions are read
from a simple text file (using vim-complete). So now all I need is a
list of openscad and BOSL2 modules and functions with their arguments
in a flat text file.
For openscad itself I can get away with just copy/pasting the
cheatsheet and fixing up manually as that pretty much covers my needs
for this specific use case, and that's a 10 minute job. For BOSL2 this
is obviously not an option because of the sheer amount of
functionality. So now my question is whether there is someone who's
already done something similar that I can leverage. BOSL2 seems to be
documented very cleanly and using a very strict format, so I could
just make a simple program to search for all lines that start with
'Usage:' and then read the next indented lines. Even if there would be
some issues in the formatting here or there, a 90% solution would be
fine with me. But still, maybe there are already more robust and
elaborate solutions to this issue that I could either use, re-use or
contribute to? Thanks.
(I seem to remember this topic having come up on this list some years
ago but I can't seem to find it? Maybe I'm just not remembering right)
regards
Roel
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.org
--
This email has been checked for viruses by AVG antivirus software.
www.avg.com
OpenSCAD mailing list
To unsubscribe send an email to discuss-leave@lists.openscad.org