implement printconsole API

Author: WinterMute

gc/ogc/console.h

@@ -1,9 +1,12 @@
 #ifndef __LIBOGC_CONSOLE_H__
 #define __LIBOGC_CONSOLE_H__
 
-/*!
- * \file console.h
- * \brief Console subsystem
+/**
+ * @file console.h
+ * @brief ogc stdio support.
+ *
+ * Provides stdio integration for printing to the framebuffer as well as debug print
+ * functionality provided by stderr.
  *
  */
 
@@ -94,8 +97,133 @@ void CON_GetPosition(int *cols, int *rows);
  */
 void CON_EnableGecko(int channel,int safe);
 
+/// A callback for printing a character.
+typedef bool(*ConsolePrint)(void* con, int c);
+
+/// A font struct for the console.
+typedef struct ConsoleFont
+{
+	u8* gfx;         ///< A pointer to the font graphics
+	u16 asciiOffset; ///< Offset to the first valid character in the font table
+	u16 numChars;    ///< Number of characters in the font graphics
+}ConsoleFont;
+
+/**
+ * @brief Console structure used to store the state of a console render context.
+ *
+ * Default values from consoleGetDefault();
+ * @code
+ * PrintConsole defaultConsole =
+ * {
+ * 	//Font:
+ * 	{
+ * 		(u8*)default_font_bin, //font gfx
+ * 		0, //first ascii character in the set
+ * 		128, //number of characters in the font set
+ *	},
+ *	0,0, //cursorX cursorY
+ *	0,0, //prevcursorX prevcursorY
+ *	40, //console width
+ *	30, //console height
+ *	0,  //window x
+ *	0,  //window y
+ *	32, //window width
+ *	24, //window height
+ *	3, //tab size
+ *	0, //font character offset
+ *	0,  //print callback
+ *	false //console initialized
+ * };
+ * @endcode
+ */
+
+typedef struct PrintConsole
+{
+	ConsoleFont font;        ///< Font of the console
+
+	void *destbuffer;        ///< Framebuffer address
+	int con_xres,con_yres,con_stride;
+	int target_x,target_y, tgt_stride;
+
+	int cursorX;             ///< Current X location of the cursor (as a tile offset by default)
+	int cursorY;             ///< Current Y location of the cursor (as a tile offset by default)
+
+	int prevCursorX;         ///< Internal state
+	int prevCursorY;         ///< Internal state
+
+	int con_cols;            ///< Width of the console hardware layer in characters
+	int con_rows;            ///< Height of the console hardware layer in characters
+
+	int windowX;             ///< Window X location in characters (not implemented)
+	int windowY;             ///< Window Y location in characters (not implemented)
+	int windowWidth;         ///< Window width in characters (not implemented)
+	int windowHeight;        ///< Window height in characters (not implemented)
+
+	int tabSize;             ///< Size of a tab
+	unsigned int fg;         ///< Foreground color
+	unsigned int bg;         ///< Background color
+	unsigned int flags;      ///< Attribute flags
+
+	ConsolePrint PrintChar;  ///< Callback for printing a character. Should return true if it has handled rendering the graphics (else the print engine will attempt to render via tiles).
+
+	bool consoleInitialised; ///< True if the console is initialized
+} PrintConsole;
+
+/// Console debug devices supported by libogc.
+typedef enum {
+	debugDevice_NULL,    ///< Swallows prints to stderr
+	debugDevice_EXI,     ///< Outputs stderr debug statements using exi uart
+	debugDevice_CONSOLE, ///< Directs stderr debug statements to console window
+} debugDevice;
+
+/**
+ * @brief Loads the font into the console.
+ * @param console Pointer to the console to update, if NULL it will update the current console.
+ * @param font The font to load.
+ */
+void consoleSetFont(PrintConsole* console, ConsoleFont* font);
+
+/**
+ * @brief Sets the print window.
+ * @param console Console to set, if NULL it will set the current console window.
+ * @param x X location of the window.
+ * @param y Y location of the window.
+ * @param width Width of the window.
+ * @param height Height of the window.
+ */
+void consoleSetWindow(PrintConsole* console, unsigned int x, unsigned int y, unsigned int width, unsigned int height);
+
+/**
+ * @brief Gets a pointer to the console with the default values.
+ * This should only be used when using a single console or without changing the console that is returned, otherwise use consoleInit().
+ * @return A pointer to the console with the default values.
+ */
+PrintConsole* consoleGetDefault(void);
+
+/**
+ * @brief Make the specified console the render target.
+ * @param console A pointer to the console struct (must have been initialized with consoleInit(PrintConsole* console)).
+ * @return A pointer to the previous console.
+ */
+PrintConsole *consoleSelect(PrintConsole* console);
+
+/**
+ * @brief Initialise the console.
+ * @param console A pointer to the console data to initialize (if it's NULL, the default console will be used).
+ * @return A pointer to the current console.
+ */
+PrintConsole* consoleInit(PrintConsole* console);
+
+/**
+ * @brief Initializes debug console output on stderr to the specified device.
+ * @param device The debug device (or devices) to output debug print statements to.
+ */
+void consoleDebugInit(debugDevice device);
+
+/// Clears the screen by using iprintf("\x1b[2J");
+void consoleClear(void);
+
 #ifdef __cplusplus
-	}
+}
 #endif
-
 #endif