Extract constants information

mpi-forum / pympistandard

Other

4 stars 0 forks source link

Extract constants information #5

Open martinruefenacht opened 1 year ago

martinruefenacht commented 1 year ago

[ ] Annotate constants in the latex files
[ ] Output these in the prepass to a constants.json or modify the apis.json file
[ ] Provide access to the constants information through the pympistandard module
[ ] Make sure that the emitter correctly removed any additional blocks

wgropp commented 1 year ago

Some of this has already been implemented, as part of the index processing pass. This should start from that. The --constfiles option to buildindices creates some LaTeX files, e.g., splittype-list.tex:

\const{MPI\_COMM\_TYPE\_HW\_GUIDED}\\ \const{MPI\_COMM\_TYPE\_HW\_UNGUIDED}\\ \const{MPI\_COMM\_TYPE\_SHARED}\\

martinruefenacht commented 1 year ago

I wasn't aware of this, but good!

The intention is to annotate the constants not just by name, but by KIND. So perhaps we need to use the prepass for that so it can be converted in normal latex, or we can have additional blocks defining the KINDs.

wgropp commented 1 year ago

buildindices creates a separate file for each type of constant. The current collection is:

datatype-list.tex infoval-list.tex splittype-list.tex err-list.tex maxsize-list.tex string-list.tex err-t-list.tex modes-list.tex infokey-list.tex pvarclass-list.tex

Or did you mean Fortran KIND?

martinruefenacht commented 1 year ago

I meant the KINDs that we did for the pythonization.