data.h 26.3 KB
Newer Older
1
// Copyright (C) 2010, 2014  Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

15 16
#ifndef ISC_DATA_H
#define ISC_DATA_H 1
17 18 19 20 21

#include <string>
#include <vector>
#include <map>
#include <boost/shared_ptr.hpp>
22
#include <stdexcept>
23
#include <exceptions/exceptions.h>
24

Jelte Jansen's avatar
Jelte Jansen committed
25
namespace isc { namespace data {
26

27 28 29
class Element;
// todo: describe the rationale behind ElementPtr?
typedef boost::shared_ptr<Element> ElementPtr;
30
typedef boost::shared_ptr<const Element> ConstElementPtr;
31 32 33 34 35 36

///
/// \brief A standard Data module exception that is thrown if a function
/// is called for an Element that has a wrong type (e.g. int_value on a
/// ListElement)
///
37
class TypeError : public isc::Exception {
38
public:
Jelte Jansen's avatar
Jelte Jansen committed
39
    TypeError(const char* file, size_t line, const char* what) :
40
        isc::Exception(file, line, what) {}
41 42 43 44 45 46
};

///
/// \brief A standard Data module exception that is thrown if a parse
/// error is encountered when constructing an Element from a string
///
Jelte Jansen's avatar
Jelte Jansen committed
47 48 49
// i'd like to use Exception here but we need one that is derived from
// runtime_error (as this one is directly based on external data, and
// i want to add some values to any static data string that is provided)
50
class JSONError : public isc::Exception {
51
public:
52 53
    JSONError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
54 55 56 57 58 59 60 61 62 63 64
};

///
/// \brief The \c Element class represents a piece of data, used by
/// the command channel and configuration parts.
///
/// An \c Element can contain simple types (int, real, string, bool and
/// None), and composite types (list and string->element maps)
///
/// Elements should in calling functions usually be referenced through
/// an \c ElementPtr, which can be created using the factory functions
65
/// \c Element::create() and \c Element::fromJSON()
66 67 68 69 70 71 72 73
///
/// Notes to developers: Element is a base class, implemented by a
/// specific subclass for each type (IntElement, BoolElement, etc).
/// Element does define all functions for all types, and defaults to
/// raising a \c TypeError for functions that are not supported for
/// the type in question.
///
class Element {
74

75 76 77
public:
    /// \brief Represents the position of the data element within a
    /// configuration string.
78 79 80 81 82 83 84 85 86
    ///
    /// Position comprises a line number and an offset within this line
    /// where the element value starts. For example, if the JSON string is
    ///
    /// \code
    /// { "foo": "some string",
    ///   "bar": 123 }
    /// \endcode
    ///
87
    /// the position of the element "bar" is: line_ = 2; pos_ = 9, because
88 89 90
    /// begining of the value "123" is at offset 9 from the beginning of
    /// the second line, including whitespaces.
    ///
91
    /// Note that the @c Position structure is used as an argument to @c Element
92 93 94
    /// constructors and factory functions to avoid ambiguity and so that the
    /// uint32_t arguments holding line number and position within the line are
    /// not confused with the @c Element values passed to these functions.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
    struct Position {
        uint32_t line_; ///< Line number.
        uint32_t pos_;  ///< Position within the line.

        /// \brief Constructor.
        ///
        /// \param line Line number.
        /// \param pos Position within the line.
        Position(const uint32_t line, const uint32_t pos)
            : line_(line), pos_(pos) {
        }
    };

    /// \brief Returns @c Position object with line_ and pos_ set to 0.
    ///
    /// The object containing two zeros is a default for most of the
111 112 113
    /// methods creating @c Element objects. The returned value is static
    /// so as it is not created everytime the function with the default
    /// position argument is called.
114 115 116 117 118
    static const Position& ZERO_POSITION() {
        static Position position(0, 0);
        return (position);
    }

119 120 121 122
private:
    // technically the type could be omitted; is it useful?
    // should we remove it or replace it with a pure virtual
    // function getType?
123 124 125 126
    int type_;

