1 // Copyright (C) 2013 James Turner - zakalawe@mac.com
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Library General Public
5 // License as published by the Free Software Foundation; either
6 // version 2 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Library General Public License for more details.
13 // You should have received a copy of the GNU General Public License
14 // along with this program; if not, write to the Free Software
15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 #ifndef SG_PACKAGE_PACKAGE_HXX
19 #define SG_PACKAGE_PACKAGE_HXX
24 #include <simgear/props/props.hxx>
25 #include <simgear/misc/strutils.hxx>
27 #include <simgear/structure/SGReferenced.hxx>
28 #include <simgear/structure/SGSharedPtr.hxx>
30 typedef std::set<std::string> string_set;
43 typedef SGSharedPtr<Package> PackageRef;
44 typedef SGSharedPtr<Catalog> CatalogRef;
45 typedef SGSharedPtr<Install> InstallRef;
47 typedef std::vector<PackageRef> PackageList;
49 class Package : public SGReferenced
53 * get or create an install for the package
57 bool isInstalled() const;
59 std::string id() const;
62 * human-readable name - note this is probably not localised,
63 * although this is not ruled out for the future.
65 std::string name() const;
68 * syntactic sugar to get the localised description
70 std::string description() const;
73 * access the raw property data in the package
75 SGPropertyNode* properties() const;
78 * hex-encoded MD5 sum of the download files
80 std::string md5() const;
82 std::string getLocalisedProp(const std::string& aName) const;
84 unsigned int revision() const;
86 CatalogRef catalog() const
89 bool matches(const SGPropertyNode* aFilter) const;
92 * download URLs for the package
94 string_list downloadUrls() const;
96 string_list thumbnailUrls() const;
99 * Packages we depend upon.
100 * If the dependency list cannot be satisifed for some reason,
101 * this will raise an sg_exception.
103 PackageList dependencies() const;
105 friend class Catalog;
107 Package(const SGPropertyNode* aProps, CatalogRef aCatalog);
109 void initWithProps(const SGPropertyNode* aProps);
111 std::string getLocalisedString(const SGPropertyNode* aRoot, const char* aName) const;
113 SGPropertyNode_ptr m_props;
115 CatalogRef m_catalog;
121 } // of namespace pkg
123 } // of namespace simgear
125 #endif // of SG_PACKAGE_PACKAGE_HXX