1 #ifdef USE_PRAGMA_IDENT_HDR
   2 #pragma ident "@(#)filebuff.hpp 1.27 07/05/05 17:05:01 JVM"
   3 #endif
   4 /*
   5  * Copyright 1997-2004 Sun Microsystems, Inc.  All Rights Reserved.
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This code is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License version 2 only, as
  10  * published by the Free Software Foundation.
  11  *
  12  * This code is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15  * version 2 for more details (a copy is included in the LICENSE file that
  16  * accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License version
  19  * 2 along with this work; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *  
  26  */
  27 
  28 // FILEBUFF.HPP - Definitions for parser file buffering routines
  29 #include <iostream>
  30 
  31 using namespace std;
  32 // STRUCTURE FOR HANDLING INPUT AND OUTPUT FILES
  33 typedef struct {
  34   const char *_name;
  35   FILE *_fp;
  36 } BufferedFile;
  37 
  38 class ArchDesc;
  39 
  40 //------------------------------FileBuff--------------------------------------
  41 // This class defines a nicely behaved buffer of text.  Entire file of text
  42 // is read into buffer at creation, with sentinals at start and end.
  43 class FileBuff {
  44   friend class FileBuffRegion;
  45  private:
  46   long  _bufferSize;            // Size of text holding buffer.
  47   long  _offset;                // Expected filepointer offset.
  48   long  _bufoff;                // Start of buffer file offset
  49 
  50   char *_buf;                   // The buffer itself.
  51   char *_bigbuf;                // The buffer plus sentinals; actual heap area
  52   char *_bufmax;                // A pointer to the buffer end sentinal
  53   char *_bufeol;                // A pointer to the last complete line end
  54 
  55   int   _err;                   // Error flag for file seek/read operations
  56   long  _filepos;               // Current offset from start of file
  57 
  58   ArchDesc& _AD;                // Reference to Architecture Description
  59 
  60   // Error reporting function
  61   void file_error(int flag, int linenum, const char *fmt, ...);
  62 
  63  public:
  64   const BufferedFile *_fp;           // File to be buffered
  65 
  66   FileBuff(BufferedFile *fp, ArchDesc& archDesc); // Constructor
  67   ~FileBuff();                  // Destructor
  68 
  69   // This returns a pointer to the start of the current line in the buffer,
  70   // and increments bufeol and filepos to point at the end of that line.
  71   char *get_line(void);
  72 
  73   // This converts a pointer into the buffer to a file offset.  It only works
  74   // when the pointer is valid (i.e. just obtained from getline()).
  75   int getoff(const char *s) { return _bufoff+(int)(s-_buf); }
  76 };
  77 
  78 //------------------------------FileBuffRegion---------------------------------
  79 // A buffer region is really a region of some file, specified as a linked list
  80 // of offsets and lengths.  These regions can be merged; overlapping regions
  81 // will coalesce.
  82 class FileBuffRegion {
  83  public:                        // Workaround dev-studio friend/private bug
  84   FileBuffRegion *_next;        // Linked list of regions sorted by offset.
  85  private:
  86   FileBuff       *_bfr;         // The Buffer of the file
  87   int _offset, _length;         // The file area
  88   int             _sol;         // Start of line where the file area starts
  89   int             _line;        // First line of region
  90 
  91  public:
  92   FileBuffRegion(FileBuff*, int sol, int line, int offset, int len);
  93   ~FileBuffRegion();
  94 
  95   FileBuffRegion *copy();                   // Deep copy
  96   FileBuffRegion *merge(FileBuffRegion*); // Merge 2 regions; delete input
  97 
  98 //  void print(std::ostream&);
  99 //  friend std::ostream& operator<< (std::ostream&, FileBuffRegion&);
 100   void print(ostream&);
 101   friend ostream& operator<< (ostream&, FileBuffRegion&);
 102 };