HtmlayoutDelphi/HtmlValueH.pas at master · Keksov/HtmlayoutDelphi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
unit HtmlValueH;

(*
  HTMLayout License terms could be found here http://www.terrainformatica.com/htmlayout/prices.whtm
  SDK - http://www.terrainformatica.com/htmlayout/HTMLayoutSDK.zip

  Delphi binding of HTMLayout published under LGPL. Visit https://github.com/Keksov/HtmlayoutDelphi

  This file contains object wrapper for function from include\value.h of
  Most accurate documentation could be found in include\value.h itself
*)

interface

{$IFDEF USER_DEFINES_INC}{$I user_defines.inc}{$ENDIF}

uses Windows, sysutils
;

type

{
Data structures and functions described in this file are used for handling second argument used by these two functions:
    function  HTMLayoutControlGetValue( he : HELEMENT; var pVal : HtmlValue ) : HLDOM_RESULT; stdcall;
    function  HTMLayoutControlSetValue( he : HELEMENT; const pVal : PHtmlValue ) : HLDOM_RESULT; stdcall;
}

    //enum VALUE_RESULT
    VALUE_RESULT = (
        HV_OK_TRUE              = -1,
        HV_OK                   = 0,
        HV_BAD_PARAMETER        = 1,
        HV_INCOMPATIBLE_TYPE    = 2
    );

    RHtmlValue = record
        t                       : UINT;
        u                       : UINT;
        d                       : UINT64;
    end;
    PRHtmlValue = ^RHtmlValue;

    LPCBYTES = PChar;
    FLOAT_VALUE = double;

    //enum VALUE_TYPE
    VALUE_TYPE = (
        T_UNDEFINED             = 0,
        T_NULL                  = 1,
        T_BOOL                  = 2,
        T_INT                   = 3,
        T_FLOAT                 = 4,
        T_STRING                = 5,
        T_DATE                  = 6, // INT64 - contains a 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC), a.k.a. FILETIME on Windows
        T_CURRENCY              = 7, // INT64 - 14.4 fixed number. E.g. dollars = int64 / 10000;
        T_LENGTH                = 8, // length units, value is int or float, units are VALUE_UNIT_TYPE
        T_ARRAY                 = 9,
        T_MAP                   = 10,
        T_FUNCTION              = 11,
        T_BYTES                 = 12, // sequence of bytes - e.g. image data
        T_OBJECT                = 13, // scripting object proxy (TISCRIPT/SCITER)
        T_DOM_OBJECT            = 14 // DOM object (CSSS!), use get_object_data to get HELEMENT
    );

    //enum VALUE_UNIT_TYPE
    VALUE_UNIT_TYPE = (
        UT_EM                   = 1, //height of the element's font.
        UT_EX                   = 2, //height of letter 'x'
        UT_PR                   = 3, //%
        UT_SP                   = 4, //%% "springs", a.k.a. flex units
        reserved1               = 5,
        reserved2               = 6,
        UT_PX                   = 7, //pixels
        UT_IN                   = 8, //inches (1 inch = 2.54 centimeters).
        UT_CM                   = 9, //centimeters.
        UT_MM                   = 10, //millimeters.
        UT_PT                   = 11, //points (1 point = 1/72 inches).
        UT_PC                   = 12, //picas (1 pica = 12 points).
        UT_DIP                  = 13,
        reserved3               = 14,
        UT_COLOR                = 15, // color in int
        UT_URL                  = 16,  // url in string
        UT_SYMBOL               = $FFFF // for T_STRINGs designates symbol string ( so called NAME_TOKEN - CSS or JS identifier )
    );

    //enum VALUE_UNIT_TYPE_DATE
    VALUE_UNIT_TYPE_DATE = (
        DT_HAS_DATE             = $01, // date contains date portion
        DT_HAS_TIME             = $02, // date contains time portion HH:MM
        DT_HAS_SECONDS          = $04, // date contains time and seconds HH:MM:SS
        DT_UTC                  = $10 // T_DATE is known to be UTC. Otherwise it is local date/time
    );


    VALUE_STRING_CVT_TYPE = (
        CVT_SIMPLE,       ///< simple conversion of terminal values
        CVT_JSON_LITERAL, ///< json literal parsing/emission
        CVT_JSON_MAP      ///< json parsing/emission, it parses as if token '{' already recognized
    );

