src/share/vm/adlc/filebuff.cpp

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 1907
c18cbe5936b8
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.CPP - Routines for handling a parser file buffer
duke@435 26 #include "adlc.hpp"
duke@435 27
twisti@1038 28 using namespace std;
twisti@1038 29
duke@435 30 //------------------------------FileBuff---------------------------------------
duke@435 31 // Create a new parsing buffer
duke@435 32 FileBuff::FileBuff( BufferedFile *fptr, ArchDesc& archDesc) : _fp(fptr), _AD(archDesc) {
duke@435 33 _err = fseek(_fp->_fp, 0, SEEK_END); // Seek to end of file
duke@435 34 if (_err) {
duke@435 35 file_error(SEMERR, 0, "File seek error reading input file");
duke@435 36 exit(1); // Exit on seek error
duke@435 37 }
duke@435 38 _filepos = ftell(_fp->_fp); // Find offset of end of file
duke@435 39 _bufferSize = _filepos + 5; // Filepos points to last char, so add padding
duke@435 40 _err = fseek(_fp->_fp, 0, SEEK_SET); // Reset to beginning of file
duke@435 41 if (_err) {
duke@435 42 file_error(SEMERR, 0, "File seek error reading input file\n");
duke@435 43 exit(1); // Exit on seek error
duke@435 44 }
duke@435 45 _filepos = ftell(_fp->_fp); // Reset current file position
never@850 46 _linenum = 0;
duke@435 47
duke@435 48 _bigbuf = new char[_bufferSize]; // Create buffer to hold text for parser
duke@435 49 if( !_bigbuf ) {
duke@435 50 file_error(SEMERR, 0, "Buffer allocation failed\n");
duke@435 51 exit(1); // Exit on allocation failure
duke@435 52 }
twisti@1040 53 *_bigbuf = '\n'; // Lead with a sentinel newline
twisti@1040 54 _buf = _bigbuf+1; // Skip sentinel
duke@435 55 _bufmax = _buf; // Buffer is empty
twisti@1040 56 _bufeol = _bigbuf; // _bufeol points at sentinel
duke@435 57 _filepos = -1; // filepos is in sync with _bufeol
duke@435 58 _bufoff = _offset = 0L; // Offset at file start
duke@435 59
duke@435 60 _bufmax += fread(_buf, 1, _bufferSize-2, _fp->_fp); // Fill buffer & set end value
duke@435 61 if (_bufmax == _buf) {
duke@435 62 file_error(SEMERR, 0, "File read error, no input read\n");
duke@435 63 exit(1); // Exit on read error
duke@435 64 }
twisti@1040 65 *_bufmax = '\n'; // End with a sentinel new-line
twisti@1040 66 *(_bufmax+1) = '\0'; // Then end with a sentinel NULL
duke@435 67 }
duke@435 68
duke@435 69 //------------------------------~FileBuff--------------------------------------
duke@435 70 // Nuke the FileBuff
duke@435 71 FileBuff::~FileBuff() {
duke@435 72 delete _bigbuf;
duke@435 73 }
duke@435 74
duke@435 75 //------------------------------get_line----------------------------------------
duke@435 76 char *FileBuff::get_line(void) {
duke@435 77 char *retval;
duke@435 78
duke@435 79 // Check for end of file & return NULL
duke@435 80 if (_bufeol >= _bufmax) return NULL;
duke@435 81
never@850 82 _linenum++;
duke@435 83 retval = ++_bufeol; // return character following end of previous line
twisti@1040 84 if (*retval == '\0') return NULL; // Check for EOF sentinel
duke@435 85 // Search for newline character which must end each line
duke@435 86 for(_filepos++; *_bufeol != '\n'; _bufeol++)
duke@435 87 _filepos++; // keep filepos in sync with _bufeol
duke@435 88 // _bufeol & filepos point at end of current line, so return pointer to start
duke@435 89 return retval;
duke@435 90 }
duke@435 91
duke@435 92 //------------------------------FileBuffRegion---------------------------------
duke@435 93 // Create a new region in a FileBuff.
duke@435 94 FileBuffRegion::FileBuffRegion( FileBuff* bufr, int soln, int ln,
duke@435 95 int off, int len)
duke@435 96 : _bfr(bufr), _sol(soln), _line(ln), _offset(off), _length(len) {
duke@435 97 _next = NULL; // No chained regions
duke@435 98 }
duke@435 99
duke@435 100 //------------------------------~FileBuffRegion--------------------------------
duke@435 101 // Delete the entire linked list of buffer regions.
duke@435 102 FileBuffRegion::~FileBuffRegion() {
duke@435 103 if( _next ) delete _next;
duke@435 104 }
duke@435 105
duke@435 106 //------------------------------copy-------------------------------------------
duke@435 107 // Deep copy a FileBuffRegion
duke@435 108 FileBuffRegion *FileBuffRegion::copy() {
duke@435 109 if( !this ) return NULL; // The empty buffer region
duke@435 110 FileBuffRegion *br = new FileBuffRegion(_bfr,_sol,_line,_offset,_length);
duke@435 111 if( _next ) br->_next = _next->copy();
duke@435 112 return br;
duke@435 113 }
duke@435 114
duke@435 115 //------------------------------merge------------------------------------------
duke@435 116 // Merge another buffer region into this buffer region. Make overlapping areas
duke@435 117 // become a single region. Remove (delete) the input FileBuffRegion.
duke@435 118 // Since the buffer regions are sorted by file offset, this is a varient of a
duke@435 119 // "sorted-merge" running in linear time.
duke@435 120 FileBuffRegion *FileBuffRegion::merge( FileBuffRegion *br ) {
duke@435 121 if( !br ) return this; // Merging nothing
duke@435 122 if( !this ) return br; // Merging into nothing
duke@435 123
duke@435 124 assert( _bfr == br->_bfr, "" ); // Check for pointer-equivalent buffers
duke@435 125
duke@435 126 if( _offset < br->_offset ) { // "this" starts before "br"
duke@435 127 if( _offset+_length < br->_offset ) { // "this" ends before "br"
duke@435 128 if( _next ) _next->merge( br ); // Merge with remainder of list
duke@435 129 else _next = br; // No more in this list; just append.
duke@435 130 } else { // Regions overlap.
duke@435 131 int l = br->_offset + br->_length - _offset;
duke@435 132 if( l > _length ) _length = l; // Pick larger region
duke@435 133 FileBuffRegion *nr = br->_next; // Get rest of region
duke@435 134 br->_next = NULL; // Remove indication of rest of region
duke@435 135 delete br; // Delete this region (it's been subsumed).
duke@435 136 if( nr ) merge( nr ); // Merge with rest of region
duke@435 137 } // End of if regions overlap or not.
duke@435 138 } else { // "this" starts after "br"
duke@435 139 if( br->_offset+br->_length < _offset ) { // "br" ends before "this"
duke@435 140 FileBuffRegion *nr = new FileBuffRegion(_bfr,_sol,_line,_offset,_length);
duke@435 141 nr->_next = _next; // Structure copy "this" guy to "nr"
duke@435 142 *this = *br; // Structure copy "br" over "this".
duke@435 143 br->_next = NULL; // Remove indication of rest of region
duke@435 144 delete br; // Delete this region (it's been copied)
duke@435 145 merge( nr ); // Finish merging
duke@435 146 } else { // Regions overlap.
duke@435 147 int l = _offset + _length - br->_offset;
duke@435 148 if( l > _length ) _length = l; // Pick larger region
duke@435 149 _offset = br->_offset; // Start with earlier region
duke@435 150 _sol = br->_sol; // Also use earlier line start
duke@435 151 _line = br->_line; // Also use earlier line
duke@435 152 FileBuffRegion *nr = br->_next; // Get rest of region
duke@435 153 br->_next = NULL; // Remove indication of rest of region
duke@435 154 delete br; // Delete this region (it's been subsumed).
duke@435 155 if( nr ) merge( nr ); // Merge with rest of region
duke@435 156 } // End of if regions overlap or not.
duke@435 157 }
duke@435 158 return this;
duke@435 159 }
duke@435 160
duke@435 161 //------------------------------expandtab--------------------------------------
duke@435 162 static int expandtab( ostream &os, int off, char c, char fill1, char fill2 ) {
duke@435 163 if( c == '\t' ) { // Tab?
duke@435 164 do os << fill1; // Expand the tab; Output space
duke@435 165 while( (++off) & 7 ); // Expand to tab stop
duke@435 166 } else { // Normal character
duke@435 167 os << fill2; // Display normal character
duke@435 168 off++; // Increment "cursor" offset
duke@435 169 }
duke@435 170 return off;
duke@435 171 }
duke@435 172
duke@435 173 //------------------------------printline--------------------------------------
duke@435 174 // Print and highlite a region of a line. Return the amount of highliting left
duke@435 175 // to do (i.e. highlite length minus length of line).
duke@435 176 static int printline( ostream& os, const char *fname, int line,
duke@435 177 const char *_sol, int skip, int len ) {
duke@435 178
duke@435 179 // Display the entire tab-expanded line
duke@435 180 os << fname << ":" << line << ": ";
duke@435 181 const char *t = strchr(_sol,'\n')+1; // End of line
duke@435 182 int off = 0; // Cursor offset for tab expansion
duke@435 183 const char *s = _sol; // Nice string pointer
duke@435 184 while( t-s ) { // Display whole line
duke@435 185 char c = *s++; // Get next character to display
duke@435 186 off = expandtab(os,off,c,' ',c);
duke@435 187 }
duke@435 188
duke@435 189 // Display the tab-expanded skippings before underlining.
duke@435 190 os << fname << ":" << line << ": ";
duke@435 191 off = 0; // Cursor offset for tab expansion
duke@435 192 s = _sol; // Restart string pointer
duke@435 193
duke@435 194 // Start underlining.
duke@435 195 if( skip != -1 ) { // The no-start-indicating flag
duke@435 196 const char *u = _sol+skip; // Amount to skip
duke@435 197 while( u-s ) // Display skipped part
duke@435 198 off = expandtab(os,off,*s++,' ',' ');
duke@435 199 os << '^'; // Start region
duke@435 200 off++; // Moved cursor
duke@435 201 len--; // 1 less char to do
duke@435 202 if( *s++ == '\t' ) // Starting character is a tab?
duke@435 203 off = expandtab(os,off,'\t','-','^');
duke@435 204 }
duke@435 205
duke@435 206 // Long region doesn't end on this line
duke@435 207 int llen = (int)(t-s); // Length of line, minus what's already done
duke@435 208 if( len > llen ) { // Doing entire rest of line?
duke@435 209 while( t-s ) // Display rest of line
duke@435 210 off = expandtab(os,off,*s++,'-','-');
duke@435 211 os << '\n'; // EOL
duke@435 212 return len-llen; // Return what's not yet done.
duke@435 213 }
duke@435 214
duke@435 215 // Region does end on this line. This code fails subtly if the region ends
duke@435 216 // in a tab character.
duke@435 217 int i;
duke@435 218 for( i=1; i<len; i++ ) // Underline just what's needed
duke@435 219 off = expandtab(os,off,*s++,'-','-');
duke@435 220 if( i == len ) os << '^'; // Mark end of region
duke@435 221 os << '\n'; // End of marked line
twisti@1038 222 return 0; // All done
duke@435 223 }
duke@435 224
duke@435 225 //------------------------------print------------------------------------------
duke@435 226 //std::ostream& operator<< ( std::ostream& os, FileBuffRegion &br ) {
duke@435 227 ostream& operator<< ( ostream& os, FileBuffRegion &br ) {
duke@435 228 if( &br == NULL ) return os; // The empty buffer region
duke@435 229 FileBuffRegion *brp = &br; // Pointer to region
duke@435 230 while( brp ) { // While have chained regions
duke@435 231 brp->print(os); // Print region
duke@435 232 brp = brp->_next; // Chain to next
duke@435 233 }
duke@435 234 return os; // Return final stream
duke@435 235 }
duke@435 236
duke@435 237 //------------------------------print------------------------------------------
duke@435 238 // Print the FileBuffRegion to a stream. FileBuffRegions are printed with the
duke@435 239 // filename and line number to the left, and complete text lines to the right.
duke@435 240 // Selected portions (portions of a line actually in the FileBuffRegion are
duke@435 241 // underlined. Ellipses are used for long multi-line regions.
duke@435 242 //void FileBuffRegion::print( std::ostream& os ) {
duke@435 243 void FileBuffRegion::print( ostream& os ) {
duke@435 244 if( !this ) return; // Nothing to print
duke@435 245 char *s = _bfr->get_line();
duke@435 246 int skip = (int)(_offset - _sol); // Amount to skip to start of data
duke@435 247 int len = printline( os, _bfr->_fp->_name, _line, s, skip, _length );
duke@435 248
duke@435 249 if( !len ) return; // All done; exit
duke@435 250
duke@435 251 // Here we require at least 2 lines
duke@435 252 int off1 = _length - len + skip; // Length of line 1
duke@435 253 int off2 = off1 + _sol; // Offset to start of line 2
duke@435 254 char *s2 = _bfr->get_line(); // Start of line 2
duke@435 255 char *s3 = strchr( s2, '\n' )+1; // Start of line 3 (unread)
duke@435 256 if( len <= (s3-s2) ) { // It all fits on the next line
duke@435 257 printline( os, _bfr->_fp->_name, _line+1, s2, -1, len ); // Print&underline
duke@435 258 return;
duke@435 259 }
duke@435 260
duke@435 261 // Here we require at least 3 lines
duke@435 262 int off3 = off2 + (int)(s3-s2); // Offset to start of line 3
duke@435 263 s3 = _bfr->get_line(); // Start of line 3 (read)
duke@435 264 const char *s4 = strchr( s3, '\n' )+1;// Start of line 4 (unread)
duke@435 265 if( len < (s4-s3) ) { // It all fits on the next 2 lines
duke@435 266 s2 = _bfr->get_line();
duke@435 267 len = printline( os, _bfr->_fp->_name, _line+1, s2, -1, len ); // Line 2
duke@435 268 s3 = _bfr->get_line();
duke@435 269 printline( os, _bfr->_fp->_name, _line+2, s3, -1, len ); // Line 3
duke@435 270 return;
duke@435 271 }
duke@435 272
duke@435 273 // Here we require at least 4 lines.
duke@435 274 // Print only the 1st and last line, with ellipses in middle.
duke@435 275 os << "...\n"; // The ellipses
duke@435 276 int cline = _line+1; // Skipped 2 lines
duke@435 277 do { // Do until find last line
duke@435 278 len -= (int)(s3-s2); // Remove length of line
duke@435 279 cline++; // Next line
duke@435 280 s2 = _bfr->get_line(); // Get next line from end of this line
duke@435 281 s3 = strchr( s2, '\n' ) + 1;// Get end of next line
duke@435 282 } while( len > (s3-s2) ); // Repeat until last line
duke@435 283 printline( os, _bfr->_fp->_name, cline, s2, -1, len ); // Print & underline
duke@435 284 }
duke@435 285
duke@435 286 //------------------------------file_error-------------------------------------
duke@435 287 void FileBuff::file_error(int flag, int linenum, const char *fmt, ...)
duke@435 288 {
duke@435 289 va_list args;
duke@435 290
duke@435 291 va_start(args, fmt);
duke@435 292 switch (flag) {
duke@435 293 case 0: _AD._warnings += _AD.emit_msg(0, flag, linenum, fmt, args);
duke@435 294 case 1: _AD._syntax_errs += _AD.emit_msg(0, flag, linenum, fmt, args);
duke@435 295 case 2: _AD._semantic_errs += _AD.emit_msg(0, flag, linenum, fmt, args);
duke@435 296 default: assert(0, ""); break;
duke@435 297 }
duke@435 298 va_end(args);
duke@435 299 _AD._no_output = 1;
duke@435 300 }

mercurial