Skip to content

Commit 128e179

Browse files
committed
Rename methods by replacing "opaque" with "external"
This is to reflect the new meaning of these methods since b2ec9e5, when they were updated to process all external types from the perspective of the current type, not only opaque types.
1 parent a03420c commit 128e179

11 files changed

+22
-22
lines changed

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class ClassCompiler(
1919

2020
override def compile: CompileLog.SpecSuccess = {
2121
lang.fileHeader(topClassName.head)
22-
compileOpaqueClasses(topClass)
22+
compileExternalClasses(topClass)
2323
compileClass(topClass)
2424
lang.fileFooter(topClassName.head)
2525

@@ -29,9 +29,9 @@ class ClassCompiler(
2929
)
3030
}
3131

32-
def compileOpaqueClasses(topClass: ClassSpec) = {
33-
TypeProcessor.getOpaqueClasses(topClass).foreach((classSpec) =>
34-
lang.opaqueClassDeclaration(classSpec)
32+
def compileExternalClasses(topClass: ClassSpec) = {
33+
TypeProcessor.getExternalClasses(topClass).foreach((classSpec) =>
34+
lang.externalClassDeclaration(classSpec)
3535
)
3636
}
3737

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class NimClassCompiler(
2121

2222
override def compile: CompileLog.SpecSuccess = {
2323
lang.fileHeader(classNameFlattened(topClass))
24-
compileOpaqueClasses(topClass)
24+
compileExternalClasses(topClass)
2525

2626
// if there are any enums at all maybe we can detect it and not generate this template
2727
// nimlang.enumTemplate

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,28 @@ import io.kaitai.struct.format._
77
import scala.collection.mutable
88

99
object TypeProcessor {
10-
def getOpaqueClasses(curClass: ClassSpec): Iterable[ClassSpec] = {
10+
def getExternalClasses(curClass: ClassSpec): Iterable[ClassSpec] = {
1111
val res = mutable.Set[ClassSpec]()
1212
curClass.seq.map((attr) =>
13-
res ++= getOpaqueDataTypes(attr.dataType, curClass)
13+
res ++= getExternalDataTypes(attr.dataType, curClass)
1414
)
1515
curClass.instances.foreach { case (_, inst) =>
1616
inst match {
1717
case pis: ParseInstanceSpec =>
18-
res ++= getOpaqueDataTypes(pis.dataType, curClass)
18+
res ++= getExternalDataTypes(pis.dataType, curClass)
1919
case _ => None
2020
}
2121
}
2222

2323
// Traverse all nested types recursively
2424
curClass.types.foreach { case (_, nestedType) =>
25-
res ++= getOpaqueClasses(nestedType)
25+
res ++= getExternalClasses(nestedType)
2626
}
2727

2828
res
2929
}
3030

31-
def getOpaqueDataTypes(dataType: DataType, curClass: ClassSpec): Iterable[ClassSpec] = {
31+
def getExternalDataTypes(dataType: DataType, curClass: ClassSpec): Iterable[ClassSpec] = {
3232
dataType match {
3333
case ut: UserType =>
3434
if (ut.isExternal(curClass)) {
@@ -38,10 +38,10 @@ object TypeProcessor {
3838
}
3939
case st: SwitchType =>
4040
st.cases.flatMap { case (_, ut) =>
41-
getOpaqueDataTypes(ut, curClass)
41+
getExternalDataTypes(ut, curClass)
4242
}
4343
case _ =>
44-
// all other types are not opaque external user types
44+
// all other types are not external user types
4545
List()
4646
}
4747
}

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class CppCompiler(
108108
}
109109
}
110110

111-
override def opaqueClassDeclaration(classSpec: ClassSpec): Unit = {
111+
override def externalClassDeclaration(classSpec: ClassSpec): Unit = {
112112
classForwardDeclaration(classSpec.name)
113113
importListHdr.addLocal(outFileNameHeader(classSpec.name.head))
114114
}

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class JavaScriptCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
5858
out.puts("});")
5959
}
6060

61-
override def opaqueClassDeclaration(classSpec: ClassSpec): Unit = {
61+
override def externalClassDeclaration(classSpec: ClassSpec): Unit = {
6262
val className = type2class(classSpec.name.head)
6363
importList.add(s"./$className")
6464
}

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class LuaCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
3232
override def outImports(topClass: ClassSpec) =
3333
importList.toList.mkString("", "\n", "\n")
3434

35-
override def opaqueClassDeclaration(classSpec: ClassSpec): Unit =
35+
override def externalClassDeclaration(classSpec: ClassSpec): Unit =
3636
importList.add("require(\"" + classSpec.name.head + "\")")
3737

3838
override def fileHeader(topClassName: String): Unit = {

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class NimCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
5454
out.puts
5555
}
5656

57-
override def opaqueClassDeclaration(classSpec: ClassSpec): Unit =
57+
override def externalClassDeclaration(classSpec: ClassSpec): Unit =
5858
importList.add(classSpec.name.head)
5959
override def innerEnums = false
6060
override val translator: NimTranslator = new NimTranslator(typeProvider, importList)

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class PerlCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
5050
out.puts("1;")
5151
}
5252

53-
override def opaqueClassDeclaration(classSpec: ClassSpec): Unit =
53+
override def externalClassDeclaration(classSpec: ClassSpec): Unit =
5454
importList.add(type2class(classSpec.name.head))
5555

5656
override def classHeader(name: List[String]): Unit = {

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ class PythonCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
7777
out.puts
7878
}
7979

80-
override def opaqueClassDeclaration(classSpec: ClassSpec): Unit = {
80+
override def externalClassDeclaration(classSpec: ClassSpec): Unit = {
8181
val name = classSpec.name.head
8282
importList.add(
8383
if (config.pythonPackage.nonEmpty) {

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class RustCompiler(typeProvider: ClassTypeProvider, config: RuntimeConfig)
5454
out.puts
5555
}
5656

57-
override def opaqueClassDeclaration(classSpec: ClassSpec): Unit = {
57+
override def externalClassDeclaration(classSpec: ClassSpec): Unit = {
5858
val name = type2class(classSpec.name.last)
5959
val pkg = type2classAbs(classSpec.name)
6060

shared/src/main/scala/io/kaitai/struct/languages/components/LanguageCompiler.scala

+3-3
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ abstract class LanguageCompiler(
7575
def fileFooter(topClassName: String): Unit = {}
7676

7777
/**
78-
* Outputs declaration of "opaque class", i.e. class that will be referred to in this file, but
78+
* Outputs declaration of "external class", i.e. class that will be referred to in this file, but
7979
* not declared here. Some languages require either a "forward declaration" in this case, or a
80-
* statement to import that class, or something similar. Called once per each opaque class.
80+
* statement to import that class, or something similar. Called once per each external class.
8181
* @param classSpec
8282
*/
83-
def opaqueClassDeclaration(classSpec: ClassSpec): Unit = {}
83+
def externalClassDeclaration(classSpec: ClassSpec): Unit = {}
8484

8585
def classDoc(name: List[String], doc: DocSpec): Unit = {}
8686
def classHeader(name: List[String]): Unit

0 commit comments

Comments
 (0)