Mercurial > projects > hoofbaby

comparison deps/Platinum/Source/Core/PltArgument.h @ 0:3425707ddbf6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial import (hopefully this mercurial stuff works...)
author fraserofthenight
date Mon, 06 Jul 2009 08:06:28 -0700
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:3425707ddbf6
1 /*****************************************************************
2 |
3 | Platinum - Action Argument
4 |
5 | Copyright (c) 2004-2008, Plutinosoft, LLC.
6 | All rights reserved.
7 | http://www.plutinosoft.com
8 |
9 | This program is free software; you can redistribute it and/or
10 | modify it under the terms of the GNU General Public License
11 | as published by the Free Software Foundation; either version 2
12 | of the License, or (at your option) any later version.
13 |
14 | OEMs, ISVs, VARs and other distributors that combine and
15 | distribute commercially licensed software with Platinum software
16 | and do not wish to distribute the source code for the commercially
17 | licensed software under version 2, or (at your option) any later
18 | version, of the GNU General Public License (the "GPL") must enter
19 | into a commercial license agreement with Plutinosoft, LLC.
20 |
21 | This program is distributed in the hope that it will be useful,
22 | but WITHOUT ANY WARRANTY; without even the implied warranty of
23 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 | GNU General Public License for more details.
25 |
26 | You should have received a copy of the GNU General Public License
27 | along with this program; see the file LICENSE.txt. If not, write to
28 | the Free Software Foundation, Inc.,
29 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 | http://www.gnu.org/licenses/gpl-2.0.html
31 |
32 ****************************************************************/
33
34 #ifndef _PLT_ARGUMENT_H_
35 #define _PLT_ARGUMENT_H_
36
37 /*----------------------------------------------------------------------
38 | includes
39 +---------------------------------------------------------------------*/
40 #include "Neptune.h"
41
42 /*----------------------------------------------------------------------
43 | forward declarations
44 +---------------------------------------------------------------------*/
45 class PLT_StateVariable;
46 class PLT_Argument;
47 class PLT_ActionDesc;
48 typedef NPT_Array<PLT_Argument*> PLT_Arguments;
49
50 /*----------------------------------------------------------------------
51 | PLT_ArgumentDesc
52 +---------------------------------------------------------------------*/
53 class PLT_ArgumentDesc
54 {
55 public:
56 PLT_ArgumentDesc(const char* name,
57 const char* dir = "in",
58 PLT_StateVariable* variable = NULL,
59 bool has_ret = false);
60
61 // accessor methods
62 NPT_Result GetSCPDXML(NPT_XmlElementNode* node);
63 const NPT_String& GetName() const {return m_Name;}
64 const NPT_String& GetDirection() const {return m_Direction;}
65 PLT_StateVariable* GetRelatedStateVariable() {return m_RelatedStateVariable;}
66 bool HasRetValue() {return m_HasReturnValue;}
67
68 protected:
69 NPT_String m_Name;
70 NPT_String m_Direction;
71 PLT_StateVariable* m_RelatedStateVariable;
72 bool m_HasReturnValue;
73 };
74
75 /*----------------------------------------------------------------------
76 | PLT_Argument
77 +---------------------------------------------------------------------*/
78 class PLT_Argument
79 {
80 public:
81 PLT_Argument(PLT_ArgumentDesc* arg_desc);
82
83 // class methods
84 static NPT_Result CreateArgument(PLT_ActionDesc* action_desc,
85 const char* arg_name,
86 const char* arg_value,
87 PLT_Argument*& arg);
88
89 // accessor methods
90 PLT_ArgumentDesc* GetDesc() { return m_ArgDesc; }
91 NPT_Result SetValue(const char* value);
92 const NPT_String& GetValue();
93
94 private:
95 NPT_Result ValidateValue(const char* value);
96
97 protected:
98 PLT_ArgumentDesc* m_ArgDesc;
99 NPT_String m_Value;
100 };
101
102 /*----------------------------------------------------------------------
103 | PLT_ArgumentNameFinder
104 +---------------------------------------------------------------------*/
105 class PLT_ArgumentNameFinder
106 {
107 public:
108 // methods
109 PLT_ArgumentNameFinder(const char* name) : m_Name(name) {}
110
111 bool operator()(PLT_Argument* const & argument) const {
112 return argument->GetDesc()->GetName().Compare(m_Name, true) ? false : true;
113 }
114
115 private:
116 // members
117 NPT_String m_Name;
118 };
119
120 /*----------------------------------------------------------------------
121 | PLT_ArgumentDescNameFinder
122 +---------------------------------------------------------------------*/
123 class PLT_ArgumentDescNameFinder
124 {
125 public:
126 // methods
127 PLT_ArgumentDescNameFinder(const char* name) : m_Name(name) {}
128
129 bool operator()(PLT_ArgumentDesc* const & arg_desc) const {
130 return arg_desc->GetName().Compare(m_Name, true) ? false : true;
131 }
132
133 private:
134 // members
135 NPT_String m_Name;
136 };
137
138 #endif /* _PLT_ARGUMENT_H_ */