Welcome to mirror list, hosted at ThFree Co, Russian Federation.

im_message.h « IMUI « GUI « Source - github.com/WolfireGames/overgrowth.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: ec326e87319ef4efeb1e128992fa1e76f86d3e1f (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
184
185
186
187
188
189
190
//-----------------------------------------------------------------------------
//           Name: im_message.h
//      Developer: Wolfire Games LLC
//    Description: Internal helper class for communication in adhoc GUIs as 
//                 part of the UI tools  
//        License: Read below
//-----------------------------------------------------------------------------
//
//
//   Copyright 2022 Wolfire Games LLC
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
//
//-----------------------------------------------------------------------------
#pragma once

#include <GUI/IMUI/im_support.h>

class IMElement; // Forward declaration

/*******************************************************************************************/
/**
 * @brief A container for messages and its parameters
 *
 */
struct IMMessage
{
	
    std::string name;
	std::vector<std::string> stringParams;
	std::vector<int> intParams;
	std::vector<float> floatParams;
    
    int refCount; // for AS reference counting

	/*******************************************************************************************/
    /**
     * @brief  Constructor
     * 
     */
    IMMessage(std::string const& _name = "INVALID" ) :
        refCount(1)
    {
        IMrefCountTracker.addRefCountObject("Message");
        
		name = _name;
	}

	/*******************************************************************************************/
    /**
     * @brief  Copy constructor
     * 
     */
    IMMessage( IMMessage const& other )  :
        refCount(1)
    {
        IMrefCountTracker.addRefCountObject("Message");
        
        name = other.name;
        stringParams = other.stringParams;
        intParams = other.intParams;
        floatParams = other.floatParams;
    }
    
	// A few shortcuts for quickly filling in messages
	//  given that the majority of messages will have 0 or 1 parameters
    IMMessage(std::string const& _name, int param )  :
        refCount(1)
    {
        IMrefCountTracker.addRefCountObject("Message");
        
		name = _name;
		intParams.push_back( param );
	}

    IMMessage(std::string const& _name, float param )  :
        refCount(1)
    {
        IMrefCountTracker.addRefCountObject("Message");
        
		name = _name;
		floatParams.push_back( param );
	}

    IMMessage(std::string const& _name, std::string const& param )  :
        refCount(1)
    {
        IMrefCountTracker.addRefCountObject("Message");
        
		name = _name;
		stringParams.push_back( param );
	}
    
    void AddRef()
    {
        // Increase the reference counter
        refCount++;
    }
    
    void Release()
    {
        // Decrease ref count and delete if it reaches 0
        if( --refCount == 0 ) {
            delete this;
        }
    }
    
    static IMMessage* ASFactory( std::string const& name  ) {
        return new IMMessage(name);
    }
    
    static IMMessage* ASFactory_int( std::string const& name, int param  ) {
        return new IMMessage(name, param);
    }
    
    static IMMessage* ASFactory_float( std::string const& name, float param  ) {
        return new IMMessage(name, param);
    }
    
    static IMMessage* ASFactory_string( std::string const& name, std::string const& param  ) {
        return new IMMessage(name, param);
    }
    
    int numInts() {
        return (int) intParams.size();
    }
    
    int numFloats() {
        return (int) floatParams.size();
    }
    
    int numStrings() {
        return (int) stringParams.size();
    }
    
    void addInt( int param ) {
        intParams.push_back( param );
    }
    
    void addFloat( float param ) {
        floatParams.push_back( param );
    }
    
    void addString( std::string const& param ) {
        stringParams.push_back( param );
    }
    
    int getInt( int index ) {
        if( index < (int)intParams.size() ) {
            return intParams[ index ];
        }
        else {
            return 0;
        }
    }
    
    float getFloat( int index ) {
        if( index < (int)floatParams.size() ) {
            return floatParams[ index ];
        }
        else {
            return 0.0;
        }
    }
    
    std::string getString( int index ) {
        if( index < (int)stringParams.size() ) {
            return stringParams[ index ];
        }
        else {
            return "";
        }
    }
    
    ~IMMessage() {
        IMrefCountTracker.removeRefCountObject("Message");
    }
};