Better pipe assignment tokens, future keywords

bengsig · bengsig · commit 62b98f32515a · 2022-09-19T10:43:43.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
 * oltp: Option to emulate batch with no wait time
 * New more secure syntax for file/pipe open
 * Public utility netthroughput.rwl replaces nettest.rwl
+* Add case, switch, when as future keywords
 
 ## 3.0.2
 
diff --git a/docs/FILE.md b/docs/FILE.md
@@ -13,8 +13,8 @@ There are different assignment operators to allow for read, append, etc:
 * To open for write, simply assign a string containing the file name to it using := or >=.
 * To open for append, use the >>= assignment operator.
 * To open for read, use the <= assignment operator.
-* To open a pipeline for write, use the \|= operator, the concatenation will be the command to execute.
-* To open a pipeline for read, use the =\| operator, the concatenation will be the command to execute.
+* To open a pipeline for write, use the >\|= operator, the concatenation will be the command to execute.
+* To open a pipeline for read, use the <\|= operator, the concatenation will be the command to execute.
 
 The writeline and printline commands of rwloadsim do not include
 advanced output formatting, strings are 
@@ -37,7 +37,7 @@ A simple example of reading from a pipeline is:
 file id;
 string(1000) myid;
 
-id =| "id";
+id <|= "id";
 readline id,myid;
 id := null;
 
@@ -81,7 +81,7 @@ end loop;
 yt := null; # close the file
 
 # use a pipeline to read the file
-yt =| "cat numbers.txt";
+yt <|= "cat numbers.txt";
 
 for readline yt,a,b loop # similar to read a,b in the shell
   printline a,b,sqrt(b);
diff --git a/docs/refman/filestatement.html b/docs/refman/filestatement.html
diff --git a/docs/refman/statement.html b/docs/refman/statement.html
diff --git a/man/man1rwl/filestatement.1rwl b/man/man1rwl/filestatement.1rwl
@@ -2,7 +2,7 @@
 .SH NAME
 file, filestatement \- RWP*Load Simulator use of files
 .SH SYNTAX
-identifier ( \fB:=\fR | \fB>=\fR | \fB>>=\fR | \fB<=\fR | \fB|=\fR | \fB=|\fR ) concatenation
+identifier ( \fB:=\fR | \fB>=\fR | \fB>>=\fR | \fB<=\fR | \fB>|=\fR | \fB<|=\fR ) concatenation
 .P
 identifier
 .B := null
@@ -63,13 +63,13 @@ v \fB<=\fR e
 Open a file for reading.
 .RE
 .P
-v \fB|=\fR e 
+v \fB>|=\fR e 
 .RS 4
 Open a pipeline for writing; the concatenation will be given to the popen() call with 
 a second argument of "w".
 .RE
 .P
-v \fB=|\fR e 
+v \fB<|=\fR e 
 .RS 4
 Open a pipeline for reading; the concatenation will be given to the popen() call with 
 a second argument of "r".
diff --git a/man/man1rwl/statement.1rwl b/man/man1rwl/statement.1rwl
@@ -7,7 +7,7 @@ statement ::=
   simpledeclaration
 | identifier \fB(\fR [ concatenation { \fB,\fR concatenation } ] \fB)\fR [ atclause ]
 | identifier ( \fB:=\fR | \fB||=\fR | \fB+=\fR ) concatenation
-| identifier ( \fB<=\fR | \fB>=\fR | \fB>>=\fR | \fB|=\fR | \fB=|\fR ) concatenation
+| identifier ( \fB<=\fR | \fB>=\fR | \fB>>=\fR | \fB>|=\fR | \fB<|=\fR ) concatenation
 | \fBnull\fR [ concatenation ]
 | \fBreturn\fR [ concatenation ]
 | \fBexit\fR concatenation
@@ -60,7 +60,7 @@ Assignments are not expressions, so you cannot do something like:
 .PP
 a := b := 0;
 .PP
-The assignment operators \fB>=\fR, \fB>>=\fR, \fB<=\fR, \fB|=\fR, \fB=|\fR are used
+The assignment operators \fB>=\fR, \fB>>=\fR, \fB<=\fR, \fB>|=\fR, \fB<|=\fR are used
 with files to respectively open for write, append, read, write to a pipeline or
 read from a pipeline.
 See filestatement(1rwl) for details.
diff --git a/src/rwl.h b/src/rwl.h
@@ -13,6 +13,7 @@
  *
  * History
  *
