hbbtv_string.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
 *******************************************************************************/
#ifndef _HBBTV_STRING_H

#define _HHBTV_STRING_H


#include "hbbtv.h"
#include "hbbtv_types.h"
#include "hbbtv_sif_conf.h"


extern void *JS_HBBTV_STRING_CLASS;

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

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

typedef enum
{
   STRING_FORMAT_UNKNOWN,
   STRING_FORMAT_DVB,
   STRING_FORMAT_UTF8,
   STRING_FORMAT_UTF16,
   STRING_FORMAT_UTF8_LATIN1 // used to hold descriptor data
} E_STRING_FORMAT;


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

/*---Global Function prototypes for public use---------------------------------*/
S_HBBTV_STRING HBBTV_StrCreate(U32BIT strlen, U8BIT *data);

void HBBTV_StrFree(S_HBBTV_STRING *string);

/*
 * @brief   Creates a copy of the given S_HBBTV_STRING
 * @param   source source S_HBBTV_STRING to copy from
 * @return  S_HBBTV_STRING containing the same caracters contained in source
 */
S_HBBTV_STRING HBBTV_StrCopy(S_HBBTV_STRING source);

S_HBBTV_STRING HBBTV_StrGetUrlOrigin(S_HBBTV_STRING *url);

void* HBBTV_JSStringCreate(S_HBBTV_STRING *value, E_STRING_FORMAT format);

void* HBBTV_JSStringCreateFromAscii(U8BIT *ascii_string);

void* HBBTV_JSStringCreateFromUtf8(U8BIT *utf_string);

void* HBBTV_JSStringCreateFromUtf16(U16BIT *utf_string);

void HBBTV_JSStringReplace(void *string, S_HBBTV_STRING *value);

BOOLEAN HBBTV_JSStringEqual(void *obj, S_HBBTV_STRING *string, BOOLEAN ignore_case);

S8BIT HBBTV_JSStringCompare(void *obj, S_HBBTV_STRING *str2, BOOLEAN ignore_case);

BOOLEAN HBBTV_JSStringContains(void *obj, S_HBBTV_STRING *str2, BOOLEAN ignore_case);

void HBBTV_JSStringSetFormat(E_HBBTV_STRING_FORMAT string_format);

/*
 * @brief Return a string in ISO Latin1 format. For now only converts from UTF-8
 * @param obj - string object
 * @param length - length in bytes of the returned buffer
 * @return ISO Latin1 string which should be released using HBBTV_JSString_releaseString
 */
U8BIT* HBBTV_JSStringGetStringLatin1(void *obj, U32BIT *length);

#endif  /* _HBBTV_STRING_H */