annotate BEDTools-Version-2.14.3/src/utils/tabFile/tabFile.h @ 0:dfcd8b6c1bda

Uploaded
author aaronquinlan
date Thu, 03 Nov 2011 10:25:04 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
1 /*****************************************************************************
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
2 tabFile.h
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
3
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
4 (c) 2009 - Aaron Quinlan
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
5 Hall Laboratory
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
6 Department of Biochemistry and Molecular Genetics
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
7 University of Virginia
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
8 aaronquinlan@gmail.com
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
9
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
10 Licensed under the GNU General Public License 2.0 license.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
11 ******************************************************************************/
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
12 #ifndef TABFILE_H
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
13 #define TABFILE_H
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
14
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
15 #include "gzstream.h"
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
16 #include <vector>
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
17 #include <string>
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
18 #include <iostream>
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
19
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
20 using namespace std;
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
21
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
22 // enum to flag the state of a given line in a TAB file.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
23 enum TabLineStatus
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
24 {
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
25 TAB_INVALID = -1,
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
26 TAB_HEADER = 0,
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
27 TAB_BLANK = 1,
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
28 TAB_VALID = 2
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
29 };
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
30
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
31 typedef vector<string> TAB_FIELDS;
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
32
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
33 //************************************************
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
34 // TabFile Class methods and elements
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
35 //************************************************
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
36 class TabFile {
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
37
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
38 public:
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
39
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
40 // Constructor
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
41 TabFile(const string &tabFile);
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
42
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
43 // Destructor
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
44 ~TabFile(void);
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
45
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
46 // Open a TAB file for reading (creates an istream pointer)
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
47 void Open(void);
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
48
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
49 // Close an opened TAB file.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
50 void Close(void);
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
51
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
52 // Get the next TAB entry in an opened TAB file.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
53 TabLineStatus GetNextTabLine (TAB_FIELDS &tab, int &lineNum);
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
54
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
55 private:
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
56
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
57 // data
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
58 istream *_tabStream;
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
59 string _tabFile;
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
60
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
61 // methods
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
62 inline TabLineStatus parseTabLine (const vector<string> &lineVector, int &lineNum) {
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
63 // bail out if we have a blank line
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
64 if (lineVector.size() == 0)
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
65 return TAB_BLANK;
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
66 // real line with data
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
67 if (lineVector[0][0] != '#') {
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
68 return TAB_VALID;
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
69 }
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
70 // comment or header line
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
71 else {
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
72 lineNum--;
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
73 return TAB_HEADER;
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
74 }
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
75 // default
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
76 return TAB_INVALID;
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
77 }
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
78 };
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
79
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
80 #endif /* TABFILE_H */