LSSTApplications  20.0.0
LSSTDataManagementBasePackage
PolicyString.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008, 2009, 2010 LSST Corporation.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <http://www.lsstcorp.org/LegalNotices/>.
21  */
22 
27 #include <sstream>
28 // #include <iosfwd>
29 
36 
37 namespace lsst {
38 namespace pex {
39 namespace policy {
40 
41 //@cond
42 
43 using boost::regex;
44 using boost::regex_match;
45 using boost::regex_search;
47 using std::ifstream;
48 using std::string;
49 using std::unique_ptr;
50 
52 
53 const regex PolicyString::SPACE_RE("^\\s*$");
54 const regex PolicyString::COMMENT("^\\s*#");
55 const regex PolicyString::CONTENTID("^\\s*#\\s*<\\?cfg\\s+\\w+(\\s+\\w+)*\\s*\\?>", regex::icase);
56 
57 /*
58  * create a "null" Policy formed from an empty string.
59  * @param fmts a SupportedFormats object to use. An instance
60  * encapsulates a configured set of known formats.
61  */
63  : PolicySource(fmts), Persistable(), _data(), _pfact() {}
64 
65 /*
66  * create a "null" Policy formed from an empty string.
67  * @param fmts a SupportedFormats object to use. An instance
68  * encapsulates a configured set of known formats.
69  */
71  : PolicySource(fmts), Persistable(), _data(data), _pfact() {}
72 
73 #define PolStr_ERROR_MSG(use, msg, input) \
74  std::ostringstream use; \
75  use << msg << ": '"; \
76  if (input.length() > 40) \
77  use << input; \
78  else \
79  use << input.substr(0, 40) << "..."; \
80  use << "'";
81 
82 /*
83  * return the name of the format that the data is stored in. This may
84  * cause the first few records of the source to be read.
85  * @exception IOError if an error occurs while reading the first few
86  * characters of the source stream.
87  */
88 const string& PolicyString::getFormatName() {
89  // try reading the initial characters
91  if (is.fail()) {
92  PolStr_ERROR_MSG(msg, "failure opening input Policy string", _data);
93  throw LSST_EXCEPT(pexExcept::IoError, msg.str());
94  }
95 
96  // skip over comments
97  string line;
98  getline(is, line);
99  while (is.good() &&
101  }
102 
103  if (is.fail()) {
104  PolStr_ERROR_MSG(msg, "failure reading input Policy string", _data);
105  throw LSST_EXCEPT(pexExcept::IoError, msg.str());
106  }
107  if (is.eof() &&
109  // empty file; let's just assume PAF (but don't cache the name).
111  }
112  return cacheName(_formats->recognizeType(line));
113 }
114 
115 /*
116  * load the data from this Policy source into a Policy object
117  * @param policy the policy object to load the data into
118  * @exception ParserError if an error occurs while parsing the data
119  * @exception IOError if an I/O error occurs while reading from the
120  * source stream.
121  */
122 void PolicyString::load(Policy& policy) {
123  PolicyParserFactory::Ptr pfactory = _pfact;
124  if (!pfactory.get()) {
125  const string& fmtname = getFormatName();
126  if (fmtname.empty()) {
127  PolStr_ERROR_MSG(ms, "Unknown Policy format for string data", _data);
128  throw LSST_EXCEPT(pexExcept::IoError, ms.str());
129  }
130  pfactory = _formats->getFactory(fmtname);
131  }
132 
133  std::unique_ptr<PolicyParser> parser(pfactory->createParser(policy));
134 
136  if (is.fail()) {
137  PolStr_ERROR_MSG(msg, "failure opening Policy string", _data);
138  throw LSST_EXCEPT(pexExcept::IoError, msg.str());
139  }
140  parser->parse(is);
141 }
142 
143 //@endcond
144 
145 } // namespace policy
146 } // namespace pex
147 } // namespace lsst
lsst::pex::policy::SupportedFormats::Ptr
std::shared_ptr< SupportedFormats > Ptr
Definition: SupportedFormats.h:54
std::string
STL class.
lsst::pex::policy::PolicyParserFactory::Ptr
std::shared_ptr< PolicyParserFactory > Ptr
Definition: PolicyParserFactory.h:59
PolicyParser.h
definition of the PolicyParser class
lsst.synpipe.compareModel.parser
parser
Definition: compareModel.py:108
std::istringstream
STL class.
lsst::pex::policy::PolicyString::SPACE_RE
static const boost::regex SPACE_RE
Definition: PolicyString.h:101
std::regex_match
T regex_match(T... args)
lsst::pex::policy::PolicySource::_formats
SupportedFormats::Ptr _formats
Definition: PolicySource.h:135
PolicyString.h
definition of the PolicyString class
pex
Definition: __init__.py:1
parserexceptions.h
definition of Policy parsing exceptions
PAFParserFactory.h
definition of the PAFParserFactory class
data
char * data
Definition: BaseRecord.cc:62
lsst::pex::policy::PolicyString::COMMENT
static const boost::regex COMMENT
reg-exp for an empty line
Definition: PolicyString.h:102
lsst::afw.display.ds9.line
def line(points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5)
Definition: ds9.py:105
PolicyFile.h
definition of the PolicyFile class
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
std::regex_search
T regex_search(T... args)
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst::pex::exceptions::IoError
Reports errors in external input/output operations.
Definition: Runtime.h:160
exceptions.h
definition of Policy-specific exceptions classes
std::getline
T getline(T... args)
lsst::pex::policy::PolicyString::PolicyString
PolicyString(const std::string &data, const SupportedFormats::Ptr &fmts=defaultFormats)
create a PolicyString that's wrapped around a given string.
lsst::pex::policy::paf::PAFParserFactory
a class for creating PAFParser objects
Definition: PAFParserFactory.h:53
lsst::pex::exceptions
Definition: Exception.h:37
lsst::pex::policy::PolicyString::_data
std::string _data
the policy data
Definition: PolicyString.h:112
lsst::pex::policy::PolicyString::load
virtual void load(Policy &policy)
load the data from this Policy source into a Policy object
std::unique_ptr
STL class.
lsst::pex::policy::PolicyString::CONTENTID
static const boost::regex CONTENTID
reg-exp for the start of a comment
Definition: PolicyString.h:106
lsst::pex::policy::paf::PAFParserFactory::FORMAT_NAME
static const std::string FORMAT_NAME
a name for the format
Definition: PAFParserFactory.h:96
lsst::pex::policy::PolicyString::getFormatName
virtual const std::string & getFormatName()
return the name of the format that the data is stored in.
std::ifstream
STL class.