src/share/vm/adlc/filebuff.hpp

Fri, 27 Feb 2009 13:27:09 -0800

author
twisti
date
Fri, 27 Feb 2009 13:27:09 -0800
changeset 1040
98cb887364d3
parent 1038
dbbe28fc66b5
child 1063
7bb995fbd3c0
permissions
-rw-r--r--

6810672: Comment typos
Summary: I have collected some typos I have found while looking at the code.
Reviewed-by: kvn, never

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

mercurial