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 class Stateful {
  31   public:
  32         Stateful();
  33         virtual ~Stateful();
  34
  35         virtual XMLNode& get_state (void) = 0;
  36
  37         virtual int set_state (const XMLNode&) = 0;
  38
  39         /* Extra XML nodes */
  40
  41         void add_extra_xml (XMLNode&);
  42         XMLNode *extra_xml (const std::string& str);
  43
  44         const PBD::ID& id() const { return _id; }
  45
  46   protected:
  47
  48         void add_instant_xml (XMLNode&, const std::string& dir);
  49         XMLNode *instant_xml (const std::string& str, const std::string& dir);
  50
  51         XMLNode *_extra_xml;
  52         XMLNode *_instant_xml;
  53         PBD::ID _id;
  54 };
  55
  56 } // namespace PBD
  57
  58 #endif /* __pbd_stateful_h__ */
  59