1 // Copyright 2008, Google Inc. All rights reserved.
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are met:
5 //
6 // 1. Redistributions of source code must retain the above copyright notice,
7 // this list of conditions and the following disclaimer.
8 // 2. Redistributions in binary form must reproduce the above copyright notice,
9 // this list of conditions and the following disclaimer in the documentation
10 // and/or other materials provided with the distribution.
11 // 3. Neither the name of Google Inc. nor the names of its contributors may be
12 // used to endorse or promote products derived from this software without
13 // specific prior written permission.
14 //
15 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
16 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
17 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
18 // EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
24 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25
26 // This file contains function templates useful for accessing link element data.
27
28 #ifndef KML_ENGINE_LINK_UTIL_H__
29 #define KML_ENGINE_LINK_UTIL_H__
30
31 #include "kml/dom.h"
32 #include "kml/engine.h"
33
34 namespace kmlengine {
35
36 // This function fetches and parses the KML referenced by this NetworkLink.
37 // The NetworkLink must be within the KmlFile and the KmlFile must point to
38 // a KmlCache (such as a KmlFile created by KmlCache).
39 // If the fetch or parse fail a NULL KmlFilePtr is returned.
40 KmlFilePtr FetchLink(const KmlFilePtr& kml_file,
41 const kmldom::NetworkLinkPtr& networklink);
42
43 // This function fetches the Overlay's Icon image data. The KmlFile must have
44 // a KmlCache (see KmlCache). If the fetch fails false is returned.
45 bool FetchIcon(const KmlFilePtr& kml_file,
46 const kmldom::OverlayPtr& overlay,
47 string* data);
48
49
50 // This function template gets the content of the <href> child of <Link>,
51 // <Icon>, <ItemIcon> and <IconStyle>'s <Icon>. This returns true if both
52 // arguments are non-NULL and if the has_href() test passes for the parent,
53 // else false is returned. (It is safe to pass all or some NULL arguments).
54 template<typename HP>
GetHref(const HP & href_parent,string * href)55 bool GetHref(const HP& href_parent, string* href) {
56 if (href && href_parent && href_parent->has_href()) {
57 *href = href_parent->get_href();
58 return true;
59 }
60 return false;
61 }
62
63 // This function template gets the content of the <href> of the <Link> child
64 // of <NetworkLink> and <Model>. See GetHref() for info about the return.
65 template<typename LP>
GetLinkParentHref(const LP & link_parent,string * href)66 bool GetLinkParentHref(const LP& link_parent, string* href) {
67 return GetHref(link_parent->get_link(), href);
68 }
69
70 // This function template gets the content of the <href> of the <Icon> child
71 // of any Overlay, or of <IconStyle>. See GetHref() for info about the return.
72 template<typename IP>
GetIconParentHref(const IP & icon_parent,string * href)73 bool GetIconParentHref(const IP& icon_parent, string* href) {
74 return GetHref(icon_parent->get_icon(), href);
75 }
76
77 } // end namespace kmlengine
78
79 #endif // KML_ENGINE_LINK_UTIL_H__
80