mh5hypertext.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 "mh5hypertext.h"
#include "mh5object.h"          /* for actions */
#include "mh5variable.h"        /* for actions */
#include "mh5display.h"         /* for actions */
#include "mh5memory.h"          /* for constructor/destructor */
#include "mh5queue.h"           /* Events           */
#include <stdlib.h>
#include "mh5drawtext.h"

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

void MHEG5hypertextPrint(MHEG5Hypertext *hypertext, char *out)
{
   MHEG5textPrint(&hypertext->text, out);
   MHEG5interactiblePrint(&hypertext->interactible, out);
   MHEG5indent(out);
   MHEG_PRINT(out, "// LastAnchorFired:\t");
   MHEG5stringPrint( hypertext->lastAnchorFired, out);
   MHEG5newLine(out);
   MHEG_PRINT(out, "// FocusPosition:\t");
   MHEG5intPrint(hypertext->focusPosition, out);
   MHEG5newLine(out);
}

#endif

/*
     Hypertext Class
 */
void MHEG5hypertextUP(MHEG5Hypertext *hypertext)
{
   if ((hypertext->focusPosition != 0) && (hypertext->numberOfLinks != -1))
   {
      if (hypertext->focusPosition > 1)
      {
         hypertext->focusPosition--;
         MHEG5drawHypertext(hypertext);
         return;
      }
      if (hypertext->focusPosition == 1 && hypertext->anchorWrappingFlag == MHEG5TRUE)
      {
         hypertext->focusPosition = hypertext->numberOfLinks;
         MHEG5drawHypertext(hypertext);
         return;
      }
   }
   if (hypertext->anchorWrappingFlag == MHEG5FALSE)
   {
      MHEG5sendEvent((MHEG5Root *)hypertext, MHEG5ANCHORFIRED, HTEXT_TOP_STR );
      /* free any previous anchor string */
      if (hypertext->lafAlloc)
      {
         MHEG5stringDestruct( &hypertext->lastAnchorFired );
         hypertext->lafAlloc = MHEG5FALSE;
      }
      /* Keep an up-to-date copy of the last anchor fired */
      hypertext->lastAnchorFired = LNK_GetString( HTEXT_TOP_STR );
   }
}

void MHEG5hypertextDOWN(MHEG5Hypertext *hypertext)
{
   if ((hypertext->focusPosition != 0) && (hypertext->numberOfLinks != -1))
   {
      if (hypertext->focusPosition < hypertext->numberOfLinks)
      {
         hypertext->focusPosition++;
         MHEG5drawHypertext(hypertext);
         return;
      }
      if (hypertext->focusPosition == hypertext->numberOfLinks &&
          hypertext->anchorWrappingFlag == MHEG5TRUE)
      {
         hypertext->focusPosition = 1;
         MHEG5drawHypertext(hypertext);
         return;
      }
   }
   if (hypertext->anchorWrappingFlag == MHEG5FALSE)
   {
      MHEG5sendEvent((MHEG5Root *)hypertext, MHEG5ANCHORFIRED, HTEXT_BOT_STR );
      /* free any previous anchor string */
      if (hypertext->lafAlloc)
      {
         MHEG5stringDestruct( &hypertext->lastAnchorFired );
         hypertext->lafAlloc = MHEG5FALSE;
      }
      /* Keep an up-to-date copy of the last anchor fired */
      hypertext->lastAnchorFired = LNK_GetString( HTEXT_BOT_STR );
   }
}

void MHEG5hypertextSELECT(MHEG5Hypertext *hypertext)
{
   MHEG5Int anchor = 0;
   unsigned short *data;
   int i, j, len;

   data = (unsigned short *)hypertext->text.visible.ingredient.data;

   if (data)
   {
      /* data associated with the hypertext object */

      /* Search for hypertext anchors */
      for (i = 0; i != hypertext->text.visible.ingredient.dataLen; i++)
      {
         if ((data[i] == 0x1B) && (data[i + 1] == 0x41))
         {
            /* Found an anchor. Increment the counter */
            anchor++;
            len = data[i + 2];
            if (anchor != hypertext->focusPosition)
            {
               i += len + 2; /* skip past this anchor */
               if (i >= hypertext->text.visible.ingredient.dataLen)
               {
                  break;
               }
            }
            else
            {
               /* Found the anchor that we want to fire */

               /* free any previous anchor string */
               if (hypertext->lafAlloc)
               {
                  MHEG5stringDestruct( &hypertext->lastAnchorFired );
                  hypertext->lafAlloc = MHEG5FALSE;
               }

               /* Keep an up-to-date copy of the last anchor fired */
               if (len != 0)
               {
                  hypertext->lastAnchorFired.data = STR_DataAlloc(len);
                  if (hypertext->lastAnchorFired.data)
                  {
                     /* Not out of memory */
                     hypertext->lafAlloc = MHEG5TRUE;

                     for (j = 0; j != len; j++)
                     {
                        /* Note conversion from (unsigned short) to (MHEG5Byte) */
                        hypertext->lastAnchorFired.data[j] = (MHEG5Byte)data[i + 3 + j];
                     }
                     hypertext->lastAnchorFired.len = len;
                  }
                  else
                  {
                     hypertext->lastAnchorFired.len = 0;
                  }
               }
               else
               {
                  hypertext->lastAnchorFired.data = NULL;
                  hypertext->lastAnchorFired.len = 0;
               }

               /* Send the anchor fired event with anchor as parameter */
               MHEG5sendEvent((MHEG5Root *)hypertext, MHEG5ANCHORFIRED,
                  LNK_GetStringIndex( hypertext->lastAnchorFired ));
               break;
            }
         }
      }
   }
}

