/******************************** -*- C -*- ****************************
 *
 *	External definitions for the input module.
 *
 *
 ***********************************************************************/

/***********************************************************************
 *
 * Copyright 2001, 2002, 2003, 2006 Free Software Foundation, Inc.
 * Written by Paolo Bonzini.
 *
 * This file is part of GNU Smalltalk.
 *
 * GNU Smalltalk 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, or (at your option) any later 
 * version.
 * 
 * Linking GNU Smalltalk statically or dynamically with other modules is
 * making a combined work based on GNU Smalltalk.  Thus, the terms and
 * conditions of the GNU General Public License cover the whole
 * combination.
 *
 * In addition, as a special exception, the Free Software Foundation
 * give you permission to combine GNU Smalltalk with free software
 * programs or libraries that are released under the GNU LGPL and with
 * independent programs running under the GNU Smalltalk virtual machine.
 *
 * You may copy and distribute such a system following the terms of the
 * GNU GPL for GNU Smalltalk and the licenses of the other code
 * concerned, provided that you include the source code of that other
 * code when and as the GNU GPL requires distribution of source code.
 *
 * Note that people who make modified versions of GNU Smalltalk are not
 * obligated to grant this special exception for their modified
 * versions; it is their choice whether to do so.  The GNU General
 * Public License gives permission to release a modified version without
 * this exception; this exception also makes it possible to release a
 * modified version which carries forward this exception.
 *
 * GNU Smalltalk 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
 * GNU Smalltalk; see the file COPYING.  If not, write to the Free Software
 * Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  
 *
 ***********************************************************************/


#ifndef GST_INPUT_H
#define GST_INPUT_H

typedef enum
{
  STREAM_UNKNOWN,
  STREAM_FILE,
  STREAM_STRING,
  STREAM_OOP
#ifdef HAVE_READLINE
    , STREAM_READLINE
#endif				/* HAVE_READLINE */
}
stream_type;

/* If true, readline is suppressed.  */
extern mst_Boolean _gst_no_tty 
  ATTRIBUTE_HIDDEN;

/* Pass file descriptor FD, printed as file name FILENAME, to the
   parser.  */
extern void _gst_push_unix_file (int fd,
				 const char *fileName) 
  ATTRIBUTE_HIDDEN;

/* Return the current line and column into Y and X, respectively.  
   Also sets the method_start_pos pointer.  */
extern YYLTYPE _gst_get_location (void) 
  ATTRIBUTE_PURE
  ATTRIBUTE_HIDDEN;

/* Pass the OOP to the parser; it must respond to #nextHunk.  */
extern void _gst_push_stream_oop (OOP oop) 
  ATTRIBUTE_HIDDEN;

/* Pass the contents of the Smalltalk String STRINGOOP to the parser.
   While the String is being parsed, it can change because it is
   saved.  The String should not contain nulls.  */
extern void _gst_push_smalltalk_string (OOP stringOOP) 
  ATTRIBUTE_HIDDEN;

/* Pass the contents of the null-terminated String STRING to the
   parser.  While the String is being parsed, it can change because it
   is saved.  */
extern void _gst_push_cstring (const char *string) 
  ATTRIBUTE_HIDDEN;

/* Pass the contents of stdin (either through the readline interface
   or as a vanilla file descriptor) to the parser.  The readline
   interface is used if the Emacs interface is not active and stdin is
   a tty.  */
extern void _gst_push_stdin_string (void) 
  ATTRIBUTE_HIDDEN;

/* Restores the previous stream on the stack, optionally closing the
   topmost one if CLOSEIT is true.  */
extern void _gst_pop_stream (mst_Boolean closeIt) 
  ATTRIBUTE_HIDDEN;

/* This function resets the file type information for the current
   stream.  It is typically used by fileIn type methods when filing in
   a subsection of a real file via a temporary file what the real
   source of the text is.  */
extern void _gst_set_stream_info (int line,
				  OOP fileNameOOP,
				  int fileOffset) 
  ATTRIBUTE_HIDDEN;

