!============================================================================*
!									     *
!   lrschema.awk - LIBERO code generation schema for AWK (gawk/nawk)	     *
!									     *
!   Written:	95/08/01  Pieter Hintjens <ph@imatix.com>		     *
!   Revised:	96/12/29						     *
!									     *
!   Generates a script written in the Awk language.			     *
!   Compatible with GNU awk (gawk) and new awk (nawk).			     *
!									     *
!   Usage:	Add this line to the start of your dialog file: 	     *
!		-schema=lrschema.awk					     *
!									     *
!               Put your module data and code in '<script>.mod'.  When       *
!		you run lr, it creates a script file combining your modules  *
!		with the generated code from this schema.  To make a change  *
!               and rebuild 'myscript', run these commands:                  *
!									     *
!		vi myscript.l	    (make changes to dialog)		     *
!		vi myscript.mod     (modify module code)		     *
!		lr myscript	    (add stubs if needed, build script)      *
!		chmod +x myscript   (make script executable)		     *
!									     *
!		Accepts these options:					     *
!		-opt:stack_max=nnn - size of subdialog stack (20)	     *
!		-opt:template=xxxx - template file (template.awk)	     *
!		-opt:awk=xxx	   - AWK/GAWK/NAWK program (/bin/awk)	     *
!									     *
!   FSM Code Generator.  Copyright (c) 1991-97 iMatix.			     *
!									     *
!   This program is free software; you can redistribute it and/or modify     *
!   it under the terms of the GNU General Public License as published by     *
!   the Free Software Foundation; either version 2 of the License, or	     *
!   (at your option) any later version. 				     *
!									     *
!   This program is distributed in the hope that it will be useful,	     *
!   but WITHOUT ANY WARRANTY; without even the implied warranty of	     *
!   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the	     *
!   GNU General Public License for more details.			     *
!									     *
!   You should have received a copy of the GNU General Public License	     *
!   along with this program; if not, write to the Free Software 	     *
!   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.		     *
!============================================================================*

!   You can use the template file to include project-specific code in the
!   generated code at various points.  This is a (better) alternative to
!   changing the schema in order to add your own project code.
!
!   The template file should contain these sections (each starts with a
!   keyword on a line, and ends with <END> on a line).	These sections may
!   be included in a newly-generated program (keywords are case-sensitive):
!
!   <HEADER>			- program header comment
!   <Initialise-The-Program>	- in Initialise-The-Program
!   <Get-External-Event>	- in Get-External-Event
!   <Terminate-The-Program>	- in Terminate-The-Program
!   <Any-Dialog-Module> 	- any dialog module
!
:declare string $template = "template.awk"

:if not exist $source.mod
:output $source.mod
:echo "lr I: creating skeleton module file $source.mod..."
#==============================================================================
#-
#-  $source.mod - module file for $dialog.l
<help>
#
#   $source	Summary of awk program
#
#   Written:	$date	  $author
#   Revised:	$date
#
:include optional $template "<HEADER>" "<END>"
<end>
#-  Skeleton generated by LIBERO $version on $fulldate, $time.
#==============================================================================

<code>

##########################   INITIALISE THE PROGRAM   #########################

function $"initialise_the_program" \
() {
    $"the_next_event" = $"ok_event"
:include optional $template "<Initialise-The-Program>" "<END>"
}


############################   GET EXTERNAL EVENT   ###########################

function $"get_external_event" \
() {
:include optional $template "<Get-External-Event>" "<END>"
:if $included = 0
    return
:endif
}


##########################   TERMINATE THE PROGRAM    #########################

function $"terminate_the_program" \
() {
    $"the_next_event" = $"terminate_event"
:include optional $template "<Terminate-The-Program>" "<END>"
}

:close
:endif

!   Create dummy file listing the modules provided by the generated code;
!   this prevents them being added to the .mod file.
:output $dialog.tmp
:if module "Dialog-Call"
function $"dialog_call" \
function $"dialog_return" \
:endif
:close

!   Generate stubs for all modules not yet defined in source file

:set stub_first="#"
:set stub_between="#"
:set stub_last="#"
:set module_line="function %s \"
:set row_first="%ld"
:set row_after=" %ld"

:internal initialise_the_program
:internal get_external_event
:do stubs $source.mod $dialog.tmp

