Adds documentation and a sample config file for the ATARI format.

[cc65] / src / cc65 / input.h

diff --git a/src/cc65/input.h b/src/cc65/input.h
index e938d6613fac15149dac728b4ce75c769241340f..a643800ba2088aae176dae9c41fadcf641541618 100644 (file)
--- a/src/cc65/input.h
+++ b/src/cc65/input.h
@@ -1,15 +1,15 @@
 /*****************************************************************************/
 /*                                                                           */
-/*                                 input.h                                  */
+/*                                  input.h                                  */
 /*                                                                           */
-/*                           Input file handling                            */
+/*                            Input file handling                            */
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
-/* (C) 2000      Ullrich von Bassewitz                                       */
-/*               Wacholderweg 14                                             */
-/*               D-70597 Stuttgart                                           */
-/* EMail:        uz@musoftware.de                                            */
+/* (C) 2000-2010, Ullrich von Bassewitz                                      */
+/*                Roemerstrasse 52                                           */
+/*                D-70794 Filderstadt                                        */
+/* EMail:         uz@cc65.org                                                */
 /*                                                                           */
 /*                                                                           */
 /* This software is provided 'as-is', without any expressed or implied       */
@@ -38,8 +38,42 @@
 
 
 
+#include <stdio.h>
+
+/* common */
+#include "strbuf.h"
+
+
+
+/*****************************************************************************/
+/*                                   data                                    */
+/*****************************************************************************/
+
+
+
+/* An enum that describes different types of input files. The members are
+** choosen so that it is possible to combine them to bitsets
+*/
+typedef enum {
+    IT_MAIN   = 0x01,           /* Main input file */
+    IT_SYSINC = 0x02,           /* System include file (using <>) */
+    IT_USRINC = 0x04,           /* User include file (using "") */
+} InputType;
+
+/* Forward for an IFile structure */
+struct IFile;
+
+/* The current input line */
+extern StrBuf* Line;
+
+/* Current and next input character */
+extern char CurC;
+extern char NextC;
+
+
+
 /*****************************************************************************/
-/*                                  Code                                    */
+/*                                   Code                                    */
 /*****************************************************************************/
 
 
@@ -47,22 +81,40 @@
 void OpenMainFile (const char* Name);
 /* Open the main file. Will call Fatal() in case of failures. */
 
-void OpenIncludeFile (const char* Name, unsigned DirSpec);
+void OpenIncludeFile (const char* Name, InputType IT);
 /* Open an include file and insert it into the tables. */
 
+void NextChar (void);
+/* Read the next character from the input stream and make CurC and NextC
+** valid. If end of line is reached, both are set to NUL, no more lines
+** are read by this function.
+*/
+
+void ClearLine (void);
+/* Clear the current input line */
+
+StrBuf* InitLine (StrBuf* Buf);
+/* Initialize Line from Buf and read CurC and NextC from the new input line.
+** The function returns the old input line.
+*/
+
 int NextLine (void);
 /* Get a line from the current input. Returns 0 on end of file. */
 
+const char* GetInputFile (const struct IFile* IF);
+/* Return a filename from an IFile struct */
+
 const char* GetCurrentFile (void);
 /* Return the name of the current input file */
 
 unsigned GetCurrentLine (void);
 /* Return the line number in the current input file */
 
+void CreateDependencies (void);
+/* Create dependency files requested by the user */
 
 
-/* End of input.h */
-#endif
-
 
+/* End of input.h */
 
+#endif