    /// \brief Position of the element in the configuration string.
    Position position_;
127 128

protected:
129 130 131 132

    /// \brief Constructor.
    ///
    /// \param t Element type.
133 134 135
    /// \param pos Structure holding position of the value of the data element.
    /// It comprises the line number and the position within this line. The values
    /// held in this structure are used for error logging purposes.
136 137 138
    Element(int t, const Position& pos = ZERO_POSITION())
        : type_(t), position_(pos) {
    }
139 140

public:
141

142 143
    // any is a special type used in list specifications, specifying
    // that the elements can be of any type
144
    enum types { integer, real, boolean, null, string, list, map, any };
145 146 147 148
    // base class; make dtor virtual
    virtual ~Element() {};

    /// \return the type of this element
149 150
    int getType() const { return (type_); }

151 152 153 154 155
    /// \brief Returns position where the data element's value starts in a
    /// configuration string.
    ///
    /// @warning The returned reference is valid as long as the object which
    /// created it lives.
156
    const Position& getPosition() const { return (position_); }
157

158 159 160
    /// Returns a string representing the Element and all its
    /// child elements; note that this is different from stringValue(),
    /// which only returns the single value of a StringElement
Jelte Jansen's avatar
Jelte Jansen committed
161 162
    ///
    /// The resulting string will contain the Element in JSON format.
163 164
    ///
    /// \return std::string containing the string representation
165
    std::string str() const;
166 167 168 169 170

    /// Returns the wireformat for the Element and all its child
    /// elements.
    ///
    /// \return std::string containing the element in wire format
171 172
    std::string toWire() const;
    void toWire(std::ostream& out) const;
173

174
    /// \name pure virtuals, every derived class must implement these
Jelte Jansen's avatar
Jelte Jansen committed
175

176
    /// \return true if the other ElementPtr has the same type and value
177
    virtual bool equals(const Element& other) const = 0;
178

Jelte Jansen's avatar
Jelte Jansen committed
179 180
    /// Converts the Element to JSON format and appends it to
    /// the given stringstream.
181
    virtual void toJSON(std::ostream& ss) const = 0;
Jelte Jansen's avatar
Jelte Jansen committed
182

183 184 185 186 187 188 189 190
    /// \name Type-specific getters
    ///
    /// \brief These functions only
    /// work on their corresponding Element type. For all other
    /// types, a TypeError is thrown.
    /// If you want an exception-safe getter method, use
    /// getValue() below
    //@{
191
    virtual int64_t intValue() const
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
    { isc_throw(TypeError, "intValue() called on non-integer Element"); };
    virtual double doubleValue() const
    { isc_throw(TypeError, "doubleValue() called on non-double Element"); };
    virtual bool boolValue() const
    { isc_throw(TypeError, "boolValue() called on non-Bool Element"); };
    virtual std::string stringValue() const
    { isc_throw(TypeError, "stringValue() called on non-string Element"); };
    virtual const std::vector<ConstElementPtr>& listValue() const {
        // replace with real exception or empty vector?
        isc_throw(TypeError, "listValue() called on non-list Element");
    };
    virtual const std::map<std::string, ConstElementPtr>& mapValue() const {
        // replace with real exception or empty map?
        isc_throw(TypeError, "mapValue() called on non-map Element");
    };
207 208 209 210 211 212 213 214 215 216 217
    //@}

