mh5tokengroup.c

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
/*---includes for this file--------------------------------------------------*/
#include <string.h>

#include "mh5tokengroup.h"
#include "mh5object.h"          /* for actions */
#include "mh5variable.h"        /* for actions */
#include "mh5memory.h"          /* for constructor/destructor */
#include "mh5final.h"
#include "mh5queue.h"           /* Events           */
#include "mh5debug.h"
#include "mh5gate.h"

/*---constant definitions for this file--------------------------------------*/


/*---local typedef structs for this file-------------------------------------*/

/*---local (static) variable declarations for this file----------------------*/

/*---local function definitions----------------------------------------------*/

/*---global function definitions---------------------------------------------*/

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5tokenGroupPrint(MHEG5TokenGroup *tokenGroup, char *out)
{
   MHEG5TokenSlot *currTGItem;
   U32BIT token_num, actions_num, num;
   MHEG5ActionList *actions_ptr;

   MHEG5ingredientPrint(&tokenGroup->ingredient, out);
   MHEG5tokenManagerPrint(&tokenGroup->tokenManager, out);

   /* tokenGroupItems */
   MHEG5indent(out);
   MHEG_PRINT(out, ":TokenGroupItems (");
   MHEG5incIndent();

   currTGItem = tokenGroup->tokens_ptr + 1;
   token_num = tokenGroup->tokens_num - 1;
   MHEG5newLine(out);
   while (token_num != 0)
   {
      MHEG5incIndent();
      MHEG5indent(out);
      MHEG_PRINT(out, "(");
      /* Object reference */
      if ((tokenGroup->ingredient.root.grp == currTGItem->groupid.ptr.group) ||
          ((currTGItem->groupid.len) && MHEG5sameGroup(tokenGroup->ingredient.root.grp, currTGItem->groupid)))
      {
         MHEG5intPrint(currTGItem->id, out);
      }
      else
      {
         MHEG_PRINT(out, "(");
         MHEG5stringPrint(*((MHEG5String *)&currTGItem->groupid), out);
         MHEG_PRINT(out, " ");
         MHEG5intPrint(currTGItem->id, out);
         MHEG_PRINT(out, ")");
      }
      MHEG5newLine(out);
      MHEG5indent(out);
      MHEG_PRINT(out, ":ActionSlots (");
      MHEG5newLine(out);
      MHEG5incIndent();

      /* Sequence of actionslots */
      actions_num = currTGItem->actions_num;
      actions_ptr = currTGItem->actions_ptr;
      num = 1;
      while (actions_num != 0)
      {
         MHEG5indent(out);
         MHEG_PRINT(out, "( // AS=");
         MHEG5intPrint(num, out);
         MHEG5newLine(out);
         MHEG5actionPrint(*actions_ptr, out);
         MHEG5indent(out);
         MHEG_PRINT(out, ")");
         MHEG5newLine(out);
         actions_ptr++;
         actions_num--;
         num++;
      }
      MHEG5decIndent();
      MHEG5indent(out);
      MHEG_PRINT(out, ")");
      MHEG5newLine(out);

      MHEG5decIndent();
      MHEG5indent(out);
      MHEG_PRINT(out, ")");
      MHEG5newLine(out);

      currTGItem++;
      token_num--;
   }
   MHEG5decIndent();
   MHEG5newLine(out);
   MHEG5indent(out);
   MHEG_PRINT(out, ")");
   MHEG5newLine(out);
   currTGItem = tokenGroup->tokens_ptr;
   actions_num = currTGItem->actions_num;
   if (actions_num != 0)
   {
      /* noTokenActionSlots */
      MHEG5indent(out);
      MHEG_PRINT(out, ":NoTokenActionSlot ");
      MHEG5newLine(out);
      MHEG5incIndent();

      actions_ptr = currTGItem->actions_ptr;
      do
      {
         MHEG5indent(out);
         MHEG_PRINT(out, "(");
         MHEG5newLine(out);
         MHEG5actionPrint(*actions_ptr, out);
         MHEG5indent(out);
         MHEG_PRINT(out, ")");
         MHEG5newLine(out);
         actions_ptr++;
         actions_num--;
      }
      while (actions_num != 0);
      MHEG5decIndent();
      MHEG5newLine(out);
   }
}

