refactor(token)!: flatten the description packages

j-mie6 · Dec 27, 2024 · ddfef94 · ddfef94
1 parent 694205e
commit ddfef94
Show file tree

Hide file tree

Showing 32 changed files with 37 additions and 46 deletions.
diff --git a/docs/api-guide/token/Lexer.md b/docs/api-guide/token/Lexer.md
@@ -6,10 +6,8 @@ laika.site.metadata.description = "This page describes how Parsley's lexer works
 %}
 
 ```scala mdoc:invisible
-import parsley.token.{Lexer, descriptions, predicate}, descriptions.{LexicalDesc, numeric, text}
+import parsley.token.{Lexer, descriptions, predicate}, descriptions._
 import predicate.CharPredicate
-import numeric._
-import text._
 ```
 
 # Lexer (`parsley.token.Lexer`)

diff --git a/docs/tutorial/interlude-1-haskell.md b/docs/tutorial/interlude-1-haskell.md
@@ -81,8 +81,7 @@ import parsley.Parsley
 
 object lexer {
     import parsley.token.Lexer
-    import parsley.token.descriptions.{LexicalDesc, NameDesc, SymbolDesc, SpaceDesc,
-                                       numeric, text}
+    import parsley.token.descriptions.{LexicalDesc, NameDesc, SymbolDesc, SpaceDesc, NumericDesc, ExponentDesc, EscapeDesc, TextDesc}
     import parsley.token.predicate.{Unicode, Basic}
     import parsley.character.newline
     private val haskellDesc = LexicalDesc(
@@ -97,12 +96,12 @@ object lexer {
             hardOperators = Set("$", "||", "&&", "<", "<=", ">", ">=", "==", "/=", ":",
                                 "++", "+", "-", "*", "/", "^", "."),
         ),
-        numeric.NumericDesc.plain.copy(
-            octalExponentDesc = numeric.ExponentDesc.NoExponents,
-            binaryExponentDesc = numeric.ExponentDesc.NoExponents,
+        NumericDesc.plain.copy(
+            octalExponentDesc = ExponentDesc.NoExponents,
+            binaryExponentDesc = ExponentDesc.NoExponents,
         ),
-        text.TextDesc.plain.copy(
-            escapeSequences = text.EscapeDesc.haskell,
+        TextDesc.plain.copy(
+            escapeSequences = EscapeDesc.haskell,
         ),
         SpaceDesc.plain.copy(
             lineCommentStart = "--",

diff --git a/parsley/shared/src/main/scala/parsley/internal/deepembedding/frontend/Visitors.scala b/parsley/shared/src/main/scala/parsley/internal/deepembedding/frontend/Visitors.scala
@@ -11,7 +11,7 @@ import parsley.debug.{Breakpoint, Profiler}
 import parsley.errors.ErrorBuilder
 import parsley.state.Ref
 import parsley.token.descriptions.SpaceDesc
-import parsley.token.descriptions.numeric.PlusSignPresence
+import parsley.token.descriptions.PlusSignPresence
 import parsley.token.errors.{ErrorConfig, LabelConfig, LabelWithExplainConfig, SpecializedFilterConfig}
 import parsley.token.predicate.CharPredicate
 

diff --git a/parsley/shared/src/main/scala/parsley/internal/deepembedding/singletons/TokenEmbedding.scala b/parsley/shared/src/main/scala/parsley/internal/deepembedding/singletons/TokenEmbedding.scala
@@ -5,8 +5,7 @@
  */
 package parsley.internal.deepembedding.singletons
 
-import parsley.token.descriptions.SpaceDesc
-import parsley.token.descriptions.numeric.PlusSignPresence
+import parsley.token.descriptions.{PlusSignPresence, SpaceDesc}
 import parsley.token.errors.ErrorConfig
 
 import parsley.internal.deepembedding.Sign.SignType

diff --git a/parsley/shared/src/main/scala/parsley/internal/machine/instructions/TokenNumericInstrs.scala b/parsley/shared/src/main/scala/parsley/internal/machine/instructions/TokenNumericInstrs.scala
@@ -5,7 +5,7 @@
  */
 package parsley.internal.machine.instructions
 
-import parsley.token.descriptions.numeric.PlusSignPresence
+import parsley.token.descriptions.PlusSignPresence
 
 import parsley.internal.deepembedding.Sign.{CombinedType, DoubleType, IntType, SignType}
 import parsley.internal.errors.{ExpectItem, ExpectRaw}

diff --git a/parsley/shared/src/main/scala/parsley/token/descriptions/LexicalDesc.scala b/parsley/shared/src/main/scala/parsley/token/descriptions/LexicalDesc.scala
@@ -17,8 +17,8 @@ package parsley.token.descriptions
   */
 final case class LexicalDesc (nameDesc: NameDesc,
                               symbolDesc: SymbolDesc,
-                              numericDesc: numeric.NumericDesc,
-                              textDesc: text.TextDesc,
+                              numericDesc: NumericDesc,
+                              textDesc: TextDesc,
                               spaceDesc: SpaceDesc)
 
 /** This object contains any preconfigured lexical definitions.
@@ -28,5 +28,5 @@ object LexicalDesc {
     /** Defaults to the plain definitions of each sub-description.
       * @since 4.0.0
       */
-    val plain = LexicalDesc(NameDesc.plain, SymbolDesc.plain, numeric.NumericDesc.plain, text.TextDesc.plain, SpaceDesc.plain)
+    val plain = LexicalDesc(NameDesc.plain, SymbolDesc.plain, NumericDesc.plain, TextDesc.plain, SpaceDesc.plain)
 }
diff --git a/parsley/shared/src/main/scala/parsley/token/descriptions/NumericDesc.scala b/parsley/shared/src/main/scala/parsley/token/descriptions/NumericDesc.scala
@@ -3,7 +3,7 @@
  *
  * SPDX-License-Identifier: BSD-3-Clause
  */
-package parsley.token.descriptions.numeric
+package parsley.token.descriptions
 
 /** This class, and its subtypes, describe whether or not the plus sign (`+`) is allowed
   * in a specific position.

diff --git a/parsley/shared/src/main/scala/parsley/token/descriptions/TextDesc.scala b/parsley/shared/src/main/scala/parsley/token/descriptions/TextDesc.scala
@@ -3,7 +3,7 @@
  *
  * SPDX-License-Identifier: BSD-3-Clause
  */
-package parsley.token.descriptions.text
+package parsley.token.descriptions
 
 import parsley.token.predicate.{CharPredicate, Unicode}
 

diff --git a/parsley/shared/src/main/scala/parsley/token/numeric/Generic.scala b/parsley/shared/src/main/scala/parsley/token/numeric/Generic.scala
@@ -10,7 +10,7 @@ import parsley.character, character.{isHexDigit, isOctDigit, satisfy}
 import parsley.combinator.optional
 import parsley.errors.combinator.ErrorMethods
 import parsley.syntax.character.charLift
-import parsley.token.descriptions.numeric.{BreakCharDesc, NumericDesc}
+import parsley.token.descriptions.{BreakCharDesc, NumericDesc}
 import parsley.token.errors.{ErrorConfig, LabelConfig}
 
 private [token] class Generic(err: ErrorConfig) {

diff --git a/parsley/shared/src/main/scala/parsley/token/numeric/Integer.scala b/parsley/shared/src/main/scala/parsley/token/numeric/Integer.scala
@@ -6,7 +6,7 @@
 package parsley.token.numeric
 
 import parsley.Parsley
-import parsley.token.descriptions.numeric.NumericDesc
+import parsley.token.descriptions.NumericDesc
 import parsley.token.errors.{ErrorConfig, LabelWithExplainConfig}
 
 /** This class defines a uniform interface for defining parsers for integer

diff --git a/parsley/shared/src/main/scala/parsley/token/numeric/SignedCombined.scala b/parsley/shared/src/main/scala/parsley/token/numeric/SignedCombined.scala
@@ -6,7 +6,7 @@
 package parsley.token.numeric
 
 import parsley.Parsley, Parsley.atomic
-import parsley.token.descriptions.numeric.NumericDesc
+import parsley.token.descriptions.NumericDesc
 import parsley.token.errors.ErrorConfig
 
 import parsley.internal.deepembedding.Sign.CombinedType

diff --git a/parsley/shared/src/main/scala/parsley/token/numeric/SignedInteger.scala b/parsley/shared/src/main/scala/parsley/token/numeric/SignedInteger.scala
@@ -6,7 +6,7 @@
 package parsley.token.numeric
 
 import parsley.Parsley, Parsley.atomic
-import parsley.token.descriptions.numeric.NumericDesc
+import parsley.token.descriptions.NumericDesc
 import parsley.token.errors.{ErrorConfig, LabelWithExplainConfig}
 
 import parsley.internal.deepembedding.Sign.IntType

diff --git a/parsley/shared/src/main/scala/parsley/token/numeric/SignedReal.scala b/parsley/shared/src/main/scala/parsley/token/numeric/SignedReal.scala
@@ -6,7 +6,7 @@
 package parsley.token.numeric
 
 import parsley.Parsley, Parsley.atomic
-import parsley.token.descriptions.numeric.NumericDesc
+import parsley.token.descriptions.NumericDesc
 import parsley.token.errors.ErrorConfig
 
 import parsley.internal.deepembedding.Sign.DoubleType

diff --git a/parsley/shared/src/main/scala/parsley/token/numeric/UnsignedCombined.scala b/parsley/shared/src/main/scala/parsley/token/numeric/UnsignedCombined.scala
@@ -6,7 +6,7 @@
 package parsley.token.numeric
 
 import parsley.Parsley, Parsley.atomic
-import parsley.token.descriptions.numeric.NumericDesc
+import parsley.token.descriptions.NumericDesc
 import parsley.token.errors.ErrorConfig
 
 import org.typelevel.scalaccompat.annotation.unused

diff --git a/parsley/shared/src/main/scala/parsley/token/numeric/UnsignedInteger.scala b/parsley/shared/src/main/scala/parsley/token/numeric/UnsignedInteger.scala
@@ -10,7 +10,7 @@ import parsley.character.oneOf
 import parsley.combinator.optional
 import parsley.errors.combinator.ErrorMethods
 import parsley.syntax.character.charLift
-import parsley.token.descriptions.numeric.{BreakCharDesc, NumericDesc}
+import parsley.token.descriptions.{BreakCharDesc, NumericDesc}
 import parsley.token.errors.{ErrorConfig, LabelWithExplainConfig}
 
 private [token] final class UnsignedInteger(desc: NumericDesc, err: ErrorConfig, generic: Generic) extends IntegerParsers(desc) {

diff --git a/parsley/shared/src/main/scala/parsley/token/numeric/UnsignedReal.scala b/parsley/shared/src/main/scala/parsley/token/numeric/UnsignedReal.scala
@@ -12,7 +12,7 @@ import parsley.errors.combinator.{amendThenDislodge, entrench}
 import parsley.lift.lift2
 import parsley.state.Ref
 import parsley.syntax.character.charLift
-import parsley.token.descriptions.numeric.{BreakCharDesc, ExponentDesc, NumericDesc}
+import parsley.token.descriptions.{BreakCharDesc, ExponentDesc, NumericDesc}
 import parsley.token.errors.{ErrorConfig, LabelConfig}
 
 private [token] final class UnsignedReal(desc: NumericDesc, err: ErrorConfig, generic: Generic) extends RealParsers(err) {

diff --git a/parsley/shared/src/main/scala/parsley/token/text/ConcreteCharacter.scala b/parsley/shared/src/main/scala/parsley/token/text/ConcreteCharacter.scala
@@ -7,7 +7,7 @@ package parsley.token.text
 
 import parsley.Parsley
 import parsley.character.char
-import parsley.token.descriptions.text.TextDesc
+import parsley.token.descriptions.TextDesc
 import parsley.token.errors.{ErrorConfig, FilterConfig, LabelConfig, LabelWithExplainConfig}
 
 private [token] final class ConcreteCharacter(desc: TextDesc, escapes: Escape, err: ErrorConfig) extends CharacterParsers {

diff --git a/parsley/shared/src/main/scala/parsley/token/text/Escape.scala b/parsley/shared/src/main/scala/parsley/token/text/Escape.scala
@@ -7,7 +7,7 @@ package parsley.token.text
 
 import parsley.Parsley, Parsley.empty
 import parsley.character.char
-import parsley.token.descriptions.text.{EscapeDesc, NumberOfDigits, NumericEscape}
+import parsley.token.descriptions.{EscapeDesc, NumberOfDigits, NumericEscape}
 import parsley.token.errors.{ErrorConfig, NotConfigured}
 import parsley.token.numeric
 

diff --git a/parsley/shared/src/main/scala/parsley/token/text/StringCharacter.scala b/parsley/shared/src/main/scala/parsley/token/text/StringCharacter.scala
@@ -7,7 +7,7 @@ package parsley.token.text
 
 import parsley.Parsley, Parsley.{empty, some}
 import parsley.character.{char, satisfyMap}
-import parsley.token.descriptions.text.EscapeDesc
+import parsley.token.descriptions.EscapeDesc
 import parsley.token.errors.ErrorConfig
 import parsley.token.predicate.{Basic, CharPredicate, NotRequired, Unicode}
 import parsley.unicode.{satisfyMap => satisfyMapUtf16}

diff --git a/parsley/shared/src/test/scala/parsley/internal/deepembedding/frontend/VisitorTests.scala b/parsley/shared/src/test/scala/parsley/internal/deepembedding/frontend/VisitorTests.scala
@@ -18,7 +18,7 @@ import parsley.internal.deepembedding.singletons.token.*
 import parsley.internal.errors.{CaretWidth, FlexibleCaret}
 import parsley.state.Ref
 import parsley.token.descriptions.SpaceDesc
-import parsley.token.descriptions.numeric.PlusSignPresence
+import parsley.token.descriptions.PlusSignPresence
 import parsley.token.errors.{ErrorConfig, BasicFilter, LabelConfig, SpecializedFilterConfig}
 import parsley.token.predicate.Basic
 import parsley.token.errors.NotConfigured

diff --git a/parsley/shared/src/test/scala/parsley/token/DescriptionRequireTests.scala b/parsley/shared/src/test/scala/parsley/token/DescriptionRequireTests.scala
@@ -8,8 +8,6 @@ package parsley.token
 import parsley.ParsleyTest
 
 import descriptions._
-import descriptions.numeric._
-import descriptions.text._
 
 class DescriptionRequireTests extends ParsleyTest {
     "SymbolDesc" should "not allow an intersection between operators and keywords" in {

diff --git a/parsley/shared/src/test/scala/parsley/token/TokeniserTests.scala b/parsley/shared/src/test/scala/parsley/token/TokeniserTests.scala
@@ -25,8 +25,8 @@ class TokeniserTests extends ParsleyTest {
                                                "trait", "abstract", "override", "val", "var", "lazy"),
                             hardOperators = Set(":", "=", "::", ":="),
                             caseSensitive = true),
-            desc.numeric.NumericDesc.plain,
-            desc.text.TextDesc.plain,
+            desc.NumericDesc.plain,
+            desc.TextDesc.plain,
             desc.SpaceDesc(multiLineCommentStart = "/*",
                            multiLineCommentEnd = "*/",
                            lineCommentStart = "//",

diff --git a/parsley/shared/src/test/scala/parsley/token/descriptions/DescGen.scala b/parsley/shared/src/test/scala/parsley/token/descriptions/DescGen.scala
@@ -11,8 +11,6 @@ import parsley.token.predicate.implicits.Basic.charToBasic
 import org.scalacheck.Gen
 import org.scalacheck.Arbitrary
 
-import parsley.token.descriptions.text._
-
 object DescGen {
     // NAMES
     val identifierLetterGen = Gen.oneOf[CharPredicate](

diff --git a/parsley/shared/src/test/scala/parsley/token/descriptions/DescShrink.scala b/parsley/shared/src/test/scala/parsley/token/descriptions/DescShrink.scala
@@ -7,7 +7,6 @@ package parsley.token.descriptions
 
 import org.scalacheck.Shrink
 
-import parsley.token.descriptions.text._
 import org.typelevel.scalaccompat.annotation._
 
 object DescShrink {

diff --git a/parsley/shared/src/test/scala/parsley/token/numeric/RealTests.scala b/parsley/shared/src/test/scala/parsley/token/numeric/RealTests.scala
@@ -9,7 +9,7 @@ import Predef.{ArrowAssoc => _, _}
 
 import parsley.ParsleyTest
 import parsley.token.LexemeImpl
-import parsley.token.descriptions.numeric._, ExponentDesc.NoExponents
+import parsley.token.descriptions._, ExponentDesc.NoExponents
 import parsley.token.errors.ErrorConfig
 import org.scalactic.source.Position
 

diff --git a/parsley/shared/src/test/scala/parsley/token/numeric/SignedIntegerTests.scala b/parsley/shared/src/test/scala/parsley/token/numeric/SignedIntegerTests.scala
@@ -9,7 +9,7 @@ import Predef.{ArrowAssoc => _, _}
 
 import parsley.ParsleyTest
 import parsley.token.LexemeImpl
-import parsley.token.descriptions.numeric._
+import parsley.token.descriptions._
 import parsley.token.errors.ErrorConfig
 import org.scalactic.source.Position
 

diff --git a/parsley/shared/src/test/scala/parsley/token/numeric/UnsignedIntegerTests.scala b/parsley/shared/src/test/scala/parsley/token/numeric/UnsignedIntegerTests.scala
@@ -9,7 +9,7 @@ import Predef.{ArrowAssoc => _, _}
 
 import parsley.ParsleyTest
 import parsley.token.LexemeImpl
-import parsley.token.descriptions.numeric._
+import parsley.token.descriptions._
 import parsley.token.errors.ErrorConfig
 import org.scalactic.source.Position
 

diff --git a/parsley/shared/src/test/scala/parsley/token/text/CharacterTests.scala b/parsley/shared/src/test/scala/parsley/token/text/CharacterTests.scala
@@ -9,7 +9,7 @@ import scala.Predef.{ArrowAssoc => _, _}
 import parsley.ParsleyTest
 import parsley.token.LexemeImpl
 
-import parsley.token.descriptions.text._
+import parsley.token.descriptions._
 import parsley.token.errors.ErrorConfig
 import parsley.token.predicate._
 import org.scalactic.source.Position

diff --git a/parsley/shared/src/test/scala/parsley/token/text/EscapeSemanticPreservationSpec.scala b/parsley/shared/src/test/scala/parsley/token/text/EscapeSemanticPreservationSpec.scala
@@ -10,7 +10,7 @@ import org.scalatest.matchers._
 import org.scalatestplus.scalacheck.ScalaCheckPropertyChecks
 
 import parsley.Parsley.eof
-import parsley.token.descriptions.text._
+import parsley.token.descriptions._
 import parsley.token.errors.ErrorConfig
 import org.scalacheck.Gen
 

diff --git a/parsley/shared/src/test/scala/parsley/token/text/EscapeTests.scala b/parsley/shared/src/test/scala/parsley/token/text/EscapeTests.scala
@@ -8,7 +8,7 @@ package parsley.token.text
 import scala.Predef.{String => SString, ArrowAssoc => _, _}
 import parsley.ParsleyTest
 
-import parsley.token.descriptions.text._
+import parsley.token.descriptions._
 import parsley.token.errors.ErrorConfig
 import org.scalactic.source.Position
 

diff --git a/parsley/shared/src/test/scala/parsley/token/text/OriginalEscape.scala b/parsley/shared/src/test/scala/parsley/token/text/OriginalEscape.scala
@@ -9,7 +9,7 @@ import parsley.Parsley, Parsley.{atomic, empty, pure}
 import parsley.character.{bit, char, digit, hexDigit, octDigit, strings}
 import parsley.combinator.guardS
 import parsley.syntax.zipped._
-import parsley.token.descriptions.text.{EscapeDesc, NumberOfDigits, NumericEscape}
+import parsley.token.descriptions.{EscapeDesc, NumberOfDigits, NumericEscape}
 import parsley.token.errors.{ErrorConfig, NotConfigured}
 import parsley.token.numeric
 

diff --git a/parsley/shared/src/test/scala/parsley/token/text/StringTests.scala b/parsley/shared/src/test/scala/parsley/token/text/StringTests.scala
@@ -9,7 +9,7 @@ import scala.Predef.{ArrowAssoc => _, _}
 import parsley.ParsleyTest
 import parsley.token.LexemeImpl
 
-import parsley.token.descriptions.text._
+import parsley.token.descriptions._
 import parsley.token.errors.ErrorConfig
 import parsley.token.predicate._
 import parsley.character.space