data.h 27.1 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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
18
#include <stdint.h>
19 20 21 22
#include <string>
#include <vector>
#include <map>
#include <boost/shared_ptr.hpp>
23
#include <stdexcept>
24
#include <exceptions/exceptions.h>
25

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

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

///
/// \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)
///
38
class TypeError : public isc::Exception {
39
public:
Jelte Jansen's avatar
Jelte Jansen committed
40
    TypeError(const char* file, size_t line, const char* what) :
41
        isc::Exception(file, line, what) {}
42 43 44 45 46 47
};

///
/// \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
48 49 50
// 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)
51
class JSONError : public isc::Exception {
52
public:
53 54
    JSONError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
55 56 57 58 59 60 61 62 63 64 65
};

///
/// \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
66
/// \c Element::create() and \c Element::fromJSON()
67 68 69 70 71 72 73 74
///
/// 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 {
75

76 77 78
public:
    /// \brief Represents the position of the data element within a
    /// configuration string.
79
    ///
80 81
    /// Position comprises a file name, line number and an offset within this
    /// line where the element value starts. For example, if the JSON string is
82 83 84 85 86 87
    ///
    /// \code
    /// { "foo": "some string",
    ///   "bar": 123 }
    /// \endcode
    ///
88
    /// the position of the element "bar" is: line_ = 2; pos_ = 9, because
89 90 91
    /// begining of the value "123" is at offset 9 from the beginning of
    /// the second line, including whitespaces.
    ///
92
    /// Note that the @c Position structure is used as an argument to @c Element
93 94 95
    /// 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.
96
    struct Position {
97 98 99
        std::string file_; ///< File name.
        uint32_t line_;    ///< Line number.
        uint32_t pos_;     ///< Position within the line.
100 101 102

        /// \brief Constructor.
        ///
103
        /// \param file File name.
104 105
        /// \param line Line number.
        /// \param pos Position within the line.
106 107 108
        Position(const std::string& file, const uint32_t line,
                 const uint32_t pos)
            : file_(file), line_(line), pos_(pos) {
109
        }
110 111 112 113 114

        /// \brief Returns the position in the textual format.
        ///
        /// The returned position has the following format: file:line:pos.
        std::string str() const;
115 116
    };

117 118
    /// \brief Returns @c Position object with line_ and pos_ set to 0, and
    /// with an empty file name.
119 120
    ///
    /// The object containing two zeros is a default for most of the
121 122 123
    /// 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.
124
    static const Position& ZERO_POSITION() {
125
        static Position position("", 0, 0);
126 127 128
        return (position);
    }

129 130 131 132
private:
    // technically the type could be omitted; is it useful?
    // should we remove it or replace it with a pure virtual
    // function getType?
133 134 135 136
    int type_;

    /// \brief Position of the element in the configuration string.
    Position position_;
137 138

protected:
139 140 141 142

    /// \brief Constructor.
    ///
    /// \param t Element type.
143 144 145
    /// \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.
146 147 148
    Element(int t, const Position& pos = ZERO_POSITION())
        : type_(t), position_(pos) {
    }
149 150

public:
151

152 153
    // any is a special type used in list specifications, specifying
    // that the elements can be of any type
154
    enum types { integer, real, boolean, null, string, list, map, any };
155 156 157 158
    // base class; make dtor virtual
    virtual ~Element() {};

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

161 162 163 164 165
    /// \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.
166
    const Position& getPosition() const { return (position_); }
167

168 169 170
    /// 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
171 172
    ///
    /// The resulting string will contain the Element in JSON format.
173 174
    ///
    /// \return std::string containing the string representation
175
    std::string str() const;
176 177 178 179 180

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

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

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

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

193 194 195 196 197 198 199 200
    /// \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
    //@{
201
    virtual int64_t intValue() const
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
    { 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");
    };
217 218 219 220 221 222 223 224 225 226 227
    //@}

    /// \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
    ///
    //@{
228
    virtual bool getValue(int64_t& t) const;
229 230 231 232 233
    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;
234
    //@}
235

236 237 238 239 240 241 242
    ///
    /// \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
    ///
243 244
    /// Notes: Read notes of IntElement definition about the use of
    ///        long long int, long int and int.
245
    //@{
246 247 248
    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))); };
249 250 251
    virtual bool setValue(const double v);
    virtual bool setValue(const bool t);
    virtual bool setValue(const std::string& v);
252 253
    virtual bool setValue(const std::vector<ConstElementPtr>& v);
    virtual bool setValue(const std::map<std::string, ConstElementPtr>& v);
254 255 256 257 258 259 260 261 262 263 264 265 266 267
    //@}



    // 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
268
    virtual ConstElementPtr get(const int i) const;
269

270 271 272 273
    /// 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
274
    virtual void set(const size_t i, ConstElementPtr element);
275

276 277
    /// Adds an ElementPtr to the list
    /// \param element The ElementPtr to add
278
    virtual void add(ConstElementPtr element);
279

280 281 282
    /// Removes the element at the given position. If the index is out
    /// of nothing happens.
    /// \param i The index of the element to remove.
283
    virtual void remove(const int i);
284

285
    /// Returns the number of elements in the list.
286
    virtual size_t size() const;
287 288 289

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

292

293 294 295 296 297 298 299
    /// \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
300
    /// \return The ElementPtr at the given key, or null if not present
301
    virtual ConstElementPtr get(const std::string& name) const;
302

303 304
    /// Sets the ElementPtr at the given key
    /// \param name The key of the Element to set
305
    /// \param element The ElementPtr to set at the given key.
