Make structured data available to FPrime template. Refs #246.

[ivanperez-keera]

Modify FPrime backend to make more structured data directly available to the FPrime template, as prescribed in the solution proposed for #246.

[ivanperez-keera]

Change Manager: Verified that:

• Solution is implemented:
  • The code proposed compiles and passes all tests. Details:
    • Build logs:
      • https://github.com/nasa/ogma/actions/runs/13211392906/job/36885158802
      • https://github.com/nasa/ogma/actions/runs/13211392897/job/36885158793
    • Build log archives:
      • logs_34107250413.zip
      • logs_34107250433.zip
  • The solution proposed produces the expected result. Details:
    The following Dockerfile checks that generating an FPrime application with and without the feature proposed renders the same result, after which it prints the message "Success". We manually adjust a small difference using awk and sed, because it's unimportant and it would complicate the F' backend unnecessarily. It requires an additional BASE_COMMIT variable pointing to a commit prior to merging this feature.

    FROM ubuntu:focal
    
    ENV DEBIAN_FRONTEND=noninteractive
    RUN apt-get update
    
    RUN apt-get install --yes \
          curl g++ gcc git libgmp3-dev libz-dev make pkg-config
    
    RUN mkdir -p $HOME/.local/bin
    ENV PATH=$PATH:/root/.local/bin/
    
    RUN curl https://downloads.haskell.org/~ghcup/0.1.17.7/x86_64-linux-ghcup-0.1.17.7 -o $HOME/.local/bin/ghcup
    RUN chmod a+x $HOME/.local/bin/ghcup
    
    ENV PATH=$PATH:/root/.ghcup/bin/
    RUN ghcup install ghc 9.10
    RUN ghcup install cabal 3.12
    RUN ghcup set ghc 9.10.1
    RUN cabal update
    
    ADD document.json      /tmp/document.json
    ADD json-format.cfg    /tmp/json-format.cfg
    ADD fprime-variable-db /tmp/fprime-variable-db
    ADD fprime-handlers    /tmp/fprime-handlers
    
    SHELL ["/bin/bash", "-c"]
    CMD git clone $REPO \
        && cd $NAME \
        && git checkout $BASE_COMMIT \
        && cabal install ogma-cli:ogma \
        && ogma fprime --app-target-dir original --handlers-file /tmp/fprime-handlers --input-file /tmp/document.json -f /tmp/json-format.cfg -p literal --variable-db /tmp/fprime-variable-db \
        && git checkout $COMMIT \
        && cabal install --overwrite-policy=always ogma-cli:ogma \
        && ogma fprime --app-target-dir updated  --handlers-file /tmp/fprime-handlers --input-file /tmp/document.json -f /tmp/json-format.cfg -p literal --variable-db /tmp/fprime-variable-db \
        && awk '/^.*event HANDLERMYPROPERTY/{printf "%s",$$0;next}1' original/Copilot.fpp | sed -e 's/\(event HANDLERMYPROPERTY.*(\) *\().*\)/\1\2/g' > original/Copilot.fpp.adjusted \
        && mv original/Copilot.fpp.adjusted original/Copilot.fpp \
        && diff -rq original updated \
        && echo "Success"

    Command (substitute variables based on new path after merge):

    $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e "BASE_COMMIT=eae76d0c573042ca7252629535524af82cad700f" -e "COMMIT=947799cbdfe4fcd9360d967ee511066fc791ec28" -it ogma-verify-246
    

• Implementation is documented. Details:
  All new top-level definitions are documented. The README is updated to explain the new variables available in the FPrime template.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No updates needed; change does not affect the examples.
• Author is internal or has provided signed CLA.
• Required version bumps are evaluated. Details:
  Bump needed; the change does not affect the API or user interface so long as they use the default template, but it does affect custom templates that may be used by users, which need to be adapted to use the new variable names.