summaryrefslogtreecommitdiff
path: root/indra/llmessage/llnamevalue.h
blob: 4016c268d244f5251c16cc5f83a9b4c7f82e219c (plain)
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/**
 * @file llnamevalue.h
 * @brief class for defining name value pairs.
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLNAMEVALUE_H
#define LL_LLNAMEVALUE_H

// As of January 2008, I believe we only use the following name-value
// pairs.  This is hard to prove because they are initialized from
// strings.  JC
//
// FirstName STRING
// LastName STRING
// AttachPt U32
// AttachmentItemId STRING
// Title STRING
// AttachmentOffset VEC3
// AttachmentOrientation VEC3
// SitObject STRING
// SitPosition VEC3

#include "llstringtable.h"
#include "llmath.h"
#include "v3math.h"
#include "lldbstrings.h"

class LLNameValue;
class LLStringTable;

typedef enum e_name_value_types
{
    NVT_NULL,
    NVT_STRING,
    NVT_F32,
    NVT_S32,
    NVT_VEC3,
    NVT_U32,
    NVT_CAMERA, // Deprecated, but leaving in case removing this will cause problems
    NVT_ASSET,
    NVT_U64,
    NVT_EOF
} ENameValueType;

typedef enum e_name_value_class
{
    NVC_NULL,
    NVC_READ_ONLY,
    NVC_READ_WRITE,
    NVC_EOF
} ENameValueClass;

typedef enum e_name_value_sento
{
    NVS_NULL,
    NVS_SIM,
    NVS_DATA_SIM,
    NVS_SIM_VIEWER,
    NVS_DATA_SIM_VIEWER,
    NVS_EOF
} ENameValueSendto;


// NameValues can always be "printed" into a buffer of this length.
const U32 NAME_VALUE_BUF_SIZE = 1024;


const U32 NAME_VALUE_TYPE_STRING_LENGTH = 8;
const U32 NAME_VALUE_CLASS_STRING_LENGTH = 16;
const U32 NAME_VALUE_SENDTO_STRING_LENGTH = 18;
const U32 NAME_VALUE_DATA_SIZE =
            NAME_VALUE_BUF_SIZE -
            ( DB_NV_NAME_BUF_SIZE +
            NAME_VALUE_TYPE_STRING_LENGTH +
            NAME_VALUE_CLASS_STRING_LENGTH +
            NAME_VALUE_SENDTO_STRING_LENGTH );


extern char NameValueTypeStrings[NVT_EOF][NAME_VALUE_TYPE_STRING_LENGTH];           /* Flawfinder: Ignore */
extern char NameValueClassStrings[NVC_EOF][NAME_VALUE_CLASS_STRING_LENGTH];     /* Flawfinder: Ignore */
extern char NameValueSendtoStrings[NVS_EOF][NAME_VALUE_SENDTO_STRING_LENGTH];       /* Flawfinder: Ignore */

typedef union u_name_value_reference
{
    char        *string;
    F32         *f32;
    S32         *s32;
    LLVector3   *vec3;
    U32         *u32;
    U64         *u64;
} UNameValueReference;


class LLNameValue
{
public:
    void baseInit();
    void init(const char *name, const char *data, const char *type, const char *nvclass, const char *nvsendto );

    LLNameValue();
    LLNameValue(const char *data);
    LLNameValue(const char *name, const char *type, const char *nvclass );
    LLNameValue(const char *name, const char *data, const char *type, const char *nvclass );
    LLNameValue(const char *name, const char *data, const char *type, const char *nvclass, const char *nvsendto );

    ~LLNameValue();

    char            *getString();
    const char      *getAsset() const;
    F32             *getF32();
    S32             *getS32();
    void            getVec3(LLVector3 &vec);
    LLVector3       *getVec3();
    U32             *getU32();
    U64             *getU64();

    const char      *getType() const        { return mStringType; }
    const char      *getClass() const       { return mStringClass; }
    const char      *getSendto() const      { return mStringSendto; }

    BOOL            sendToData() const;
    BOOL            sendToViewer() const;

    void            callCallback();
    std::string     printNameValue() const;
    std::string     printData() const;

    ENameValueType      getTypeEnum() const     { return mType; }
    ENameValueClass     getClassEnum() const    { return mClass; }
    ENameValueSendto    getSendtoEnum() const   { return mSendto; }

    LLNameValue     &operator=(const LLNameValue &a);
    void            setString(const char *a);
    void            setAsset(const char *a);
    void            setF32(const F32 a);
    void            setS32(const S32 a);
    void            setVec3(const LLVector3 &a);
    void            setU32(const U32 a);

    friend std::ostream&        operator<<(std::ostream& s, const LLNameValue &a);

private:
    void            printNameValue(std::ostream& s);

public:
    char                        *mName;

    char                        *mStringType;
    ENameValueType              mType;
    char                        *mStringClass;
    ENameValueClass             mClass;
    char                        *mStringSendto;
    ENameValueSendto            mSendto;

    UNameValueReference         mNameValueReference;
    LLStringTable               *mNVNameTable;
};

extern LLStringTable    gNVNameTable;


#endif