(**
 * ValueInit - initialize VALUE storage
 * This call has to be made before passing VALUE* to any other functions
 *)
function HTMLayoutValueInit( pVal : PRHtmlValue ) : UINT; stdcall;

(**
 * ValueClear - clears the VALUE and deallocates all assosiated structures that are not used anywhere else.
 *)
function HTMLayoutValueClear( pVal : PRHtmlValue ) : UINT; stdcall;

(**
 * ValueType - returns VALUE_TYPE and VALUE_UNIT_TYPE flags of the VALUE
 *)
function HTMLayoutValueType( pVal : PRHtmlValue; var pType : UINT; var pUnits : UINT ) : UINT; stdcall;

(**
 * ValueStringData - returns string data for T_STRING type
 * For T_FUNCTION returns name of the fuction.
 *)
function HTMLayoutValueStringData( pVal : PRHtmlValue; var pChars : LPCWSTR; var pNumChars : UINT ) : UINT; stdcall;

(**
 * ValueFromString - parses string into value:
 * - CVT_SIMPLE - parse/emit terminal values (T_INT, T_FLOAT, T_LENGTH, T_STRING), "guess" non-strict parsing
 * - CVT_JSON_LITERAL - parse/emit value using JSON literal rules: {}, [], "string", true, false, null
 * - CVT_JSON_MAP - parse/emit MAP value without enclosing '{' and '}' brackets.
 * Returns:
 *   Number of non-parsed characters in case of errors. Thus if string was parsed in full it returns 0 (success)
*)
function HTMLayoutValueFromString( const pVal : PRHtmlValue; str : LPCWSTR; strLength : UINT; how : VALUE_STRING_CVT_TYPE ) : UINT; stdcall;

(**
 * ValueToString - converts value to T_STRING inplace:
 * - CVT_SIMPLE - parse/emit terminal values (T_INT, T_FLOAT, T_LENGTH, T_STRING)
 * - CVT_JSON_LITERAL - parse/emit value using JSON literal rules: {}, [], "string", true, false, null
 * - CVT_JSON_MAP - parse/emit MAP value without enclosing '{' and '}' brackets.
 *)
function HTMLayoutValueToString( const pVal : PRHtmlValue; how : VALUE_STRING_CVT_TYPE ) : UINT; stdcall;

implementation

uses HtmlDll;

function HTMLayoutValueInit( pVal : PRHtmlValue ) : UINT; external HTMLayoutDLL name 'ValueInit'; stdcall;
function HTMLayoutValueClear( pVal : PRHtmlValue ) : UINT; external HTMLayoutDLL name 'ValueClear'; stdcall;

function HTMLayoutValueType( pVal : PRHtmlValue; var pType : UINT; var pUnits : UINT ) : UINT; external HTMLayoutDLL name 'ValueType'; stdcall;
function HTMLayoutValueStringData( pVal : PRHtmlValue; var pChars : LPCWSTR; var pNumChars : UINT ) : UINT; external HTMLayoutDLL name 'ValueStringData'; stdcall;

function HTMLayoutValueFromString( const pVal : PRHtmlValue; str : LPCWSTR; strLength : UINT; how : VALUE_STRING_CVT_TYPE ) : UINT; external HTMLayoutDLL name 'ValueFromString'; stdcall;
function HTMLayoutValueToString( const pVal : PRHtmlValue; how : VALUE_STRING_CVT_TYPE ) : UINT; external HTMLayoutDLL name 'ValueToString'; stdcall;

end.