enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[ardour.git] / libs / ardour / session_command.cc
index 72bc3f23d71e29aae9863afebd39d306bba55787..a99738a613dea2bab463323c5ee49d23012a4613 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2007 Paul Davis 
+    Copyright (C) 2000-2007 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include <ardour/session.h>
-#include <ardour/route.h>
-#include <pbd/memento_command.h>
-#include <ardour/diskstream.h>
-#include <ardour/playlist.h>
-#include <ardour/audioplaylist.h>
-#include <ardour/audio_track.h>
-#include <ardour/midi_playlist.h>
-#include <ardour/midi_track.h>
-#include <ardour/tempo.h>
-#include <ardour/audiosource.h>
-#include <ardour/audioregion.h>
-#include <ardour/midi_source.h>
-#include <ardour/midi_region.h>
-#include <pbd/error.h>
-#include <pbd/id.h>
-#include <pbd/statefuldestructible.h>
-#include <pbd/failed_constructor.h>
+#include <string>
+
+#include "ardour/automation_list.h"
+#include "ardour/location.h"
+#include "ardour/midi_automation_list_binder.h"
+#include "ardour/playlist.h"
+#include "ardour/region.h"
+#include "ardour/region_factory.h"
+#include "ardour/route.h"
+#include "ardour/session.h"
+#include "ardour/session_playlists.h"
+#include "ardour/source.h"
+#include "ardour/tempo.h"
+#include "evoral/Curve.hpp"
+#include "pbd/error.h"
+#include "pbd/failed_constructor.h"
+#include "pbd/id.h"
+#include "pbd/memento_command.h"
+#include "pbd/stateful_diff_command.h"
+#include "pbd/statefuldestructible.h"
+
+class Command;
 
 using namespace PBD;
 using namespace ARDOUR;
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
-void Session::register_with_memento_command_factory(PBD::ID id, PBD::StatefulThingWithGoingAway *ptr)
+void Session::register_with_memento_command_factory(PBD::ID id, PBD::StatefulDestructible *ptr)
 {
     registry[id] = ptr;
 }
-    
+
 Command *
 Session::memento_command_factory(XMLNode *n)
 {
@@ -54,7 +58,12 @@ Session::memento_command_factory(XMLNode *n)
     XMLNode *child = 0;
 
     /* get id */
-    id = PBD::ID(n->property("obj_id")->value());
+
+    /* XXX: HACK! */
+    bool have_id = n->property("obj-id") != 0;
+    if (have_id) {
+           id = PBD::ID(n->property("obj-id")->value());
+    }
 
     /* get before/after */
 
@@ -72,473 +81,101 @@ Session::memento_command_factory(XMLNode *n)
            before = new XMLNode(*n->children().front());
            after = new XMLNode(*n->children().back());
            child = before;
-    } 
-                   
-    if (!child)
-    {
-       error << _("Tried to reconstitute a MementoCommand with no contents, failing. id=") << id.to_s() << endmsg;
-       return 0;
+    }
+
+    if (!child) {
+           error << string_compose (_("Tried to reconstitute a MementoCommand with no contents, failing. id=%1"), id.to_s()) << endmsg;
+           return 0;
     }
 
     /* create command */
