/*
  ScopeQuery(Test)  -  running queries to discover container contents, filtering (sub)types 
 
  Copyright (C)         Lumiera.org
    2009,               Hermann Vosseler <Ichthyostega@web.de>
 
  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 "lib/test/run.hpp"
#include "proc/mobject/session/session-service-explore-scope.hpp"
#include "proc/mobject/session/scope-query.hpp"
#include "proc/mobject/session/test-scopes.hpp"
#include "proc/mobject/session/clip.hpp"
#include "lib/symbol.hpp"

#include <iostream>
#include <string>



namespace mobject {
namespace session {
namespace test    {
  
  using lib::Literal;
  using std::string;
  using std::cout;
  using std::endl;
  
  
  /**********************************************************************************************
   * @test how to discover contents or location of a container-like part of the high-level model.
   *       As this container-like object is just a concept and actually implemented by the
   *       PlacementIndex, this means querying the index for elements registered with
   *       a given scope or finding the enclosing scopes. The discovered
   *       elements will be filtered by a runtime type check.
   *       
   * @todo change that to use a more realistic test session, based on the actual model types   //////////////// TICKET #532
   *       
   * @see  mobject::session::PlacementIndex
   * @see  mobject::session::QueryResolver
   * @see  mobject::session::ContentsQuery
   */
  class ScopeQuery_test : public Test
    {
      
      virtual void
      run (Arg) 
        {
          // Prepare an (test)Index (dummy "session")
          PPIdx testSession (build_testScopes());
          
          QueryResolver const& resolver = SessionServiceExploreScope::getResolver();
          PlacementMO   const& scope    = SessionServiceExploreScope::getScopeRoot();
          
          discover (ScopeQuery<MObject>    (resolver,scope, CONTENTS) , "contents depth-first");
          discover (ScopeQuery<Clip>       (resolver,scope, CONTENTS) , "contents depth-first, filtered to Clip");
          discover (ScopeQuery<DummyMO>    (resolver,scope, CONTENTS) , "contents depth-first, filtered to DummyMO");  ////////////////////// TICKET #532
          discover (ScopeQuery<TestSubMO1> (resolver,scope, CONTENTS) , "contents depth-first, filtered to TestSubMO1");
          discover (ScopeQuery<TestSubMO2> (resolver,scope, CONTENTS) , "contents depth-first, filtered to TestSubMO2");
          
          ScopeQuery<TestSubMO21> specialEl(resolver,scope, CONTENTS);
          ++specialEl; // step in to second solution found...
          ASSERT (specialEl);
          
          discover (ScopeQuery<MObject>    (resolver,*specialEl, PARENTS) , "parents of the second TestSubMO2 element found");
          discover (ScopeQuery<MObject>    (resolver,*specialEl, CHILDREN), "children of the this TestSubMO2 element");
          discover (ScopeQuery<MObject>    (resolver,*specialEl, PATH)    , "path from there to root");
          discover (ScopeQuery<TestSubMO2> (resolver,*specialEl, PATH)    , "same path, but filtered to TestSubMO2");
          discover (specialEl                                             , "continue exploring partially used TestSubMO2 iterator");
        }
      
      
      template<class MO>
      void
      discover (ScopeQuery<MO> const& query, Literal description)
        {
          typedef typename ScopeQuery<MO>::iterator I;
          
          announce (description);
          for (I elm(query);
               elm; ++elm)
            cout << string(*elm) << endl;
        }
      
      void
      announce (Literal description)
        {
          static uint nr(0);
          cout << "--------------------------------Test-"<< ++nr << ": " << description << endl;
        }
      
    };
  
  
  /** Register this test class... */
  LAUNCHER (ScopeQuery_test, "unit session");
  
  
}}} // namespace mobject::session::test