Distorted Android

///////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright 2016 Leszek Koltunski  leszek@koltunski.pl                                          //

//                                                                                               //

// This file is part of Distorted.                                                               //

//                                                                                               //

// This library is free software; you can redistribute it and/or                                 //

// modify it under the terms of the GNU Lesser General Public                                    //

// License as published by the Free Software Foundation; either                                  //

// version 2.1 of the License, or (at your option) any later version.                            //

//                                                                                               //

// This library 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                             //

// Lesser General Public License for more details.                                               //

//                                                                                               //

// You should have received a copy of the GNU Lesser General Public                              //

// License along with this library; if not, write to the Free Software                           //

// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA                //

///////////////////////////////////////////////////////////////////////////////////////////////////

package org.distorted.library.message;

///////////////////////////////////////////////////////////////////////////////////////////////////

import org.distorted.library.effect.Effect;

/**

 * This interface lets users of the DistortedLibrary library get notified when a given effect finishes.

 * To receive the notifications, we first have to register with a call to {@link Effect#notifyWhenFinished(EffectListener)}.

 */

public interface EffectListener 

  {

/**

 * Gets called when Effect 'effectID' finishes execution (i.e. the Dynamic inside it reaches its final point).

 * 

 * @param effectID ID of the finished effect, as returned by {@link org.distorted.library.effect.Effect#getID() }

 */

  void effectFinished(final long effectID);

  }

///////////////////////////////////////////////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright 2016 Leszek Koltunski  leszek@koltunski.pl                                          //

//                                                                                               //

// This file is part of Distorted.                                                               //

//                                                                                               //

// This library is free software; you can redistribute it and/or                                 //

// modify it under the terms of the GNU Lesser General Public                                    //

// License as published by the Free Software Foundation; either                                  //

// version 2.1 of the License, or (at your option) any later version.                            //

//                                                                                               //

// This library 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                             //

// Lesser General Public License for more details.                                               //

//                                                                                               //

// You should have received a copy of the GNU Lesser General Public                              //

// License along with this library; if not, write to the Free Software                           //

// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA                //

///////////////////////////////////////////////////////////////////////////////////////////////////

package org.distorted.library.message;

import org.distorted.library.effect.Effect;

import java.util.Vector;

///////////////////////////////////////////////////////////////////////////////////////////////////

/**

 * Not part of public API, do not document (public only because has to be used in Meshes)

 *

 * @y.exclude

 */

public final class EffectMessageSender extends Thread

  {

  private static class Message

    {

    EffectListener mListener;

    long mEffectID;

    Message(EffectListener listener, long effectID)

      {

      mListener = listener;

      mEffectID = effectID;

      }

    }

  private static final Object mLock        = new Object();

  private static Vector<Message> mList     = null;

  private static EffectMessageSender mThis = null;

  private static volatile boolean mNotify  = false;

  // debug only, to be removed later

  private static int mNumStarts = 0;

  private static long mStartTime, mStopTime;

///////////////////////////////////////////////////////////////////////////////////////////////////

  private EffectMessageSender() 

    {

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public static void startSending()

    {

    synchronized(mLock)

      {

      if( mThis==null )

        {

        mStartTime = System.currentTimeMillis();

        mNumStarts++;

        mList = new Vector<>();

        mThis = new EffectMessageSender();

        mThis.start();

        }

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public static void stopSending()

    {

    synchronized(mLock)

      {

      if( mThis!=null )

        {

        mStopTime = System.currentTimeMillis();

        mNumStarts--;

        mThis=null;

        mLock.notify();

        }

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void run()

    {

    Message tmp;  

    while(mThis!=null)

      {

      while( !mList.isEmpty() )

        {

        tmp = mList.remove(0);

        tmp.mListener.effectFinished(tmp.mEffectID);

        }

      synchronized(mLock)

        {

        if (!mNotify)

          {

          try  { mLock.wait(); }

          catch(InterruptedException ignored) { }

          }

        mNotify = false;

        }

      }

    mList.clear();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public static void newMessage(Effect effect)

    {

    int numListeners = effect.getNumListeners();

    if( numListeners>0 )

      {

      long id = effect.getID();

      for(int i=0; i<numListeners; i++)

        {

        EffectListener listener = effect.removeFirstListener();

        Message msg = new Message(listener,id);

        mList.add(msg);

        }

      synchronized(mLock)

        {

        mNotify = true;

        mLock.notify();

        }

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public static boolean isRunning()

    {

    return mThis!=null;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public static void restartThread()

    {

    synchronized(mLock)

      {

      if( mThis==null )

        {

        if( mList==null ) mList = new Vector<>();

        mThis = new EffectMessageSender();

        mThis.start();

        }

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public static String reportState()

    {

    return "running "+(mThis!=null)+" notify="+mNotify+" elements="+mList.size()+

           " start="+mStartTime+" stop="+mStopTime+" numStarts="+mNumStarts;

    }

  }