CL outline and content assist

[worksofliam]

Since the RPGLE outline now exists, I thought it might be useful for CL to have support for some outline functionality.

What items typically show up in an outline view for CL?

Also, would indent assist be useful for CL too?

[worksofliam]

I heard the standard stuff for CL is labels and subroutines. I am going to add variables to our outline too.

[szsascha]

I think labels are definitely the thing to go. Subroutines are relatively new in CL and often not existing in older CL programs.

[worksofliam]

I was also thinking we could use a system API to generate XML for command definitions - this might allows us to provide content assist for CL.

pgm parm(&name &cmd)
   dcl  &name     *char     10
   dcl  &cmd      *char     20
   dcl  &destinfo *char     64
   dcl  &destfmt  *char      8  value('DEST0200')
   dcl  &rcvvar   *char      1
   dcl  &rcvfmt   *char      8  value('CMDD0100')
   dcl  &error    *char     16  value(x'00000000')
   dcl  &null2    *char      2  value(x'0000')
   dcl  &null3    *char      3  value(x'000000')
   dcl  &null10   *char     10  value(x'00000000000000000000')
    /*chgvar  &cmd                  value('GENDDL    *LIBL') */
   chgvar  %bin(&destinfo  1  4) value(0)       /* CCSID         */
   chgvar  %sst(&destinfo  5  2) value(&null2)  /* country       */
   chgvar  %sst(&destinfo  7  3) value(&null3)  /* language      */
   chgvar  %sst(&destinfo 10  3) value(&null3)  /* reserved      */
   chgvar  %bin(&destinfo 13  4) value(0)       /* path type     */
   chgvar  %bin(&destinfo 17  4) value(15)      /* path name len */
   chgvar  %sst(&destinfo 21  2) value('/')     /* delimiter     */
   chgvar  %sst(&destinfo 23 10) value(&null10) /* reserved      */
   chgvar  %sst(&destinfo 33 32) value('/tmp/' *tcat &name)
   call qcdrcmdd (&cmd &destinfo &destfmt +
                  &rcvvar &rcvfmt &error)
endpgm

That generates XML, which we can convert to JSON. That looks something like this:

