subsys/csrss/api.h

   1 #ifndef _CSRSS_API_H
   2 #define _CSRSS_API_H
   3
   4 #include <ntos.h>
   5
   6 #include <csrss/csrss.h>
   7
   8 /* Object type magic numbers */
   9
  10 #define CSRSS_CONSOLE_MAGIC         1
  11 #define CSRSS_SCREEN_BUFFER_MAGIC   2
  12
  13 typedef struct Object_tt
  14 {
  15    LONG Type;
  16    LONG ReferenceCount;
  17 } Object_t;
  18
  19 typedef struct ConsoleInput_t
  20 {
  21   LIST_ENTRY ListEntry;
  22   INPUT_RECORD InputEvent;
  23   BOOLEAN Echoed;        // already been echoed or not
  24 } ConsoleInput;
  25
  26
  27 /************************************************************************
  28  * Screen buffer structure represents the win32 screen buffer object.   *
  29  * Internally, the portion of the buffer being shown CAN loop past the  *
  30  * bottom of the virtual buffer and wrap around to the top.  Win32 does *
  31  * not do this.  I decided to do this because it eliminates the need to *
  32  * do a massive memcpy() to scroll the contents of the buffer up to     *
  33  * scroll the screen on output, instead I just shift down the position  *
  34  * to be displayed, and let it wrap around to the top again.            *
  35  * The VirtualX member keeps track of the top X coord that win32        *
  36  * clients THINK is currently being displayed, because they think that  *
  37  * when the display reaches the bottom of the buffer and another line   *
  38  * being printed causes another line to scroll down, that the buffer IS *
  39  * memcpy()'s up, and the bottom of the buffer is still displayed, but  *
  40  * internally, I just wrap back to the top of the buffer.               *
  41  ***********************************************************************/
  42
  43 typedef struct CSRSS_SCREEN_BUFFER_t
  44 {
  45    Object_t Header;                 /* Object header */
  46    BYTE *Buffer;                    /* pointer to screen buffer */
  47    USHORT MaxX, MaxY;               /* size of the entire scrollback buffer */
  48    USHORT ShowX, ShowY;             /* beginning offset for the actual display area */
  49    ULONG CurrentX;                  /* Current X cursor position */
  50    ULONG CurrentY;                  /* Current Y cursor position */
  51    BYTE DefaultAttrib;              /* default char attribute */
  52    USHORT VirtualX;                 /* top row of buffer being displayed, reported to callers */
  53    CONSOLE_CURSOR_INFO CursorInfo;
  54    USHORT Mode;
  55 } CSRSS_SCREEN_BUFFER, *PCSRSS_SCREEN_BUFFER;
  56
  57 typedef struct CSRSS_CONSOLE_t
  58 {
  59    Object_t Header;                      /* Object header */
  60    struct CSRSS_CONSOLE_t *Prev, *Next;  /* Next and Prev consoles in console wheel */
  61    HANDLE ActiveEvent;
  62    LIST_ENTRY InputEvents;               /* List head for input event queue */
  63    WORD WaitingChars;
  64    WORD WaitingLines;                    /* number of chars and lines in input queue */
  65    PCSRSS_SCREEN_BUFFER ActiveBuffer;    /* Pointer to currently active screen buffer */
  66    WORD Mode;                            /* Console mode flags */
  67    WORD EchoCount;                       /* count of chars to echo, in line buffered mode */
  68    UNICODE_STRING Title;                 /* Title of console */
  69    struct {                              /* active code pages */
  70            UINT Input;
  71            UINT Output;
  72    } CodePageId;
  73    BOOL EarlyReturn;                     /* wake client and return data, even if we are in line buffered mode, and we don't have a complete line */
  74    DWORD HardwareState;                  /* _GDI_MANAGED, _DIRECT */
  75    HWND hWindow;
  76    LIST_ENTRY ProcessList;
  77 } CSRSS_CONSOLE, *PCSRSS_CONSOLE;
  78
  79 typedef struct _CSRSS_PROCESS_DATA
  80 {
  81   PCSRSS_CONSOLE Console;
  82   ULONG HandleTableSize;
  83   Object_t ** HandleTable;
  84   ULONG ProcessId;
  85   ULONG ShutdownLevel;
  86   ULONG ShutdownFlags;
  87   HANDLE ConsoleEvent;
  88   PVOID CsrSectionViewBase;
  89   ULONG CsrSectionViewSize;
  90   struct _CSRSS_PROCESS_DATA * next;
  91   LIST_ENTRY ProcessEntry;
  92   PCONTROLDISPATCHER CtrlDispatcher;
  93 } CSRSS_PROCESS_DATA, *PCSRSS_PROCESS_DATA;
  94
  95 #define CSR_API(n) NTSTATUS n (\
  96 PCSRSS_PROCESS_DATA ProcessData,\
  97 PCSRSS_API_REQUEST Request,\
  98 PCSRSS_API_REPLY Reply)
  99
 100 /* api/process.c */
 101 CSR_API(CsrConnectProcess);
 102 CSR_API(CsrCreateProcess);
 103 CSR_API(CsrTerminateProcess);
 104
 105 /* api/conio.c */
 106 CSR_API(CsrWriteConsole);
 107 CSR_API(CsrAllocConsole);
 108 CSR_API(CsrFreeConsole);
 109 CSR_API(CsrReadConsole);
 110 CSR_API(CsrConnectProcess);
 111 CSR_API(CsrGetScreenBufferInfo);
 112 CSR_API(CsrSetCursor);
 113 CSR_API(CsrFillOutputChar);
 114 CSR_API(CsrReadInputEvent);
 115 CSR_API(CsrWriteConsoleOutputChar);
 116 CSR_API(CsrWriteConsoleOutputAttrib);
 117 CSR_API(CsrFillOutputAttrib);
 118 CSR_API(CsrGetCursorInfo);
 119 CSR_API(CsrSetCursorInfo);
 120 CSR_API(CsrSetTextAttrib);
 121 CSR_API(CsrSetConsoleMode);
 122 CSR_API(CsrGetConsoleMode);
 123 CSR_API(CsrCreateScreenBuffer);
 124 CSR_API(CsrSetScreenBuffer);
 125 CSR_API(CsrSetTitle);
 126 CSR_API(CsrGetTitle);
 127 CSR_API(CsrWriteConsoleOutput);
 128 CSR_API(CsrFlushInputBuffer);
 129 CSR_API(CsrScrollConsoleScreenBuffer);
 130 CSR_API(CsrReadConsoleOutputChar);
 131 CSR_API(CsrReadConsoleOutputAttrib);
 132 CSR_API(CsrGetNumberOfConsoleInputEvents);
 133 CSR_API(CsrRegisterServicesProcess);
 134 CSR_API(CsrExitReactos);
 135 CSR_API(CsrGetShutdownParameters);
 136 CSR_API(CsrSetShutdownParameters);
 137 CSR_API(CsrPeekConsoleInput);
 138 CSR_API(CsrReadConsoleOutput);
 139 CSR_API(CsrWriteConsoleInput);
 140 CSR_API(CsrGetInputHandle);
 141 CSR_API(CsrGetOutputHandle);
 142 CSR_API(CsrCloseHandle);
 143 CSR_API(CsrVerifyHandle);
 144 CSR_API(CsrDuplicateHandle);
 145 CSR_API(CsrHardwareStateProperty);
 146 CSR_API(CsrGetConsoleWindow);
 147
 148 /* print.c */
 149 VOID STDCALL DisplayString(LPCWSTR lpwString);
 150 VOID STDCALL PrintString (char* fmt, ...);
 151
 152 /* api/wapi.c */
 153 VOID Thread_Api(PVOID PortHandle);
 154 VOID Console_Api( DWORD Ignored );
 155
 156 extern HANDLE CsrssApiHeap;
 157
 158 /* api/conio.c */
 159 NTSTATUS STDCALL CsrInitConsole(PCSRSS_CONSOLE Console);
 160 VOID STDCALL CsrDeleteConsole( PCSRSS_CONSOLE Console );
 161 VOID STDCALL CsrDeleteScreenBuffer( PCSRSS_SCREEN_BUFFER Buffer );
 162 NTSTATUS STDCALL CsrInitConsoleScreenBuffer( PCSRSS_SCREEN_BUFFER Console );
 163 VOID STDCALL CsrInitConsoleSupport(VOID);
 164
 165 /* api/process.c */
 166 VOID STDCALL CsrInitProcessData(VOID);
 167 PCSRSS_PROCESS_DATA STDCALL CsrGetProcessData(ULONG ProcessId);
 168 NTSTATUS STDCALL CsrFreeProcessData( ULONG Pid );
 169
 170 /* api/handle.c */
 171 NTSTATUS STDCALL CsrInsertObject( PCSRSS_PROCESS_DATA ProcessData, PHANDLE Handle, Object_t *Object );
 172 NTSTATUS STDCALL CsrGetObject( PCSRSS_PROCESS_DATA ProcessData, HANDLE Handle, Object_t **Object );
 173 BOOL STDCALL CsrServerInitialization (ULONG ArgumentCount, PWSTR *ArgumentArray);
 174 NTSTATUS STDCALL CsrReleaseObject( PCSRSS_PROCESS_DATA ProcessData, HANDLE Object );
 175 NTSTATUS STDCALL CsrVerifyObject( PCSRSS_PROCESS_DATA ProcessData, HANDLE Object );
 176 VOID STDCALL CsrDrawConsole( PCSRSS_SCREEN_BUFFER Console );
 177 NTSTATUS STDCALL CsrpWriteConsole( PCSRSS_SCREEN_BUFFER Buff, CHAR *Buffer, DWORD Length, BOOL Attrib );
 178
 179 #endif /* ndef _CSRSS_API_H */