/usr/include/rcsb/CifParserBase.h is in librcsb-core-wrapper0-dev 1.005-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | //$$FILE$$
//$$VERSION$$
//$$DATE$$
//$$LICENSE$$
/*!
** \file CifParserBase.h
**
** \brief Header file for CifParser class.
*/
#ifndef CIF_PARSER_BASE_H
#define CIF_PARSER_BASE_H
#include <iostream>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <rcsb/ISTable.h>
#include <rcsb/CifFile.h>
#include <rcsb/CifScannerBase.h>
#include <rcsb/CifParserInt.h>
#include <rcsb/CifFileReadDef.h>
#define DATA_TAG "data_"
/**
** \class CifParser
**
** \brief Public class that respresents a CIF parser.
**
** This class represents a CIF parser. This class utilizes flex/bison for
** syntax/semantic processing and stores the parsed data (data blocks and
** tables) in a \e CifFile object.
*/
class CifParser : public CifScanner
{
public:
/**
** Constructs a CIF parser.
**
** \param[in] cifFileP - pointer to the \e CifFile object that the
** CIF parser is to use to store the parsed data
** \param[in] verbose - optional parameter that indicates whether
** parsing logging should be turned on (if true) or off (if false).
** If \e verbose is not specified, logging is turned off.
**
** \return Not applicable
**
** \pre \e cifFileP must not be NULL
**
** \post None
**
** \exception EmptyValueException - if \e cifFileP is NULL
*/
CifParser(CifFile* cifFileP, bool verbose = false);
/**
** Method, not currently part of users public API, and will soon be
** re-examined.
*/
CifParser(CifFile* cifFileP, CifFileReadDef readDef,
bool verbose = false);
/**
** Parses the CIF file.
**
** \param[in] fileName - relative or absolute name of the CIF file
** that is to be parsed.
** \param[in] parseLogFileName - relative or absolute name of the file
** where parsing log is to be stored. Defaults to
** "<input-file>-parser.log" if left empty.
** Use "/dev/null" to disable logging.
** \param[out] diagnostics - parsing result. If empty, parsing
** completed with no warnings or errors. If non-empty, there were
** parsing warnings and/or parsing errors.
**
** \return None
**
** \pre None
**
** \post None
**
** \exception: None
*/
void Parse(const string& fileName, string& diagnostics,
const std::string& parseLogFileName = std::string());
/**
** Parses the CIF data in a string.
**
** \param[in] cifString - a string that contains CIF data that is to
** be parsed.
** \param[out] diagnostics - parsing result. If empty, parsing
** completed with no warnings or errors. If non-empty, there were
** parsing warnings and/or parsing errors.
**
** \return None
**
** \pre None
**
** \post None
**
** \exception: None
*/
void ParseString(const string& cifString, string& diagnostics);
/**
** Destructs a CIF parser by releasing all the used resources.
**
** \param: Not applicable
**
** \return Not applicable
**
** \pre None
**
** \post None
**
** \exception: None
*/
virtual ~CifParser();
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
void Error(const char*);
/**
** Method, not currently part of users public API, and will soon be
** re-examined.
*/
void Clear();
/**
** Method, not currently part of users public API, and will soon be
** re-examined.
*/
void Reset();
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
int ProcessLoopDeclaration(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
int ProcessItemNameList(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
int ProcessValueList(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
int ProcessItemValuePair(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
void ProcessAssignments(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
void ProcessLoop(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
void ProcessItemName(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
void ProcessItemValue(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
void ProcessLsItemValue(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
void ProcessUnknownValue(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
void ProcessMissingValue(void);
/**
** Utility method, not part of users public API, and will soon be
** removed.
*/
void ProcessDataBlockName(void);
private:
CifFile *_fobj;
CifFileReadDef _readDef;
ISTable *_tbl;
int _afterLoop;
int _nTablesInBlock;
int _curItemNo, _curValueNo, _numDataBlocks, _fieldListAlloc, _curRow;
vector<string> _fieldList;
string _pBufValue;
string _tBufKeyword;
string _curCategoryName;
string _curDataBlockName;
string _prevDataBlockName;
void _ComplexWriteTable();
int _err, _warn;
};
#endif /* CIF_PARSER_BASE_H */
|