function $name \
() {
:include optional $template "<$module_name>" "<END>"
:if $included = 0
    return
:endif
}

:enddo stubs
:delete $dialog.tmp

:output $source
:echo "lr I: building $source..."
:declare string $awk = "/bin/awk"       # Full name of awk program
#! $awk -f
#----------------------------------------------------------------------------
:include $source.mod "<help>" "<end>"
#-  $source - generated script; do not modify directly. See $dialog.l
#-  Generated by LIBERO $version on $fulldate, $time.
#-  Schema used: $schema
#----------------------------------------------------------------------------

:if $states < 10
:   declare int nswid = 1		# Size of item in LR_nextst table
:else
:if $states < 100
:   declare int nswid = 2
:else
:   declare int nswid = 3
:endif all
:
:if $vectors < 10
:   declare int acwid = 1		# Size of item in LR_action table
:else
:if $vectors < 100
:   declare int acwid = 2
:else
:   declare int acwid = 3
:endif all
:
:if $modules < 10
:   declare int mowid = 1		# Size of item in LR_module table
:   declare string null = "0"
:else
:if $modules < 100
:   declare int mowid = 2
:   declare string null = "00"
:else
:   declare int mowid = 3
:   declare string null = "000"
:endif all
:
function LR_initialise () {
    #  Symbolic constants and event numbers
    $"terminate_event"  = -1            # Halts the dialog
    LR_NULL_EVENT	= -2
:do event
    $name		= $number
:enddo
:if defaults
    LR_defaults_state	= $defaults
:endif
:do state
    LR_STATE_$name	= $number
:enddo

    #  Public dialog variables
    $"the_next_event" = 0               #   Next event from module
    $"the_exception_event" = 0          #   Exception event from module
    $"feedback" = 0                     #   Return code from this function
    $"exception_raised" = 0             #   TRUE if exception raised

    #  Variables used by dialog interpreter
    LR_event = 0			#   Event for state transition
    LR_state = 0			#   Current dialog state
    LR_savest = 0			#   Saved dialog state
    LR_index = 0			#   Index into vector table
    LR_vecptr = 0			#   Index into module vector

:set row_width	= 42			# If $row is longer, do overflow
:set number_fmt = "%ld"
:set row_first  = "%0$nswid\ld"
:set row_after  = "%0$nswid\ld"
:set number_fmt = "%ld"
:
    LR_nextst = ""
:do nextst
    LR_nextst = LR_nextst "$row"
:  do overflow
    LR_nextst = LR_nextst "$row"
:  enddo
:enddo

:set number_fmt = "%ld"
:set row_first  = "%0$acwid\ld"
:set row_after  = "%0$acwid\ld"
:set number_fmt = "%ld"
:
:set array_base = 1
    LR_action = ""
:do action
    LR_action = LR_action "$row"
:  do overflow
    LR_action = LR_action "$row"
:  enddo
:enddo

:set number_fmt = "%ld"
:set row_first  = "%0$mowid\ld"
:set row_after  = "%0$mowid\ld"
:set number_fmt = "%ld"
:
    LR_module = ""
:do vector
    LR_module = LR_module "$row" "$null"
:enddo
:set array_base = 0

:declare int offsetidx
:do vector
:   set offsetidx = $number + 1
    LR_offset [$offsetidx] = $offset
:enddo
:if animate

:push $style
:option -style=normal
:do state
    LR_sname [$number] = "$name"
:enddo
:do event
    LR_ename [$number] = "$name"
:enddo
:set array_base = 1
:do module
    LR_mname [$number] = "$name"
:enddo
:set array_base = 0
:pop $style
:option -style=$style
:endif
:if module "Dialog-Call"
:  if not event "Return"
:     echo "lr E: you must define the 'Return' event"
:     exit 1
:  endif
:  declare int $stack_max = 20
    LR_stack_size = 0
:endif
}

function $"raise_exception" (event) {
    $"exception_raised" = 1
    if (event)
        $"the_exception_event" = event
}

:if module "Dialog-Call"
function $"dialog_call" \
() {
    if (LR_stack_size < $stack_max)
	LR_stack [++LR_stack_size] = LR_state
    else
      {
        print "State " LR_state " - Dialog-Call overflow"
	exit 1
      }
}