void MHEG5hyperTextInitCurrentLink(MHEG5Hypertext *hypertext)
{
   hypertext->focusPosition = 0;
   hypertext->numberOfLinks = -1;
   hypertext->anchorWrappingFlag = MHEG5FALSE;
}

/*
     Constructor
 */
void MHEG5hypertextInit(MHEG5Hypertext *hypertext)
{
   assert(hypertext);

   MHEG5textInit(&hypertext->text);
   MHEG5interactibleInit(&hypertext->interactible);
}

void MHEG5hypertextFree(MHEG5Hypertext *hypertext)
{
   assert(hypertext);

   /* free any previous anchor string */
   if (hypertext->lafAlloc)
   {
      MHEG5stringDestruct( &hypertext->lastAnchorFired );
   }
   MHEG5textFree(&hypertext->text);
   MHEG5interactibleFree(&hypertext->interactible);
}

/*
     Internal behaviours
 */
void MHEG5hypertextPrepare(MHEG5Hypertext *hypertext)
{
   assert(hypertext);

   MHEG5interactiblePrepare(&hypertext->interactible);

   hypertext->numberOfLinks = -1;
   hypertext->focusPosition = 0;
   hypertext->lastFocusPosition = 0;
   hypertext->anchorWrappingFlag = MHEG5FALSE;

   MHEG5textPrepare(&hypertext->text);
}

void MHEG5hypertextActivate(MHEG5Hypertext *hypertext)
{
   assert(hypertext);
   if (!hypertext->text.visible.ingredient.root.runningStatus)
   {
      if (!hypertext->text.visible.ingredient.root.availabilityStatus)
      {
         MHEG5interactiblePrepare(&hypertext->interactible);
         hypertext->lastFocusPosition = 0;
      }
      MHEG5hyperTextInitCurrentLink(hypertext);
      MHEG5textActivate(&hypertext->text);
   }
}

void MHEG5hypertextDeactivate(MHEG5Hypertext *hypertext)
{
   assert(hypertext);
   MHEG5textDeactivate(&hypertext->text);

   /* Apply deactivation behaviour inherrited from Interactible class */
   MHEG5interactibleDeactivate(&hypertext->interactible);
}

void MHEG5hypertextDestruct(MHEG5Hypertext *hypertext)
{
   assert(hypertext);

   MHEG5textDestruct(&hypertext->text);
   MHEG5interactibleDestruct(&hypertext->interactible);
}

MHEG5ErrorCode MHEG5getLastAnchorFired(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Root *var = 0;
   MHEG5Hypertext *hypertext;
   MHEG5OctetStringVariable *oc_var;

   assert(target);

   if (target->clazz != MHEG5HYPERTEXT)
   {
      return MHEG5ERR_WRONGTARGET;
   }

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveORef(params, &var);
   if (!var)
   {
      return MHEG5ERR_REFERENCEDPARAMNOTAVAILABLE;
   }
   if (var->clazz != MHEG5OCTETSTRINGVARIABLE)
   {
      return MHEG5ERR_WRONGPARAM;
   }

   oc_var = (MHEG5OctetStringVariable *)var;
   hypertext = (MHEG5Hypertext *)target;
   MHEG5stringDestruct(&oc_var->value);
   oc_var->value = MHEG5stringCopy( hypertext->lastAnchorFired );

   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5getFocusPosition(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Root *var = 0;
   MHEG5Hypertext *hypertext;
   MHEG5IntegerVariable *i_var;

   if (target->clazz != MHEG5HYPERTEXT)
   {
      return MHEG5ERR_WRONGTARGET;
   }
   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveORef(params, &var);
   if (!var)
   {
      return MHEG5ERR_REFERENCEDPARAMNOTAVAILABLE;
   }
   if (var->clazz != MHEG5INTEGERVARIABLE)
   {
      return MHEG5ERR_WRONGPARAM;
   }

   i_var = (MHEG5IntegerVariable *)var;
   hypertext = (MHEG5Hypertext *)target;

   i_var->value = hypertext->focusPosition;

   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5setFocusPosition(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Int focusPosition;
   MHEG5Hypertext *hypertext;

   assert(target);

   if (target->clazz != MHEG5HYPERTEXT)
   {
      return MHEG5ERR_WRONGTARGET;
   }
   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveGenericInteger(params, &focusPosition);

   hypertext = (MHEG5Hypertext *)target;
   hypertext->focusPosition = focusPosition;
   MHEG5drawHypertext(hypertext);
   return MHEG5ERR_NOERROR;
}