    /// \name Exception-safe getters
    ///
    /// \brief The getValue() functions return false if the given reference
    /// is of another type than the element contains
    /// By default it always returns false; the derived classes
    /// override the function for their type, copying their
    /// data to the given reference and returning true
    ///
    //@{
218
    virtual bool getValue(int64_t& t) const;
219 220 221 222 223
    virtual bool getValue(double& t) const;
    virtual bool getValue(bool& t) const;
    virtual bool getValue(std::string& t) const;
    virtual bool getValue(std::vector<ConstElementPtr>& t) const;
    virtual bool getValue(std::map<std::string, ConstElementPtr>& t) const;
224
    //@}
225

226 227 228 229 230 231 232
    ///
    /// \name Exception-safe setters.
    ///
    /// \brief Return false if the Element is not
    /// the right type. Set the value and return true if the Elements
    /// is of the correct type
    ///
233 234
    /// Notes: Read notes of IntElement definition about the use of
    ///        long long int, long int and int.
235
    //@{
236 237 238
    virtual bool setValue(const long long int v);
    bool setValue(const long int i) { return (setValue(static_cast<long long int>(i))); };
    bool setValue(const int i) { return (setValue(static_cast<long long int>(i))); };
239 240 241
    virtual bool setValue(const double v);
    virtual bool setValue(const bool t);
    virtual bool setValue(const std::string& v);
242 243
    virtual bool setValue(const std::vector<ConstElementPtr>& v);
    virtual bool setValue(const std::map<std::string, ConstElementPtr>& v);
244 245 246 247 248 249 250 251 252 253 254 255 256 257
    //@}



    // Other functions for specific subtypes

    /// \name ListElement functions
    ///
    /// \brief If the Element on which these functions are called are not
    /// an instance of ListElement, a TypeError exception is thrown.
    //@{
    /// Returns the ElementPtr at the given index. If the index is out
    /// of bounds, this function throws an std::out_of_range exception.
    /// \param i The position of the ElementPtr to return
258
    virtual ConstElementPtr get(const int i) const;
259

260 261 262 263
    /// Sets the ElementPtr at the given index. If the index is out
    /// of bounds, this function throws an std::out_of_range exception.
    /// \param i The position of the ElementPtr to set
    /// \param element The ElementPtr to set at the position
264
    virtual void set(const size_t i, ConstElementPtr element);
265

266 267
    /// Adds an ElementPtr to the list
    /// \param element The ElementPtr to add
268
    virtual void add(ConstElementPtr element);
269

270 271 272
    /// Removes the element at the given position. If the index is out
    /// of nothing happens.
    /// \param i The index of the element to remove.
273
    virtual void remove(const int i);
274

275
    /// Returns the number of elements in the list.
276
    virtual size_t size() const;
277 278 279

    /// Return true if there are no elements in the list.
    virtual bool empty() const;
280
    //@}
281

282

283 284 285 286 287 288 289
    /// \name MapElement functions
    ///
    /// \brief If the Element on which these functions are called are not
    /// an instance of MapElement, a TypeError exception is thrown.
    //@{
    /// Returns the ElementPtr at the given key
    /// \param name The key of the Element to return
290
    /// \return The ElementPtr at the given key, or null if not present
291
    virtual ConstElementPtr get(const std::string& name) const;
292

293 294
    /// Sets the ElementPtr at the given key
    /// \param name The key of the Element to set
295
    /// \param element The ElementPtr to set at the given key.
296
    virtual void set(const std::string& name, ConstElementPtr element);
297

298 299
    /// Remove the ElementPtr at the given key
    /// \param name The key of the Element to remove
300
    virtual void remove(const std::string& name);
301

302 303 304
    /// Checks if there is data at the given key
    /// \param name The key of the Element to remove
    /// \return true if there is data at the key, false if not.
305
    virtual bool contains(const std::string& name) const;
306

307 308 309 310 311 312 313 314 315 316 317 318 319
    /// Recursively finds any data at the given identifier. The
    /// identifier is a /-separated list of names of nested maps, with
    /// the last name being the leaf that is returned.
    ///
    /// For instance, if you have a MapElement that contains another
    /// MapElement at the key "foo", and that second MapElement contains
    /// Another Element at key "bar", the identifier for that last
    /// element from the first is "foo/bar".
    ///
    /// \param identifier The identifier of the element to find
    /// \return The ElementPtr at the given identifier. Returns a
    /// null ElementPtr if it is not found, which can be checked with
    /// Element::is_null(ElementPtr e).
320
    virtual ConstElementPtr find(const std::string& identifier) const;
321

322 323 324 325
    /// See \c Element::find()
    /// \param identifier The identifier of the element to find
    /// \param t Reference to store the resulting ElementPtr, if found.
    /// \return true if the element was found, false if not.
326
    virtual bool find(const std::string& identifier, ConstElementPtr& t) const;
327 328
    //@}

329

330
    /// \name Factory functions
331

332 333 334 335 336 337 338 339
    // TODO: should we move all factory functions to a different class
    // so as not to burden the Element base with too many functions?
    // and/or perhaps even to a separate header?

