automation_list_property_test.cc

Go to the documentation of this file.

/*
    Copyright (C) 2012 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
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include <glibmm/fileutils.h>
#include <glibmm/miscutils.h>

#include "pbd/properties.h"
#include "pbd/stateful_diff_command.h"
#include "ardour/automation_list.h"
#include "automation_list_property_test.h"
#include "test_util.h"

CPPUNIT_TEST_SUITE_REGISTRATION (AutomationListPropertyTest);

using namespace std;
using namespace PBD;
using namespace ARDOUR;

void
write_automation_list_xml (XMLNode* node, std::string filename)
{
        // use the same output dir for all of them
        static std::string test_output_dir = new_test_output_dir ("automation_list_property");
        std::string output_file = Glib::build_filename (test_output_dir, filename);

        CPPUNIT_ASSERT (write_ref (node, output_file));
}

void
AutomationListPropertyTest::basicTest ()
{
        list<string> ignore_properties;
        ignore_properties.push_back ("id");

        PropertyDescriptor<boost::shared_ptr<AutomationList> > descriptor;
        descriptor.property_id = g_quark_from_static_string ("FadeIn");
        AutomationListProperty property (
                descriptor,
                boost::shared_ptr<AutomationList> (new AutomationList (Evoral::Parameter (FadeInAutomation)))
                );

        property.clear_changes ();

        /* No change since we just cleared them */
        CPPUNIT_ASSERT_EQUAL (false, property.changed());
        
        property->add (1, 2, false, false);
        property->add (3, 4, false, false);

        /* Now it has changed */
        CPPUNIT_ASSERT_EQUAL (true, property.changed());

        std::string test_data_filename = "automation_list_property_test1.ref";
        std::string test_data_file1 = Glib::build_filename (test_search_path().front(), test_data_filename);
        CPPUNIT_ASSERT (Glib::file_test (test_data_file1, Glib::FILE_TEST_EXISTS));

        XMLNode* foo = new XMLNode ("test");
        property.get_changes_as_xml (foo);
        write_automation_list_xml (foo, test_data_filename);
        check_xml (foo, test_data_file1, ignore_properties);

        test_data_filename = "automation_list_property_test2.ref";
        std::string test_data_file2 = Glib::build_filename (test_search_path().front(), test_data_filename);
        CPPUNIT_ASSERT (Glib::file_test (test_data_file2, Glib::FILE_TEST_EXISTS));

        /* Do some more */
        property.clear_changes ();
        CPPUNIT_ASSERT_EQUAL (false, property.changed());
        property->add (5, 6, false, false);
        property->add (7, 8, false, false);
        CPPUNIT_ASSERT_EQUAL (true, property.changed());
        delete foo;
        foo = new XMLNode ("test");
        property.get_changes_as_xml (foo);
        write_automation_list_xml (foo, test_data_filename);
        check_xml (foo, test_data_file2, ignore_properties);
        delete foo;
}

class Fred : public StatefulDestructible
{
public:
        Fred ()
                : _jim (_descriptor, boost::shared_ptr<AutomationList> (new AutomationList (Evoral::Parameter (FadeInAutomation))))

        {
                add_property (_jim);
        }

        XMLNode & get_state () {
                XMLNode* n = new XMLNode ("State");
                add_properties (*n);
                return *n;
        }

        int set_state (XMLNode const & node, int) {
                set_values (node);
                return 0;
        }

        static void make_property_quarks () {
                _descriptor.property_id = g_quark_from_static_string ("FadeIn");
        }

        AutomationListProperty _jim;
        static PropertyDescriptor<boost::shared_ptr<AutomationList> > _descriptor;
};

PropertyDescriptor<boost::shared_ptr<AutomationList> > Fred::_descriptor;

void
AutomationListPropertyTest::undoTest ()
{
        list<string> ignore_properties;
        ignore_properties.push_back ("id");

        Fred::make_property_quarks ();

        boost::shared_ptr<Fred> sheila (new Fred);

        /* Add some data */
        sheila->_jim->add (1, 2, false, false);
        sheila->_jim->add (3, 4, false, false);

        /* Do a `command' */
        sheila->clear_changes ();
        sheila->_jim->add (5, 6, false, false);
        sheila->_jim->add (7, 8, false, false);
        StatefulDiffCommand sdc (sheila);

        std::string test_data_filename = "automation_list_property_test3.ref";
        std::string test_data_file3 = Glib::build_filename (test_search_path().front(), test_data_filename);
        CPPUNIT_ASSERT (Glib::file_test (test_data_file3, Glib::FILE_TEST_EXISTS));

        /* Undo */
        sdc.undo ();
        write_automation_list_xml (&sheila->get_state(), test_data_filename);
        check_xml (&sheila->get_state(), test_data_file3, ignore_properties);

        test_data_filename = "automation_list_property_test4.ref";
        std::string test_data_file4 = Glib::build_filename (test_search_path().front(), test_data_filename);
        CPPUNIT_ASSERT (Glib::file_test (test_data_file4, Glib::FILE_TEST_EXISTS));

        /* Redo */
        sdc.redo ();
        write_automation_list_xml (&sheila->get_state(), test_data_filename);
        check_xml (&sheila->get_state(), test_data_file4, ignore_properties);
}