diff options
| -rw-r--r-- | doc/realvnc-internals.txt | 389 |
1 files changed, 389 insertions, 0 deletions
diff --git a/doc/realvnc-internals.txt b/doc/realvnc-internals.txt new file mode 100644 index 00000000..998b78aa --- /dev/null +++ b/doc/realvnc-internals.txt @@ -0,0 +1,389 @@ + +The RealVNC code base is mostly undocumented. Rather than adding +comments to the actual source files, documentation is keept in +separate files in this directory. This is done because we want to make +as few changes to the RealVNC sources as possible. + + + +Files +===== +(t) means only in TightVNC. + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +Xregion/Xregion.h +Xregion/region.h +jpeg/jchuff.h B(t) B(t) +jpeg/jconfig.h B(t) B(t) +jpeg/jdct.h B(t) B(t) +jpeg/jdhuff.h B(t) B(t) +jpeg/jerror.h B(t) B(t) +jpeg/jinclude.h B(t) B(t) +jpeg/jmemsys.h B(t) B(t) +jpeg/jmorecfg.h B(t) B(t) +jpeg/jpegint.h B(t) B(t) +jpeg/jpeglib.h B(t) B(t) +jpeg/jversion.h B(t) B(t) +logmessages/messages.h +network/Socket.h +network/TcpSocket.cxx +network/TcpSocket.h +network/msvcwarning.h + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +rdr/Exception.cxx +rdr/Exception.h +rdr/FdInStream.cxx +rdr/FdInStream.h +rdr/FdOutStream.cxx +rdr/FdOutStream.h +rdr/FixedMemOutStream.h +rdr/HexInStream.cxx +rdr/HexInStream.h +rdr/HexOutStream.cxx +rdr/HexOutStream.h +rdr/InStream.cxx +rdr/InStream.h +rdr/MemInStream.h +rdr/MemOutStream.h +rdr/NullOutStream.cxx +rdr/NullOutStream.h +rdr/OutStream.h +rdr/RandomStream.cxx +rdr/RandomStream.h +rdr/SubstitutingInStream.h +rdr/ZlibInStream.cxx +rdr/ZlibInStream.h +rdr/ZlibOutStream.cxx +rdr/ZlibOutStream.h +rdr/msvcwarning.h +rdr/types.h + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +rfb/win32/Threading_win32.cxx +rfb/win32/Threading_win32.h +rfb/win32/msvcwarning.h +rfb/win32/util_win32.h +rfb/Blacklist.cxx +rfb/Blacklist.h +rfb/CConnection.cxx +rfb/CConnection.h +rfb/CMsgHandler.cxx +rfb/CMsgHandler.h +rfb/CMsgReader.h +rfb/CMsgReaderV3.cxx +rfb/CMsgReaderV3.h +rfb/CMsgWriter.cxx +rfb/CMsgWriter.h +rfb/CMsgWriterV3.cxx +rfb/CMsgWriterV3.h +rfb/CSecurity.h +rfb/CSecurityNone.h +rfb/CSecurityVncAuth.cxx +rfb/CSecurityVncAuth.h +rfb/ColourCube.h +rfb/ColourMap.h +rfb/ComparingUpdateTracker.cxx +rfb/ComparingUpdateTracker.h +rfb/Configuration.cxx +rfb/Configuration.h +rfb/ConnParams.cxx B B +rfb/ConnParams.h B B +rfb/Cursor.cxx +rfb/Cursor.h +rfb/Decoder.cxx +rfb/Decoder.h +rfb/Encoder.cxx +rfb/Encoder.h +rfb/Exception.h +rfb/HTTPServer.cxx +rfb/HTTPServer.h +rfb/HextileDecoder.cxx +rfb/HextileDecoder.h +rfb/HextileEncoder.cxx +rfb/HextileEncoder.h +rfb/Hostname.h +rfb/ImageGetter.h +rfb/LogWriter.cxx +rfb/LogWriter.h +rfb/Logger.cxx +rfb/Logger.h +rfb/Logger_file.cxx +rfb/Logger_file.h +rfb/Logger_stdio.cxx +rfb/Logger_stdio.h +rfb/Pixel.h +rfb/PixelBuffer.cxx +rfb/PixelBuffer.h +rfb/PixelFormat.cxx +rfb/PixelFormat.h +rfb/RREDecoder.cxx +rfb/RREDecoder.h +rfb/RREEncoder.cxx +rfb/RREEncoder.h +rfb/RawDecoder.cxx +rfb/RawDecoder.h +rfb/RawEncoder.cxx +rfb/RawEncoder.h +rfb/Rect.h +rfb/Region.cxx +rfb/Region.h +rfb/SConnection.cxx +rfb/SConnection.h +rfb/SDesktop.h +rfb/SMsgHandler.cxx +rfb/SMsgHandler.h +rfb/SMsgReader.cxx +rfb/SMsgReader.h +rfb/SMsgReaderV3.cxx +rfb/SMsgReaderV3.h +rfb/SMsgWriter.cxx +rfb/SMsgWriter.h +rfb/SMsgWriterV3.h +rfb/SSecurity.h +rfb/SSecurityFactoryStandard.cxx +rfb/SSecurityFactoryStandard.h +rfb/SSecurityNone.h +rfb/SSecurityVncAuth.cxx +rfb/SSecurityVncAuth.h +rfb/ServerCore.cxx +rfb/ServerCore.h +rfb/Threading.h +rfb/TransImageGetter.cxx +rfb/TransImageGetter.h +rfb/TrueColourMap.h +rfb/UpdateTracker.cxx +rfb/UpdateTracker.h +rfb/UserPasswdGetter.h +rfb/VNCSConnectionST.cxx +rfb/VNCSConnectionST.h +rfb/VNCServer.h +rfb/VNCServerST.cxx +rfb/VNCServerST.h +rfb/ZRLEDecoder.cxx +rfb/ZRLEDecoder.h +rfb/ZRLEEncoder.cxx +rfb/ZRLEEncoder.h +rfb/d3des.h +rfb/encodings.cxx +rfb/encodings.h +rfb/hextileConstants.h +rfb/hextileDecode.h +rfb/hextileEncode.h +rfb/keysymdef.h +rfb/msgTypes.h +rfb/msvcwarning.h +rfb/rreDecode.h +rfb/rreEncode.h +rfb/SMsgWriterV3.cxx +rfb/transInitTempl.h +rfb/transTempl.h +rfb/util.cxx +rfb/util.h +rfb/vncAuth.cxx +rfb/vncAuth.h +rfb/zrleDecode.h +rfb/zrleEncode.h +rfb/secTypes.cxx +rfb/CMsgReader.cxx +rfb/TightDecoder.cxx +rfb/tightDecode.h +rfb/TightDecoder.h +rfb/secTypes.h + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +rfb_win32/AboutDialog.cxx +rfb_win32/AboutDialog.h +rfb_win32/CKeyboard.cxx +rfb_win32/CKeyboard.h +rfb_win32/CPointer.cxx +rfb_win32/CPointer.h +rfb_win32/CleanDesktop.cxx +rfb_win32/CleanDesktop.h +rfb_win32/Clipboard.cxx +rfb_win32/Clipboard.h +rfb_win32/CurrentUser.cxx +rfb_win32/CurrentUser.h +rfb_win32/DIBSectionBuffer.cxx +rfb_win32/DIBSectionBuffer.h +rfb_win32/DeviceFrameBuffer.cxx +rfb_win32/DeviceFrameBuffer.h +rfb_win32/Dialog.cxx +rfb_win32/Dialog.h +rfb_win32/IntervalTimer.h +rfb_win32/LaunchProcess.cxx +rfb_win32/LaunchProcess.h +rfb_win32/MsgWindow.cxx +rfb_win32/MsgWindow.h +rfb_win32/OSVersion.cxx +rfb_win32/OSVersion.h +rfb_win32/RegConfig.cxx +rfb_win32/RegConfig.h +rfb_win32/Registry.cxx +rfb_win32/Registry.h +rfb_win32/SDisplay.cxx +rfb_win32/SDisplay.h +rfb_win32/SInput.cxx +rfb_win32/SInput.h +rfb_win32/Security.h +rfb_win32/Service.cxx +rfb_win32/Service.h +rfb_win32/SocketManager.cxx +rfb_win32/SocketManager.h +rfb_win32/TCharArray.cxx +rfb_win32/TCharArray.h +rfb_win32/TrayIcon.h +rfb_win32/WMCursor.cxx +rfb_win32/WMCursor.h +rfb_win32/WMHooks.cxx +rfb_win32/WMHooks.h +rfb_win32/WMNotifier.cxx +rfb_win32/WMNotifier.h +rfb_win32/WMPoller.cxx +rfb_win32/WMPoller.h +rfb_win32/WMShatter.cxx +rfb_win32/WMShatter.h +rfb_win32/WMWindowCopyRect.cxx +rfb_win32/WMWindowCopyRect.h +rfb_win32/Win32Util.cxx +rfb_win32/Win32Util.h +rfb_win32/keymap.h +rfb_win32/msvcwarning.h + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +tx/TXButton.h +tx/TXCheckbox.h +tx/TXDialog.h +tx/TXEntry.h +tx/TXImage.cxx +tx/TXImage.h +tx/TXLabel.h +tx/TXMenu.cxx +tx/TXMenu.h +tx/TXMsgBox.h +tx/TXScrollbar.cxx +tx/TXScrollbar.h +tx/TXViewport.cxx +tx/TXViewport.h +tx/TXWindow.cxx +tx/TXWindow.h +tx/Timer.cxx +tx/Timer.h + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +vncconfig/Authentication.h +vncconfig/Connections.h +vncconfig/Desktop.h +vncconfig/Hooking.h +vncconfig/Inputs.h +vncconfig/Legacy.cxx +vncconfig/Legacy.h +vncconfig/Sharing.h +vncconfig/resource.h +vncconfig/vncconfig.cxx +vncconfig_unix/vncExt.h +vncconfig_unix/vncconfig.cxx +vncmkdepend/def.h +vncmkdepend/ifparser.h +vncpasswd/vncpasswd.cxx + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +vncviewer/CViewManager.cxx +vncviewer/CViewManager.h +vncviewer/CViewOptions.cxx C W +vncviewer/CViewOptions.h C W +vncviewer/ConnectingDialog.h +vncviewer/ConnectionDialog.cxx +vncviewer/ConnectionDialog.h +vncviewer/InfoDialog.cxx +vncviewer/InfoDialog.h +vncviewer/MRU.h +vncviewer/OptionsDialog.cxx +vncviewer/OptionsDialog.h +vncviewer/UserPasswdDialog.cxx +vncviewer/UserPasswdDialog.h +vncviewer/buildTime.cxx +vncviewer/cview.cxx C W +vncviewer/cview.h +vncviewer/msvcwarning.h +vncviewer/resource.h +vncviewer/vncviewer.cxx + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +vncviewer_unix/AboutDialog.h +vncviewer_unix/CConn.cxx +vncviewer_unix/CConn.h +vncviewer_unix/DesktopWindow.cxx +vncviewer_unix/DesktopWindow.h +vncviewer_unix/InfoDialog.h +vncviewer_unix/OptionsDialog.h +vncviewer_unix/PasswdDialog.h +vncviewer_unix/ServerDialog.h +vncviewer_unix/parameters.h +vncviewer_unix/vncviewer.cxx + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +winvnc/AddNewClientDialog.h +winvnc/JavaViewer.cxx +winvnc/JavaViewer.h +winvnc/QueryConnectDialog.cxx +winvnc/QueryConnectDialog.h +winvnc/STrayIcon.cxx +winvnc/STrayIcon.h +winvnc/VNCServerService.cxx +winvnc/VNCServerService.h +winvnc/VNCServerWin32.cxx +winvnc/VNCServerWin32.h +winvnc/buildTime.cxx +winvnc/msvcwarning.h +winvnc/resource.h +winvnc/winvnc.cxx +wm_hooks/msvcwarning.h +wm_hooks/resource.h +wm_hooks/wm_hooks.cxx +wm_hooks/wm_hooks.h + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +x0vncserver/Image.cxx +x0vncserver/Image.h +x0vncserver/x0vncserver.cxx +xc/programs/Xserver/vnc/RegionHelper.h +xc/programs/Xserver/vnc/XserverDesktop.h +xc/programs/Xserver/vnc/vncExtInit.h +xc/programs/Xserver/vnc/vncHooks.h + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +zlib/deflate.h +zlib/infblock.h +zlib/infcodes.h +zlib/inffast.h +zlib/inffixed.h +zlib/inftrees.h +zlib/infutil.h +zlib/trees.h +zlib/zconf.h +zlib/zlib.h +zlib/zutil.h + +Name Server/Client/Both Windows/UNIX/Both +------------------------------------------------------------------------- +rfbplayer/FbsInputStream.cxx +rfbplayer/FbsInputStream.h +rfbplayer/RfbProto.cxx +rfbplayer/RfbProto.h +rfbplayer/buildTime.cxx +rfbplayer/resource.h +rfbplayer/rfbplayer.cxx +rfbplayer/rfbplayer.h +rfbplayer/utils.h |