    /// \name Direct factory functions
    /// \brief These functions simply wrap the given data directly
    /// in an Element object, and return a reference to it, in the form
    /// of an \c ElementPtr.
340 341 342
    /// These factory functions are exception-free (unless there is
    /// no memory available, in which case bad_alloc is raised by the
    /// underlying system).
343 344
    /// (Note that that is different from an NullElement, which
    /// represents an empty value, and is created with Element::create())
345 346 347
    ///
    /// Notes: Read notes of IntElement definition about the use of
    ///        long long int, long int and int.
348
    //@{
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
    static ElementPtr create(const Position& pos = ZERO_POSITION());
    static ElementPtr create(const long long int i,
                             const Position& pos = ZERO_POSITION());
    static ElementPtr create(const int i,
                             const Position& pos = ZERO_POSITION()) {
        return (create(static_cast<long long int>(i), pos));
    };
    static ElementPtr create(const long int i,
                             const Position& pos = ZERO_POSITION()) {
        return (create(static_cast<long long int>(i), pos));
    };
    static ElementPtr create(const double d,
                             const Position& pos = ZERO_POSITION());

    static ElementPtr create(const bool b,
                             const Position& pos = ZERO_POSITION());
    static ElementPtr create(const std::string& s,
                             const Position& pos = ZERO_POSITION());
367 368
    // need both std:string and char *, since c++ will match
    // bool before std::string when you pass it a char *
369 370 371 372
    static ElementPtr create(const char *s,
                             const Position& pos = ZERO_POSITION()) {
        return (create(std::string(s), pos));
    }
373 374

    /// \brief Creates an empty ListElement type ElementPtr.
375
    ///
376 377
    /// \param pos A structure holding position of the data element value
    /// in the configuration string. It is used for error logging purposes.
378
    static ElementPtr createList(const Position& pos = ZERO_POSITION());
379

380
    /// \brief Creates an empty MapElement type ElementPtr.
381
    ///
382 383
    /// \param pos A structure holding position of the data element value
    /// in the configuration string. It is used for error logging purposes.
384
    static ElementPtr createMap(const Position& pos = ZERO_POSITION());
385 386
    //@}

387

388 389
    /// \name Compound factory functions

Jelte Jansen's avatar
Jelte Jansen committed
390 391
    /// \brief These functions will parse the given string (JSON)
    /// representation  of a compound element. If there is a parse
Jelte Jansen's avatar
Jelte Jansen committed
392
    /// error, an exception of the type isc::data::JSONError is thrown.
393 394

