npapi_utils.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2013 Ocean Blue Software Ltd
 *
 * 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
 *******************************************************************************/
// pre-processor mechanism so multiple inclusions don't cause compilation error
#ifndef _NPAPI_UTILS_H
#define _NPAPI_UTILS_H

#include "plugin.h"

//---Constant and macro definitions for public use-----------------------------


//---Enumerations for public use-----------------------------------------------

//---Global type defs for public use-------------------------------------------

//---Global Function prototypes for public use---------------------------------
void NP_UtilsInit(void);

void NP_UtilsArrayToResult(NPP instance, U32BIT *array, U32BIT num_elements, NPVariant *result);
void NP_UtilsStringToResult(S_HBBTV_STRING str, NPVariant *result);
void NP_UtilsHbbtvStringToResult(void *hbbtv_string, NPVariant *result);
bool NP_UtilsStringIsNumeric(char *in_string);

/*!**************************************************************************
 * @brief   Extracts a number from an NPVariant and saves it (with casting)
 *          into the U32BIT pointed by output. This function checks whether
 *          the NPVariant contains an uint32_t or a double
 * @param   input - NPVariant variable containing the number
 * @param   output - pointer to an U32BIT variable where to store the result
 * @return  TRUE/FALSE - Success
 ****************************************************************************/
BOOLEAN NP_UtilsGetU32BIT(const NPVariant *input, U32BIT *output);

/*!**************************************************************************
 * @brief   Adds a new event lister to an object.
 * @param   input - NPP plugin instance reference
 * @param   input - Pointer to head of handler list
 * @param   input - NPObject reference to new event handler
 * @param   input - Object-specific event-type id
 * @return  Pointer to new head of the handler list
 ****************************************************************************/
NPObject* NP_UtilsAddEventListener( S_PLUGIN *plugin,
   const NPVariant *value, U32BIT event_type );

/*!**************************************************************************
 * @brief   Remove an event lister from an object.
 * @param   input - Pointer to head of handler list
 * @param   input - NPObject reference of event handler to be removed
 * @return  Pointer to new head of the handler list
 ****************************************************************************/
U32BIT NP_UtilsRemoveEventListener(S_PLUGIN *plugin, NPObject *handler);

/*!**************************************************************************
 * @brief   Free all event handlers for an object.
 * @param   input - Pointer to head of handler list to be freed
 * @return  void
 ****************************************************************************/
void NP_UtilsFreeAllEventListeners(S_PLUGIN *plugin);


/*!**************************************************************************
 * @brief   Call browser's pluginthreadasynccall to execute JS callback function
 * @param   input - NPP plugin instance reference
 * @param   input - NP object of JS Callback function to invoke
 * @param   input - Array of arguments
 * @param   input - Number of arguments
 ****************************************************************************/
void NP_UtilsAsyncCallback( S_PLUGIN **plugin_list, void *handle,
   U32BIT event_type, NPVariant *args, uint32_t num_args );


/*!**************************************************************************
 * @brief   Resolve URL, convert to full path URL, if needed.
 * @param   input - NPP plugin instance reference
 * @param   input/output - URL (input relative or full, output is full path)
 * @return  TRUE - if relative URL and was converted to full path,
 *                 Note: uri->zptr will need to be freed after use.
 *          FALSE - already full path (not touched)
 ****************************************************************************/
BOOLEAN NP_UtilsResolveUrl(NPP instance, S_HBBTV_STRING *uri);

#endif /*_NPAPI_UTILS_H*/
//*****************************************************************************
// End of file
//*****************************************************************************