#Iconsole compatible apps how to
#Iconsole compatible apps update

Runs an action that may or may not modify the console state that can cause corruptions when thread context swaps. Void DoCommand(IConsole console, Action action) void DoCommand(IConsole console, Action action).The way to protect against corruption is to manage locking and manually save and restore state. Interface for all the console methods that are most at risk of causing corruptions in multithreaded programs. If you are writing a windowing library like Konsole then each window region needs to report back an AbsoluteX and AbsoluteY position so that printing can happen at the correct (relative) position on the real console.

void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop, char sourceChar, ConsoleColor sourceForeColor, ConsoleColor sourceBackColor).This will most likely cause your library to require platform specific implementations for scrolling. Interface for a class that needs to be able to scroll portions of the screen. void PrintAtColor(ConsoleColor foreground, int x, int y, string text, ConsoleColor? background).void PrintAt(int x, int y, string text).void PrintAt(int x, int y, string format, params object args).Interface for a class that needs to print at a specific location in a window. void Clear(ConsoleColor? backgroundColor).void WriteLine(ConsoleColor color, string text).void WriteLine(ConsoleColor color, string format, params object args).void Write(ConsoleColor color, string text).void Write(ConsoleColor color, string format, params object args).Public interface IWriteColor : ISetColors printing only (no color) and printing at? Then use interface inheritance and implement just the bits you need. Logging, printing only? IWrite, Needs to print in color? IWriteColor, Need to change the cursor position when printing? IPrintAt, eed to scroll portions of the screen? IScrolling, Need all of the above? IConsole. Pick the narrowest set of features that the class that you are refactoring depends on. As soon as that's done I'll release the first version 1.0.0-alpha do some testing, and then remove the alpha status. I have not yet migrated Goblinfactory.Konsole over to using the new contracts yet. The ink on this project is still only a few days wet. pre-beta and inviting discussion before it get's released as official version 1.0), meaning that the final interface contracts are still being finalised and may change with the final version. The project is in currently only at alpha concept stage (i.e.IWrite is good enough for 99% of System.Console refactorings, where you're essentially just logging stuff to the console. If the app you are refactoring does not set the cursor position, and merely 'writes' out via System.Console then use the IWrite interface as your dependancy. Public interface IConsole : IPrintAtColor, IConsoleState, IWriteColor, IScrollingWindow Typically you often only need IWrite and-or IPrintAt or IPrintAtColor It will require the most work to implement. You can always come back later and remove it. You can use IConsole as simply as typing, add package IConsole. Since you would have started by writing your own interface, and then also writing something that implements that interface, why not save yourself the 2 or 3 hours you will be sidetracked doing that and dive right in to cleaning up your code. It's about setting a standard of interoperability between everyone that uses this as their interface. However, It's not about writing a wrapper, that is very easy. A quick search on Github returns more than 21K+ projects with their own form of IConsole or IConsoleWriter, so its very common (and easy) to do exactly that. But I can write my own System.Console wrapper, it will be done in less than 40 lines?

#Iconsole compatible apps how to

If you have any questions about how to use this package, please join the discussion on our gitter group at : or contact me directly. The hope for this project is that it will enable interoperability between open source console library and app developers.

( ) The home of ProgressBar, Window, Form and Drawing. Use to remove a direct dependancy on System.Console and replace with a dependancy on a well used and well known console interface, IConsole, to allow for building rich 'testable', high quality interactive console applications and utilities.Īs used by Goblinfactory.Konsole. Draft for discussion proposal, call for review old documentation for IConsole is below, these class designs will be available in Goblinfactory.Konsole from version 6 onwards. Please checkout the project at Goblinfactory.Konsole. IConsole is included in Goblinfactory.Konsole.

#Iconsole compatible apps update

IConsole Update - Project moved to Goblinfactory.Konsole