Organize everything in folders

AngheloAlf · AngheloAlf · commit 04156dc7eadd · 2026-04-29T08:51:39.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Many files were moved into folders for better organization.
+- Moved many structs into `mod`s for better organization.
+
 ## [0.5.0] - 2026-04-26
 
 ### Added
diff --git a/slinky/src/file_format/assert_entry.rs b/slinky/src/file_format/assert_entry.rs
@@ -3,7 +3,10 @@
 
 use serde::Deserialize;
 
-use crate::{absent_nullable::AbsentNullable, traits::Serial, Settings, SlinkyError};
+use crate::utils::{traits::Serial, AbsentNullable};
+use crate::SlinkyError;
+
+use super::Settings;
 
 #[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
 #[non_exhaustive]
diff --git a/slinky/src/file_format/document.rs b/slinky/src/file_format/document.rs
@@ -5,12 +5,14 @@ use std::{fs, path::Path};
 
 use serde::Deserialize;
 
-use crate::{
-    absent_nullable::AbsentNullable, assert_entry::AssertEntrySerial,
-    required_symbol::RequiredSymbolSerial, segment::SegmentSerial, settings::SettingsSerial,
-    symbol_assignment::SymbolAssignmentSerial, traits::Serial, vram_class::VramClassSerial,
-    AssertEntry, KeepSections, RequiredSymbol, Segment, Settings, SlinkyError, SymbolAssignment,
-    VramClass,
+use crate::utils::{traits::Serial, AbsentNullable};
+use crate::SlinkyError;
+
+use super::{
+    assert_entry::AssertEntrySerial, required_symbol::RequiredSymbolSerial, segment::SegmentSerial,
+    settings::SettingsSerial, symbol_assignment::SymbolAssignmentSerial,
+    vram_class::VramClassSerial, AssertEntry, KeepSections, RequiredSymbol, Segment, Settings,
+    SymbolAssignment, VramClass,
 };
 
 #[derive(Debug, PartialEq)]
diff --git a/slinky/src/file_format/file_info.rs b/slinky/src/file_format/file_info.rs
@@ -1,16 +1,17 @@
 /* SPDX-FileCopyrightText: © 2024-2026 decompals */
 /* SPDX-License-Identifier: MIT */
 
-use serde::Deserialize;
 use std::{
     collections::HashMap,
     path::{Path, PathBuf},
 };
 
-use crate::{
-    absent_nullable::AbsentNullable, file_kind::FileKind, traits::Serial, EscapedPath,
-    KeepSections, RuntimeSettings, Settings, SlinkyError,
-};
+use serde::Deserialize;
+
+use crate::utils::{traits::Serial, AbsentNullable, EscapedPath};
+use crate::{RuntimeSettings, SlinkyError};
+
+use super::{file_kind::FileKind, KeepSections, Settings};
 
 #[derive(PartialEq, Debug, Clone)]
 #[non_exhaustive]
diff --git a/slinky/src/file_format/file_kind.rs b/slinky/src/file_format/file_kind.rs
diff --git a/slinky/src/file_format/gp_info.rs b/slinky/src/file_format/gp_info.rs
@@ -3,9 +3,13 @@
 
 use serde::Deserialize;
 
-use crate::{absent_nullable::AbsentNullable, traits::Serial, Settings, SlinkyError};
+use crate::utils::{traits::Serial, AbsentNullable};
+use crate::SlinkyError;
 
-#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
+use super::Settings;
+
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[non_exhaustive]
 pub struct GpInfo {
     // The relative section to emit the `_gp` symbol
     pub section: String,
diff --git a/slinky/src/file_format/keep_sections.rs b/slinky/src/file_format/keep_sections.rs
diff --git a/slinky/src/file_format/linker_symbols_style.rs b/slinky/src/file_format/linker_symbols_style.rs
diff --git a/slinky/src/file_format/mod.rs b/slinky/src/file_format/mod.rs
@@ -0,0 +1,36 @@
+/* SPDX-FileCopyrightText: © 2026 decompals */
+/* SPDX-License-Identifier: MIT */
+
+pub(crate) mod linker_symbols_style;
+pub(crate) mod partial;
+pub(crate) mod settings;
+
+pub(crate) mod assert_entry;
+pub(crate) mod file_info;
+pub(crate) mod file_kind;
+pub(crate) mod gp_info;
+pub(crate) mod keep_sections;
+pub(crate) mod required_symbol;
+pub(crate) mod segment;
+pub(crate) mod symbol_assignment;
+
+pub(crate) mod vram_class;
+
+pub(crate) mod document;
+
+pub use linker_symbols_style::LinkerSymbolsStyle;
+pub use partial::Partial;
+pub use settings::Settings;
+
+pub use assert_entry::AssertEntry;
+pub use file_info::FileInfo;
+pub use file_kind::FileKind;
+pub use gp_info::GpInfo;
+pub use keep_sections::KeepSections;
+pub use required_symbol::RequiredSymbol;
+pub use segment::Segment;
+pub use symbol_assignment::SymbolAssignment;
+
+pub use vram_class::VramClass;
+
+pub use document::Document;
diff --git a/slinky/src/file_format/partial.rs b/slinky/src/file_format/partial.rs
@@ -5,7 +5,8 @@ use std::path::PathBuf;
 
 use serde::Deserialize;
 
-use crate::{absent_nullable::AbsentNullable, EscapedPath, RuntimeSettings, SlinkyError};
+use crate::utils::{AbsentNullable, EscapedPath};
+use crate::{RuntimeSettings, SlinkyError};
 
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
 #[non_exhaustive]
diff --git a/slinky/src/file_format/required_symbol.rs b/slinky/src/file_format/required_symbol.rs
@@ -3,7 +3,10 @@
 
 use serde::Deserialize;
 
-use crate::{absent_nullable::AbsentNullable, traits::Serial, Settings, SlinkyError};
+use crate::utils::{traits::Serial, AbsentNullable};
+use crate::SlinkyError;
+
+use super::Settings;
 
 #[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
 #[non_exhaustive]
diff --git a/slinky/src/file_format/segment.rs b/slinky/src/file_format/segment.rs
@@ -5,12 +5,11 @@ use std::{borrow::Cow, collections::HashMap, path::PathBuf};
 
 use serde::Deserialize;
 
-use crate::{
-    absent_nullable::AbsentNullable,
-    file_info::{FileInfo, FileInfoSerial},
-    gp_info::{GpInfo, GpInfoSerial},
-    traits::Serial,
-    utils, EscapedPath, KeepSections, RuntimeSettings, Settings, SlinkyError,
+use crate::utils::{self, traits::Serial, AbsentNullable, EscapedPath};
+use crate::{RuntimeSettings, SlinkyError};
+
+use super::{
+    file_info::FileInfoSerial, gp_info::GpInfoSerial, FileInfo, GpInfo, KeepSections, Settings,
 };
 
 #[derive(PartialEq, Debug, Clone)]
diff --git a/slinky/src/file_format/settings.rs b/slinky/src/file_format/settings.rs
@@ -5,10 +5,10 @@ use std::{collections::HashMap, path::PathBuf};
 
 use serde::Deserialize;
 
-use crate::{
-    absent_nullable::AbsentNullable, linker_symbols_style::LinkerSymbolsStyle,
-    partial::PartialSerial, EscapedPath, Partial, RuntimeSettings, SlinkyError,
-};
+use crate::utils::{AbsentNullable, EscapedPath};
+use crate::{RuntimeSettings, SlinkyError};
+
+use super::{partial::PartialSerial, LinkerSymbolsStyle, Partial};
 
 #[derive(Debug, PartialEq)]
 #[non_exhaustive]
diff --git a/slinky/src/file_format/symbol_assignment.rs b/slinky/src/file_format/symbol_assignment.rs
@@ -3,7 +3,10 @@
 
 use serde::Deserialize;
 
-use crate::{absent_nullable::AbsentNullable, traits::Serial, Settings, SlinkyError};
+use crate::utils::{traits::Serial, AbsentNullable};
+use crate::SlinkyError;
+
+use super::Settings;
 
 #[derive(PartialEq, Debug, Clone)]
 #[non_exhaustive]
diff --git a/slinky/src/file_format/vram_class.rs b/slinky/src/file_format/vram_class.rs
@@ -3,7 +3,10 @@
 
 use serde::Deserialize;
 
-use crate::{absent_nullable::AbsentNullable, traits::Serial, KeepSections, Settings, SlinkyError};
+use crate::utils::{traits::Serial, AbsentNullable};
+use crate::SlinkyError;
+
+use super::{KeepSections, Settings};
 
 #[derive(PartialEq, Debug, Clone)]
 #[non_exhaustive]
diff --git a/slinky/src/lib.rs b/slinky/src/lib.rs
@@ -4,62 +4,27 @@
 #![warn(clippy::exhaustive_enums)]
 #![warn(clippy::exhaustive_structs)]
 
-mod absent_nullable;
 mod error;
-mod escaped_path;
-mod traits;
 mod utils;
 
-mod linker_symbols_style;
-mod settings;
+pub mod file_format;
 
-mod assert_entry;
-mod file_info;
-mod file_kind;
-mod gp_info;
-mod keep_sections;
-mod partial;
-mod required_symbol;
-mod segment;
-mod symbol_assignment;
-
-mod vram_class;
-
-mod document;
-
-mod script_buffer;
-
-mod linker_writer;
-mod partial_linker_writer;
+pub mod writers;
 
 mod runtime_settings;
 
 pub mod version;
 
 pub use error::SlinkyError;
-pub use escaped_path::EscapedPath;
-
-pub use linker_symbols_style::LinkerSymbolsStyle;
-pub use settings::Settings;
-
-pub use assert_entry::AssertEntry;
-pub use file_info::FileInfo;
-pub use file_kind::FileKind;
-pub use keep_sections::KeepSections;
-pub use partial::Partial;
-pub use required_symbol::RequiredSymbol;
-pub use segment::Segment;
-pub use symbol_assignment::SymbolAssignment;
-
-pub use vram_class::VramClass;
 
-pub use document::Document;
+pub use utils::EscapedPath;
+pub use utils::ScriptExporter;
+pub use utils::ScriptGenerator;
+pub use utils::ScriptImporter;
 
-pub use traits::ScriptExporter;
-pub use traits::ScriptGenerator;
-pub use traits::ScriptImporter;
+pub use file_format::Document;
 
-pub use linker_writer::LinkerWriter;
-pub use partial_linker_writer::PartialLinkerWriter;
+pub use writers::LinkerWriter;
+pub use writers::PartialLinkerWriter;
 
 pub use runtime_settings::RuntimeSettings;
diff --git a/slinky/src/runtime_settings.rs b/slinky/src/runtime_settings.rs
@@ -7,7 +7,8 @@ use std::{
     path::{Path, PathBuf},
 };
 
-use crate::{EscapedPath, SlinkyError};
+use crate::utils::EscapedPath;
+use crate::SlinkyError;
 
 #[derive(PartialEq, Debug)]
 pub struct RuntimeSettings {
diff --git a/slinky/src/utils/absent_nullable.rs b/slinky/src/utils/absent_nullable.rs
@@ -7,7 +7,7 @@ use crate::SlinkyError;
 
 // https://stackoverflow.com/a/44332837/6292472
 
-#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd, Default)]
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
 pub(crate) enum AbsentNullable<T> {
     #[default]
     Absent,
diff --git a/slinky/src/utils/escaped_path.rs b/slinky/src/utils/escaped_path.rs
diff --git a/slinky/src/utils/mod.rs b/slinky/src/utils/mod.rs
@@ -1,6 +1,14 @@
 /* SPDX-FileCopyrightText: © 2024-2026 decompals */
 /* SPDX-License-Identifier: MIT */
 
+mod absent_nullable;
+mod escaped_path;
+pub(crate) mod traits;
+
+pub(crate) use absent_nullable::AbsentNullable;
+pub use escaped_path::EscapedPath;
+pub use traits::{ScriptExporter, ScriptGenerator, ScriptImporter};
+
 use std::{
     fs::{self, File},
     path::Path,
diff --git a/slinky/src/utils/traits.rs b/slinky/src/utils/traits.rs
@@ -1,19 +1,21 @@
 /* SPDX-FileCopyrightText: © 2024-2026 decompals */
 /* SPDX-License-Identifier: MIT */
 
-use crate::{
-    AssertEntry, Document, EscapedPath, RequiredSymbol, Segment, Settings, SlinkyError,
-    SymbolAssignment,
+use crate::file_format::{
+    AssertEntry, Document, RequiredSymbol, Segment, Settings, SymbolAssignment,
 };
+use crate::utils::EscapedPath;
+use crate::SlinkyError;
 
 mod private {
-    use crate::{
+    use crate::file_format::{
         assert_entry::AssertEntrySerial, file_info::FileInfoSerial, gp_info::GpInfoSerial,
         required_symbol::RequiredSymbolSerial, segment::SegmentSerial,
-        symbol_assignment::SymbolAssignmentSerial, vram_class::VramClassSerial, LinkerWriter,
-        PartialLinkerWriter,
+        symbol_assignment::SymbolAssignmentSerial, vram_class::VramClassSerial,
     };
 
+    use crate::writers::{LinkerWriter, PartialLinkerWriter};
+
     pub trait Sealed {}
 
     impl Sealed for LinkerWriter<'_> {}
diff --git a/slinky/src/writers/linker_writer.rs b/slinky/src/writers/linker_writer.rs
@@ -4,13 +4,13 @@
 use std::borrow::Cow;
 use std::io::Write;
 
-use crate::{
-    utils, version, AssertEntry, Document, EscapedPath, FileInfo, FileKind, KeepSections,
-    RequiredSymbol, RuntimeSettings, ScriptExporter, ScriptGenerator, ScriptImporter, Segment,
-    SlinkyError, SymbolAssignment, VramClass,
+use super::script_buffer::ScriptBuffer;
+use crate::file_format::{
+    AssertEntry, Document, FileInfo, FileKind, KeepSections, RequiredSymbol, Segment,
+    SymbolAssignment, VramClass,
 };
-
-use crate::script_buffer::ScriptBuffer;
+use crate::utils::{self, EscapedPath, ScriptExporter, ScriptGenerator, ScriptImporter};
+use crate::{version, RuntimeSettings, SlinkyError};
 
 pub struct LinkerWriter<'a> {
     buffer: ScriptBuffer,
diff --git a/slinky/src/writers/mod.rs b/slinky/src/writers/mod.rs
@@ -0,0 +1,10 @@
+/* SPDX-FileCopyrightText: © 2026 decompals */
+/* SPDX-License-Identifier: MIT */
+
+mod script_buffer;
+
+mod linker_writer;
+mod partial_linker_writer;
+
+pub use linker_writer::LinkerWriter;
+pub use partial_linker_writer::PartialLinkerWriter;
diff --git a/slinky/src/writers/partial_linker_writer.rs b/slinky/src/writers/partial_linker_writer.rs
@@ -1,11 +1,12 @@
 /* SPDX-FileCopyrightText: © 2024-2026 decompals */
 /* SPDX-License-Identifier: MIT */
 
-use crate::{
-    AssertEntry, Document, EscapedPath, FileInfo, LinkerWriter, Partial, RequiredSymbol,
-    RuntimeSettings, ScriptExporter, ScriptGenerator, ScriptImporter, Segment, SlinkyError,
-    SymbolAssignment,
+use super::LinkerWriter;
+use crate::file_format::{
+    AssertEntry, Document, FileInfo, Partial, RequiredSymbol, Segment, SymbolAssignment,
 };
+use crate::utils::{EscapedPath, ScriptExporter, ScriptGenerator, ScriptImporter};
+use crate::{RuntimeSettings, SlinkyError};
 
 pub struct PartialLinkerWriter<'a> {
     main_writer: LinkerWriter<'a>,
diff --git a/slinky/src/writers/script_buffer.rs b/slinky/src/writers/script_buffer.rs