/* Emits a warning, with the current file and line in front of it, on
   the standard error descriptor.  */
extern void _gst_warningf (const char *str,
			   ...)
  ATTRIBUTE_PRINTF_1 
  ATTRIBUTE_HIDDEN;

/* Emits a warning, with the current file and the given LINE in front
   of it, on the standard error descriptor.  */
extern void _gst_warningf_at (int line,
			      const char *str,
			      ...)
  ATTRIBUTE_PRINTF_2 
  ATTRIBUTE_HIDDEN;

/* Emits an error, with the current file and line in front of it, on
   the standard error descriptor.  */
extern void _gst_errorf (const char *str,
			 ...)
  ATTRIBUTE_PRINTF_1 
  ATTRIBUTE_HIDDEN;

/* Emits an error, with the current file and the given LINE in front
   of it, on the standard error descriptor.  */
extern void _gst_errorf_at (int line,
			    const char *str,
			    ...)
  ATTRIBUTE_PRINTF_2 
  ATTRIBUTE_HIDDEN;

/* Interface to the Bison-generated parser.  */
extern void _gst_yyerror (const char *s)
  ATTRIBUTE_HIDDEN;

/* Push character 'ic' back into the input queue.  Allows for two
   character pushback currently.  This solves the problem of lexing
   3. and then finding out that what we should have lexed was 3
   followed by . as a statement terminator.  */
extern void _gst_unread_char (int ic) 
  ATTRIBUTE_HIDDEN;

/* Return the next character from the topmost stream in the stack.  */
extern int _gst_next_char (void) 
  ATTRIBUTE_HIDDEN;

/* Return whether the topmost stream is an interactive one.  */
extern mst_Boolean _gst_get_cur_stream_prompt (void)
  ATTRIBUTE_PURE 
  ATTRIBUTE_HIDDEN;

/* Return the type of the topmost stream in the stack.  */
extern stream_type _gst_get_cur_stream_type (void)
  ATTRIBUTE_PURE 
  ATTRIBUTE_HIDDEN;

/* Return the name of the topmost stream in the stack if it is of type
   STREAM_FILE; nil otherwise.  */
extern OOP _gst_get_cur_file_name (void)
  ATTRIBUTE_PURE 
  ATTRIBUTE_HIDDEN;

/* Returns an OOP containing the string of the topmost stream if it is
   a STREAM_STRING, STREAM_OOP or STREAM_READLINE, or if it has a filename;
   nil otherwise.  */
extern OOP _gst_get_source_string (off_t startPos, off_t endPos)
  ATTRIBUTE_HIDDEN;

#ifdef HAVE_READLINE
/* Initialize the completion interface for Readline.  */
extern void _gst_initialize_readline (void) 
  ATTRIBUTE_HIDDEN;

/* Look at the first LEN bytes starting at STR, and add the
   colon-separated keywords, or the whole string if it starts with an
   uppercase character AND it contains no colons.  */
extern void _gst_add_symbol_completion (const char *str,
					int len) 
  ATTRIBUTE_HIDDEN;

/* Add 1 to the completion-enabling flag.  The flag starts at 1
   (completions are active) and completions are enabled until the flag
   falls below this value.  */
extern void _gst_enable_completion (void) 
  ATTRIBUTE_HIDDEN;

/* Subtract 1 from the completion-enabling flag.  The flag starts at 1
   (completions are active) and if completions are disabled, they are
   not enabled while the flag is below this value.  */
extern void _gst_disable_completion (void) 
  ATTRIBUTE_HIDDEN;

#endif /* HAVE_READLINE */


/* Parse the Smalltalk source code read from stdin, showing the
   PROMPT that is passed.  */
extern void _gst_process_stdin (const char *prompt)
  ATTRIBUTE_HIDDEN;

/* Parse the Smalltalk source code read from file FILE found within
   the search path DIR.  */
extern mst_Boolean _gst_process_file (const char *fileName,
				      enum gst_file_dir dir)
  ATTRIBUTE_HIDDEN;


#endif