webengine/wmlengine/src/wml/include/wml_var.h
changeset 0 dd21522fd290
equal deleted inserted replaced
-1:000000000000 0:dd21522fd290
       
     1 /*
       
     2 * Copyright (c) 1999 - 2001 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 /*
       
    20     $Workfile: wml_var.h $
       
    21 
       
    22     Purpose:
       
    23 
       
    24         Function and structure declaration for WML variables and WML variable
       
    25         lists. The core browser manages user defined variables while processing WML
       
    26         documents.
       
    27 */
       
    28 
       
    29 #ifndef WML_VARS_H
       
    30 #define WML_VARS_H
       
    31 
       
    32 #include "nw_wml_var.h"
       
    33 #include "BrsrStatusCodes.h"
       
    34 
       
    35 /* Global function declarations */
       
    36 
       
    37 TBrowserStatusCode NW_WmlVar_ParseList(NW_Ucs2 *str, NW_Int32  *size, NW_Mem_Segment_Id_t mem_scope, NW_Wml_Var_t **ret_var);
       
    38 
       
    39 NW_Wml_VarList_t * NW_WmlVar_NewList(NW_Mem_Segment_Id_t mem_scope);
       
    40 
       
    41 TBrowserStatusCode NW_WmlVar_AddToList(NW_Wml_VarList_t *l, const NW_Ucs2 *n, 
       
    42                                 const NW_Ucs2 *v, NW_Mem_Segment_Id_t mem_scope);
       
    43 
       
    44 TBrowserStatusCode NW_WmlVar_ReplaceValue(NW_Wml_Var_t *v, const NW_Ucs2 *value, NW_Mem_Segment_Id_t mem_scope);
       
    45 
       
    46 NW_Wml_VarList_t * NW_WmlVar_DupList(NW_Wml_VarList_t *l, NW_Mem_Segment_Id_t mem_scope);
       
    47 
       
    48 
       
    49 NW_Ucs2 *NW_WmlVar_GetValue(NW_Wml_VarList_t *l, const NW_Ucs2 *name);
       
    50 
       
    51 NW_Bool NW_WmlVar_Replace(NW_Wml_VarList_t *l, NW_Wml_Var_t *param_var);
       
    52 
       
    53 NW_Wml_Var_t *NW_WmlVar_Get(NW_Wml_VarList_t *l, const NW_Ucs2 *name);
       
    54 
       
    55 NW_Wml_Var_t *NW_WmlVar_Next(NW_Wml_VarList_t *l, NW_Wml_Var_t *current);
       
    56 
       
    57 NW_Bool NW_WmlVar_Remove(NW_Wml_VarList_t *l, NW_Ucs2 *name);
       
    58 
       
    59 void NW_WmlVar_Clear(NW_Wml_VarList_t *l);
       
    60 
       
    61 NW_Wml_Var_t *NW_WmlVar_PopFirst(NW_Wml_VarList_t *l);
       
    62 
       
    63 void NW_WmlVar_AddVarToList(NW_Wml_VarList_t *l, NW_Wml_Var_t *v);
       
    64 
       
    65 NW_Bool NW_WmlVar_IsListEmpty(NW_Wml_VarList_t *l);
       
    66 
       
    67 #endif /* WML_VARS_H */