Monitor interface routines

Available subroutines:
        SIC_LOAD        SIC_OPT         SIC_RUN 
        SIC_INSERT      SIC_LOG         SIC_LANG        
Available functions:
        SIC_CTRLC       SIC_LIRE        SIC_INTER_STATE

To build a program around the SIC monitor, different routines are provided. Some must always be used (SIC_LOAD and SIC_RUN), others are simply provided for additional capabilities. These routines have a standard SIC_ like name and are fully described in this section.   SIC_RUN (LINE,LANG,COMMAND,ERROR,ICODE,OCODE)

This subroutine is used to enter SIC, retrieve and analyse a command line for further execution. All SIC possibilities, including execution levels and error recoveries, made accessible (In particular, the LINE command line can be a call to a macro file).

• LINE Character*(*) (maximum size is 2048)
  Command line to be executed. Modified by SICNo need to initialize it when ICODE = 0 or 1, but must be initialized is ICODE = -1 or 2
• LANG Character*12
  Name of the language returned by SIC
• COMMAND Character*12
  Name of the command returned by SIC
• ERROR Logical
  Return error code
• ICODE Operation code
  
  • ICODE = -1
    Analyse the command line passed as argument LINE, and return to calling program to execute it.
  • ICODE = 0
    Loop into SIC to retrieve a new command line LINE, and return to calling program to execute it.
  • ICODE = 1
    Start SIC, and retrieve a first command line.
  • ICODE = 2
    Start SIC, analyse the command line passed as argument, and return to calling program to execute it.
• OCODE Return code
  
  • OCODE = -1
    End of execution in sub-routine mode. Program must return immediately to its caller.
  • OCODE = 0
    Successful analysis of a command. Program must execute it, and then loop again on SIC_RUN with ICODE=0 to get further commands.
  • OCODE = 1
    End of execution caused by typing the EXIT command. Program should perform any necessary action (close files, etc...) and return to its caller.

  SIC_LOAD (LANG,HELP,NCOM,CCOM,VERSION)

This subroutine initialize a SIC language and thus is usually the first one called. All arguments are unchanged by the routines and may be passed as immediate values.

• LANG Character*(*).
  The language name, as it will appear in the HELP and will be returned by SIC after command line processing. It is truncated to 12 characters if necessary.
• HELP Character*(*).
  The logical name for the HELP file corresponding to the language being initialized.
• NCOM Integer.
  The number of command and options, i.e. the dimension of the CCOM character array
• CCOM Character*12 array of dimension NCOM.
  Contains the vocabulary of the language. The structure of the command vocabulary is described elsewhere in this document.
• VERSION Character*(*).
  A string to indicate the version number, the last modified date, the programmer name,... which will appear as a message with the language name at run time.

  SIC_OPT (PROMPT,LOGFILE,MEMORY)

This routine is not compulsory. It is used to set the prompt the log file name and the stack usage. This routine only changes the prompt if called after SIC_LOAD.

• PROMPT Character*(*).
  The prompt to be used in interactive mode, truncated to 8 characters if necessary. Default is SIC. Note that the caret > and other alterations such as : or _1> are added by SIC at run time and should not be included.
• LOGFILE Character*(*).
  The log file name. Default is LOG.
• MEMORY Logical.
  Indicates whether the Stack is used or not.

  SIC_INSERT(LINE)

This routine is only useful when the Stack Buffer is used to store commands. This is the default, and the case when the flag MEMORY was set to .TRUE. in the first call to SIC_OPT. It can be changed with the SIC MEMORY command. SIC_INSERT is used to put a command line into the Stack buffer, a very useful possibility for some applications, when several lines must be put or when the command line must be expanded by the user program before the insertion is made.

Note however that command lines are automatically inserted in the Stack Buffer by the monitor for usual commands. This is the standard way of using the Stack insertion mode, since it automatically takes into account many things like the execution level before deciding whether an insertion must occur. Using directly SIC_INSERT usually implies to disable the automatic insertion by the monitor (using the character code * in the definition of the associated command, c.f. Section 2.2). You need also to perform a call to SIC_LIRE to check the SIC   execution mode (you should only call SIC_INSERT when SIC_LIRE() is equal to 0) and associated calls to SIC_LOG to write the same information in the LOG file. The insertion does not occur if the memory flag is turned off (SIC MEMORY OFF).

• LINE Character*(*).

  SUBROUTINE SIC_LOG (LINE,NL,LIRE)

This subroutine writes LINE(1:NL) into the Log_File if LIRE=0. LIRE is here necessary for consistency with the internal pointer indicating if SIC is processing a macro, the stack or the loop. This pointer can be retrieved by the function SIC_LIRE. A call to SIC_LOG when LIRE is not 0 has no action.

• LINE Character*(*) Input
• NL Integer Input
• LIRE Integer Input

  SUBROUTINE SIC_LANG(LANG)

This subroutine returns the name of the language corresponding to the last command analysed. It is called only when building the library version of a multi-language application.

• LANG Character*(*) is returned by the routine

  LOGICAL FUNCTION SIC_CTRLC ( )

SIC itself traps the <^C> by generating a PAUSE at the end of the command which was being executed when <^C> was pressed. You may want in time-consuming applications to check yourself at specific points whether <^C> has been pressed. SIC_CTRLC allows you to do so, and resets an internal flag to .FALSE. when called. It returns .TRUE. if <^C> has been pressed since either the last command completed execution or the last time it was called (using the most recent event), .FALSE. otherwise.

  INTEGER FUNCTION SIC_LIRE ( )

This subroutine returns the internal pointer of SIC indicating where SIC is currently reading its commands. SIC_LIRE may take the values

• -10 Subroutine mode
• -2 Reading in the Loop buffer
• -1 Called from SIC_RUN with ICODE = -1
• 0 Interactive mode
• I>0 Reading in macro number I

  LOGICAL FUNCTION SIC_INTER_STATE ( )

This subroutine returns .TRUE. if the session is interactive, .FALSE. otherwise. This is the case if SIC is ran during a batch process, or if the logical unit FOR005 is assigned to a file (either directly or through an assignment of SYS$INPUT).