function $"dialog_return" \
() {
    if (LR_stack_size > 0)
      {
	LR_state = LR_stack [LR_stack_size--]
        $"raise_exception"($"return_event")
      }
    else
      {
        print "State " LR_state " - Dialog-Return underflow"
	exit 1
      }
}

:endif

:include $source.mod "<code>" "<end>"

###################################  BEGIN   ##################################

BEGIN {
    LR_state = 0			# First state is always 0
:if module "Dialog-Call"
    LR_stack_size = 0			# Clear subdialog stack
:endif

    LR_initialise()			# Initialise static strings
    $"initialise_the_program"()
    while ($"the_next_event" != $"terminate_event")
      {
        LR_event = $"the_next_event"
:if check
	if (LR_event < 0 || LR_event >= $events)
	  {
            print "State " LR_state " - event " LR_event " out of range"
	    exit 1
	  }
:endif
	LR_index = (LR_state * $events + LR_event) * $acwid + 1
	LR_index = int (substr (LR_action, LR_index, $acwid))
	LR_savest = LR_state

:if defaults
	#   if no action for this event, try the defaults state
	if (LR_index == 0)
	  {
	    LR_state = LR_defaults_state
	    LR_index = (LR_state * $events + LR_event) * $acwid + 1
	    LR_index = int (substr (LR_action, LR_index, $acwid))
:endif
:if check
	    if (LR_index == 0)
	      {
                print "State " LR_state " - event " LR_event " is not accepted"
		exit 1
	      }
:endif
:if defaults
	  }
:endif
:if animate
        print ""
        print LR_sname [LR_state] ":"
        print "    (--) " LR_ename [LR_event]
:endif
:if check
        $"the_next_event" = LR_NULL_EVENT
:endif
        $"the_exception_event" = LR_NULL_EVENT
        $"exception_raised" = 0

	#   Execute module list for state transition, 0 indicates end of list
	LR_vecptr = LR_offset [LR_index]
	LR_modnbr = int (substr (LR_module, LR_vecptr * $mowid + 1, $mowid))
        while (LR_modnbr > 0 && $"exception_raised" == 0)
	  {
:if animate
            print "          + " LR_mname [LR_modnbr]
:endif
:set array_base = 1
:if $modules < 16
:  do module
	    if (LR_modnbr == $number)
		$name()
:    if $number != $modules
	    else
:    endif
:  enddo
:else                                   #   Break into multiple if's
:  declare int $modfrom = 1             #     each with 1 to 15 if's
:  declare int $modto	= 15
:  do module				
:    if $number == $modfrom
:      if $modto > $modules
:	 set $modto = $modules
:      endif
:      if $modfrom == 1
	    if (LR_modnbr <= $modto)
:      else
:	 if $modto < $modules
	    if (LR_modnbr >= $modfrom || LR_modnbr <= $modto)
:	 endif
:      endif
	      {
:    endif
		if (LR_modnbr == $number)
		    $name()
:    if $number < $modto
		else
:    endif
:    if $number == $modto
	      }
:      if $modto < $modules
	    else
:      endif
:      set $modfrom = $modfrom + 15
:      set $modto   = $modto   + 15
:    endif
:  enddo
:endif
:set array_base = 0

	    LR_vecptr = LR_vecptr + 1
	    LR_modnbr = int (substr (LR_module, LR_vecptr * $mowid + 1, $mowid))
	  }
	#   Handle exception if any was raised
        if ($"exception_raised")
	  {
            if ($"the_exception_event" != LR_NULL_EVENT)
                LR_event = $"the_exception_event"
            $"the_next_event" = LR_event
:if animate
            print "    (=>) " LR_ename [LR_event]
:endif
	  }
	else
	  {
	    LR_index = (LR_state * $events + LR_event) * $nswid + 1
	    LR_state = int (substr (LR_nextst, LR_index, $nswid))
	  }
:if defaults
	if (LR_state == LR_defaults_state)
	    LR_state = LR_savest
:endif
        if ($"the_next_event" == LR_NULL_EVENT)
	  {
            $"get_external_event"()
:if check
            if ($"the_next_event" == LR_NULL_EVENT)
	      {
                print "No event set after event " LR_event \
                      " in state " LR_state
		exit 1
	      }
:endif
	  }
      }
    exit $"feedback"
}