duke@435: /*
twisti@1038:  * Copyright 1997-2009 Sun Microsystems, Inc.  All Rights Reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
duke@435:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435:  * have any questions.
duke@435:  *
duke@435:  */
duke@435: 
duke@435: // FILEBUFF.HPP - Definitions for parser file buffering routines
xlu@664: #include <iostream>
duke@435: 
xlu@664: using namespace std;
twisti@1038: 
duke@435: // STRUCTURE FOR HANDLING INPUT AND OUTPUT FILES
duke@435: typedef struct {
duke@435:   const char *_name;
duke@435:   FILE *_fp;
duke@435: } BufferedFile;
duke@435: 
duke@435: class ArchDesc;
duke@435: 
duke@435: //------------------------------FileBuff--------------------------------------
duke@435: // This class defines a nicely behaved buffer of text.  Entire file of text
twisti@1040: // is read into buffer at creation, with sentinels at start and end.
duke@435: class FileBuff {
duke@435:   friend class FileBuffRegion;
duke@435:  private:
duke@435:   long  _bufferSize;            // Size of text holding buffer.
duke@435:   long  _offset;                // Expected filepointer offset.
duke@435:   long  _bufoff;                // Start of buffer file offset
duke@435: 
duke@435:   char *_buf;                   // The buffer itself.
twisti@1040:   char *_bigbuf;                // The buffer plus sentinels; actual heap area
twisti@1040:   char *_bufmax;                // A pointer to the buffer end sentinel
duke@435:   char *_bufeol;                // A pointer to the last complete line end
duke@435: 
duke@435:   int   _err;                   // Error flag for file seek/read operations
duke@435:   long  _filepos;               // Current offset from start of file
never@850:   int   _linenum;
duke@435: 
duke@435:   ArchDesc& _AD;                // Reference to Architecture Description
duke@435: 
duke@435:   // Error reporting function
duke@435:   void file_error(int flag, int linenum, const char *fmt, ...);
duke@435: 
duke@435:  public:
duke@435:   const BufferedFile *_fp;           // File to be buffered
duke@435: 
duke@435:   FileBuff(BufferedFile *fp, ArchDesc& archDesc); // Constructor
duke@435:   ~FileBuff();                  // Destructor
duke@435: 
duke@435:   // This returns a pointer to the start of the current line in the buffer,
duke@435:   // and increments bufeol and filepos to point at the end of that line.
duke@435:   char *get_line(void);
never@850:   int linenum() const { return _linenum; }
jrose@910:   void set_linenum(int line) { _linenum = line; }
duke@435: 
duke@435:   // This converts a pointer into the buffer to a file offset.  It only works
duke@435:   // when the pointer is valid (i.e. just obtained from getline()).
twisti@1038:   long getoff(const char* s) { return _bufoff + (s - _buf); }
duke@435: };
duke@435: 
duke@435: //------------------------------FileBuffRegion---------------------------------
duke@435: // A buffer region is really a region of some file, specified as a linked list
duke@435: // of offsets and lengths.  These regions can be merged; overlapping regions
duke@435: // will coalesce.
duke@435: class FileBuffRegion {
duke@435:  public:                        // Workaround dev-studio friend/private bug
duke@435:   FileBuffRegion *_next;        // Linked list of regions sorted by offset.
duke@435:  private:
duke@435:   FileBuff       *_bfr;         // The Buffer of the file
duke@435:   int _offset, _length;         // The file area
duke@435:   int             _sol;         // Start of line where the file area starts
duke@435:   int             _line;        // First line of region
duke@435: 
duke@435:  public:
duke@435:   FileBuffRegion(FileBuff*, int sol, int line, int offset, int len);
duke@435:   ~FileBuffRegion();
duke@435: 
duke@435:   FileBuffRegion *copy();                   // Deep copy
duke@435:   FileBuffRegion *merge(FileBuffRegion*); // Merge 2 regions; delete input
duke@435: 
duke@435:   void print(ostream&);
duke@435:   friend ostream& operator<< (ostream&, FileBuffRegion&);
duke@435: };