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, 2009, 2015 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#pragma once
26
27#include "ActiveDOMCallback.h"
28#include "CallbackResult.h"
29#include <wtf/RefCounted.h>
30
31namespace WebCore {
32
33class Node;
34
35class NodeFilter : public RefCounted<NodeFilter>, public ActiveDOMCallback {
36public:
37 using ActiveDOMCallback::ActiveDOMCallback;
38
39 virtual CallbackResult<unsigned short> acceptNode(Node&) = 0;
40
41 virtual bool hasCallback() const = 0;
42
43 /*
44 * The following constants are returned by the acceptNode()
45 * method:
46 */
47 enum {
48 FILTER_ACCEPT = 1,
49 FILTER_REJECT = 2,
50 FILTER_SKIP = 3
51 };
52
53 /*
54 * These are the available values for the whatToShow parameter.
55 * They are the same as the set of possible types for Node, and
56 * their values are derived by using a bit position corresponding
57 * to the value of NodeType for the equivalent node type.
58 */
59 enum : unsigned long {
60 SHOW_ALL = 0xFFFFFFFF,
61 SHOW_ELEMENT = 0x00000001,
62 SHOW_ATTRIBUTE = 0x00000002,
63 SHOW_TEXT = 0x00000004,
64 SHOW_CDATA_SECTION = 0x00000008,
65 SHOW_ENTITY_REFERENCE = 0x00000010,
66 SHOW_ENTITY = 0x00000020,
67 SHOW_PROCESSING_INSTRUCTION = 0x00000040,
68 SHOW_COMMENT = 0x00000080,
69 SHOW_DOCUMENT = 0x00000100,
70 SHOW_DOCUMENT_TYPE = 0x00000200,
71 SHOW_DOCUMENT_FRAGMENT = 0x00000400,
72 SHOW_NOTATION = 0x00000800
73 };
74};
75
76} // namespace WebCore
77