annotate src/share/vm/adlc/filebuff.hpp @ 605:98cb887364d3

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