From cc47af32dee74cee1436ef0721d10afe77f318d1 Mon Sep 17 00:00:00 2001 From: Rylan/wowmom98 Date: Tue, 16 May 2017 21:37:54 -0400 Subject: [PATCH] started documentation of engine <3 you too michael --- ShiftOS_TheReturn/AppearanceManager.cs | 236 ++++++------------------- 1 file changed, 58 insertions(+), 178 deletions(-) diff --git a/ShiftOS_TheReturn/AppearanceManager.cs b/ShiftOS_TheReturn/AppearanceManager.cs index a10f419..81858d3 100644 --- a/ShiftOS_TheReturn/AppearanceManager.cs +++ b/ShiftOS_TheReturn/AppearanceManager.cs @@ -38,9 +38,7 @@ using static ShiftOS.Engine.SaveSystem; namespace ShiftOS.Engine { - /// - /// Provides functionality for managing windows within ShiftOS. - /// + // Provides functionality for managing windows within ShiftOS. public static class AppearanceManager { [Obsolete("Please use Localization.GetAllLanguages().")] @@ -49,12 +47,7 @@ namespace ShiftOS.Engine return Localization.GetAllLanguages(); } - /// - /// Sets the title text of the specified window. - /// - /// The window to modify - /// The title text to use - /// Thrown if the window is null. + // Sets the title text of the specified window. public static void SetWindowTitle(IShiftOSWindow window, string title) { if (window == null) @@ -62,11 +55,13 @@ namespace ShiftOS.Engine winmgr.SetTitle(window, title); } + //HEY LETS FIND THE WINDOWS public static IEnumerable GetAllWindowTypes() { List types = new List(); foreach(var file in System.IO.Directory.GetFiles(Environment.CurrentDirectory)) { + // hey if a thing is an exe or a dll show up plz kthx if(file.EndsWith(".exe") || file.EndsWith(".dll")) { try @@ -84,12 +79,7 @@ namespace ShiftOS.Engine return types; } - /// - /// Returns the default window title for a specified -inheriting type. - /// - /// The type to scan - /// The default title - /// Thrown if is null. + // hey you know that window we just made appear? well give it its title public static string GetDefaultTitle(Type winType) { if (winType == null) @@ -104,123 +94,95 @@ namespace ShiftOS.Engine return winType.Name; } - /// - /// Current cursor position of the console - /// + // Current cursor position of the console public static int CurrentPosition { get; set; } - /// - /// We don't know what this does. It may be gone if it does nothing. - /// + // We don't know what this does. It may be gone if it does nothing. public static int LastLength { get; set; } - /// - /// Minimize a window. - /// - /// The window border to minimize. - /// Thrown if is null. - /// Thrown if this part of the engine hasn't been enabled. + // Minimize a window. public static void Minimize(IWindowBorder form) { if (form == null) + //FUCK WHY THE FUCK IS THIS NULL throw new ArgumentNullException("form"); if (winmgr == null) + //FUCK THIS PART OF THE ENGINE WASNT TURNED ON YET throw new EngineModuleDisabledException(); winmgr.Minimize(form); } - /// - /// Maximizes a window. - /// - /// The window border to maximize. - /// Thrown if is null. - /// Thrown if this engine module hasn't been enabled. + // Maximizes a window! :D public static void Maximize(IWindowBorder form) { if (form == null) + //AHHHH SHOULDNT BE NULLLLLL throw new ArgumentNullException("form"); if (winmgr == null) + //WHY ARE YOU DOING THIS PART OF THE ENGINE IT WASNT ENABLED FUCK throw new EngineModuleDisabledException(); winmgr.Maximize(form); } - /// - /// Provides a list of all open ShiftOS windows. - /// + // Provides a list of all open ShiftOS windows. public static List OpenForms = new List(); - /// - /// Decorates a window with a border, then shows the window. - /// - /// The window to decorate and show. - /// Thrown if is null. - /// Thrown if this engine module has not been initiated yet. + // Decorates a window with a border, then shows the window. public static void SetupWindow(IShiftOSWindow form) { if (form == null) + //YOU GET THE POINT THIS REALLY SHOULDNT BE NULL throw new ArgumentNullException("form"); if (winmgr == null) + //SAME HERE throw new EngineModuleDisabledException(); winmgr.SetupWindow(form); Desktop.ResetPanelButtons(); } - /// - /// Closes the specified window. - /// - /// The window to close. - /// Thrown if is null. - /// Thrown if this engine module has not been initiated yet. + // Closes the specified window. SHOCKED YOU ARE I KNOW, HOW COULD YOU HAVE GUESSED public static void Close(IShiftOSWindow win) { if (win == null) + //NOPE SHOULDNT BE NULL throw new ArgumentNullException("win"); if (winmgr == null) + //WHY IS THIS NULL throw new EngineModuleDisabledException(); winmgr.Close(win); Desktop.ResetPanelButtons(); } - /// - /// Decorates a window with a border, then shows the window, as a dialog box. - /// - /// The window to decorate and show. - /// Thrown if is null. - /// Thrown if this engine module has not been initiated yet. + + // Decorates a window with a border, then shows the window, as a dialog box. public static void SetupDialog(IShiftOSWindow form) { if (form == null) + //NULLLLLLLLL throw new ArgumentNullException("form"); if (winmgr == null) + //ASGDFHASDGF throw new EngineModuleDisabledException(); winmgr.SetupDialog(form); Desktop.ResetPanelButtons(); } - /// - /// The underlying window manager for this engine module - /// + // The underlying window manager for this engine module private static WindowManager winmgr = null; - /// - /// Initiate this engine module, and perform mandatory configuration. - /// - /// A working, configured to use as a backend for this module + // Initiate this engine module, and perform mandatory configuration. public static void Initiate(WindowManager mgr) { - winmgr = mgr; + winmgr = mgr; // A working, configured window manager to use as a backend for this module } - /// - /// Raised when the engine is entering its shutdown phase. Save your work! - /// + + // Raised when the engine is entering its shutdown phase. Save your work! public static event EmptyEventHandler OnExit; - /// - /// Starts the engine's exit routine, firing the OnExit event. - /// + // Starts the engine's exit routine, firing the OnExit event. internal static void Exit() { OnExit?.Invoke(); @@ -228,137 +190,59 @@ namespace ShiftOS.Engine ServerManager.Disconnect(); Desktop.InvokeOnWorkerThread(() => { - Environment.Exit(0); + Environment.Exit(0); //bye bye }); } - /// - /// The current terminal body control. - /// + // The current terminal body control. public static ITerminalWidget ConsoleOut { get; set; } - /// - /// Redirects the .NET to a new instance. - /// + // Redirects the .NET to a new TerminalTextWriter instance. public static void StartConsoleOut() { - Console.SetOut(new TerminalTextWriter()); + Console.SetOut(new TerminalTextWriter()); //"plz start writing text .NET kthx" } - /// - /// Invokes an action on the window management thread. - /// - /// The action to invoke + // Invokes an action on the window management thread. public static void Invoke(Action act) { winmgr.InvokeAction(act); } } - /// - /// Provides the base functionality for a ShiftOS terminal. - /// + // Provides the base functionality for a ShiftOS terminal. public interface ITerminalWidget { - /// - /// Write text to this Terminal. - /// - /// Text to write - void Write(string text); - /// - /// Write text to this Terminal, followed by a newline. - /// - /// Text to write. - void WriteLine(string text); - /// - /// Clear the contents of this Terminal. - /// - void Clear(); - /// - /// Move the cursor to the last character in the Terminal. - /// - void SelectBottom(); + void Write(string text); // Actually write text to this Terminal! :D:D:D:D + void WriteLine(string text); // Write text to this Terminal, followed by a newline. + void Clear(); // Clear the contents of this Terminal, i bet you wouldve never guessed that + void SelectBottom(); // Move the cursor to the last character in the Terminal. } - /// - /// Provides the base functionality for a ShiftOS window manager. - /// + // makes the window manager actually do its job public abstract class WindowManager { - /// - /// Minimizes a window - /// - /// The window border to minimize - public abstract void Minimize(IWindowBorder border); - - /// - /// Maximizes a window - /// - /// The window border to maximize - public abstract void Maximize(IWindowBorder border); - - /// - /// Closes a window - /// - /// The window to close - public abstract void Close(IShiftOSWindow win); - - /// - /// Decorates a window with a window border, then shows it to the user. - /// - /// The window to decorate. - public abstract void SetupWindow(IShiftOSWindow win); - - /// - /// Decorates a window with a border, then shows it to the user as a dialog box. - /// - /// The window to decorate - public abstract void SetupDialog(IShiftOSWindow win); - - /// - /// Invokes an action on the window management thread. - /// - /// The action to invoke. - public abstract void InvokeAction(Action act); - - /// - /// Sets the title text of a window. - /// - /// The window to modify. - /// The new title text. - public abstract void SetTitle(IShiftOSWindow win, string title); + public abstract void Minimize(IWindowBorder border); // guess what this does + public abstract void Maximize(IWindowBorder border); // ooh this too + public abstract void Close(IShiftOSWindow win); // omg this probably does something + public abstract void SetupWindow(IShiftOSWindow win); // i cant think of what this does + public abstract void SetupDialog(IShiftOSWindow win); // how about this??????? + public abstract void InvokeAction(Action act); // i wonder what this invokes + public abstract void SetTitle(IShiftOSWindow win, string title); // what is a title again } - /// - /// Provides the base functionality for a typical ShiftOS window border. - /// + // Provides the base functionality for a typical ShiftOS window border, what did you expect public interface IWindowBorder { - /// - /// Closes the border along with its window. Unload events should be invoked here. - /// - void Close(); - - /// - /// Gets or sets the title text for the window border. - /// - string Text { get; set; } - - /// - /// Gets or sets the underlying for this border. - /// - IShiftOSWindow ParentWindow { get; set; } + void Close(); // CLOSES THE BORDER ALONG WITH ITS WINDOW!!!!!!! HOLY SHIT I DIDNT EXPECT THAT + string Text { get; set; } // title text exists now + IShiftOSWindow ParentWindow { get; set; } // Gets or sets the underlying for this border. } - - /// - /// Provides a way of setting default title text for classes. - /// + + // Provides a way of setting default title text for classes. public class DefaultTitleAttribute : Attribute { - /// - /// Creates a new instance of the . - /// - /// A default title to associate with this attribute. + // oy if you cant find a title this is the one you should use public DefaultTitleAttribute(string title) { Title = title; @@ -367,17 +251,13 @@ namespace ShiftOS.Engine public string Title { get; private set; } } - /// - /// An exception that is thrown when mandatory configuration to run a specific method or module hasn't been done yet. - /// + // An exception that is thrown when mandatory configuration to run a specific method or module hasn't been done yet. public class EngineModuleDisabledException : Exception { - /// - /// Initializes a new instance of the . - /// + // FUCK WE DIDNT ORDER THINGS RIGHT public EngineModuleDisabledException() : base("This engine module has not yet been enabled.") { - + //FUCK } } }