cannam@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 
cannam@0: /*
cannam@0:     Vamp Plugin Tester
cannam@0:     Chris Cannam, cannam@all-day-breakfast.com
cannam@0:     Centre for Digital Music, Queen Mary, University of London.
Chris@42:     Copyright 2009-2014 QMUL.
cannam@0: 
cannam@0:     This program loads a Vamp plugin and tests its susceptibility to a
cannam@0:     number of common pitfalls, including handling of extremes of input
cannam@0:     data.  If you can think of any additional useful tests that are
cannam@0:     easily added, please send them to me.
cannam@0:   
cannam@0:     Permission is hereby granted, free of charge, to any person
cannam@0:     obtaining a copy of this software and associated documentation
cannam@0:     files (the "Software"), to deal in the Software without
cannam@0:     restriction, including without limitation the rights to use, copy,
cannam@0:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0:     of the Software, and to permit persons to whom the Software is
cannam@0:     furnished to do so, subject to the following conditions:
cannam@0: 
cannam@0:     The above copyright notice and this permission notice shall be
cannam@0:     included in all copies or substantial portions of the Software.
cannam@0: 
cannam@0:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@0:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 
cannam@0:     Except as contained in this notice, the names of the Centre for
cannam@0:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0:     shall not be used in advertising or otherwise to promote the sale,
cannam@0:     use or other dealings in this Software without prior written
cannam@0:     authorization.
cannam@0: */
cannam@0: 
cannam@0: #ifndef _TESTER_H_
cannam@0: #define _TESTER_H_
cannam@0: 
cannam@0: #include <string>
cannam@0: 
cannam@0: #include "Test.h"
cannam@0: 
cannam@0: class Tester
cannam@0: {
cannam@0: public:
Chris@39:     Tester(std::string pluginKey, Test::Options, std::string singleTestId = "");
cannam@0:     ~Tester();
cannam@0: 
cannam@4:     bool test(int &notes, int &warnings, int &errors);
cannam@0: 
Chris@40:     static void listTests();
Chris@40: 
cannam@0:     class Registrar {
cannam@0:     public:
Chris@39:         Registrar(std::string id, std::string name) { 
Chris@39:             Tester::registerTest(id, name, this);
Chris@39:         }
cannam@15:         virtual ~Registrar() { }
cannam@0:         virtual Test *makeTest() = 0;
cannam@0:     };
cannam@0:     
cannam@0:     template <typename T>
cannam@0:     class TestRegistrar : Registrar {
cannam@0:     public:
Chris@39:         TestRegistrar(std::string id, std::string name) : 
Chris@39:             Registrar(id, name) { }
cannam@0:         virtual Test *makeTest() { return new T(); }
cannam@0:     };
cannam@0: 
Chris@39:     static void registerTest(std::string id, std::string name, Registrar *r) {
Chris@39:         nameIndex()[id] = name;
Chris@39:         registry()[id] = r;
cannam@0:     }
cannam@0:     
cannam@0: protected:
cannam@0:     std::string m_key;
cannam@8:     Test::Options m_options;
Chris@39:     std::string m_singleTest;
Chris@39:     typedef std::map<std::string, std::string> NameIndex;
cannam@0:     typedef std::map<std::string, Registrar *> Registry;
Chris@39:     static NameIndex &nameIndex();
cannam@0:     static Registry &registry();
Chris@39: 
Chris@39:     bool performTest(std::string id, int &notes, int &warnings, int &errors);
cannam@0: };
cannam@0: 
cannam@0: #endif
cannam@0: