2006-09-25 Anders Carlsson <acarlsson@apple.com>
[WebKit-https.git] / WebCore / css / MediaList.cpp
1 /**
2  * This file is part of the DOM implementation for KDE.
3  *
4  * (C) 1999-2003 Lars Knoll (knoll@kde.org)
5  * Copyright (C) 2004, 2006 Apple Computer, Inc.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22 #include "config.h"
23 #include "MediaList.h"
24
25 #include "CSSRule.h"
26 #include "CSSStyleSheet.h"
27 #include "ExceptionCode.h"
28 #include "MediaQuery.h"
29 #include "cssparser.h"
30
31
32 namespace WebCore {
33
34 /* MediaList is used to store 3 types of media related entities which mean the same:
35  * Media Queries, Media Types and Media Descriptors.
36  * Currently MediaList always tries to parse media queries and if parsing fails,
37  * tries to fallback to Media Descriptors if m_fallback flag is set.
38  * Slight problem with syntax error handling:
39  * CSS 2.1 Spec (http://www.w3.org/TR/CSS21/media.html)
40  * specifies that failing media type parsing is a syntax error
41  * CSS 3 Media Queries Spec (http://www.w3.org/TR/css3-mediaqueries/)
42  * specifies that failing media query is a syntax error
43  * HTML 4.01 spec (http://www.w3.org/TR/REC-html40/present/styles.html#adef-media)
44  * specifies that Media Descriptors should be parsed with forward-compatible syntax
45  * DOM Level 2 Style Sheet spec (http://www.w3.org/TR/DOM-Level-2-Style/)
46  * talks about MediaList.mediaText and refers
47  *   -  to Media Descriptors of HTML 4.0 in context of StyleSheet
48  *   -  to Media Types of CSS 2.0 in context of CSSMediaRule and CSSImportRule
49  *
50  * These facts create situation where same (illegal) media specification may result in
51  * different parses depending on whether it is media attr of style element or part of
52  * css @media rule.
53  * <style media="screen and resolution > 40dpi"> ..</style> will be enabled on screen devices where as
54  * @media screen and resolution > 40dpi {..} will not.
55  * This gets more counter-intuitive in JavaScript:
56  * document.styleSheets[0].media.mediaText = "screen and resolution > 40dpi" will be ok and
57  * enabled, while
58  * document.styleSheets[0].cssRules[0].media.mediaText = "screen and resolution > 40dpi" will
59  * throw SYNTAX_ERR exception.
60  */
61
62 MediaList::MediaList(CSSStyleSheet* parentSheet, bool fallbackToDescriptor)
63     : StyleBase(parentSheet)
64     , m_fallback(fallbackToDescriptor)
65 {
66 }
67
68 MediaList::MediaList(CSSStyleSheet* parentSheet, const String& media, bool fallbackToDescriptor)
69     : StyleBase(parentSheet)
70     , m_fallback(fallbackToDescriptor)
71 {
72     ExceptionCode ec = 0;
73     setMediaText(media, ec);
74     // FIXME: parsing can fail. The problem with failing constructor is that
75     // we would need additional flag saying MediaList is not valid
76     // Parse can fail only when fallbackToDescriptor == false, i.e when HTML4 media descriptor
77     // forward-compatible syntax is not in use. 
78     // DOMImplementationCSS seems to mandate that media descriptors are used
79     // for both html and svg, even though svg:style doesn't use media descriptors
80     // Currently the only places where parsing can fail are
81     // creating <svg:style>, creating css media / import rules from js
82     if (ec)
83         setMediaText("invalid", ec);
84 }
85
86 MediaList::MediaList(CSSRule* parentRule, const String& media, bool fallbackToDescriptor)
87     : StyleBase(parentRule)
88     , m_fallback(fallbackToDescriptor)
89 {
90     ExceptionCode ec = 0;
91     setMediaText(media, ec);
92     //FIXME: parsing can fail.
93     if (ec)
94         setMediaText("invalid", ec);
95 }
96
97 MediaList::~MediaList()
98 {
99     deleteAllValues(m_queries);
100 }
101
102 CSSStyleSheet *MediaList::parentStyleSheet() const
103 {
104     return parent()->isCSSStyleSheet() ? static_cast<CSSStyleSheet*>(parent()) : 0;
105 }
106
107 CSSRule *MediaList::parentRule() const
108 {
109     return parent()->isRule() ? static_cast<CSSRule*>(parent()) : 0;
110 }
111
112 static String parseMediaDescriptor(const String& s)
113 {
114     int len = s.length();
115
116     // http://www.w3.org/TR/REC-html40/types.html#type-media-descriptors
117     // "Each entry is truncated just before the first character that isn't a
118     // US ASCII letter [a-zA-Z] (ISO 10646 hex 41-5a, 61-7a), digit [0-9] (hex 30-39),
119     // or hyphen (hex 2d)."
120     int i;
121     unsigned short c;
122     for (i = 0; i < len; ++i) {
123         c = s[i];
124         if (! ((c >= 'a' && c <= 'z')
125             || (c >= 'A' && c <= 'Z')
126             || (c >= '1' && c <= '9')
127             || (c == '-')))
128             break;
129     }
130     return s.left(i);
131 }
132
133 void MediaList::deleteMedium(const String& oldMedium, ExceptionCode& ec)
134 {
135     MediaList tempMediaList;
136     CSSParser p(true);
137
138     MediaQuery* oldQuery = 0;
139     bool deleteOldQuery = false;
140
141     if (p.parseMediaQuery(&tempMediaList, oldMedium)) {
142         if (tempMediaList.m_queries.size() > 0)
143             oldQuery = tempMediaList.m_queries[0];
144     } else if (m_fallback) {
145         String medium = parseMediaDescriptor(oldMedium);
146         if (!medium.isNull()) {
147             oldQuery = new MediaQuery(MediaQuery::None, medium, 0);
148             deleteOldQuery = true;
149         }
150     }
151
152     // DOM Style Sheets spec doesn't allow SYNTAX_ERR to be thrown in deleteMedium
153     ec = NOT_FOUND_ERR;
154
155     if (oldQuery) {
156         for(size_t i = 0; i < m_queries.size(); ++i) {
157             MediaQuery* a = m_queries[i];
158             if (*a == *oldQuery) {
159                 m_queries.remove(i);
160                 delete a;
161                 ec = 0;
162                 break;
163             }
164         }
165         if (deleteOldQuery)
166             delete oldQuery;
167     }
168 }
169
170 String MediaList::mediaText() const
171 {
172     String text("");
173
174     bool first = true;
175     for (size_t i = 0; i < m_queries.size(); ++i) {
176         if (!first)
177             text += ", ";
178         else
179             first = false;
180         text += m_queries[i]->cssText();
181     }
182
183     return text;
184 }
185
186 void MediaList::setMediaText(const String& value, ExceptionCode& ec)
187 {
188     MediaList tempMediaList;
189     CSSParser p(true);
190
191     Vector<String> list = value.split(',');
192     Vector<String>::const_iterator end = list.end();
193     for (Vector<String>::const_iterator it = list.begin(); it != end; ++it) {
194         String medium = (*it).stripWhiteSpace();
195         if (!medium.isEmpty()) {
196             if (!p.parseMediaQuery(&tempMediaList, medium)) {
197                 if (m_fallback) {
198                     String mediaDescriptor = parseMediaDescriptor(medium);
199                     if (!mediaDescriptor.isNull())
200                         tempMediaList.m_queries.append(new MediaQuery(MediaQuery::None, mediaDescriptor, 0));
201                 } else {
202                     ec = SYNTAX_ERR;
203                     return;
204                 }
205             }          
206         } else if (!m_fallback) {
207             ec = SYNTAX_ERR;
208             return;
209         }            
210     }
211     // ",,,," falls straight through, but is not valid unless fallback
212     if (!m_fallback && list.begin() == list.end()) {
213         String s = value.stripWhiteSpace();
214         if (!s.isEmpty()) {
215             ec = SYNTAX_ERR;
216             return;
217         }
218     }
219     
220     ec = 0;
221     deleteAllValues(m_queries);
222     m_queries = tempMediaList.m_queries;
223     tempMediaList.m_queries.clear();
224 }
225
226 String MediaList::item(unsigned index) const
227 {
228     if (index < m_queries.size()) {
229         MediaQuery* query = m_queries[index];
230         return query->cssText();
231     }
232
233     return String();
234 }
235
236 void MediaList::appendMedium(const String& newMedium, ExceptionCode& ec)
237 {
238     ec = INVALID_CHARACTER_ERR;
239     CSSParser p(true);
240     if (p.parseMediaQuery(this, newMedium)) {
241         ec = 0;
242     } else if (m_fallback) {
243         String medium = parseMediaDescriptor(newMedium);
244         if (!medium.isNull()) {
245             m_queries.append(new MediaQuery(MediaQuery::None, medium, 0));
246             ec = 0;
247         }
248     }
249 }
250
251 void MediaList::appendMediaQuery(MediaQuery* mediaQuery)
252 {
253     m_queries.append(mediaQuery);
254 }
255
256 }