-    string obj_T = n->property ("type_name")->value();
-    if (obj_T == typeid (AudioRegion).name() || obj_T == typeid (MidiRegion).name() || obj_T == typeid (Region).name()) {
-           if (regions.count(id)) {
-                   return new MementoCommand<Region>(*regions[id], before, after);
+    std::string obj_T = n->property ("type-name")->value();
+
+    if (obj_T == "ARDOUR::AudioRegion" || obj_T == "ARDOUR::MidiRegion" || obj_T == "ARDOUR::Region") {
+           boost::shared_ptr<Region> r = RegionFactory::region_by_id (id);
+           if (r) {
+                   return new MementoCommand<Region>(*r, before, after);
            }
-    } else if (obj_T == typeid (AudioSource).name() || obj_T == typeid (MidiSource).name()) {
+
+    } else if (obj_T == "ARDOUR::AudioSource" || obj_T == "ARDOUR::MidiSource") {
            if (sources.count(id))
                    return new MementoCommand<Source>(*sources[id], before, after);
-    } else if (obj_T == typeid (Location).name()) {
-           Location* loc = _locations.get_location_by_id(id);
+
+    } else if (obj_T == "ARDOUR::Location") {
+           Location* loc = _locations->get_location_by_id(id);
            if (loc) {
                    return new MementoCommand<Location>(*loc, before, after);
            }
-    } else if (obj_T == typeid (Locations).name()) {
-           return new MementoCommand<Locations>(_locations, before, after);
-    } else if (obj_T == typeid (TempoMap).name()) {
-           return new MementoCommand<TempoMap>(*_tempo_map, before, after);
-    } else if (obj_T == typeid (Playlist).name() || obj_T == typeid (AudioPlaylist).name() || obj_T == typeid (MidiPlaylist).name()) {
-           if (boost::shared_ptr<Playlist> pl = playlist_by_name(child->property("name")->value())) {
-                   return new MementoCommand<Playlist>(*(pl.get()), before, after);
-           }
-    } else if (obj_T == typeid (Route).name() || obj_T == typeid (AudioTrack).name() || obj_T == typeid(MidiTrack).name()) { 
-           return new MementoCommand<Route>(*route_by_id(id), before, after);
-    } else if (obj_T == typeid (Curve).name() || obj_T == typeid (AutomationList).name()) {
-           if (automation_lists.count(id))
-                   return new MementoCommand<AutomationList>(*automation_lists[id], before, after);
-    } else if (registry.count(id)) { // For Editor and AutomationLine which are off-limits here
-           return new MementoCommand<PBD::StatefulThingWithGoingAway>(*registry[id], before, after);
-    }
 
-    /* we failed */
-    error << string_compose (_("could not reconstitute MementoCommand from XMLNode. object type = %1 id = %2"), obj_T, id.to_s()) << endmsg;
+    } else if (obj_T == "ARDOUR::Locations") {
+           return new MementoCommand<Locations>(*_locations, before, after);
 
-    return 0 ;
-}
+    } else if (obj_T == "ARDOUR::TempoMap") {
+           return new MementoCommand<TempoMap>(*_tempo_map, before, after);
 
-Command *
-Session::global_state_command_factory (const XMLNode& node)
-{
-       const XMLProperty* prop;
-       Command* command = 0;
+    } else if (obj_T == "ARDOUR::Playlist" || obj_T == "ARDOUR::AudioPlaylist" || obj_T == "ARDOUR::MidiPlaylist") {
+           if (boost::shared_ptr<Playlist> pl = playlists->by_name(child->property("name")->value())) {
+                   return new MementoCommand<Playlist>(*(pl.get()), before, after);
+           }
 
-       if ((prop = node.property ("type")) == 0) {
-               error << _("GlobalRouteStateCommand has no \"type\" node, ignoring") << endmsg;
-               return 0;
-       }
-       
-       try {
-
-               if (prop->value() == "solo") {
-                       command = new GlobalSoloStateCommand (*this, node);
-               } else if (prop->value() == "mute") {
-                       command = new GlobalMuteStateCommand (*this, node);
-               } else if (prop->value() == "rec-enable") {
-                       command = new GlobalRecordEnableStateCommand (*this, node);
-               } else if (prop->value() == "metering") {
-                       command = new GlobalMeteringStateCommand (*this, node);
+    } else if (obj_T == "ARDOUR::Route" || obj_T == "ARDOUR::AudioTrack" || obj_T == "ARDOUR::MidiTrack") {
+               if (boost::shared_ptr<Route> r = route_by_id(id)) {
+                       return new MementoCommand<Route>(*r, before, after);
                } else {
-                       error << string_compose (_("unknown type of GlobalRouteStateCommand (%1), ignored"), prop->value()) << endmsg;
+                       error << string_compose (X_("Route %1 not found in session"), id) << endmsg;
                }
-       }
-
-       catch (failed_constructor& err) {
-               return 0;
-       }
-
-       return command;
-}
-
-Session::GlobalRouteStateCommand::GlobalRouteStateCommand (Session& s, void* p)
-       : sess (s), src (p)
-{
-}
-
-Session::GlobalRouteStateCommand::GlobalRouteStateCommand (Session& s, const XMLNode& node)
-       : sess (s), src (this)
-{
-       if (set_state (node)) {
-               throw failed_constructor ();
-       }
-}
-
-int
-Session::GlobalRouteStateCommand::set_state (const XMLNode& node)
-{
-       GlobalRouteBooleanState states;
-       XMLNodeList nlist;
-       const XMLProperty* prop;
-       XMLNode* child;
-       XMLNodeConstIterator niter;
-       int loop;
-
-       before.clear ();
-       after.clear ();
-       
-       for (loop = 0; loop < 2; ++loop) {
-
-               const char *str;
-
-               if (loop) {
-                       str = "after";
-               } else {
-                       str = "before";
-               }
-               
-               if ((child = node.child (str)) == 0) {
-                       warning << string_compose (_("global route state command has no \"%1\" node, ignoring entire command"), str) << endmsg;
-                       return -1;
-               }
-
-               nlist = child->children();
-
-               for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-                       
-                       RouteBooleanState rbs;
-                       boost::shared_ptr<Route> route;
-                       ID id;
-                       
-                       prop = (*niter)->property ("id");
-                       id = prop->value ();
-                       
-                       if ((route = sess.route_by_id (id)) == 0) {
-                               warning << string_compose (_("cannot find track/bus \"%1\" while rebuilding a global route state command, ignored"), id.to_s()) << endmsg;
-                               continue;
-                       }
-                       
-                       rbs.first = boost::weak_ptr<Route> (route);
-                       
-                       prop = (*niter)->property ("yn");
-                       rbs.second = (prop->value() == "1");
-                       
-                       if (loop) {
-                               after.push_back (rbs);
-                       } else {
-                               before.push_back (rbs);
-                       }
-               }
-       }
-
-       return 0;
-}
-
-XMLNode&
-Session::GlobalRouteStateCommand::get_state ()
-{
-       XMLNode* node = new XMLNode (X_("GlobalRouteStateCommand"));
-       XMLNode* nbefore = new XMLNode (X_("before"));
-       XMLNode* nafter = new XMLNode (X_("after"));
-
-       for (Session::GlobalRouteBooleanState::iterator x = before.begin(); x != before.end(); ++x) {
-               XMLNode* child = new XMLNode ("s");
-               boost::shared_ptr<Route> r = x->first.lock();
-
-               if (r) {
-                       child->add_property (X_("id"), r->id().to_s());
-                       child->add_property (X_("yn"), (x->second ? "1" : "0"));
-                       nbefore->add_child_nocopy (*child);
-               }
-       }
-
-       for (Session::GlobalRouteBooleanState::iterator x = after.begin(); x != after.end(); ++x) {
-               XMLNode* child = new XMLNode ("s");
-               boost::shared_ptr<Route> r = x->first.lock();
-
-               if (r) {
-                       child->add_property (X_("id"), r->id().to_s());
-                       child->add_property (X_("yn"), (x->second ? "1" : "0"));
-                       nafter->add_child_nocopy (*child);
-               }
-       }
-
-       node->add_child_nocopy (*nbefore);
-       node->add_child_nocopy (*nafter);
-
-       return *node;
-}
-
-// solo
-
-Session::GlobalSoloStateCommand::GlobalSoloStateCommand(Session &sess, void *src)
-       : GlobalRouteStateCommand (sess, src)
-{
-    after = before = sess.get_global_route_boolean(&Route::soloed);
-}
-
-Session::GlobalSoloStateCommand::GlobalSoloStateCommand (Session& sess, const XMLNode& node)
-       : Session::GlobalRouteStateCommand (sess, node)
-{
-}
-
-void 
-Session::GlobalSoloStateCommand::mark()
-{
-    after = sess.get_global_route_boolean(&Route::soloed);
-}
-
-void 
-Session::GlobalSoloStateCommand::operator()()
-{
-    sess.set_global_solo(after, src);
-}
 
-void 
-Session::GlobalSoloStateCommand::undo()
-{
-    sess.set_global_solo(before, src);
-}
-
-XMLNode&
-Session::GlobalSoloStateCommand::get_state()
-{
-       XMLNode& node = GlobalRouteStateCommand::get_state();
-       node.add_property ("type", "solo");
-       return node;
-}
-
-// mute
-Session::GlobalMuteStateCommand::GlobalMuteStateCommand(Session &sess, void *src)
-       : GlobalRouteStateCommand (sess, src)
-{
-    after = before = sess.get_global_route_boolean(&Route::muted);
-}
-
-Session::GlobalMuteStateCommand::GlobalMuteStateCommand (Session& sess, const XMLNode& node)
-       : Session::GlobalRouteStateCommand (sess, node)
-{
-}
-
-void 
-Session::GlobalMuteStateCommand::mark()
-{
-       after = sess.get_global_route_boolean(&Route::muted);
-}
-
-void 
-Session::GlobalMuteStateCommand::operator()()
-{
-       sess.set_global_mute(after, src);
-}
-
-void 
-Session::GlobalMuteStateCommand::undo()
-{
-       sess.set_global_mute(before, src);
-}
-
-XMLNode&
-Session::GlobalMuteStateCommand::get_state()
-{
-       XMLNode& node = GlobalRouteStateCommand::get_state();
-       node.add_property ("type", "mute");
-       return node;
-}
-
-// record enable
-Session::GlobalRecordEnableStateCommand::GlobalRecordEnableStateCommand(Session &sess, void *src) 
-       : GlobalRouteStateCommand (sess, src)
-{
-       after = before = sess.get_global_route_boolean(&Route::record_enabled);
-}
-
-Session::GlobalRecordEnableStateCommand::GlobalRecordEnableStateCommand (Session& sess, const XMLNode& node)
-       : Session::GlobalRouteStateCommand (sess, node)
-{
-}
-
-void 
-Session::GlobalRecordEnableStateCommand::mark()
-{
-       after = sess.get_global_route_boolean(&Route::record_enabled);
-}
-
-void 
-Session::GlobalRecordEnableStateCommand::operator()()
-{
-       sess.set_global_record_enable(after, src);
-}
-
-void 
-Session::GlobalRecordEnableStateCommand::undo()
-{
-       sess.set_global_record_enable(before, src);
-}
-
-XMLNode& 
-Session::GlobalRecordEnableStateCommand::get_state()
-{
-       XMLNode& node = GlobalRouteStateCommand::get_state();
-       node.add_property ("type", "rec-enable");
-       return node;
-}
-
-// metering
-Session::GlobalMeteringStateCommand::GlobalMeteringStateCommand(Session &s, void *p) 
-       : sess (s), src (p)
-{
-       after = before = sess.get_global_route_metering();
-}
+    } else if (obj_T == "Evoral::Curve" || obj_T == "ARDOUR::AutomationList") {
+           if (have_id) {
+                   std::map<PBD::ID, AutomationList*>::iterator i = automation_lists.find(id);
+                   if (i != automation_lists.end()) {
+                           return new MementoCommand<AutomationList>(*i->second, before, after);
+                   }
+           } else {
+                   return new MementoCommand<AutomationList> (
+                           new MidiAutomationListBinder (n, sources),
+                           before, after
+                           );
+           }
 
-Session::GlobalMeteringStateCommand::GlobalMeteringStateCommand (Session& s, const XMLNode& node)
-       : sess (s), src (this)
-{
-       if (set_state (node)) {
-               throw failed_constructor();
-       }
-}
+           std::cerr << "Alist " << id << " not found\n";
 
-void 
-Session::GlobalMeteringStateCommand::mark()
-{
-       after = sess.get_global_route_metering();
-}
+    } else if (registry.count(id)) { // For Editor and AutomationLine which are off-limits herea
+           return new MementoCommand<PBD::StatefulDestructible>(*registry[id], before, after);
+    }
 
