libs/pbd/pbd/stateful.h

   1 /*
   2     Copyright (C) 2000 Paul Davis
   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 #ifndef __pbd_stateful_h__
  21 #define __pbd_stateful_h__
  22
  23 #include <string>
  24 #include "pbd/id.h"
  25
  26 class XMLNode;
  27
  28 namespace PBD {
  29
  30 namespace sys {
  31         class path;
  32 }
  33
  34 class Stateful {
  35   public:
  36         Stateful();
  37         virtual ~Stateful();
  38
  39         virtual XMLNode& get_state (void) = 0;
  40
  41         virtual int set_state (const XMLNode&, int version) = 0;
  42
  43         /* Extra XML nodes */
  44
  45         void add_extra_xml (XMLNode&);
  46         XMLNode *extra_xml (const std::string& str);
  47
  48         const PBD::ID& id() const { return _id; }
  49
  50         static int current_state_version;
  51         static int loading_state_version;
  52
  53   protected:
  54
  55         void add_instant_xml (XMLNode&, const sys::path& directory_path);
  56         XMLNode *instant_xml (const std::string& str, const sys::path& directory_path);
  57
  58         XMLNode *_extra_xml;
  59         XMLNode *_instant_xml;
  60         PBD::ID _id;
  61 };
  62
  63 } // namespace PBD
  64
  65 #endif /* __pbd_stateful_h__ */
  66