Integrate most of GoogleURL in WTFURL
[WebKit-https.git] / Source / WTF / wtf / url / src / URLSegments.h
1 /*
2  * Copyright 2007 Google Inc. All rights reserved.
3  * Copyright 2012 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef URLSegments_h
33 #define URLSegments_h
34
35 #include "URLComponent.h"
36 #include <wtf/OwnPtr.h>
37 #include <wtf/PassOwnPtr.h>
38
39 #if USE(WTFURL)
40
41 namespace WTF {
42
43 class URLSegments;
44
45 // A structure that holds the identified parts of an input URL. This structure
46 // does NOT store the URL itself. The caller will have to store the URL text
47 // and its corresponding Parsed structure separately.
48 class URLSegments {
49 public:
50     // Identifies different components.
51     enum ComponentType {
52         Scheme,
53         Username,
54         Password,
55         Host,
56         Port,
57         Path,
58         Query,
59         Fragment,
60     };
61     enum DelimiterInclusion {
62         DelimiterExcluded,
63         DelimiterIncluded
64     };
65
66     URLSegments() { }
67
68     URLSegments(const URLSegments& otherSegment)
69     {
70         *this = otherSegment;
71     }
72
73     URLSegments& operator=(const URLSegments& otherSegment)
74     {
75         scheme = otherSegment.scheme;
76         username = otherSegment.username;
77         password = otherSegment.password;
78         host = otherSegment.host;
79         port = otherSegment.port;
80         path = otherSegment.path;
81         query = otherSegment.query;
82         fragment = otherSegment.fragment;
83         if (otherSegment.m_innerURLSegments)
84             m_innerURLSegments = adoptPtr(new URLSegments(*otherSegment.m_innerURLSegments));
85             return *this;
86     }
87
88     // Returns the length of the URL (the end of the last component).
89     //
90     // Note that for some invalid, non-canonical URLs, this may not be the length
91     // of the string. For example "http://": the parsed structure will only
92     // contain an entry for the four-character scheme, and it doesn't know about
93     // the "://". For all other last-components, it will return the real length.
94     int length() const;
95
96     // Returns the number of characters before the given component if it exists,
97     // or where the component would be if it did exist. This will return the
98     // string length if the component would be appended to the end.
99     //
100     // Note that this can get a little funny for the port, query, and fragment
101     // components which have a delimiter that is not counted as part of the
102     // component. The |includeDelimiter| flag controls if you want this counted
103     // as part of the component or not when the component exists.
104     //
105     // This example shows the difference between the two flags for two of these
106     // delimited components that is present (the port and query) and one that
107     // isn't (the reference). The components that this flag affects are marked
108     // with a *.
109     //                 0         1         2
110     //                 012345678901234567890
111     // Example input: http://foo:80/?query
112     //              include_delim=true,  ...=false  ("<-" indicates different)
113     //      Scheme: 0                    0
114     //    Username: 5                    5
115     //    Password: 5                    5
116     //        Host: 7                    7
117     //       *Port: 10                   11 <-
118     //        Path: 13                   13
119     //      *Query: 14                   15 <-
120     //        *Fragment: 20                   20
121     //
122     int charactersBefore(ComponentType, DelimiterInclusion) const;
123
124     // Each component excludes the related delimiters and has a length of -1
125     // if that component is absent but 0 if the component exists but is empty.
126     URLComponent scheme;
127     URLComponent username;
128     URLComponent password;
129     URLComponent host;
130     URLComponent port;
131     URLComponent path;
132     URLComponent query;
133     URLComponent fragment;
134
135     // FIXME: this is a damn ugly API and is basically untested.
136     const URLSegments* innerURLSegments() const { return m_innerURLSegments.get(); }
137     void setInnerURLSegments(const URLSegments& urlSegments) { m_innerURLSegments = adoptPtr(new URLSegments(urlSegments)); }
138     void clearInnerURLSegments() { return m_innerURLSegments.clear(); }
139
140 private:
141     // The Filesystem API describe a URL format with an internal URL. E.g.: filesystem:http://www.apple.com/
142     // The inner URL segment contains the parsed inner URL of a filesystem: URL.
143     OwnPtr<URLSegments> m_innerURLSegments;
144 };
145
146 } // namespace WTF
147
148 #endif // USE(WTFURL)
149
150 #endif // URLSegments_h