+ * bengsig  19-sep-2022 - Future keywords
  * bengsig  10-aug-2022 - Output userhelp in order from rwl source file
  * bengsig  11-jul-2022 - $sessionpool_no_rlb directive
  * bengsig  28-jun-2022 - Generate project
@@ -887,6 +888,7 @@ struct rwl_main
 #define RWL_P3_GENERATE_OK   0x00200000 // OK to actually generate
 #define RWL_P3_GEN_SENSITIVE 0x00400000 // During generation, a sensible keyword was found
 #define RWL_P3_SP_NORLB      0x00800000 // $sessionpool_no_rlb:on (which is default)
+#define RWL_P3_FUTNOTIDENT   0x01000000 // warn about an identifier becoming a keyword
 
   int userexit; // value for user exit
 
diff --git a/src/rwldilex.l b/src/rwldilex.l
@@ -241,7 +241,8 @@
 ":="			|
 ">>="			|
 "<<="			|
-"=|"			|
+">|="			|
+"<|="			|
 "+="			|
 "sql_id"  		|
 "serverrelease" 	|
diff --git a/src/rwlerror.h b/src/rwlerror.h
@@ -11,6 +11,7 @@
  *
  * History
  *
+ * bengsig  19-sep-2022 - Future keywords
  * bengsig  15-sep-2022 - New file assignment operators
  * bengsig  12-sep-2022 - More options to access function
  * bengsig  11-jul-2022 - Correct option error
@@ -1598,3 +1599,9 @@ RWLERROR("closing a file with an operator used for open", RWL_ERROR_WARNING)
 RWLEDESC("You are using one of the operators used to open a file or pipeline to\n"
 "close a file by assigning null to it. You should use the := operator")
 
+#define RWL_ERROR_RESERVED_FOR_FUTURE2 293
+RWLERROR("'%s' will be a keyword in a future release", RWL_ERROR_WARNING)
+RWLEDESC("You are using an identifier that in some future release will be a keyword.\n"
+"You should change your code and use a different identifer as it otherwise will"
+"cause a syntax error in the future")
+
diff --git a/src/rwllexer.l b/src/rwllexer.l
@@ -11,6 +11,7 @@
  *
  * History
  *
+ * bengsig  19-sep-2022 - Future keywords
  * bengsig  15-sep-2022 - New file assignment operators
  * bengsig  11-jul-2022 - $sessionpool_no_rlb directive
  * bengsig  28-jun-2022 - Generate project
@@ -585,9 +586,9 @@
   /*LEXTAG:RWL_T_CONCAT*/
 "||"			if (!rwm->ifdirbit) return RWL_T_CONCAT;
   /*LEXTAG:RWL_T_PIPETO*/
-"|="			if (!rwm->ifdirbit) return RWL_T_PIPETO;
+">|="			if (!rwm->ifdirbit) return RWL_T_PIPETO;
   /*LEXTAG:RWL_T_PIPEFROM*/
-"=|"			if (!rwm->ifdirbit) return RWL_T_PIPEFROM;
+"<|="			if (!rwm->ifdirbit) return RWL_T_PIPEFROM;
   /*LEXTAG:RWL_T_APPEND*/
 "||="			if (!rwm->ifdirbit) return RWL_T_APPEND;
   /*LEXTAG:RWL_T_SERVERRELEASE*/
@@ -643,6 +644,19 @@
     			  if (!rwm->ifdirbit) return RWL_T_ASNPLUS;
 		        }
 
