File: HtmlElementDescription.java

package info (click to toggle)
ruby-nokogiri 1.11.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 5,576 kB
  • sloc: xml: 28,086; ruby: 18,456; java: 13,067; ansic: 5,138; yacc: 265; sh: 208; makefile: 27
file content (148 lines) | stat: -rw-r--r-- 5,218 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/**
 * (The MIT License)
 *
 * Copyright (c) 2008 - 2012:
 *
 * * {Aaron Patterson}[http://tenderlovemaking.com]
 * * {Mike Dalessio}[http://mike.daless.io]
 * * {Charles Nutter}[http://blog.headius.com]
 * * {Sergio Arbeo}[http://www.serabe.com]
 * * {Patrick Mahoney}[http://polycrystal.org]
 * * {Yoko Harada}[http://yokolet.blogspot.com]
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * 'Software'), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package nokogiri;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.cyberneko.html.HTMLElements;
import org.jruby.Ruby;
import org.jruby.RubyClass;
import org.jruby.RubyObject;
import org.jruby.anno.JRubyClass;
import org.jruby.anno.JRubyMethod;
import org.jruby.runtime.ThreadContext;
import org.jruby.runtime.builtin.IRubyObject;

/**
 * Class for Nokogiri::HTML::ElementDescription.
 * 
 * @author Patrick Mahoney <pat@polycrystal.org>
 */
@JRubyClass(name="Nokogiri::HTML::ElementDescription")
public class HtmlElementDescription extends RubyObject {

    /**
     * Stores memoized hash of element -> list of valid subelements.
     */
    static protected Map<Short, List<String>> subElements;
    static {
        Map<Short, List<String>> _subElements =
            new HashMap<Short, List<String>>();
        subElements = Collections.synchronizedMap(_subElements);
    }

    protected HTMLElements.Element element;

    public HtmlElementDescription(Ruby runtime, RubyClass rubyClass) {
        super(runtime, rubyClass);
    }

    /**
     * Lookup the list of sub elements of <code>code</code>.  If not
     * already stored, iterate through all elements to find valid
     * subelements; save this list and return it.
     */
    protected static List<String> findSubElements(HTMLElements.Element elem) {
        List<String> subs = subElements.get(elem.code);

        if (subs == null) {
            subs = new ArrayList<String>();

            /*
             * A bit of a hack.  NekoHtml source code shows that
             * UNKNOWN is the highest value element.  We cannot access
             * the list of elements directly because it's protected.
             */
            for (short c = 0; c < HTMLElements.UNKNOWN; c++) {
                HTMLElements.Element maybe_sub =
                    HTMLElements.getElement(c);
                if (maybe_sub.isParent(elem)) {
                    subs.add(maybe_sub.name);
                }
            }

            subElements.put(elem.code, subs);
        }

        return subs;
    }

    @JRubyMethod(name="[]", meta=true)
    public static IRubyObject get(ThreadContext context,
                                  IRubyObject klazz, IRubyObject name) {

        // nekohtml will return an element even for invalid names, see
        // http://sourceforge.net/p/nekohtml/code/HEAD/tree/trunk/src/org/cyberneko/html/HTMLElements.java#l514
        // which breaks `test_fetch_nonexistent'
        HTMLElements.Element elem = HTMLElements.getElement(name.asJavaString(), HTMLElements.NO_SUCH_ELEMENT);
        if (elem == HTMLElements.NO_SUCH_ELEMENT)
            return context.nil;

        HtmlElementDescription desc =
            new HtmlElementDescription(context.getRuntime(), (RubyClass)klazz);
        desc.element = elem;
        return desc;
    }

    @JRubyMethod()
    public IRubyObject name(ThreadContext context) {
        return context.getRuntime().newString(element.name.toLowerCase());
    }

    @JRubyMethod(name="inline?")
    public IRubyObject inline_eh(ThreadContext context) {
        return context.getRuntime().newBoolean(element.isInline());
    }

    @JRubyMethod(name="empty?")
    public IRubyObject empty_eh(ThreadContext context) {
        return context.getRuntime().newBoolean(element.isEmpty());
    }

    @JRubyMethod()
    public IRubyObject sub_elements(ThreadContext context) {
        Ruby ruby = context.getRuntime();
        List<String> subs = findSubElements(element);
        IRubyObject[] ary = new IRubyObject[subs.size()];
        for (int i = 0; i < subs.size(); ++i) {
            ary[i] = ruby.newString(subs.get(i));
        }

        return ruby.newArray(ary);
    }

}