WebCore/NodeFilter.h

   1 /*
   2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
   3  * Copyright (C) 2000 Frederik Holljen (frederik.holljen@hig.no)
   4  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
   5  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
   6  * Copyright (C) 2004, 2008 Apple Inc. All rights reserved.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library 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 GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public License
  19  * along with this library; see the file COPYING.LIB.  If not, write to
  20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  *
  23  */
  24
  25 #ifndef NodeFilter_h
  26 #define NodeFilter_h
  27
  28 #include "JSDOMBinding.h"
  29 #include "NodeFilterCondition.h"
  30 #include <wtf/PassRefPtr.h>
  31 #include <wtf/RefPtr.h>
  32
  33 namespace WebCore {
  34
  35     class NodeFilter : public RefCounted<NodeFilter> {
  36     public:
  37         /**
  38          * The following constants are returned by the acceptNode()
  39          * method:
  40          */
  41         enum {
  42             FILTER_ACCEPT = 1,
  43             FILTER_REJECT = 2,
  44             FILTER_SKIP   = 3
  45         };
  46
  47         /**
  48          * These are the available values for the whatToShow parameter.
  49          * They are the same as the set of possible types for Node, and
  50          * their values are derived by using a bit position corresponding
  51          * to the value of NodeType for the equivalent node type.
  52          */
  53         enum {
  54             SHOW_ALL                       = 0xFFFFFFFF,
  55             SHOW_ELEMENT                   = 0x00000001,
  56             SHOW_ATTRIBUTE                 = 0x00000002,
  57             SHOW_TEXT                      = 0x00000004,
  58             SHOW_CDATA_SECTION             = 0x00000008,
  59             SHOW_ENTITY_REFERENCE          = 0x00000010,
  60             SHOW_ENTITY                    = 0x00000020,
  61             SHOW_PROCESSING_INSTRUCTION    = 0x00000040,
  62             SHOW_COMMENT                   = 0x00000080,
  63             SHOW_DOCUMENT                  = 0x00000100,
  64             SHOW_DOCUMENT_TYPE             = 0x00000200,
  65             SHOW_DOCUMENT_FRAGMENT         = 0x00000400,
  66             SHOW_NOTATION                  = 0x00000800
  67         };
  68
  69         static PassRefPtr<NodeFilter> create(PassRefPtr<NodeFilterCondition> condition)
  70         {
  71             return adoptRef(new NodeFilter(condition));
  72         }
  73
  74         short acceptNode(ScriptState*, Node*) const;
  75         void mark() { m_condition->mark(); };
  76
  77         // For non-JS bindings. Silently ignores the JavaScript exception if any.
  78         short acceptNode(Node* node) const { return acceptNode(scriptStateFromNode(node), node); }
  79
  80     private:
  81         NodeFilter(PassRefPtr<NodeFilterCondition> condition) : m_condition(condition) { }
  82
  83         RefPtr<NodeFilterCondition> m_condition;
  84     };
  85
  86 } // namespace WebCore
  87
  88 #endif // NodeFilter_h