    //@{
395
    /// Creates an Element from the given JSON string
396 397 398
    /// \param in The string to parse the element from
    /// \return An ElementPtr that contains the element(s) specified
    /// in the given string.
399
    static ElementPtr fromJSON(const std::string& in);
Jelte Jansen's avatar
Jelte Jansen committed
400

401 402 403
    /// Creates an Element from the given input stream containing JSON
    /// formatted data.
    ///
404 405 406
    /// \param in The string to parse the element from
    /// \return An ElementPtr that contains the element(s) specified
    /// in the given input stream.
Jelte Jansen's avatar
Jelte Jansen committed
407
    static ElementPtr fromJSON(std::istream& in) throw(JSONError);
408 409
    static ElementPtr fromJSON(std::istream& in, const std::string& file_name)
        throw(JSONError);
410

411 412 413
    /// Creates an Element from the given input stream, where we keep
    /// track of the location in the stream for error reporting.
    ///
414 415
    /// \param in The string to parse the element from.
    /// \param file The input file name.
416 417
    /// \param line A reference to the int where the function keeps
    /// track of the current line.
418
    /// \param pos A reference to the int where the function keeps
419 420 421 422
    /// track of the current position within the current line.
    /// \return An ElementPtr that contains the element(s) specified
    /// in the given input stream.
    // make this one private?
423 424 425
    static ElementPtr fromJSON(std::istream& in, const std::string& file,
                               int& line, int &pos)
        throw(JSONError);
426 427
    //@}

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    /// \name Type name conversion functions

    /// Returns the name of the given type as a string
    ///
    /// \param type The type to return the name of
    /// \return The name of the type, or "unknown" if the type
    ///         is not known.
    static std::string typeToName(Element::types type);

    /// Converts the string to the corresponding type
    /// Throws a TypeError if the name is unknown.
    ///
    /// \param type_name The name to get the type of
    /// \return the corresponding type value
    static Element::types nameToType(const std::string& type_name);

444 445 446 447 448
    /// \name Wire format factory functions

