libdap Updated for version 3.20.10
libdap4 is an implementation of OPeNDAP's DAP protocol.
Str.cc
1
2// -*- mode: c++; c-basic-offset:4 -*-
3
4// This file is part of libdap, A C++ implementation of the OPeNDAP Data
5// Access Protocol.
6
7// Copyright (c) 2002,2003 OPeNDAP, Inc.
8// Author: James Gallagher <jgallagher@opendap.org>
9//
10// This library is free software; you can redistribute it and/or
11// modify it under the terms of the GNU Lesser General Public
12// License as published by the Free Software Foundation; either
13// version 2.1 of the License, or (at your option) any later version.
14//
15// This library is distributed in the hope that it will be useful,
16// but WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18// Lesser General Public License for more details.
19//
20// You should have received a copy of the GNU Lesser General Public
21// License along with this library; if not, write to the Free Software
22// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23//
24// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
25
26// (c) COPYRIGHT URI/MIT 1994-1999
27// Please read the full copyright statement in the file COPYRIGHT_URI.
28//
29// Authors:
30// jhrg,jimg James Gallagher <jgallagher@gso.uri.edu>
31
32// Implementation for Str.
33//
34// jhrg 9/7/94
35
36
37#include "config.h"
38
39#include <sstream>
40
41#include "Byte.h"
42#include "Int16.h"
43#include "UInt16.h"
44#include "Int32.h"
45#include "UInt32.h"
46#include "Float32.h"
47#include "Float64.h"
48#include "Str.h"
49#include "Url.h"
50#include "Array.h"
51#include "Structure.h"
52#include "Sequence.h"
53#include "Grid.h"
54
55#include "DDS.h"
56#include "Marshaller.h"
57#include "UnMarshaller.h"
58
59#include "DMR.h"
60#include "D4StreamMarshaller.h"
61#include "D4StreamUnMarshaller.h"
62
63#include "util.h"
64#include "parser.h"
65#include "Operators.h"
66#include "InternalErr.h"
67#include "escaping.h"
68#include "debug.h"
69#include "DapIndent.h"
70
71using std::cerr;
72using std::endl;
73
74namespace libdap {
75
84Str::Str(const string &n) : BaseType(n, dods_str_c), d_buf("")
85{}
86
94Str::Str(const string &n, const string &d) : BaseType(n, d, dods_str_c), d_buf("")
95{}
96
97Str::Str(const Str &copy_from) : BaseType(copy_from)
98{
99 d_buf = copy_from.d_buf;
100}
101
102BaseType *
104{
105 return new Str(*this);
106}
107
108Str &
109Str::operator=(const Str &rhs)
110{
111 if (this == &rhs)
112 return *this;
113 BaseType::operator=(rhs);
114 d_buf = rhs.d_buf;
115 return *this;
116}
117
118int
120{
121 return d_buf.length();
122}
123
124unsigned int
125Str::width(bool) const
126{
127 return sizeof(string);
128}
129
130bool
131Str::serialize(ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval)
132{
133
134 DBG(cerr << "Entering (" << this->name() << " [" << this << "])" << endl);
135#if USE_LOCAL_TIMEOUT_SCHEME
136 dds.timeout_on();
137#endif
138 if (!read_p())
139 read();
140
141 if (ce_eval && !eval.eval_selection(dds, dataset()))
142 return true;
143#if USE_LOCAL_TIMEOUT_SCHEME
144 dds.timeout_off();
145#endif
146 m.put_str( d_buf ) ;
147
148 DBG(cerr << "Exiting: buf = " << d_buf << endl);
149
150 return true;
151}
152
153// deserialize the string on stdin and put the result in BUF.
154
155bool
157{
158 um.get_str( d_buf ) ;
159
160 return false;
161}
162
163void
165{
166 checksum.AddData(reinterpret_cast<const uint8_t*>(d_buf.data()), d_buf.length());
167}
168
177void
178Str::serialize(D4StreamMarshaller &m, DMR &, /*ConstraintEvaluator &,*/ bool)
179{
180 if (!read_p())
181 read(); // read() throws Error
182
183 m.put_str( d_buf ) ;
184}
185
186void
188{
189 um.get_str( d_buf ) ;
190}
191
201unsigned int
202Str::buf2val(void **val)
203{
204 // Jose Garcia
205 // The same comment justifying throwing an Error in val2buf applies here.
206 if (!val)
207 throw InternalErr(__FILE__, __LINE__,
208 "No place to store a reference to the data.");
209 // If *val is null, then the caller has not allocated storage for the
210 // value; we must. If there is storage there, assume it is a string and
211 // assign d_buf's value to that storage.
212 if (!*val)
213 *val = new string(d_buf);
214 else
215 *static_cast<string*>(*val) = d_buf;
216
217 return sizeof(string*);
218}
219
229unsigned int
230Str::val2buf(void *val, bool)
231{
232 // Jose Garcia
233 // This method is public therefore and I believe it has being designed
234 // to be use by read which must be implemented on the surrogated library,
235 // thus if the pointer val is NULL, is an Internal Error.
236 if (!val)
237 throw InternalErr(__FILE__, __LINE__, "NULL pointer.");
238
239 d_buf = *static_cast<string*>(val);
240
241 return sizeof(string*);
242}
243
248bool
249Str::set_value(const string &value)
250{
251 d_buf = value;
252 set_read_p(true);
253
254 return true;
255}
256
259string
261{
262 return d_buf;
263}
264
265void
266Str::print_val(FILE *out, string space, bool print_decl_p)
267{
268 ostringstream oss;
269 print_val(oss, space, print_decl_p);
270 fwrite(oss.str().data(), sizeof(char), oss.str().length(), out);
271}
272
273void
274Str::print_val(ostream &out, string space, bool print_decl_p)
275{
276 if (print_decl_p) {
277 print_decl(out, space, false);
278 out << " = \"" << escattr(d_buf) << "\";\n" ;
279 }
280 else
281 out << "\"" << escattr(d_buf) << "\"" ;
282}
283
284bool
286{
287 // Extract the Byte arg's value.
288 if (!read_p() && !read()) {
289 // Jose Garcia
290 // Since the read method is virtual and implemented outside
291 // libdap++ if we cannot read the data that is the problem
292 // of the user or of whoever wrote the surrogate library
293 // implemeting read therefore it is an internal error.
294 throw InternalErr(__FILE__, __LINE__, "This value was not read!");
295 }
296
297 // Extract the second arg's value.
298 if (!b || !(b->read_p() || b->read())) {
299 // Jose Garcia
300 // Since the read method is virtual and implemented outside
301 // libdap++ if we cannot read the data that is the problem
302 // of the user or of whoever wrote the surrogate library
303 // implemeting read therefore it is an internal error.
304 throw InternalErr(__FILE__, __LINE__, "Argument value was not read!");
305 }
306
307 return d4_ops(b, op);
308}
309
313bool Str::d4_ops(BaseType *b, int op)
314{
315 switch (b->type()) {
316 case dods_byte_c:
317 case dods_int8_c:
318 case dods_int16_c:
319 case dods_uint16_c:
320 case dods_int32_c:
321 case dods_uint32_c:
322 case dods_int64_c:
323 case dods_uint64_c:
324 case dods_float32_c:
325 case dods_float64_c:
326 throw Error(malformed_expr, "Relational operators can only compare compatible types (string, number).");
327 case dods_str_c:
328 return StrCmp<string, string>(op, d_buf, static_cast<Str*>(b)->value());
329 case dods_url_c:
330 return StrCmp<string, string>(op, d_buf, static_cast<Url*>(b)->value());
331 default:
332 throw Error(malformed_expr, "Relational operators only work with scalar types.");
333 }
334}
335
344void
345Str::dump(ostream &strm) const
346{
347 strm << DapIndent::LMarg << "Str::dump - ("
348 << (void *)this << ")" << endl ;
349 DapIndent::Indent() ;
350 BaseType::dump(strm) ;
351 strm << DapIndent::LMarg << "value: " << d_buf << endl ;
352 DapIndent::UnIndent() ;
353}
354
355} // namespace libdap
356
Definition crc.h:77
void AddData(const uint8_t *pData, const uint32_t length)
Definition crc.h:98
The basic data type for the DODS DAP types.
Definition BaseType.h:118
virtual bool read()
Read data into a local buffer.
Definition BaseType.cc:895
virtual string name() const
Returns the name of the class instance.
Definition BaseType.cc:316
virtual void print_decl(FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
Print an ASCII representation of the variable structure.
Definition BaseType.cc:999
virtual bool read_p()
Has this variable been read?
Definition BaseType.cc:476
virtual void set_read_p(bool state)
Sets the value of the read_p property.
Definition BaseType.cc:512
virtual string dataset() const
Returns the name of the dataset used to create this instance.
Definition BaseType.cc:354
void dump(ostream &strm) const override
dumps information about this object
Definition BaseType.cc:287
Evaluate a constraint expression.
bool eval_selection(DDS &dds, const std::string &dataset)
Evaluate a boolean-valued constraint expression. This is main method for the evaluator and is called ...
Marshaller that knows how to marshal/serialize dap data objects to a C++ iostream using DAP4's receiv...
Read data from the stream made by D4StreamMarshaller.
A class for error processing.
Definition Error.h:94
A class for software fault reporting.
Definition InternalErr.h:65
abstract base class used to marshal/serialize dap data objects
Definition Marshaller.h:50
Holds character string data.
Definition Str.h:63
virtual bool d4_ops(BaseType *b, int op)
Definition Str.cc:313
virtual bool serialize(ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true)
Move data to the net, then remove them from the object.
Definition Str.cc:131
Str(const string &n)
Definition Str.cc:84
virtual bool deserialize(UnMarshaller &um, DDS *dds, bool reuse=false)
Receive data from the net.
Definition Str.cc:156
virtual void print_val(FILE *out, string space="", bool print_decl_p=true)
Prints the value of the variable.
Definition Str.cc:266
virtual BaseType * ptr_duplicate()
Definition Str.cc:103
virtual bool ops(BaseType *b, int op)
Evaluate relational operators.
Definition Str.cc:285
virtual int length() const
How many elements are in this variable.
Definition Str.cc:119
virtual unsigned int width(bool constrained=false) const
How many bytes does this variable use Return the number of bytes of storage this variable uses....
Definition Str.cc:125
virtual string value() const
Definition Str.cc:260
virtual void dump(ostream &strm) const
dumps information about this object
Definition Str.cc:345
virtual unsigned int buf2val(void **val)
Definition Str.cc:202
virtual bool set_value(const string &value)
Definition Str.cc:249
virtual unsigned int val2buf(void *val, bool reuse=false)
Definition Str.cc:230
virtual void compute_checksum(Crc32 &checksum)
include the data for this variable in the checksum DAP4 includes a checksum with every data response....
Definition Str.cc:164
abstract base class used to unmarshall/deserialize dap data objects
Holds an Internet address (URL).
Definition Url.h:69
top level DAP object to house generic methods
string escattr(string s)
Definition escaping.cc:368