File read.scm

Function SCM-READ

• Prototype: (SCM-READ PORT)
• Description: Reads a top-level expression (one that starts a the beginning of a line) or a documentation comment.
• Arguments:
  • PORT : The port from which to read
• Return: A two-element list, the first being the type of the data read ('expression or a doc-comment type), the second being the expression read or the documentation string.

Function READ-TO-NEXT-LINE

• Prototype: (READ-TO-NEXT-LINE PORT)
• Description: Reads all the characters up to the end of the line and put them in a string.
• Arguments:
  • PORT : The port from which the function reads
• Return: A string containing all the characters read, excluding the end-of-line character

Function READ-DOC-COMMENT

• Prototype: (READ-DOC-COMMENT PORT)
• Description: Reads a documentation comment, one that starts at the beginning of a line
• Arguments:
  • PORT : The port from which the function reads the comment
• Return: A two-element list, the first being the type of the comment and the other being the documentation string

Function PACK-DOC-STRINGS

• Prototype: (PACK-DOC-STRINGS LST)
• Description: Since documentation strings can span many lines, we must pack all the related doc strings.
• Arguments:
  • LST : A list of documentation string objects
• Return: A packed list of doc. string objects