    /// These function pparse the wireformat at the given stringstream
    /// (of the given length). If there is a parse error an exception
    /// of the type isc::cc::DecodeError is raised.
449

450 451 452
    //@{
    /// Creates an Element from the wire format in the given
    /// stringstream of the given length.
Jelte Jansen's avatar
Jelte Jansen committed
453
    /// Since the wire format is JSON, thise is the same as
454
    /// fromJSON, and could be removed.
Jelte Jansen's avatar
Jelte Jansen committed
455
    ///
456 457 458 459
    /// \param in The input stringstream.
    /// \param length The length of the wireformat data in the stream
    /// \return ElementPtr with the data that is parsed.
    static ElementPtr fromWire(std::stringstream& in, int length);
Jelte Jansen's avatar
Jelte Jansen committed
460

461
    /// Creates an Element from the wire format in the given string
Jelte Jansen's avatar
Jelte Jansen committed
462
    /// Since the wire format is JSON, thise is the same as
463
    /// fromJSON, and could be removed.
Jelte Jansen's avatar
Jelte Jansen committed
464
    ///
465 466 467 468 469 470
    /// \param s The input string
    /// \return ElementPtr with the data that is parsed.
    static ElementPtr fromWire(const std::string& s);
    //@}
};

471 472 473 474 475
/// Notes: IntElement type is changed to int64_t.
///        Due to C++ problems on overloading and automatic type conversion,
///          (C++ tries to convert integer type values and reference/pointer
///           if value types do not match exactly)
///        We decided the storage as int64_t,
476
///           three (long long, long, int) override function defintions
477 478 479 480
///           and cast int/long/long long to int64_t via long long.
///        Therefore, call by value methods (create, setValue) have three
///        (int,long,long long) definitions. Others use int64_t.
///
481
class IntElement : public Element {
482 483
    int64_t i;
private:
484 485

public:
486 487
    IntElement(int64_t v, const Position& pos = ZERO_POSITION())
        : Element(integer, pos), i(v) { }
488
    int64_t intValue() const { return (i); }
489
    using Element::getValue;
490
    bool getValue(int64_t& t) const { t = i; return (true); }
491
    using Element::setValue;
492
    bool setValue(long long int v) { i = v; return (true); }
493 494
    void toJSON(std::ostream& ss) const;
    bool equals(const Element& other) const;
495 496 497 498 499 500
};

class DoubleElement : public Element {
    double d;

public:
501 502
    DoubleElement(double v, const Position& pos = ZERO_POSITION())
        : Element(real, pos), d(v) {};
503
    double doubleValue() const { return (d); }
504
    using Element::getValue;
505
    bool getValue(double& t) const { t = d; return (true); }
506
    using Element::setValue;
JINMEI Tatuya's avatar
JINMEI Tatuya committed
507
    bool setValue(const double v) { d = v; return (true); }
508 509
    void toJSON(std::ostream& ss) const;
    bool equals(const Element& other) const;
510 511 512 513 514 515
};

class BoolElement : public Element {
    bool b;

public:
516 517
    BoolElement(const bool v, const Position& pos = ZERO_POSITION())
        : Element(boolean, pos), b(v) {};
518
    bool boolValue() const { return (b); }
519
    using Element::getValue;
520
    bool getValue(bool& t) const { t = b; return (true); }
521
    using Element::setValue;
JINMEI Tatuya's avatar
JINMEI Tatuya committed
522
    bool setValue(const bool v) { b = v; return (true); }
523 524
    void toJSON(std::ostream& ss) const;
    bool equals(const Element& other) const;
525 526 527 528
};

class NullElement : public Element {
public:
529 530
    NullElement(const Position& pos = ZERO_POSITION())
        : Element(null, pos) {};
531 532
    void toJSON(std::ostream& ss) const;
    bool equals(const Element& other) const;
533 534 535 536 537 538
};

class StringElement : public Element {
    std::string s;

public:
539 540
    StringElement(std::string v, const Position& pos = ZERO_POSITION())
        : Element(string, pos), s(v) {};
541
    std::string stringValue() const { return (s); }
542
    using Element::getValue;
543
    bool getValue(std::string& t) const { t = s; return (true); }
544
    using Element::setValue;
JINMEI Tatuya's avatar
JINMEI Tatuya committed
545
    bool setValue(const std::string& v) { s = v; return (true); }
546 547
    void toJSON(std::ostream& ss) const;
    bool equals(const Element& other) const;
548 549 550
};

class ListElement : public Element {
551
    std::vector<ConstElementPtr> l;
552 553

public:
554 555
    ListElement(const Position& pos = ZERO_POSITION())
        : Element(list, pos) {}
556
    const std::vector<ConstElementPtr>& listValue() const { return (l); }
557
    using Element::getValue;
558
    bool getValue(std::vector<ConstElementPtr>& t) const {
559 560 561
        t = l;
        return (true);
    }
562
    using Element::setValue;
563 564 565 566
    bool setValue(const std::vector<ConstElementPtr>& v) {
        l = v;
        return (true);
    }
567
    using Element::get;
568
    ConstElementPtr get(int i) const { return (l.at(i)); }
569
    using Element::set;
570 571 572 573
    void set(size_t i, ConstElementPtr e) {
        l.at(i) = e;
    }
    void add(ConstElementPtr e) { l.push_back(e); };
574
    using Element::remove;
575
    void remove(int i) { l.erase(l.begin() + i); };
576 577
    void toJSON(std::ostream& ss) const;
    size_t size() const { return (l.size()); }
578
    bool empty() const { return (l.empty()); }
579
    bool equals(const Element& other) const;
580 581 582
};

class MapElement : public Element {
583
    std::map<std::string, ConstElementPtr> m;
584 585

public:
586 587 588
    MapElement(const Position& pos = ZERO_POSITION()) : Element(map, pos) {}
    // @todo should we have direct iterators instead of exposing the std::map
    // here?
589 590 591
    const std::map<std::string, ConstElementPtr>& mapValue() const {
        return (m);
    }
592
    using Element::getValue;
593
    bool getValue(std::map<std::string, ConstElementPtr>& t) const {
594 595 596
        t = m;
        return (true);
    }
597
    using Element::setValue;
598
    bool setValue(const std::map<std::string, ConstElementPtr>& v) {
599 600 601
        m = v;
        return (true);
    }
602
    using Element::get;
603
    ConstElementPtr get(const std::string& s) const {
604 605
        return (contains(s) ? m.find(s)->second : ConstElementPtr());
    }
606
    using Element::set;
607
    void set(const std::string& key, ConstElementPtr value);
608
    using Element::remove;
609
    void remove(const std::string& s) { m.erase(s); }
610 611 612 613
    bool contains(const std::string& s) const {
        return (m.find(s) != m.end());
    }
    void toJSON(std::ostream& ss) const;
614

615 616 617 618 619
    // we should name the two finds better...
    // find the element at id; raises TypeError if one of the
    // elements at path except the one we're looking for is not a
    // mapelement.
    // returns an empty element if the item could not be found
620
    ConstElementPtr find(const std::string& id) const;
621 622 623