-void 
-Session::GlobalMeteringStateCommand::operator()()
-{
-       sess.set_global_route_metering(after, src);
-}
+    /* we failed */
+    info << string_compose (_("could not reconstitute MementoCommand from XMLNode. object type = %1 id = %2"), obj_T, id.to_s()) << endmsg;
 
-void 
-Session::GlobalMeteringStateCommand::undo()
-{
-       sess.set_global_route_metering(before, src);
+    return 0 ;
 }
 
-XMLNode&
-Session::GlobalMeteringStateCommand::get_state()
+Command *
+Session::stateful_diff_command_factory (XMLNode* n)
 {
-       XMLNode* node = new XMLNode (X_("GlobalRouteStateCommand"));
-       XMLNode* nbefore = new XMLNode (X_("before"));
-       XMLNode* nafter = new XMLNode (X_("after"));
-
-       for (Session::GlobalRouteMeterState::iterator x = before.begin(); x != before.end(); ++x) {
-               XMLNode* child = new XMLNode ("s");
-               boost::shared_ptr<Route> r = x->first.lock();
+       PBD::ID const id (n->property("obj-id")->value ());
 
+       std::string const obj_T = n->property ("type-name")->value ();
+       if ((obj_T == "ARDOUR::AudioRegion" || obj_T == "ARDOUR::MidiRegion")) {
+               boost::shared_ptr<Region> r = RegionFactory::region_by_id (id);
                if (r) {
-                       child->add_property (X_("id"), r->id().to_s());
-
-                       const char* meterstr = 0;
-                       
-                       switch (x->second) {
-                       case MeterInput:
-                               meterstr = X_("input");
-                               break;
-                       case MeterPreFader:
-                               meterstr = X_("pre");
-                               break;
-                       case MeterPostFader:
-                               meterstr = X_("post");
-                               break;
-                       default:
-                               fatal << string_compose (_("programming error: %1") , "no meter state in Session::GlobalMeteringStateCommand::get_state") << endmsg;
-                       }
-
-                       child->add_property (X_("meter"), meterstr);
-                       nbefore->add_child_nocopy (*child);
+                       return new StatefulDiffCommand (r, *n);
                }
-       }
 
-       for (Session::GlobalRouteMeterState::iterator x = after.begin(); x != after.end(); ++x) {
-               XMLNode* child = new XMLNode ("s");
-               boost::shared_ptr<Route> r = x->first.lock();
-
-               if (r) {
-                       child->add_property (X_("id"), r->id().to_s());
-
-                       const char* meterstr;
-                       
-                       switch (x->second) {
-                       case MeterInput:
-                               meterstr = X_("input");
-                               break;
-                       case MeterPreFader:
-                               meterstr = X_("pre");
-                               break;
-                       case MeterPostFader:
-                               meterstr = X_("post");
-                               break;
-                       default: meterstr = "";
-                       }
-
-                       child->add_property (X_("meter"), meterstr);
-                       nafter->add_child_nocopy (*child);
+       } else if (obj_T == "ARDOUR::AudioPlaylist" ||  obj_T == "ARDOUR::MidiPlaylist") {
+               boost::shared_ptr<Playlist> p = playlists->by_id (id);
+               if (p) {
+                       return new StatefulDiffCommand (p, *n);
+               } else {
+                       std::cerr << "Playlist with ID = " << id << " not found\n";
                }
        }
 
-       node->add_child_nocopy (*nbefore);
-       node->add_child_nocopy (*nafter);
-
-       node->add_property ("type", "metering");
+       /* we failed */
 
-       return *node;
-}
-
-int
-Session::GlobalMeteringStateCommand::set_state (const XMLNode& node)
-{
-       GlobalRouteBooleanState states;
-       XMLNodeList nlist;
-       const XMLProperty* prop;
-       XMLNode* child;
-       XMLNodeConstIterator niter;
-       int loop;
-
-       before.clear ();
-       after.clear ();
-       
-       for (loop = 0; loop < 2; ++loop) {
-
-               const char *str;
-
-               if (loop) {
-                       str = "after";
-               } else {
-                       str = "before";
-               }
-               
-               if ((child = node.child (str)) == 0) {
-                       warning << string_compose (_("global route meter state command has no \"%1\" node, ignoring entire command"), str) << endmsg;
-                       return -1;
-               }
-
-               nlist = child->children();
-
-               for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-                       
-                       RouteMeterState rms;
-                       boost::shared_ptr<Route> route;
-                       ID id;
-                       
-                       prop = (*niter)->property ("id");
-                       id = prop->value ();
-                       
-                       if ((route = sess.route_by_id (id)) == 0) {
-                               warning << string_compose (_("cannot find track/bus \"%1\" while rebuilding a global route state command, ignored"), id.to_s()) << endmsg;
-                               continue;
-                       }
-                       
-                       rms.first = boost::weak_ptr<Route> (route);
-                       
-                       prop = (*niter)->property ("meter");
-
-                       if (prop->value() == X_("pre")) {
-                               rms.second = MeterPreFader;
-                       } else if (prop->value() == X_("post")) {
-                               rms.second = MeterPostFader;
-                       } else {
-                               rms.second = MeterInput;
-                       }
-                       
-                       if (loop) {
-                               after.push_back (rms);
-                       } else {
-                               before.push_back (rms);
-                       }
-               }
-       }
+       error << string_compose (
+               _("could not reconstitute StatefulDiffCommand from XMLNode. object type = %1 id = %2"), obj_T, id.to_s())
+             << endmsg;
 
        return 0;
 }