#endif


void MHEG5tokenGroupFree(MHEG5TokenGroup *tokenGroup)
{
   MHEG5TokenSlot *token_ptr;
   U32BIT token_num, actions_num;
   MHEG5ActionList *actions_ptr;

   assert(tokenGroup);

   MHEG5ingredientFree(&tokenGroup->ingredient);
   MHEG5tokenManagerFree(&tokenGroup->tokenManager);

   token_ptr = tokenGroup->tokens_ptr;
   token_num = tokenGroup->tokens_num;
   while (token_num)
   {
      if (token_ptr->groupid.len)
      {
         MHEG5stringDestruct((MHEG5String *)&token_ptr->groupid);
      }
      actions_num = token_ptr->actions_num;
      actions_ptr = token_ptr->actions_ptr;
      while (actions_num)
      {
         MHEG5actionDestruct(*actions_ptr);
         actions_ptr++;
         actions_num--;
      }
      token_ptr++;
      token_num--;
   }
}

/*
   29.1.3 Own internal attributes
   This class defines no additional internal attribute.
   29.2 Events
   This class has the same events as its base classes, with identical semantics.
 */
void MHEG5tokenGroupPrepare(MHEG5TokenGroup *tokenGroup)
{
   U32BIT token_num;
   MHEG5TokenSlot *token_ptr;
   U32BIT actions_num;
   MHEG5ActionList *actions_ptr;

   assert(tokenGroup);

   token_ptr = tokenGroup->tokens_ptr;
   token_num = tokenGroup->tokens_num;
   while (token_num)
   {
      actions_num = token_ptr->actions_num;
      actions_ptr = token_ptr->actions_ptr;

      while (actions_num)
      {
         MHEG5queueResolveTargets( *actions_ptr );
         actions_ptr++;
         actions_num--;
      }
      token_ptr++;
      token_num--;
   }
   MHEG5tokenManagerPrepare(&tokenGroup->tokenManager);
   MHEG5ingredientPrepare(&tokenGroup->ingredient);
}

/*
   Âctivation
   Execute the following sequence of actions:
   1. Apply the Activation behaviour as inherited from the Presentable class.
   2. Apply the activation behaviour to each item in the order given by
   TokenGroupItems.
   3. Generate a TokenMovedTo event with the value of the TokenPosition
   attribute as associated data.
   4. Set the RunningStatus to True and generate an IsRunning event.
 */
void MHEG5tokenGroupActivate(MHEG5TokenGroup *tokenGroup)
{
   MHEG5TokenSlot *token_ptr;
   MHEG5Root *item;
   U32BIT token_num;

   assert(tokenGroup);

   if (!tokenGroup->ingredient.root.runningStatus)
   {
      if (!tokenGroup->ingredient.root.availabilityStatus)
      {
         MHEG5tokenGroupPrepare( tokenGroup );
      }
      /* Could call the base class activation behaviour, but */
      /* MHEG5ingredientActivate(&tokenGroup->ingredient); <- does nothing, so don't bother */

      token_ptr = tokenGroup->tokens_ptr + 1;
      token_num = tokenGroup->tokens_num - 1;
      while (token_num)
      {
         item = MHEG5findObject(token_ptr->groupid, token_ptr->id);
         if (item)
         {
            MHEG5finalActivate(item);
         }
         token_ptr++;
         token_num--;
      }
      MHEG5sendSync((MHEG5Root *)tokenGroup, MHEG5TOKENMOVEDTO, tokenGroup->tokenManager.tokenPosition );
      tokenGroup->ingredient.root.runningStatus = MHEG5TRUE;
      MHEG5sendSync((MHEG5Root *)tokenGroup, MHEG5ISRUNNING, 0);
   }
}

/*
   Deactivation
   1. Generate a TokenMoveFrom event with the value of the TokenPosition
   attribute as associated data.
   2. Apply the Deactivation behaviour as inherited from the Presentable class.
 */
void MHEG5tokenGroupDeactivate(MHEG5TokenGroup *tokenGroup)
{
   assert(tokenGroup);

   if (tokenGroup->ingredient.root.runningStatus)
   {
      MHEG5sendSync((MHEG5Root *)tokenGroup, MHEG5TOKENMOVEDFROM, tokenGroup->tokenManager.tokenPosition );
      MHEG5ingredientDeactivate(&tokenGroup->ingredient);
   }
}