306
    virtual void set(const std::string& name, ConstElementPtr element);
307

308 309
    /// Remove the ElementPtr at the given key
    /// \param name The key of the Element to remove
310
    virtual void remove(const std::string& name);
311

312 313 314
    /// 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.
315
    virtual bool contains(const std::string& name) const;
316

317 318 319 320 321 322 323 324 325 326 327 328 329
    /// 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).
330
    virtual ConstElementPtr find(const std::string& identifier) const;
331

332 333 334 335
    /// 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.
336
    virtual bool find(const std::string& identifier, ConstElementPtr& t) const;
337 338
    //@}

339

340
    /// \name Factory functions
341

342 343 344 345 346 347 348 349
    // 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.
350 351 352
    /// These factory functions are exception-free (unless there is
    /// no memory available, in which case bad_alloc is raised by the
    /// underlying system).
353 354
    /// (Note that that is different from an NullElement, which
    /// represents an empty value, and is created with Element::create())
355 356 357
    ///
    /// Notes: Read notes of IntElement definition about the use of
    ///        long long int, long int and int.
358
    //@{
359 360 361 362
    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,
363
                             const Position& pos = ZERO_POSITION());
364
    static ElementPtr create(const long int i,
365
                             const Position& pos = ZERO_POSITION());
366 367 368 369 370 371
    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());
372 373
    // need both std:string and char *, since c++ will match
    // bool before std::string when you pass it a char *
374
    static ElementPtr create(const char *s,
375
                             const Position& pos = ZERO_POSITION());
376 377

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

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

390

391 392
    /// \name Compound factory functions

Jelte Jansen's avatar
Jelte Jansen committed
393 394
    /// \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
395
    /// error, an exception of the type isc::data::JSONError is thrown.
396 397

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

404 405 406
    /// Creates an Element from the given input stream containing JSON
    /// formatted data.
    ///
407 408 409
    /// \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
410
    static ElementPtr fromJSON(std::istream& in) throw(JSONError);
411 412
    static ElementPtr fromJSON(std::istream& in, const std::string& file_name)
        throw(JSONError);
413

414 415 416
    /// Creates an Element from the given input stream, where we keep
    /// track of the location in the stream for error reporting.
    ///
417 418
    /// \param in The string to parse the element from.
    /// \param file The input file name.
419 420
    /// \param line A reference to the int where the function keeps
    /// track of the current line.
421
    /// \param pos A reference to the int where the function keeps
422 423 424 425
    /// 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?
426 427 428
    static ElementPtr fromJSON(std::istream& in, const std::string& file,
                               int& line, int &pos)
        throw(JSONError);
429 430
    //@}

431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
    /// \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);

447 448 449 450 451
    /// \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.
452

453 454 455
    //@{
    /// Creates an Element from the wire format in the given
    /// stringstream of the given length.
Jelte Jansen's avatar
Jelte Jansen committed
456
    /// Since the wire format is JSON, thise is the same as
457
    /// fromJSON, and could be removed.
Jelte Jansen's avatar
Jelte Jansen committed
458
    ///
459 460 461 462
    /// \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
463

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

474 475 476 477 478
/// 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,
479
///           three (long long, long, int) override function definitions
480 481 482 483
///           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.
///
484
class IntElement : public Element {
485 486
    int64_t i;
private:
487 488

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

class DoubleElement : public Element {
    double d;

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

class BoolElement : public Element {
    bool b;

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

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

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

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

class ListElement : public Element {
554
    std::vector<ConstElementPtr> l;
555 556

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

class MapElement : public Element {
586
    std::map<std::string, ConstElementPtr> m;
587 588

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

618 619 620 621 622
    // 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
623
    ConstElementPtr find(const std::string& id) const;
624 625 626

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

631
    bool equals(const Element& other) const;
632 633 634 635 636
};

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

639 640
///
/// \brief Remove all values from the first ElementPtr that are
641
/// equal in the second. Both ElementPtrs MUST be MapElements
642 643 644 645
/// 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
646 647 648 649 650 651 652 653
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);
654

655 656 657 658 659
/// \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
660 661 662 663 664 665
/// 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).
666
/// Raises a TypeError if either ElementPtr is not a MapElement
667
void merge(ElementPtr element, ConstElementPtr other);
668

669 670 671 672 673 674 675 676 677 678 679 680 681
///
/// \brief Insert Element::Position as a string into stream.
///
/// This operator converts the \c Element::Position into a string and
/// inserts it into the output stream \c out.
///
/// \param out A \c std::ostream object on which the insertion operation is
/// performed.
/// \param pos The \c Element::Position structure to insert.
/// \return A reference to the same \c std::ostream object referenced by
/// parameter \c out after the insertion operation.
std::ostream& operator<<(std::ostream& out, const Element::Position& pos);

682 683 684
///
/// \brief Insert the Element as a string into stream.
///
685
/// This method converts the \c ElementPtr into a string with
686 687 688 689 690 691
/// \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.
///
692
/// \param out A \c std::ostream object on which the insertion operation is
693 694 695
/// performed.
/// \param e The \c ElementPtr object to insert.
/// \return A reference to the same \c std::ostream object referenced by
696
/// parameter \c out after the insertion operation.
697
std::ostream& operator<<(std::ostream& out, const Element& e);
698

699 700
bool operator==(const Element& a, const Element& b);
bool operator!=(const Element& a, const Element& b);
JINMEI Tatuya's avatar
JINMEI Tatuya committed
701
} }
702
#endif // ISC_DATA_H
703

704
// Local Variables:
705
// mode: c++
706
// End: