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
|
/*****************************************************************************
*
* Copyright (c) 2000 - 2017, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-442911
* All rights reserved.
*
* This file is part of VisIt. For details, see https://visit.llnl.gov/. The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the disclaimer (as noted below) in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of the LLNS/LLNL nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL LAWRENCE LIVERMORE NATIONAL SECURITY,
* LLC, THE U.S. DEPARTMENT OF ENERGY OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/
#ifndef CONFIGURATION_MANAGER_H
#define CONFIGURATION_MANAGER_H
#include <state_exports.h>
#include <stdio.h>
#include <DataNode.h>
#include <string>
// ****************************************************************************
// Class: ConfigManager
//
// Purpose:
// This class contains logic to read and write config files.
//
// Notes:
//
// Programmer: Brad Whitlock
// Creation: Thu Sep 28 10:29:28 PDT 2000
//
// Modifications:
// Brad Whitlock, Thu Mar 29 17:21:51 PST 2001
// Modified the GetDefaultConfigFile method so it accepts an argument.
//
// Brad Whitlock, Tue Feb 19 12:29:17 PDT 2002
// Added a method to get the name of the system config file.
//
// Brad Whitlock, Thu Jul 3 16:14:04 PST 2003
// Rewrote the methods that read in the file.
//
// Brad Whitlock, Thu Jul 3 17:43:47 PST 2003
// I added a convenience method to get the user's home .visit dir.
//
// Brad Whitlock, Fri Oct 3 16:11:27 PST 2003
// Added internal methods to handle string vectors better.
//
// Brad Whitlock, Wed Feb 16 09:13:21 PDT 2005
// Removed GetUserVisItDirectory, GetDefaultConfigFile, GetSystemConfigFile
// methods and made them part of the utility library (Utility.h).
//
// Brad Whitlock, Thu Feb 17 15:45:19 PST 2005
// I made WriteConfigFile return a bool.
//
// Jeremy Meredith, Tue Aug 2 16:05:09 PDT 2005
// Added WriteEscapedString method.
//
// ****************************************************************************
class STATE_API ConfigManager
{
public:
ConfigManager();
virtual ~ConfigManager();
virtual bool WriteConfigFile(const char *filename) = 0;
virtual DataNode *ReadConfigFile(const char *filename) = 0;
virtual bool WriteConfigFile(std::ostream& out) = 0;
virtual DataNode *ReadConfigFile(std::istream& in) = 0;
protected:
// Functions to write out the tree.
void WriteObject(std::ostream& out, DataNode *node, int indentLevel = 0);
void WriteData(std::ostream &out, DataNode *node);
void WriteQuotedStringData(std::ostream& out, const std::string &str);
void WriteEscapedString(std::ostream& out, const std::string &str);
void WriteIndent(std::ostream &out, int indentLevel);
void WriteBack(DataNode *root);
// Functions to read in the tree.
bool ReadObject(std::istream& in, DataNode *);
bool ReadObjectHelper(std::istream &in, DataNode *, bool &);
char ReadChar(std::istream &in);
void PutBackChar(char c);
void FinishTag(std::istream& in);
bool ReadField(std::istream &in, DataNode *parentNode,
const std::string &tagName,
NodeTypeEnum tagType, int tagLength, bool noEndTag);
DataNode *ReadFieldData(std::istream& in, const std::string &tagName,
NodeTypeEnum tagType, int tagLength, bool noEndTag);
bool ReadTag(std::istream &in, std::string &tagName, NodeTypeEnum &tagType,
int &tagLength, bool &tagIsEndTag, bool &noEndTag);
stringVector ReadStringVector(std::istream &in, char termChar);
void RemoveLeadAndTailQuotes(stringVector &sv);
private:
// File attributes used in reading.
bool putback;
char putbackChar;
};
#endif
|