+"when" |
+"switch" |
+"case"			{
+			  bic(rwm->m3flags, RWL_P3_WARNSQLKW);
+			  if (!rwm->ifdirbit)
+			  {
+			    rwm->previnam = rwm->inam;
+			    rwm->inam = rwlstrdup(rwm, (text *)yytext);
+			    bis(rwm->m3flags, RWL_P3_FUTNOTIDENT);
+			    return RWL_T_IDENTIFIER;
+			  }
+			}
+
   /*LEXTAG:RWL_T_IDENTIFIER*/
 [a-zA-Z_][a-zA-Z0-9_]*	{
 			  /*
diff --git a/src/rwlvariable.c b/src/rwlvariable.c
@@ -11,6 +11,7 @@
  *
  * History
  *
+ * bengsig  19-sep-2022 - Future keywords
  * bengsig  16-may-2022 - Debug bit 0x40 to printvar internal
  * bengsig  16-may-2022 - Flush local sql upon exit
  * bengsig  31-mar-2022 - Warn if using future sql keyword as identifier
@@ -57,6 +58,10 @@ sb4 rwladdvar2(rwl_main *rwm, text *varn, rwl_type vart, ub2 flags, text *pname)
     return RWL_VAR_NOGUESS;
   }
 
+  if (bit(rwm->m3flags, RWL_P3_FUTNOTIDENT))
+    rwlerror(rwm, RWL_ERROR_RESERVED_FOR_FUTURE2, varn);
+  bic(rwm->m3flags, RWL_P3_FUTNOTIDENT);
+
   switch(vart)
   {
     case RWL_TYPE_NONE: stype = "none"; break;
diff --git a/test/124.rwl b/test/124.rwl
@@ -29,6 +29,6 @@ stderr := null;
 writeline stderr, "is it null";
 
 # show the file we wrote
-bla |= "cat - 124.txt";
+bla >|= "cat - 124.txt";
 writeline bla, "super duper";
 bla := null;
diff --git a/test/140.rwl b/test/140.rwl
@@ -23,7 +23,7 @@ seldual;
 
 printline sql_id(seldual);
 
-out |= "cat - 140.out";
+out >|= "cat - 140.out";
 writeline out, sql_id(seldual);
 out := null;
 
diff --git a/test/172.rwl b/test/172.rwl
@@ -5,7 +5,7 @@ file x;
 procedure fullline(string cmd)
 
   string(65) s;
-  x =| cmd;
+  x <|= cmd;
 
   for readline x, s loop
     printline s;
@@ -33,7 +33,7 @@ integer a1,a5;
 procedure line6(string cmd, integer limit)
   string s2,s4,s6;
   double d3;
-  x =| cmd;
+  x <|= cmd;
 
   for readline x,a1,s2,d3,s4,a5,s6 and limit>0 loop
     if a1 is null then print "a1null "; end;
diff --git a/test/242.rwl b/test/242.rwl
@@ -4,7 +4,7 @@ file x;
 
 procedure test242(integer b)
   integer i, j;
-  x =| "for x in 1 2 3 4 5 6 7 8 ; do echo $x ; done";
+  x <|= "for x in 1 2 3 4 5 6 7 8 ; do echo $x ; done";
 
   i := 0;
 
diff --git a/test/308.rwl b/test/308.rwl
@@ -0,0 +1,5 @@
+integer case; # warn about this
+
+case := 123;
+
+printline case;
diff --git a/test/36.rwl b/test/36.rwl
@@ -2,7 +2,7 @@ file sort; # check files as command lines
 integer i;
 
 procedure fubar()
-  sort |= "sort";
+  sort >|= "sort";
   for i:= 1..20 loop
     writeline sort, uniform(1,100);
   end;
diff --git a/test/test.sh b/test/test.sh
@@ -46,7 +46,7 @@ if test $# -gt 0
 then
   testlist="$*"
 else
-  testlist='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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307'
+  testlist='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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308'
 fi
 
 diffokcount=0;
diff --git a/test/testres/308.err.good b/test/testres/308.err.good
@@ -0,0 +1 @@
+RWL-293: warning at [308.rwl;1]: 'case' will be a keyword in a future release
diff --git a/test/testres/308.out.good b/test/testres/308.out.good
@@ -0,0 +1 @@
+123

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`*`
`14`	`14`	`* History`
`15`	`15`	`*`
	`16`	`+ * bengsig 19-sep-2022 - Future keywords`
`16`	`17`	`* bengsig 10-aug-2022 - Output userhelp in order from rwl source file`
`17`	`18`	`* bengsig 11-jul-2022 - $sessionpool_no_rlb directive`
`18`	`19`	`* bengsig 28-jun-2022 - Generate project`
`@@ -887,6 +888,7 @@ struct rwl_main`
`887`	`888`	`#define RWL_P3_GENERATE_OK 0x00200000 // OK to actually generate`
`888`	`889`	`#define RWL_P3_GEN_SENSITIVE 0x00400000 // During generation, a sensible keyword was found`
`889`	`890`	`#define RWL_P3_SP_NORLB 0x00800000 // $sessionpool_no_rlb:on (which is default)`
	`891`	`+#define RWL_P3_FUTNOTIDENT 0x01000000 // warn about an identifier becoming a keyword`
`890`	`892`
`891`	`893`	`int userexit; // value for user exit`
`892`	`894`