Added TODOs to appropriate locations that describe the future for tscn (

#236)
porkbrain · Sep 4, 2024 · a20f7b7 · a20f7b7
1 parent 614823b
commit a20f7b7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/main_game_lib/src/rscn.rs b/main_game_lib/src/rscn.rs
@@ -15,6 +15,11 @@
 //! relationships are preserved. Plain nodes are typically components.
 //! See the wiki for current status of what's supported and what custom nodes
 //! are available.
+//!
+//! TODO(https://github.com/porkbrain/dont-count-the-sheep/issues/235):
+//! Needs further refactor: separation of concerns between stages of
+//! representations; lexing vs parsing; support for async spawning of scenes;
+//! support for a signal when all textures are loaded
 
 mod intermediate_repr;
 mod loader;

diff --git a/main_game_lib/src/rscn/token.rs b/main_game_lib/src/rscn/token.rs
@@ -1,3 +1,6 @@
+//! TODO(https://github.com/porkbrain/dont-count-the-sheep/issues/235): Refactor
+//! parsing and lexing into separate modules.
+
 mod colon;
 mod curly_bracket;
 mod number;
@@ -26,6 +29,7 @@ pub(crate) fn parse(tscn: &str) -> State {
     state
 }
 
+/// TODO(https://github.com/porkbrain/dont-count-the-sheep/issues/235): Lexing should be done separately from parsing.
 #[derive(Logos, Debug, PartialEq, Eq)]
 #[logos(skip r"[\r\t\n\f,]+")]
 enum TscnToken {