Skip to content

Commit a216e8e

Browse files
committed
Rename Identifier constants: ITERATOR -> THIS, ITERATOR2 -> THIS_RAW
The new names better reflects purpose and that fact, that variable `_` (ITERATOR) used not only as reference to the last parsed object in loops, but also as current object in other contexts
1 parent efae9a6 commit a216e8e

25 files changed

+50
-50
lines changed

shared/src/main/scala/io/kaitai/struct/ClassTypeProvider.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class ClassTypeProvider(classSpecs: ClassSpecs, var topClass: ClassSpec) extends
3333
inClass.parentClass.toDataType
3434
case Identifier.IO =>
3535
KaitaiStreamType
36-
case Identifier.ITERATOR =>
36+
case Identifier.THIS =>
3737
currentIteratorType
3838
case Identifier.SWITCH_ON =>
3939
currentSwitchType

shared/src/main/scala/io/kaitai/struct/format/Identifier.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ object Identifier {
8787
val ROOT = "_root"
8888
val PARENT = "_parent"
8989
val IO = "_io"
90-
val ITERATOR = "_"
91-
val ITERATOR2 = "_buf"
90+
val THIS = "_"
91+
val THIS_RAW = "_buf"
9292
val INDEX = "_index"
9393
val SWITCH_ON = "_on"
9494
val IS_LE = "_is_le"

shared/src/main/scala/io/kaitai/struct/languages/CSharpCompiler.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ class CSharpCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
226226
val ioName = s"io_$privateVarName"
227227

228228
val args = rep match {
229-
case RepeatUntil(_) => translator.doName(Identifier.ITERATOR2)
229+
case RepeatUntil(_) => translator.doName(Identifier.THIS_RAW)
230230
case _ => getRawIdExpr(varName, rep)
231231
}
232232

@@ -322,9 +322,9 @@ class CSharpCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
322322

323323
override def handleAssignmentRepeatUntil(id: Identifier, expr: String, isRaw: Boolean): Unit = {
324324
val (typeDecl, tempVar) = if (isRaw) {
325-
("byte[] ", translator.doName(Identifier.ITERATOR2))
325+
("byte[] ", translator.doName(Identifier.THIS_RAW))
326326
} else {
327-
("", translator.doName(Identifier.ITERATOR))
327+
("", translator.doName(Identifier.THIS))
328328
}
329329
out.puts(s"$typeDecl$tempVar = $expr;")
330330
out.puts(s"${privateMemberName(id)}.Add($tempVar);")

shared/src/main/scala/io/kaitai/struct/languages/CppCompiler.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ class CppCompiler(
483483
val ioId = IoStorageIdentifier(id)
484484

485485
val args = rep match {
486-
case RepeatUntil(_) => translator.doName(Identifier.ITERATOR2)
486+
case RepeatUntil(_) => translator.doName(Identifier.THIS_RAW)
487487
case _ => getRawIdExpr(id, rep)
488488
}
489489

@@ -619,9 +619,9 @@ class CppCompiler(
619619

620620
override def handleAssignmentRepeatUntil(id: Identifier, expr: String, isRaw: Boolean): Unit = {
621621
val (typeDecl, tempVar) = if (isRaw) {
622-
("std::string ", translator.doName(Identifier.ITERATOR2))
622+
("std::string ", translator.doName(Identifier.THIS_RAW))
623623
} else {
624-
("", translator.doName(Identifier.ITERATOR))
624+
("", translator.doName(Identifier.THIS))
625625
}
626626

627627
val (wrappedTempVar, rawPtrExpr) = if (config.cppConfig.pointers == UniqueAndRawPointers) {

shared/src/main/scala/io/kaitai/struct/languages/GoCompiler.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ class GoCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
244244
val ioName = idToStr(IoStorageIdentifier(varName))
245245

246246
val args = rep match {
247-
case RepeatUntil(_) => translator.specialName(Identifier.ITERATOR2)
247+
case RepeatUntil(_) => translator.specialName(Identifier.THIS_RAW)
248248
case _ => getRawIdExpr(varName, rep)
249249
}
250250

@@ -341,7 +341,7 @@ class GoCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
341341

342342
override def handleAssignmentRepeatUntil(id: Identifier, r: TranslatorResult, isRaw: Boolean): Unit = {
343343
val expr = translator.resToStr(r)
344-
val tempVar = translator.specialName(if (isRaw) Identifier.ITERATOR2 else Identifier.ITERATOR)
344+
val tempVar = translator.specialName(if (isRaw) Identifier.THIS_RAW else Identifier.THIS)
345345
out.puts(s"$tempVar := $expr")
346346
out.puts(s"${privateMemberName(id)} = append(${privateMemberName(id)}, $tempVar)")
347347
}

shared/src/main/scala/io/kaitai/struct/languages/JavaCompiler.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ class JavaCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
272272
val ioName = idToStr(IoStorageIdentifier(varName))
273273

274274
val args = rep match {
275-
case RepeatUntil(_) => translator.doName(Identifier.ITERATOR2)
275+
case RepeatUntil(_) => translator.doName(Identifier.THIS_RAW)
276276
case _ => getRawIdExpr(varName, rep)
277277
}
278278

@@ -400,9 +400,9 @@ class JavaCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
400400

401401
override def handleAssignmentRepeatUntil(id: Identifier, expr: String, isRaw: Boolean): Unit = {
402402
val (typeDecl, tempVar) = if (isRaw) {
403-
("byte[] ", translator.doName(Identifier.ITERATOR2))
403+
("byte[] ", translator.doName(Identifier.THIS_RAW))
404404
} else {
405-
("", translator.doName(Identifier.ITERATOR))
405+
("", translator.doName(Identifier.THIS))
406406
}
407407
out.puts(s"$typeDecl$tempVar = $expr;")
408408
out.puts(s"${privateMemberName(id)}.add($tempVar);")

shared/src/main/scala/io/kaitai/struct/languages/JavaScriptCompiler.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ class JavaScriptCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
339339
}
340340

341341
override def handleAssignmentRepeatUntil(id: Identifier, expr: String, isRaw: Boolean): Unit = {
342-
val tmpName = translator.doName(if (isRaw) Identifier.ITERATOR2 else Identifier.ITERATOR)
342+
val tmpName = translator.doName(if (isRaw) Identifier.THIS_RAW else Identifier.THIS)
343343
out.puts(s"var $tmpName = $expr;")
344344
out.puts(s"${privateMemberName(id)}.push($tmpName);")
345345
}

shared/src/main/scala/io/kaitai/struct/languages/LuaCompiler.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ class LuaCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
309309
override def handleAssignmentRepeatExpr(id: Identifier, expr: String): Unit =
310310
out.puts(s"${privateMemberName(id)}[i + 1] = $expr")
311311
override def handleAssignmentRepeatUntil(id: Identifier, expr: String, isRaw: Boolean): Unit = {
312-
val tmpName = translator.doName(if (isRaw) Identifier.ITERATOR2 else Identifier.ITERATOR)
312+
val tmpName = translator.doName(if (isRaw) Identifier.THIS_RAW else Identifier.THIS)
313313
out.puts(s"local $tmpName = $expr")
314314
out.puts(s"${privateMemberName(id)}[i + 1] = $tmpName")
315315
}

shared/src/main/scala/io/kaitai/struct/languages/NimCompiler.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class NimCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
6565
val ioName = s"${idToStr(id)}Io"
6666
val arg = rep match {
6767
case NoRepeat => idToStr(id) + "Expr"
68-
case _ => translator.doName(Identifier.ITERATOR2)
68+
case _ => translator.doName(Identifier.THIS_RAW)
6969
}
7070
out.puts(s"let $ioName = newKaitaiStream($arg)")
7171
ioName
@@ -363,8 +363,8 @@ class NimCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
363363
def handleAssignmentIterative(id: Identifier, expr: String): Unit = {
364364
// Need better design for this XXX
365365
val exprName = id match {
366-
case _: RawIdentifier => translator.doName(Identifier.ITERATOR2)
367-
case _ => translator.doName(Identifier.ITERATOR)
366+
case _: RawIdentifier => translator.doName(Identifier.THIS_RAW)
367+
case _ => translator.doName(Identifier.THIS)
368368
}
369369
out.puts(s"let $exprName = $expr")
370370
out.puts(s"${privateMemberName(id)}.add($exprName)")

shared/src/main/scala/io/kaitai/struct/languages/PHPCompiler.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ class PHPCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
241241
val ioName = s"$$_io_${idToStr(id)}"
242242

243243
val args = rep match {
244-
case RepeatUntil(_) => translator.doLocalName(Identifier.ITERATOR2)
244+
case RepeatUntil(_) => translator.doLocalName(Identifier.THIS_RAW)
245245
case _ => getRawIdExpr(id, rep)
246246
}
247247

@@ -313,7 +313,7 @@ class PHPCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
313313
}
314314

315315
override def handleAssignmentRepeatUntil(id: Identifier, expr: String, isRaw: Boolean): Unit = {
316-
val tmpName = translator.doLocalName(if (isRaw) Identifier.ITERATOR2 else Identifier.ITERATOR)
316+
val tmpName = translator.doLocalName(if (isRaw) Identifier.THIS_RAW else Identifier.THIS)
317317
out.puts(s"$tmpName = $expr;")
318318
out.puts(s"${privateMemberName(id)}[] = $tmpName;")
319319
}

0 commit comments

Comments
 (0)