english
version "1.0"
identify "wxyz"

# Copyright (c) 1998-1999 by Wayne C. Gramlich.
# All rights reserved.
#
# Permission to use, copy, modify, distribute, and sell this software
# for any purpose is hereby granted without fee provided that the above
# copyright notice and this permission are retained.  The author makes
# no representations about the suitability of this software for any purpose.
# It is provided "as is" without express or implied warranty.

module swit_restore

#: This module implements SWIT restore.


#: {restore} procedures:

procedure color_read@restore
    takes
	restore restore
    returns color

    #: This procedure will read a color from {restore}.


procedure create@restore
    takes
	in_stream in_stream
	error_stream out_stream
    returns restore

    #: This procedure will create and return a new {restore} object
    #, that contains {application}, {in_stream} and {error_stream}.


procedure error@restore
    takes
	restore restore
	message string
    returns_nothing

    #: This procedure will output {message} to {restore} as an error message.


procedure has_errors_get@restore
    takes
	restore restore
    returns logical

    #: This procedure will return the {true} if any errors have occured
    #, with {restore}.


procedure line_end@restore
    takes
	restore restore
    returns_nothing

    #: This procedure will verify that the current line buffer in {restore}
    #, has been entirely processed.


procedure line_read@restore
    takes
	restore restore
	line_tag string
    returns_nothing
	
    #: This procedure will read in a line from {restore} and verify
    #, that the tag character is {line_tag}.
	

procedure sticky_read@restore
    takes
	restore restore
    returns sticky

    #: This procedure will read a {sticky} value from {restore}.


procedure unsigned_read@restore
    takes
	restore restore
    returns unsigned

    #: This procedure will return the the next number from {restore}.


procedure string_read@restore
    takes
	restore restore
    returns string

    #: This procedure will return the next symbol from {restore}.
    #, The returned string is in a temporary buffer that gets reused


procedure symbol_read@restore
    takes
	restore restore
    returns string

    #: This procedure will return the next symbol from {restore}.
    #, The returned string is in a temporary buffer that gets reused