Re: [NTG-context] How to write readable source files?

On 5/29/2021 5:03 PM, Nicola wrote:

On 2021-04-25, Hans Hagen wrote:

...

...

If there is a way to automatically get a list of all ConTeXt commands and options (and, ideally, MetaFun defs, types, and other keywords), I'd be happy to improve omni-completion for ConTeXt in Vim. All is in xml files (i-*.xml) in the distribution maintained by Wolfgang. We ship with this for editors:

...

dir t:\texmf\context\data

04/21/2021 11:40 AM <DIR> scite 04/21/2021 11:40 AM <DIR> textadept 04/21/2021 11:40 AM <DIR> texworks 04/21/2021 11:40 AM <DIR> vscode

these lists are generated by mtx-interface so we can add more if needed

Could you please elaborate on the (automatic?) data flow from ConTeXt's source files to data files for each application? Is it:

source code -> XML -> .lua -> mtx-interface -> data?

In particular, it is not clear to me how i-*.xml files are related to mtx-interface, as the latter does not use them directly, AFAICS.

for sure it does in the early days of context mkii we had \startsetups kind of definitions that got filtered from the source but when xml support was built that moved to an xml file then Wolfgang did an excellent job on checking each xml snippet and added many more and these i-* files showed up, we extended the xml a bit, redid the rendering of these lists etc wolfgang is in charge of this so when something specific in the files is needed ...

Anyway, mtx-interface seems exactly what I am looking for, and I would like to use it to generate ConTeXt keywords for Vim. Can I patch that script?

basically we only need function flushers.vim(collected) end

For MetaFun keywords I don't know yet: do those XML files contain enough information about the content of all mp-* source files? E.g., the fact that `hlingrid` is a def? Looking at the Scite files, I see only internals and commands, and they seem to cover only the "main" MetaFun names.

it is still on the agenda to make xml files for metafun but there is no timeline for that now, when it comes to highlighting, the reference is the scite one (which supports several of the languages that we use, and also supports mixed lua/mp/tex/... lexing) ... right from the start the way it shows up in an editor determined how the user interface evolved ... believe it or not, but for a long time we used texedit (written in modula, was pretty ok in 640K mem, also fast and one could scroll files in the sidebar and see them instantly; it used the character based windowing i'd written as a student for terminals connected to a dec vax .. just for fun ... i'm that old) ... when modula disappeared i actually rewrote that one in perl/tk and it still works but then decided to use scite anyway, so scite is still my reference (i looked to vscode but seeing all this extra stuff, the need for 'servers', the lack of simply running a command based on suffix ... not now) that said, we can support whatever editor one uses makes much sense (one should really use the editor, word processor, operating system etc one feels most comfortable with) so just make a prototype (or tell me what kind of lists you need, because it's rather trivial to generate them)

I have used a custom script in the past for fine-grained keyword extraction from MetaFun's source code. By fine-grained, I mean that the output contains information about the kind of keyword (def, primary def, vardef, constant, variable, etc.) I could update it to Lua and mp-*.mpxl if that interests you—unless that has already been done, of course. just look at the files in the scite path ... much info is available, for context it comes from the xml files, for the tex engine and meta* it comes from mult* lua files

adding more detail (not sure if distinguishing between def and vardef makes sense ... we more use the 'primitive', 'lowlevel', 'interface' kind of grouping let's see what Wolfgang thinks of it ... Hans ----------------------------------------------------------------- Hans Hagen | PRAGMA ADE Ridderstraat 27 | 8061 GH Hasselt | The Netherlands tel: 038 477 53 69 | www.pragma-ade.nl | www.pragma-pod.nl -----------------------------------------------------------------