simgear/package/Package.hxx

   1 // Copyright (C) 2013  James Turner - zakalawe@mac.com
   2 //
   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.
   7 //
   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.
  12 //
  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.
  16 //
  17
  18 #ifndef SG_PACKAGE_PACKAGE_HXX
  19 #define SG_PACKAGE_PACKAGE_HXX
  20
  21 #include <set>
  22 #include <vector>
  23
  24 #include <simgear/props/props.hxx>
  25 #include <simgear/misc/strutils.hxx>
  26
  27 #include <simgear/structure/SGReferenced.hxx>
  28 #include <simgear/structure/SGSharedPtr.hxx>
  29
  30 typedef std::set<std::string> string_set;
  31
  32 namespace simgear
  33 {
  34
  35 namespace pkg
  36 {
  37
  38 // forward decls
  39 class Install;
  40 class Catalog;
  41 class Package;
  42
  43 typedef SGSharedPtr<Package> PackageRef;
  44 typedef SGSharedPtr<Catalog> CatalogRef;
  45 typedef SGSharedPtr<Install> InstallRef;
  46
  47 typedef std::vector<PackageRef> PackageList;
  48
  49   class Package : public SGReferenced
  50 {
  51 public:
  52     /**
  53      * get or create an install for the package
  54      */
  55     InstallRef install();
  56
  57     InstallRef existingInstall() const;
  58
  59     bool isInstalled() const;
  60
  61     std::string id() const;
  62
  63     /**
  64      * Variant IDs. Note the primary ID will always be included as
  65      * variants()[0], to simplify enumerating all variants
  66      */
  67     string_list variants() const;
  68
  69     /**
  70      * Fully-qualified ID, including our catalog'd ID
  71      */
  72     std::string qualifiedId() const;
  73
  74     /**
  75      * human-readable name - note this is probably not localised,
  76      * although this is not ruled out for the future.
  77      */
  78     std::string name() const;
  79
  80     /**
  81      * Human readable name of a variant
  82      */
  83     std::string nameForVariant(const std::string& vid) const;
  84
  85     /**
  86      * syntactic sugar to get the localised description
  87      */
  88     std::string description() const;
  89
  90     /**
  91      * access the raw property data in the package
  92      */
  93     SGPropertyNode* properties() const;
  94
  95     /**
  96      * hex-encoded MD5 sum of the download files
  97      */
  98     std::string md5() const;
  99
 100     std::string getLocalisedProp(const std::string& aName) const;
 101
 102     unsigned int revision() const;
 103
 104     size_t fileSizeBytes() const;
 105
 106     CatalogRef catalog() const
 107         { return m_catalog; }
 108
 109     bool matches(const SGPropertyNode* aFilter) const;
 110
 111     /**
 112      * download URLs for the package
 113      */
 114     string_list downloadUrls() const;
 115
 116     string_list thumbnailUrls() const;
 117
 118     /**
 119      * Packages we depend upon.
 120      * If the dependency list cannot be satisifed for some reason,
 121      * this will raise an sg_exception.
 122      */
 123     PackageList dependencies() const;
 124 private:
 125     SGPath pathOnDisk() const;
 126
 127     friend class Catalog;
 128
 129     Package(const SGPropertyNode* aProps, CatalogRef aCatalog);
 130
 131     void initWithProps(const SGPropertyNode* aProps);
 132
 133     void updateFromProps(const SGPropertyNode* aProps);
 134
 135     std::string getLocalisedString(const SGPropertyNode* aRoot, const char* aName) const;
 136
 137     SGPropertyNode_ptr m_props;
 138     std::string m_id;
 139     string_set m_tags;
 140     CatalogRef m_catalog;
 141 };
 142
 143
 144
 145
 146 } // of namespace pkg
 147
 148 } // of namespace simgear
 149
 150 #endif // of SG_PACKAGE_PACKAGE_HXX
 151