mh5interactible.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 "mh5variable.h"        /* for actions              */
#include "mh5object.h"          /* for actions              */
#include "mh5queue.h"           /* Events           */
#include "mh5interactible.h"
#include "mh5application.h"
#include "mh5button.h"
#include "mh5slider.h"
#include "mh5display.h"
#include "mh5entryfield.h"
#include "mh5hypertext.h"
#include "mh5scene.h"
#include "mh5memory.h"

#include "mh5profile.h"

#include "mh5debug.h"
#include "mh5drawtext.h"

#ifdef MH5PRINTOUT
#include <string.h>
#endif  /* #ifdef MH5PRINTOUT */

/*---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 MHEG5interactiblePrint(MHEG5Interactible *interactible, char *out)
{
   MHEG5indent(out);
   MHEG_PRINT(out, ":EngineResp ");
   MHEG5boolPrint(interactible->engineResp, out);
   MHEG5newLine(out);
   MHEG5indent(out);
   MHEG_PRINT(out, ":HighlightRefColour ");
   MHEG5colourPrint(interactible->highlightRefColour, out);
   MHEG5newLine(out);
   MHEG5indent(out);
   MHEG_PRINT(out, "// HighlightStatus:\t");
   MHEG5boolPrint(interactible->highlightStatus, out);
   MHEG5newLine(out);
   MHEG5indent(out);
   MHEG_PRINT(out, "// InteractionStatus:\t");
   MHEG5boolPrint(interactible->interactionStatus, out);
   MHEG5newLine(out);
}

#endif  /* #ifdef MH5PRINTOUT */


void MHEG5interactibleInit(MHEG5Interactible *interactible)
{
   assert(interactible);

   interactible->engineResp = MHEG5TRUE;
}

void MHEG5interactiblePrepare(MHEG5Interactible *interactible)
{
   assert(interactible);

   interactible->highlightStatus = MHEG5FALSE;
   interactible->interactionStatus = MHEG5FALSE;
}

void MHEG5interactibleFree(MHEG5Interactible *interactible)
{
   assert(interactible);

   MHEG5genericDestruct(&interactible->highlightRefColour);
}

/*
   Internal behaviours
 */
void MHEG5interactibleDestruct(MHEG5Interactible *interactible)
{
   assert(interactible);
}

void MHEG5interactibleDeactivate(MHEG5Interactible *interactible)
{
   assert(interactible);

   interactible->interactionStatus = MHEG5FALSE;
}

/*
   Internal functions
 */

static void MHEG5interactibleHighlightOn(MHEG5Interactible *interactible, MHEG5Root *item)
{
   assert(interactible);
   assert(item);

   if (interactible->highlightStatus)
   {
      return;
   }

   interactible->highlightStatus = MHEG5TRUE;
   MHEG5sendSync(item, MHEG5HIGHLIGHTON, 0);

   if (interactible->engineResp)
   {
      MHEG5displayRedraw((MHEG5Visible *)item);
   }
}

static void MHEG5interactibleHighlightOff(MHEG5Interactible *interactible, MHEG5Root *item)
{
   assert(interactible);
   assert(item);

   if (!interactible->highlightStatus)
   {
      return;
   }

   interactible->highlightStatus = MHEG5FALSE;
   MHEG5sendSync(item, MHEG5HIGHLIGHTOFF, 0);

   if (interactible->engineResp)
   {
      MHEG5displayRedraw((MHEG5Visible *)item);
   }
}

#ifdef _MOVINGCURSOR_

void MHEG5interactibleCursorEnter(MHEG5Interactible *interactible, MHEG5Root *item)
{
   MHEG5sendEvent(item, MHEG5CURSORENTER, 0);
}

void MHEG5interactibleCursorLeave(MHEG5Interactible *interactible, MHEG5Root *item)
{
   MHEG5sendEvent(item, MHEG5CURSORLEAVE, 0);
}

#endif  /* #ifdef _MOVINGCURSOR_ */


void MHEG5interactibleInteractionCompleted(MHEG5Interactible *interactible, MHEG5Root *item)
{
   MHEG5sendEvent(item, MHEG5INTERACTIONCOMPLETED, 0);
}

/*
   Actions
 */