{
  "QcdCLCmd": {
    "$": {
      "DTDVersion": "1.0"
    },
    "Cmd": [
      {
        "$": {
          "CmdName": "CRTBNDDIR",
          "CmdLib": "QSYS",
          "CCSID": "37",
          "HlpPnlGrp": "QHBNCMD",
          "HlpPnlGrpLib": "__LIBL",
          "HlpID": "CRTBNDDIR",
          "MaxPos": "1",
          "Prompt": "Create Binding Directory",
          "MsgF": "QCPFMSG",
          "MsgFLib": "__LIBL",
          "ExecBatch": "YES",
          "ChgCmdExit": "NO",
          "RtvCmdExit": "NO"
        },
        "Parm": [
          {
            "$": {
              "Kwd": "BNDDIR",
              "PosNbr": "1",
              "KeyParm": "NO",
              "Type": "QUAL",
              "Min": "1",
              "Max": "1",
              "Prompt": "Binding directory",
              "Rstd": "NO",
              "AlwUnprt": "YES",
              "AlwVar": "YES",
              "Expr": "YES",
              "Full": "NO",
              "DspInput": "YES"
            },
            "Qual": [
              {
                "$": {
                  "Type": "NAME",
                  "Min": "1",
                  "Max": "1",
                  "Len": "10",
                  "Rstd": "NO",
                  "AlwUnprt": "YES",
                  "AlwVar": "YES",
                  "Expr": "YES",
                  "Full": "NO",
                  "DspInput": "YES",
                  "Choice": "Name"
                }
              },
              {
                "$": {
                  "Type": "NAME",
                  "Min": "0",
                  "Max": "1",
                  "Prompt": "Library",
                  "Len": "10",
                  "Rstd": "NO",
                  "Dft": "*CURLIB",
                  "AlwUnprt": "YES",
                  "AlwVar": "YES",
                  "Expr": "YES",
                  "Full": "NO",
                  "DspInput": "YES",
                  "Choice": "Name"
                },
                "SpcVal": [
                  {
                    "Value": [
                      {
                        "$": {
                          "Val": "*CURLIB",
                          "MapTo": "*CURLIB   "
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "$": {
              "Kwd": "AUT",
              "PosNbr": "2",
              "KeyParm": "NO",
              "Type": "NAME",
              "Min": "0",
              "Max": "1",
              "Prompt": "Authority",
              "Len": "10",
              "Rstd": "NO",
              "Dft": "*LIBCRTAUT",
              "AlwUnprt": "YES",
              "AlwVar": "YES",
              "Expr": "YES",
              "Full": "NO",
              "DspInput": "YES",
              "Choice": "Name"
            },
            "SpcVal": [
              {
                "Value": [
                  {
                    "$": {
                      "Val": "*LIBCRTAUT",
                      "MapTo": "*LIBCRTAUT"
                    }
                  },
                  {
                    "$": {
                      "Val": "*CHANGE",
                      "MapTo": "*CHANGE"
                    }
                  },
                  {
                    "$": {
                      "Val": "*ALL",
                      "MapTo": "*ALL"
                    }
                  },
                  {
                    "$": {
                      "Val": "*USE",
                      "MapTo": "*USE"
                    }
                  },
                  {
                    "$": {
                      "Val": "*EXCLUDE",
                      "MapTo": "*EXCLUDE"
                    }
                  }
                ]
              }
            ]
          },
          {
            "$": {
              "Kwd": "TEXT",
              "PosNbr": "3",
              "KeyParm": "NO",
              "Type": "CHAR",
              "Min": "0",
              "Max": "1",
              "Prompt": "Text 'description'",
              "Len": "50",
              "Rstd": "NO",
              "Dft": "*BLANK",
              "AlwUnprt": "YES",
              "AlwVar": "YES",
              "Expr": "YES",
              "Full": "NO",
              "DspInput": "YES",
              "Choice": "Character value"
            },
            "SpcVal": [
              {
                "Value": [
                  {
                    "$": {
                      "Val": "*BLANK",
                      "MapTo": ""
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

I guess we'd have to figure out how to translate this to a command string.. which looks simple enough.

[worksofliam]

More example JSON:

{"QcdCLCmd":{"$":{"DTDVersion":"1.0"},"Cmd":[{"$":{"CmdName":"CHKOBJ","CmdLib":"__LIBL","CCSID":"37","HlpPnlGrp":"QHLICMD","HlpPnlGrpLib":"__LIBL","HlpID":"CHKOBJ","MaxPos":"4","Prompt":"Check Object","MsgF":"QCPFMSG","MsgFLib":"__LIBL","ExecBatch":"YES","ChgCmdExit":"NO","RtvCmdExit":"NO"},"Parm":[{"$":{"Kwd":"OBJ","PosNbr":"1","KeyParm":"NO","Type":"QUAL","Min":"1","Max":"1","Prompt":"Object","Rstd":"NO","AlwUnprt":"YES","AlwVar":"YES","Expr":"YES","Full":"NO","DspInput":"YES"},"Qual":[{"$":{"Type":"NAME","Min":"1","Max":"1","Len":"10","Rstd":"NO","AlwUnprt":"YES","AlwVar":"YES","Expr":"YES","Full":"NO","DspInput":"YES","Choice":"Name"}},{"$":{"Type":"NAME","Min":"0","Max":"1","Prompt":"Library","Len":"10","Rstd":"NO","Dft":"*LIBL","AlwUnprt":"YES","AlwVar":"YES","Expr":"YES","Full":"NO","DspInput":"YES","Choice":"Name"},"SpcVal":[{"Value":[{"$":{"Val":"*LIBL","MapTo":"*LIBL"}},{"$":{"Val":"*CURLIB","MapTo":"*CURLIB   "}}]}]}]},{"$":{"Kwd":"OBJTYPE","PosNbr":"2","KeyParm":"NO","Type":"CHAR","Min":"1","Max":"1","Prompt":"Object type","Len":"7","Rstd":"YES","AlwUnprt":"YES","AlwVar":"YES","Expr":"YES","Full":"NO","DspInput":"YES","Choice":"*ALRTBL, *AUTL, *BNDDIR..."},"SpcVal":[{"Value":[{"$":{"Val":"*ALRTBL","MapTo":"ALRTBL"}},{"$":{"Val":"*AUTL","MapTo":"AUTL"}},{"$":{"Val":"*BNDDIR","MapTo":"BNDDIR"}},{"$":{"Val":"*CFGL","MapTo":"CFGL"}},{"$":{"Val":"*CHTFMT","MapTo":"CHTFMT"}},{"$":{"Val":"*CLD","MapTo":"CLD"}},{"$":{"Val":"*CLS","MapTo":"CLS"}},{"$":{"Val":"*CMD","MapTo":"CMD"}},{"$":{"Val":"*CNNL","MapTo":"CNNL"}},{"$":{"Val":"*COSD","MapTo":"COSD"}},{"$":{"Val":"*CRG","MapTo":"CRG"}},{"$":{"Val":"*CRQD","MapTo":"CRQD"}},{"$":{"Val":"*CSI","MapTo":"CSI"}},{"$":{"Val":"*CSPMAP","MapTo":"CSPMAP"}},{"$":{"Val":"*CSPTBL","MapTo":"CSPTBL"}},{"$":{"Val":"*CTLD","MapTo":"CTLD"}},{"$":{"Val":"*DEVD","MapTo":"DEVD"}},{"$":{"Val":"*DOC","MapTo":"DOC"}},{"$":{"Val":"*DTAARA","MapTo":"DTAARA"}},{"$":{"Val":"*DTADCT","MapTo":"DTADCT"}},{"$":{"Val":"*DTAQ","MapTo":"DTAQ"}},{"$":{"Val":"*EDTD","MapTo":"EDTD"}},{"$":{"Val":"*EXITRG","MapTo":"EXITRG"}},{"$":{"Val":"*FCT","MapTo":"FCT"}},{"$":{"Val":"*FILE","MapTo":"FILE"}},{"$":{"Val":"*FLR","MapTo":"FLR"}},{"$":{"Val":"*FNTRSC","MapTo":"FNTRSC"}},{"$":{"Val":"*FNTTBL","MapTo":"FNTTBL"}},{"$":{"Val":"*FORMDF","MapTo":"FORMDF"}},{"$":{"Val":"*FTR","MapTo":"FTR"}},{"$":{"Val":"*GSS","MapTo":"GSS"}},{"$":{"Val":"*IGCDCT","MapTo":"IGCDCT"}},{"$":{"Val":"*IGCSRT","MapTo":"IGCSRT"}},{"$":{"Val":"*IGCTBL","MapTo":"IGCTBL"}},{"$":{"Val":"*IMGCLG","MapTo":"IMGCLG"}},{"$":{"Val":"*IPXD","MapTo":"IPXD"}},{"$":{"Val":"*JOBD","MapTo":"JOBD"}},{"$":{"Val":"*JOBQ","MapTo":"JOBQ"}},{"$":{"Val":"*JOBSCD","MapTo":"JOBSCD"}},{"$":{"Val":"*JRN","MapTo":"JRN"}},{"$":{"Val":"*JRNRCV","MapTo":"JRNRCV"}},{"$":{"Val":"*LIB","MapTo":"LIB"}},{"$":{"Val":"*LIND","MapTo":"LIND"}},{"$":{"Val":"*LOCALE","MapTo":"LOCALE"}},{"$":{"Val":"*MEDDFN","MapTo":"MEDDFN"}},{"$":{"Val":"*MENU","MapTo":"MENU"}},{"$":{"Val":"*MGTCOL","MapTo":"MGTCOL"}},{"$":{"Val":"*MODD","MapTo":"MODD"}},{"$":{"Val":"*MODULE","MapTo":"MODULE"}},{"$":{"Val":"*MSGF","MapTo":"MSGF"}},{"$":{"Val":"*MSGQ","MapTo":"MSGQ"}},{"$":{"Val":"*M36","MapTo":"M36"}},{"$":{"Val":"*M36CFG","MapTo":"M36CFG"}},{"$":{"Val":"*NODGRP","MapTo":"NODGRP"}},{"$":{"Val":"*NODL","MapTo":"NODL"}},{"$":{"Val":"*NTBD","MapTo":"NTBD"}},{"$":{"Val":"*NWID","MapTo":"NWID"}},{"$":{"Val":"*NWSCFG","MapTo":"NWSCFG"}},{"$":{"Val":"*NWSD","MapTo":"NWSD"}},{"$":{"Val":"*OUTQ","MapTo":"OUTQ"}},{"$":{"Val":"*OVL","MapTo":"OVL"}},{"$":{"Val":"*PAGDFN","MapTo":"PAGDFN"}},{"$":{"Val":"*PAGSEG","MapTo":"PAGSEG"}},{"$":{"Val":"*PDFMAP","MapTo":"PDFMAP"}},{"$":{"Val":"*PDG","MapTo":"PDG"}},{"$":{"Val":"*PGM","MapTo":"PGM"}},{"$":{"Val":"*PNLGRP","MapTo":"PNLGRP"}},{"$":{"Val":"*PRDDFN","MapTo":"PRDDFN"}},{"$":{"Val":"*PRDLOD","MapTo":"PRDLOD"}},{"$":{"Val":"*PSFCFG","MapTo":"PSFCFG"}},{"$":{"Val":"*QMFORM","MapTo":"QMFORM"}},{"$":{"Val":"*QMQRY","MapTo":"QMQRY"}},{"$":{"Val":"*QRYDFN","MapTo":"QRYDFN"}},{"$":{"Val":"*RCT","MapTo":"RCT"}},{"$":{"Val":"*SBSD","MapTo":"SBSD"}},{"$":{"Val":"*SCHIDX","MapTo":"SCHIDX"}},{"$":{"Val":"*SPADCT","MapTo":"SPADCT"}},{"$":{"Val":"*SQLPKG","MapTo":"SQLPKG"}},{"$":{"Val":"*SQLUDT","MapTo":"SQLUDT"}},{"$":{"Val":"*SQLXSR","MapTo":"SQLXSR"}},{"$":{"Val":"*SRVPGM","MapTo":"SRVPGM"}},{"$":{"Val":"*SSND","MapTo":"SSND"}},{"$":{"Val":"*SVRSTG","MapTo":"SVRSTG"}},{"$":{"Val":"*S36","MapTo":"S36"}},{"$":{"Val":"*TBL","MapTo":"TBL"}},{"$":{"Val":"*TIMZON","MapTo":"TIMZON"}},{"$":{"Val":"*USRIDX","MapTo":"USRIDX"}},{"$":{"Val":"*USRPRF","MapTo":"USRPRF"}},{"$":{"Val":"*USRQ","MapTo":"USRQ"}},{"$":{"Val":"*USRSPC","MapTo":"USRSPC"}},{"$":{"Val":"*VLDL","MapTo":"VLDL"}},{"$":{"Val":"*WSCST","MapTo":"WSCST"}}]}]},{"$":{"Kwd":"MBR","PosNbr":"3","KeyParm":"NO","Type":"NAME","Min":"0","Max":"1","Prompt":"Member, if data base file","Len":"10","Rstd":"NO","Dft":"*NONE","AlwUnprt":"YES","AlwVar":"YES","Expr":"YES","Full":"NO","DspInput":"YES","Choice":"Name"},"SpcVal":[{"Value":[{"$":{"Val":"*NONE","MapTo":"*NONE"}},{"$":{"Val":"*FIRST","MapTo":"*FIRST"}}]}]},{"$":{"Kwd":"AUT","PosNbr":"4","KeyParm":"NO","Type":"CHAR","Min":"0","Max":"10","Prompt":"Authority","Len":"10","Rstd":"YES","Dft":"*NONE","AlwUnprt":"YES","AlwVar":"YES","Expr":"YES","Full":"NO","DspInput":"YES","Choice":"*NONE, *ALL, *CHANGE, *USE..."},"SngVal":[{"Value":[{"$":{"Val":"*NONE","MapTo":"*NONE"}},{"$":{"Val":"*ALL","MapTo":"*ALL"}},{"$":{"Val":"*CHANGE","MapTo":"*CHANGE"}},{"$":{"Val":"*USE","MapTo":"*USE"}},{"$":{"Val":"*EXCLUDE","MapTo":"*EXCLUDE"}},{"$":{"Val":"*AUTLMGT","MapTo":"*AUTLMGT"}}]}],"Values":[{"Value":[{"$":{"Val":"*OBJALTER"}},{"$":{"Val":"*OBJEXIST"}},{"$":{"Val":"*OBJMGT"}},{"$":{"Val":"*OBJOPR"}},{"$":{"Val":"*OBJREF"}},{"$":{"Val":"*ADD"}},{"$":{"Val":"*DLT"}},{"$":{"Val":"*EXECUTE"}},{"$":{"Val":"*READ"}},{"$":{"Val":"*UPD"}}]}]}],"Dep":[{"$":{"CtlKwdRel":"NE","CtlKwd":"OBJTYPE","CmpVal":"FILE","NbrTrueRel":"EQ","NbrTrue":"1","MsgID":"CPD2168"},"DepParm":[{"$":{"Kwd":"MBR","Rel":"EQ","CmpVal":"*NONE"}}]},{"$":{"CtlKwdRel":"EQ","CtlKwd":"AUT","CmpVal":"*AUTLMGT","NbrTrueRel":"EQ","NbrTrue":"1","MsgID":"CPF22AE"},"DepParm":[{"$":{"Kwd":"OBJTYPE","Rel":"EQ","CmpVal":"AUTL"}}]}]}]}}

[martintosney]

Interested to follow your progress on this. I was looking at whether this API could be used to generate bash shell completions for the system/cl commands. Ultimately, the work/reward ratio didn't seem worth it!

[worksofliam]

@onewheelonly in theory it could be for that also!

I am kind of at the last hard part of this implementation which is to build a command string out of the JSON above.

It's kind of messy so I am procrastinating hard. I don't want to spend hours on a feature that users may find useless.

[worksofliam]

Got it prompting for command parameters!!!

[worksofliam]