    // find the Element at 'id', and store the element pointer in t
    // returns true if found, or false if not found (either because
624
    // it doesn't exist or one of the elements in the path is not
625
    // a MapElement)
626
    bool find(const std::string& id, ConstElementPtr& t) const;
627

628
    bool equals(const Element& other) const;
629 630 631 632 633
};

/// Checks whether the given ElementPtr is a NULL pointer
/// \param p The ElementPtr to check
/// \return true if it is NULL, false if not.
634
bool isNull(ConstElementPtr p);
635

636 637
///
/// \brief Remove all values from the first ElementPtr that are
638
/// equal in the second. Both ElementPtrs MUST be MapElements
639 640 641 642
/// The use for this function is to end up with a MapElement that
/// only contains new and changed values (for ModuleCCSession and
/// configuration update handlers)
/// Raises a TypeError if a or b are not MapElements
643 644 645 646 647 648 649 650
void removeIdentical(ElementPtr a, ConstElementPtr b);

/// \brief Create a new ElementPtr from the first ElementPtr, removing all
/// values that are equal in the second. Both ElementPtrs MUST be MapElements.
/// The returned ElementPtr will be a MapElement that only contains new and
/// changed values (for ModuleCCSession and configuration update handlers).
/// Raises a TypeError if a or b are not MapElements
ConstElementPtr removeIdentical(ConstElementPtr a, ConstElementPtr b);
651

652 653 654 655 656
/// \brief Merges the data from other into element.
/// (on the first level). Both elements must be
/// MapElements.
/// Every string,value pair in other is copied into element
/// (the ElementPtr of value is copied, this is not a new object)
Jelte Jansen's avatar
Jelte Jansen committed
657 658 659 660 661 662
/// Unless the value is a NullElement, in which case the
/// key is removed from element, rather than setting the value to
/// the given NullElement.
/// This way, we can remove values from for instance maps with
/// configuration data (which would then result in reverting back
/// to the default).
663
/// Raises a TypeError if either ElementPtr is not a MapElement
664
void merge(ElementPtr element, ConstElementPtr other);
665

666 667 668
///
/// \brief Insert the Element as a string into stream.
///
669
/// This method converts the \c ElementPtr into a string with
670 671 672 673 674 675
/// \c Element::str() and inserts it into the
/// output stream \c out.
///
/// This function overloads the global operator<< to behave as described in
/// ostream::operator<< but applied to \c ElementPtr objects.
///
676
/// \param out A \c std::ostream object on which the insertion operation is
677 678 679
/// performed.
/// \param e The \c ElementPtr object to insert.
/// \return A reference to the same \c std::ostream object referenced by
680
/// parameter \c out after the insertion operation.
681
std::ostream& operator<<(std::ostream& out, const Element& e);
682

683 684
bool operator==(const Element& a, const Element& b);
bool operator!=(const Element& a, const Element& b);
JINMEI Tatuya's avatar
JINMEI Tatuya committed
685
} }
686
#endif // ISC_DATA_H
687

688
// Local Variables:
689
// mode: c++
690
// End: