Line data Source code
1 : // EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University of Illinois,
2 : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
3 : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
4 : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
5 : // contributors. All rights reserved.
6 : //
7 : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
8 : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
9 : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
10 : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
11 : // derivative works, and perform publicly and display publicly, and to permit others to do so.
12 : //
13 : // Redistribution and use in source and binary forms, with or without modification, are permitted
14 : // provided that the following conditions are met:
15 : //
16 : // (1) Redistributions of source code must retain the above copyright notice, this list of
17 : // conditions and the following disclaimer.
18 : //
19 : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
20 : // conditions and the following disclaimer in the documentation and/or other materials
21 : // provided with the distribution.
22 : //
23 : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
24 : // the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
25 : // used to endorse or promote products derived from this software without specific prior
26 : // written permission.
27 : //
28 : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
29 : // without changes from the version obtained under this License, or (ii) Licensee makes a
30 : // reference solely to the software portion of its product, Licensee must refer to the
31 : // software as "EnergyPlus version X" software, where "X" is the version number Licensee
32 : // obtained under this License and may not use a different name for the software. Except as
33 : // specifically required in this Section (4), Licensee shall not use in a company name, a
34 : // product name, in advertising, publicity, or other promotional activities any name, trade
35 : // name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
36 : // similar designation, without the U.S. Department of Energy's prior written consent.
37 : //
38 : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
39 : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
40 : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
41 : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
42 : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
43 : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
44 : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
45 : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
46 : // POSSIBILITY OF SUCH DAMAGE.
47 :
48 : // ObjexxFCL Headers
49 : #include <ObjexxFCL/string.functions.hh>
50 :
51 : // EnergyPlus Headers
52 : #include <EnergyPlus/DataRuntimeLanguage.hh>
53 : #include <EnergyPlus/UtilityRoutines.hh>
54 :
55 : namespace EnergyPlus {
56 :
57 : // Data only module for EMS runtime language
58 :
59 : namespace DataRuntimeLanguage {
60 :
61 : // MODULE INFORMATION:
62 : // AUTHOR Peter Graham Ellis
63 : // DATE WRITTEN June 2006
64 : // MODIFIED Brent Griffith, May 2009
65 : // RE-ENGINEERED na
66 :
67 : // PURPOSE OF THIS MODULE:
68 :
69 : // METHODOLOGY EMPLOYED: na
70 :
71 : // Data
72 : // module should be available to other modules and routines.
73 : // Thus, all variables in this module must be PUBLIC.
74 :
75 170 : void ValidateEMSVariableName(EnergyPlusData &state,
76 : std::string const &cModuleObject, // the current object name
77 : std::string const &cFieldValue, // the field value
78 : std::string const &cFieldName, // the current field name
79 : bool &errFlag, // true if errors found in this routine, false otherwise.
80 : bool &ErrorsFound // true if errors found in this routine, untouched otherwise.
81 : )
82 : {
83 :
84 : // SUBROUTINE INFORMATION:
85 : // AUTHOR Linda Lawrie
86 : // DATE WRITTEN May 2012
87 : // MODIFIED na
88 : // RE-ENGINEERED na
89 :
90 : // PURPOSE OF THIS SUBROUTINE:
91 : // Consolidate error checking on EMS variable names.
92 :
93 : // METHODOLOGY EMPLOYED:
94 : // na
95 :
96 : // REFERENCES:
97 : // na
98 :
99 : // Using/Aliasing
100 :
101 : // Locals
102 : // SUBROUTINE ARGUMENT DEFINITIONS:
103 :
104 : // SUBROUTINE PARAMETER DEFINITIONS:
105 : static constexpr std::string_view InvalidStartCharacters("0123456789");
106 :
107 : // INTERFACE BLOCK SPECIFICATIONS:
108 : // na
109 :
110 : // DERIVED TYPE DEFINITIONS:
111 : // na
112 :
113 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
114 :
115 170 : errFlag = false;
116 170 : if (has(cFieldValue, ' ')) {
117 1 : ShowSevereError(state, format("{}=\"{}\", Invalid variable name entered.", cModuleObject, cFieldValue));
118 1 : ShowContinueError(state, format("...{}; Names used as EMS variables cannot contain spaces", cFieldName));
119 1 : errFlag = true;
120 1 : ErrorsFound = true;
121 : }
122 170 : if (has(cFieldValue, '-')) {
123 1 : ShowSevereError(state, format("{}=\"{}\", Invalid variable name entered.", cModuleObject, cFieldValue));
124 1 : ShowContinueError(state, format("...{}; Names used as EMS variables cannot contain \"-\" characters.", cFieldName));
125 1 : errFlag = true;
126 1 : ErrorsFound = true;
127 : }
128 170 : if (has(cFieldValue, '+')) {
129 1 : ShowSevereError(state, format("{}=\"{}\", Invalid variable name entered.", cModuleObject, cFieldValue));
130 1 : ShowContinueError(state, format("...{}; Names used as EMS variables cannot contain \"+\" characters.", cFieldName));
131 1 : errFlag = true;
132 1 : ErrorsFound = true;
133 : }
134 170 : if (has(cFieldValue, '.')) {
135 1 : ShowSevereError(state, format("{}=\"{}\", Invalid variable name entered.", cModuleObject, cFieldValue));
136 1 : ShowContinueError(state, format("...{}; Names used as EMS variables cannot contain \".\" characters.", cFieldName));
137 1 : errFlag = true;
138 1 : ErrorsFound = true;
139 : }
140 170 : if ((cFieldValue.length() > 0) && (is_any_of(cFieldValue[0], InvalidStartCharacters))) {
141 1 : ShowSevereError(state, format("{}=\"{}\", Invalid variable name entered.", cModuleObject, cFieldValue));
142 1 : ShowContinueError(state, format("...{}; Names used as EMS variables cannot start with numeric characters.", cFieldName));
143 1 : errFlag = true;
144 1 : ErrorsFound = true;
145 : }
146 170 : }
147 :
148 39 : void ValidateEMSProgramName(EnergyPlusData &state,
149 : std::string const &cModuleObject, // the current object name
150 : std::string const &cFieldValue, // the field value
151 : std::string const &cFieldName, // the current field name
152 : std::string const &cSubType, // sub type = Program or Subroutine
153 : bool &errFlag, // true if errors found in this routine, false otherwise.
154 : bool &ErrorsFound // true if errors found in this routine, untouched otherwise.
155 : )
156 : {
157 :
158 : // SUBROUTINE INFORMATION:
159 : // AUTHOR Linda Lawrie
160 : // DATE WRITTEN May 2012
161 : // MODIFIED na
162 : // RE-ENGINEERED na
163 :
164 : // PURPOSE OF THIS SUBROUTINE:
165 : // Consolidate error checking on EMS variable names.
166 :
167 : // METHODOLOGY EMPLOYED:
168 : // na
169 :
170 : // REFERENCES:
171 : // na
172 :
173 : // Using/Aliasing
174 :
175 : // Locals
176 : // SUBROUTINE ARGUMENT DEFINITIONS:
177 :
178 : // SUBROUTINE PARAMETER DEFINITIONS:
179 :
180 : // INTERFACE BLOCK SPECIFICATIONS:
181 : // na
182 :
183 : // DERIVED TYPE DEFINITIONS:
184 : // na
185 :
186 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
187 : // INTEGER :: pos
188 :
189 39 : errFlag = false;
190 39 : if (has(cFieldValue, ' ')) {
191 1 : ShowSevereError(state, format("{}=\"{}\", Invalid variable name entered.", cModuleObject, cFieldValue));
192 1 : ShowContinueError(state, format("...{}; Names used for EMS {} cannot contain spaces", cFieldName, cSubType));
193 1 : errFlag = true;
194 1 : ErrorsFound = true;
195 : }
196 39 : if (has(cFieldValue, '-')) {
197 1 : ShowSevereError(state, format("{}=\"{}\", Invalid variable name entered.", cModuleObject, cFieldValue));
198 1 : ShowContinueError(state, format("...{}; Names used for EMS {} cannot contain \"-\" characters.", cFieldName, cSubType));
199 1 : errFlag = true;
200 1 : ErrorsFound = true;
201 : }
202 39 : if (has(cFieldValue, '+')) {
203 1 : ShowSevereError(state, format("{}=\"{}\", Invalid variable name entered.", cModuleObject, cFieldValue));
204 1 : ShowContinueError(state, format("...{}; Names used for EMS {} cannot contain \"+\" characters.", cFieldName, cSubType));
205 1 : errFlag = true;
206 1 : ErrorsFound = true;
207 : }
208 : // pos=SCAN(cFieldValue(1:1),InvalidStartCharacters)
209 : // IF (pos > 0) THEN
210 : // CALL ShowSevereError(state, TRIM(cModuleObject)//'="'//TRIM(cFieldValue)//'", Invalid variable name entered.')
211 : // CALL ShowContinueError(state, '...'//TRIM(cFieldName)//'; Names used as EMS variables cannot start with numeric characters.')
212 : // errFlag=.TRUE.
213 : // ErrorsFound = .TRUE.
214 : // ENDIF
215 39 : }
216 :
217 : } // namespace DataRuntimeLanguage
218 :
219 : } // namespace EnergyPlus
|
