src/third_party/WebKit/public/web/WebNodeCollection.h

   1 /*
   2  * Copyright (C) 2009 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebNodeCollection_h
  32 #define WebNodeCollection_h
  33
  34 #include "../platform/WebCommon.h"
  35
  36 namespace WebCore { class HTMLCollection; }
  37 #if BLINK_IMPLEMENTATION
  38 namespace WTF { template <typename T> class PassRefPtr; }
  39 #endif
  40
  41 namespace blink {
  42 class WebNode;
  43
  44 // Provides readonly access to some properties of a DOM node.
  45 class WebNodeCollection {
  46 public:
  47     ~WebNodeCollection() { reset(); }
  48
  49     WebNodeCollection() : m_private(0), m_current(0) { }
  50     WebNodeCollection(const WebNodeCollection& n) : m_private(0) { assign(n); }
  51     WebNodeCollection& operator=(const WebNodeCollection& n)
  52     {
  53         assign(n);
  54         return *this;
  55     }
  56
  57     bool isNull() const { return !m_private; }
  58
  59     BLINK_EXPORT void reset();
  60     BLINK_EXPORT void assign(const WebNodeCollection&);
  61
  62     BLINK_EXPORT unsigned length() const;
  63     BLINK_EXPORT WebNode nextItem() const;
  64     BLINK_EXPORT WebNode firstItem() const;
  65
  66 #if BLINK_IMPLEMENTATION
  67     WebNodeCollection(const WTF::PassRefPtr<WebCore::HTMLCollection>&);
  68 #endif
  69
  70 private:
  71     void assign(WebCore::HTMLCollection*);
  72     WebCore::HTMLCollection* m_private;
  73     mutable unsigned m_current;
  74 };
  75
  76 } // namespace blink
  77
  78 #endif