lumiera_/src/steam/mobject/session/session.cpp

/*
  Session  -  holds the complete session to be edited by the user

   Copyright (C)
     2008,            Hermann Vosseler <Ichthyostega@web.de>

  **Lumiera** 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. See the file COPYING for further details.

* *****************************************************************/


/** @file session.cpp
 ** Actual connection between the Session interface and its Implementation.
 ** Holds the storage for the SessionManager implementation (singleton)
 ** 
 ** @see session::SessionImpl
 ** @see session::SessionManagerImpl
 **
 */


#include "steam/mobject/session.hpp"
#include "steam/mobject/session/session-impl.hpp"
#include "steam/mobject/session/sess-manager-impl.hpp"
//#include "common/query/defs-manager.hpp"

#include "lib/symbol.hpp"
#include "lib/depend.hpp"



namespace steam {
namespace mobject {
  
  using lib::Symbol;
  using session::SessManager;
  using session::SessManagerImpl;
  using session::SessionImplAPI;


  namespace { // the global session manager instance...
    lib::Depend<SessManagerImpl> theSessionManager;
  }
  
  
  /** temporary fix for init problems
   *  @todo really solve the basic init of session manager TICKET #518
   */
  bool Session::initFlag = false;
  
  
  /** the sole access point for all client code to the system-wide
   *  "current session". Implemented as smart pointer to singleton
   *  implementation object, where the smart pointer is actually
   *  the SessionManager (which is singleton as well...).
   * 
   *  Consequently, if you want to talk to the _session manager_,
   *  you use dot-notation, while you access the _session object_
   *  via arrow notation (e.g. `Session::current->getFixture()` )
   */
  SessManager& Session::current = theSessionManager();
  
  
  /** special access point allowing Steam-Layer internals
   *  to cooperate with session implementation level APIs
   */
  template<>
  SessManagerImpl& SessionImplAPI::current = static_cast<SessManagerImpl&> (Session::current);
  
  
  
  
  /**
   *  LifecycleHook, to perform all the basic setup for a new session,
   *  prior to adding any specific data, configuration or content. Any subsystems
   *  requiring to (re)-initialise for a new session should register here. When this
   *  hook is activated, the session implementation facilities are available and the
   *  corresponding interfaces are already opened and accessible, but the session itself
   *  is completely pristine and empty.
   *  @note plugins providing additional facilities to be used by content of a (persisted)
   *        session should register their basic setup functions using this hook, which can be
   *        done via the C interface functions defined in lifecycle.h
   */
  CStr ON_SESSION_START = "ON_SESSION_START";
  
  /**
   *  LifecycleHook, to perform any initialisation, wiring and registrations necessary
   *  to get the session into a usable state. When activated, the specific session content
   *  and configuration has already be loaded. Any subsystems requiring to build some indices
   *  or wiring to keep track of the session's content should register here.
   */
  CStr ON_SESSION_INIT = "ON_SESSION_INIT";
  
  /**
   *  LifecycleHook, to perform post loading tasks, requiring an already completely usable
   *  and configured session to be in place. When activated, the session is completely restored
   *  according to the standard or persisted definition and any access interfaces are already
   *  opened and enabled. Scripts and the GUI might even be accessing the session in parallel.
   *  Subsystems intending to perform additional processing should register here, if requiring
   *  fully functional client side APIs. Examples would be statistics gathering, validation
   *  or auto-correction of the session's contents.
   */
  CStr ON_SESSION_READY = "ON_SESSION_READY";
  
  /**
   *  LifecycleHook, to commence any activity relying on an opened and fully operative session.
   *  When invoked, the session is still in fully operative state, all interfaces are open and
   *  the render engine is available. However, after issuing this event, the session shutdown
   *  sequence will be initiated, by detaching the engine interfaces and signalling the
   *  scheduler to cease running render jobs.
   */
  CStr ON_SESSION_CLOSE ="ON_SESSION_CLOSE";
  
  /**
   *  LifecycleHook, to perform any state saving, deregistration or de-activation necessary
   *  before bringing down an existing session. When invoked, the session is still fully valid
   *  and functional, but the GUI/external access has already been closed.
   *  @todo specify how this is related to "saving". Is there a way for subsystems to add
   *        specific/internal information into the persisted state, besides actually attaching
   *        data to objects within the session?
   */
  CStr ON_SESSION_END ="ON_SESSION_END";
  
  
  
  
  Session::Session (DefaultsAccess defs
                   ,ElementsAccess quer
                   ,TimelineAccess tils
                   ,SequenceAccess seqs) noexcept
    : defaults(defs)
    , elements(quer)
    , timelines(tils)
    , sequences(seqs)
  { }
  
  
  // Emit the vtables and other magic stuff here...
  SessManager::~SessManager() { }
  Session::~Session () { }



}} // namespace steam::mobject