MHEG5ErrorCode MHEG5setInteractionStatus(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Bool interactionStatus = MHEG5FALSE;
   MHEG5Bool interactionCompleted = MHEG5FALSE;
   MHEG5Interactible *interactible = 0;
   MHEG5Scene *scene = MHEG5getCurrentScene();

   assert(target);

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   if (!scene)
   {
      return MHEG5ERR_NOSCENE;
   }

   MHEG5resolveGenericBoolean(params, &interactionStatus);

   switch (target->clazz)
   {
      case MHEG5HOTSPOT:
      case MHEG5PUSHBUTTON:
      case MHEG5SWITCHBUTTON:
         interactible = &((MHEG5Button *)target)->interactible;
         break;
      case MHEG5SLIDER:
         interactible = &((MHEG5Slider *)target)->interactible;
         break;
      case MHEG5ENTRYFIELD:
         interactible = &((MHEG5Entryfield *)target)->interactible;
         break;
      case MHEG5HYPERTEXT:
         interactible = &((MHEG5Hypertext *)target)->interactible;
         break;
      default:
         return MHEG5ERR_WRONGTARGET;
   }

   if (interactible)
   {
      if ((scene->currentInteractible) && interactionStatus)
      {
         return MHEG5ERR_NOERROR;
      }

      if (interactible->interactionStatus && !interactionStatus)
      {
         interactionCompleted = MHEG5TRUE;
      }

      interactible->interactionStatus = interactionStatus;

      if (target->clazz == MHEG5ENTRYFIELD)
      {
         MHEG5drawEntry((MHEG5Entryfield *)target, CURSOR_INSERT);
      }
      else if (target->clazz == MHEG5HYPERTEXT)
      {
         MHEG5drawHypertext((MHEG5Hypertext *)target );
      }
      MHEG5displayRedraw((MHEG5Visible *) target);

      if ((scene->currentInteractible == target) && (!interactionStatus))
      {
         scene->currentInteractible = 0;
      }

      if ((!scene->currentInteractible) && (interactionStatus))
      {
         scene->currentInteractible = target;
      }

      if (interactionCompleted)
      {
         MHEG5sendEvent(target, MHEG5INTERACTIONCOMPLETED, 0);
      }
   }

   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5getInteractionStatus(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Root *rcVar = 0;
   MHEG5Interactible *interactible = 0;

   assert(target);

   if (!params)
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   MHEG5resolveORef(params, &rcVar);
   switch (target->clazz)
   {
      case MHEG5HOTSPOT:
      case MHEG5PUSHBUTTON:
      case MHEG5SWITCHBUTTON:
         interactible = &((MHEG5Button *)target)->interactible;
         break;
      case MHEG5SLIDER:
         interactible = &((MHEG5Slider *)target)->interactible;
         break;
      case MHEG5ENTRYFIELD:
         interactible = &((MHEG5Entryfield *)target)->interactible;
         break;
      case MHEG5HYPERTEXT:
         interactible = &((MHEG5Hypertext *)target)->interactible;
         break;
      default:
         return MHEG5ERR_WRONGTARGET;
   }
   if (!rcVar)
      return MHEG5ERR_PARAMNOTACTIVE;
   if (rcVar->clazz != MHEG5BOOLEANVARIABLE)
      return MHEG5ERR_WRONGPARAM;
   if (!rcVar->runningStatus)
      return MHEG5ERR_PARAMNOTACTIVE;
   if (interactible)
      ((MHEG5BooleanVariable *) rcVar)->value = interactible->interactionStatus;
   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5setHighlightStatus(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Bool highlightStatus = MHEG5FALSE;
   MHEG5Interactible *interactible = 0;

   assert(target);

   if (!params)
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   MHEG5resolveGenericBoolean(params, &highlightStatus);
   switch (target->clazz)
   {
      case MHEG5HOTSPOT:
      case MHEG5PUSHBUTTON:
      case MHEG5SWITCHBUTTON:
         interactible = &((MHEG5Button *)target)->interactible;
         break;
      case MHEG5SLIDER:
         interactible = &((MHEG5Slider *)target)->interactible;
         break;
      case MHEG5ENTRYFIELD:
         interactible = &((MHEG5Entryfield *)target)->interactible;
         break;
      case MHEG5HYPERTEXT:
         interactible = &((MHEG5Hypertext *)target)->interactible;
         break;
      default:
         return MHEG5ERR_WRONGTARGET;
   }
   if (interactible)
   {
      if (highlightStatus)
         MHEG5interactibleHighlightOn(interactible, target);
      else
         MHEG5interactibleHighlightOff(interactible, target);
   }
   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5getHighlightStatus(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Root *rcVar = 0;
   MHEG5Interactible *interactible = 0;

   if (!params)
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   MHEG5resolveORef(params, &rcVar);
   switch (target->clazz)
   {
      case MHEG5HOTSPOT:
      case MHEG5PUSHBUTTON:
      case MHEG5SWITCHBUTTON:
         interactible = &((MHEG5Button *)target)->interactible;
         break;
      case MHEG5SLIDER:
         interactible = &((MHEG5Slider *)target)->interactible;
         break;
      case MHEG5ENTRYFIELD:
         interactible = &((MHEG5Entryfield *)target)->interactible;
         break;
      case MHEG5HYPERTEXT:
         interactible = &((MHEG5Hypertext *)target)->interactible;
         break;
      default:
         return MHEG5ERR_WRONGTARGET;
   }
   if (!rcVar)
      return MHEG5ERR_PARAMNOTACTIVE;
   if (rcVar->clazz != MHEG5BOOLEANVARIABLE)
      return MHEG5ERR_WRONGPARAM;
   if (!rcVar->runningStatus)
      return MHEG5ERR_PARAMNOTACTIVE;
   if (interactible)
      ((MHEG5BooleanVariable *) rcVar)->value = interactible->highlightStatus;
   return MHEG5ERR_NOERROR;
}