void MHEG5tokenGroupDestruct(MHEG5TokenGroup *tokenGroup)
{
   U32BIT            token_num;
   MHEG5TokenSlot    *token_ptr;
   U32BIT            actions_num;
   MHEG5ActionList   *actions_ptr;
   assert(tokenGroup);

   MHEG5ingredientDestruct(&tokenGroup->ingredient);
   MHEG5tokenManagerDestruct(&tokenGroup->tokenManager);

   token_ptr = tokenGroup->tokens_ptr;
   token_num = tokenGroup->tokens_num;
   while (token_num)
   {
      actions_num = token_ptr->actions_num;
      actions_ptr = token_ptr->actions_ptr;

      while( actions_num )
      {
         MHEG5queueUnresolveTargets( *actions_ptr );
         actions_ptr++;
         actions_num--;
      }
      token_ptr++;
      token_num--;
   }
}

#ifdef TRACING
static void TraceToken( MHEG5TokenGroup *tkn, MHEG5Int t_posn, MHEG5Int idx )
{
   int ind = (event_indent_num << 1) + 1;
   char buff[160];

   ind = (event_indent_num << 1) % MAX_EVENT_INDENT;

   buff[ind + 1] = 0;
   while (ind != 0)
   {
      buff[ind] = ' ';
      ind--;
   }
   buff[0] = '\n';
   DBG_PRINTF( buff );
   DBG_PRINTF("Tokengroup: %c%ld  posn: %d aslot: %d",
      (tkn->ingredient.root.grp->root.clazz == MHEG5SCENE) ? 'S' : 'A', tkn->ingredient.root.id, t_posn, idx );
}

#endif /*TRACING*/

/*
     Actions
 */
/*
   CallActionSlot (Index)
   Execute an Action object associated with the item that currently has the token.
   Execute the following sequence of actions:
   1. If TokenPosition is set to 0, consider the ActionSlots sequence of the
   NoTokenActionSlots attribute.
   2. If TokenPosition is different from 0, consider the ActionSlots sequence that is
   associated with the item that currently has the token.
   3. Consider the ActionSlot that is at position Index in the ActionSlots sequence. If
   this ActionSlot is NULL, then ignore the effect of the CallActionSlot action.
   Otherwise, execute that ActionSlot.

   The execution of the CallActionSlot action is not completed until the ActionSlot
   action has been executed.

   Provisions of use:
   The Target object shall be an active TokenGroup object.
   Index shall be set in the range [0, number of items in TokenGroupItem].
 */
MHEG5ErrorCode MHEG5callActionSlot(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Int idx = 0, position = 0;
   MHEG5TokenSlot *token_ptr;
   MHEG5ActionList *actions_ptr;

   if ((target->clazz != MHEG5TOKENGROUP) && (target->clazz != MHEG5LISTGROUP))
   {
      return MHEG5ERR_WRONGTARGET;
   }

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveGenericInteger(params, &idx);

   position = ((MHEG5TokenGroup *)target)->tokenManager.tokenPosition;

  #ifdef TRACING
   extra_trace_param = (position << 16) | idx;
  #endif

   if (position >= ((MHEG5TokenGroup *)target)->tokens_num || position < 0)
   {
      return MHEG5ERR_NOSUCHITEM;
   }
   else
   {
      token_ptr = ((MHEG5TokenGroup *)target)->tokens_ptr;
      token_ptr += position;
      if (idx <= token_ptr->actions_num && idx > 0)
      {
         actions_ptr = token_ptr->actions_ptr + idx - 1;

        #ifdef MHEG5LOG
         MHEG5LogPrintf(MHEG5CALLS, "MHEG5callActionSlot position = %d, %d\n", position, idx);
        #endif

        #ifdef TRACING
         if (mheg_trace_debug & (TACTIONS | TEVNTS))
            TraceToken((MHEG5TokenGroup *)target, position, idx );
        #endif

         MHEG5PrependActionList( *actions_ptr );
      }
      else
      {
         return MHEG5ERR_NOSUCHSLOT;
      }
   }
   return MHEG5ERR_NOERROR;
}