src/parse/asset_map.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/asset_map.h
  21  *  @brief Classes used to parse a AssetMap.
  22  */
  23
  24 #include <stdint.h>
  25 #include <boost/shared_ptr.hpp>
  26 #include <libcxml/cxml.h>
  27
  28 namespace dcp {
  29
  30 namespace parse {
  31
  32 /** @class Chunk
  33  *  @brief A simple parser for and representation of a \<Chunk\> node within an asset map.
  34  */
  35 class Chunk
  36 {
  37 public:
  38         Chunk ();
  39         Chunk (boost::shared_ptr<const cxml::Node> node);
  40
  41         std::string path;
  42         int64_t volume_index;
  43         int64_t offset;
  44         int64_t length;
  45 };
  46
  47 /** @class AssetMapAsset
  48  *  @brief A simple parser for and representation of an \<AssetMap\> node within an asset map.
  49  */
  50 class AssetMapAsset
  51 {
  52 public:
  53         AssetMapAsset ();
  54         AssetMapAsset (boost::shared_ptr<const cxml::Node> node);
  55
  56         std::string id;
  57         std::string packing_list;
  58         std::list<boost::shared_ptr<Chunk> > chunks;
  59 };
  60
  61 /** @class AssetMap
  62  *  @brief A simple parser for and representation of an asset map file.
  63  */
  64 class AssetMap
  65 {
  66 public:
  67         AssetMap (std::string file);
  68
  69         boost::shared_ptr<AssetMapAsset> asset_from_id (std::string id) const;
  70
  71         std::string id;
  72         std::string creator;
  73         int64_t volume_count;
  74         std::string issue_date;
  75         std::string issuer;
  76         std::list<boost::shared_ptr<AssetMapAsset> > assets;
  77 };
  78
  79 }
  80
  81 }