LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
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 std::string;
44 using std::ifstream;
45 using boost::regex;
46 using boost::regex_match;
47 using boost::regex_search;
48 using std::unique_ptr;
50 
52 
53 const regex PolicyString::SPACE_RE("^\\s*$");
54 const regex PolicyString::COMMENT("^\\s*#");
55 const regex
56  PolicyString::CONTENTID("^\\s*#\\s*<\\?cfg\\s+\\w+(\\s+\\w+)*\\s*\\?>",
57  regex::icase);
58 
59 /*
60  * create a "null" Policy formed from an empty string.
61  * @param fmts a SupportedFormats object to use. An instance
62  * encapsulates a configured set of known formats.
63  */
65  : PolicySource(fmts), Persistable(), _data(), _pfact()
66 { }
67 
68 /*
69  * create a "null" Policy formed from an empty string.
70  * @param fmts a SupportedFormats object to use. An instance
71  * encapsulates a configured set of known formats.
72  */
74  const SupportedFormats::Ptr& fmts)
75  : PolicySource(fmts), Persistable(), _data(data), _pfact()
76 { }
77 
78 #define PolStr_ERROR_MSG(use, msg, input) \
79  std::ostringstream use; \
80  use << msg << ": '"; \
81  if (input.length() > 40) \
82  use << input; \
83  else \
84  use << input.substr(0,40) << "..."; \
85  use << "'";
86 
87 /*
88  * return the name of the format that the data is stored in. This may
89  * cause the first few records of the source to be read.
90  * @exception IOError if an error occurs while reading the first few
91  * characters of the source stream.
92  */
93 const string& PolicyString::getFormatName() {
94 
95  // try reading the initial characters
97  if (is.fail()) {
98  PolStr_ERROR_MSG(msg, "failure opening input Policy string", _data);
99  throw LSST_EXCEPT(pexExcept::IoError, msg.str());
100  }
101 
102  // skip over comments
103  string line;
104  getline(is, line);
105  while (is.good() &&
106  (regex_match(line, SPACE_RE) ||
107  (regex_search(line, COMMENT) && !regex_search(line, COMMENT))))
108  { }
109 
110  if (is.fail()) {
111  PolStr_ERROR_MSG(msg, "failure reading input Policy string", _data);
112  throw LSST_EXCEPT(pexExcept::IoError, msg.str());
113  }
114  if (is.eof() &&
115  (regex_match(line, SPACE_RE) ||
116  (regex_search(line, COMMENT) && !regex_search(line, COMMENT))))
117  {
118  // empty file; let's just assume PAF (but don't cache the name).
120  }
121  return cacheName(_formats->recognizeType(line));
122 }
123 
124 /*
125  * load the data from this Policy source into a Policy object
126  * @param policy the policy object to load the data into
127  * @exception ParserError if an error occurs while parsing the data
128  * @exception IOError if an I/O error occurs while reading from the
129  * source stream.
130  */
131 void PolicyString::load(Policy& policy) {
132 
133  PolicyParserFactory::Ptr pfactory = _pfact;
134  if (! pfactory.get()) {
135  const string& fmtname = getFormatName();
136  if (fmtname.empty()) {
137  PolStr_ERROR_MSG(ms,"Unknown Policy format for string data",_data);
138  throw LSST_EXCEPT(pexExcept::IoError, ms.str());
139  }
140  pfactory = _formats->getFactory(fmtname);
141  }
142 
143  std::unique_ptr<PolicyParser> parser(pfactory->createParser(policy));
144 
146  if (is.fail()) {
147  PolStr_ERROR_MSG(msg, "failure opening Policy string", _data);
148  throw LSST_EXCEPT(pexExcept::IoError, msg.str());
149  }
150  parser->parse(is);
151 }
152 
153 //@endcond
154 
155 }}} // end lsst::pex::policy
definition of the PolicyParser class
T regex_match(T... args)
definition of the PolicyFile class
definition of Policy-specific exceptions classes
static const boost::regex CONTENTID
reg-exp for the start of a comment
Definition: PolicyString.h:112
a class for creating PAFParser objects
T getline(T... args)
definition of Policy parsing exceptions
std::shared_ptr< PolicyParserFactory > Ptr
static const std::string FORMAT_NAME
a name for the format
virtual void load(Policy &policy)
load the data from this Policy source into a Policy object
static const boost::regex COMMENT
reg-exp for an empty line
Definition: PolicyString.h:108
Reports errors in external input/output operations.
Definition: Runtime.h:160
STL class.
static const boost::regex SPACE_RE
Definition: PolicyString.h:107
definition of the PAFParserFactory class
A base class for image defects.
char * data
Definition: BaseRecord.cc:62
PolicyString(const std::string &data, const SupportedFormats::Ptr &fmts=defaultFormats)
create a PolicyString that&#39;s wrapped around a given string.
virtual const std::string & getFormatName()
return the name of the format that the data is stored in.
def line(points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5)
Definition: ds9.py:105
SupportedFormats::Ptr _formats
Definition: PolicySource.h:142
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
STL class.
T regex_search(T... args)
std::string _data
the policy data
Definition: PolicyString.h:118
std::shared_ptr< SupportedFormats > Ptr
STL class.
definition of the PolicyString class