From c15b124f40f19f1090280e1c7b7257a48bb844a8 Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Thu, 1 Jan 2026 19:31:53 +0900 Subject: Removed source code tree from the hacker guide file. The real code is the best source of info for the structure Signed-off-by: Michele Calgaro --- doc/hackers.guide.txt | 258 -------------------------------------------------- 1 file changed, 258 deletions(-) diff --git a/doc/hackers.guide.txt b/doc/hackers.guide.txt index 9004f96..5c1a893 100644 --- a/doc/hackers.guide.txt +++ b/doc/hackers.guide.txt @@ -3,264 +3,6 @@ KVIrc hackers guide - Szymon Stefanek - 2004.05.26 This is an always-work-in-progress guide for KVIrc source code hackers. -------------------------------------------------------------------------------- -The source tree -------------------------------------------------------------------------------- - -/ Root directory. -| This is almost completely automake and autoconf stuff. -| -|-- admin Administrative files used during the compilation -| automake, autoconf and document generation scripts. -| -|-- data Data for the KVIrc program. Most of this stuff is -| | installed in $(prefix)/share/kvirc/$VERSION/ -| | -| |-- app *.desktop and menu entries for KDE -| | -| |-- config Default configuration files -| | -| |-- defscript The default script -| | -| |-- deftheme The default themes -| | -| |-- doctemplates Some document templates that get parsed by gendoc.pl -| | when the html documentation is generated -| | -| |-- helppics Data pictures for the html documentation -| | -| |-- icons Icons in various sizes -| | -| |-- man The manual pages -| | -| |-- mimelnk *.desktop entries for the *.kvs and *.kvc file types -| | that are respectively kvirc scripts and kvirc -| | configuration files. This is all stuff for KDE -| | -| |-- msgcolors Default sets of message colors -| | -| |-- pics Most of the pictures that KVIrc uses -| | -| |-- protocols irc:// and irc6:// protocol definitions for konqueror -| | -| `-- resources Resources for the windows compilation. -| -|-- debian Debian mantainer's stuff -|-- debian.robin -| -|-- doc Any kind of documentation -| | -| `-- scriptexamples Various script examples -| -|-- no-dist Stuff that does NOT end in the final distribution - -|-- po Internationalisation (i18n :) -| | -| |-- kvirc Translations for kvilib and the main KVIrc executable -| | -| `-- modules Translations for the modules -| -|-- scripts Some SHELL scripts. Probably only config is used atm. -| -|-- src The sources -| | -| |-- kvilib KVIrc library. Any source code snippet that can be -| | | abstracted enough to not depend on the KVIrc core -| | | ends up here. kvilib depends only on external stuff. -| | | -| | |-- build This is the build directory for automake. -| | | The main Makefile.am is here. -| | | -| | |-- config The headers that control the compile-time -| | | configuration. -| | | -| | |-- core The really basic classes: strings, memory management, -| | | error code defines etc.. -| | | -| | |-- ext Here ends everything that has no other specific place -| | | in kvilib. -| | | -| | |-- file File management and file utilities -| | | -| | |-- include Compile-time generated include files. these are -| | | only links. -| | | -| | |-- irc IRC protocol related classes. -| | | -| | |-- net Networking related stuff: sockets, ssl, http ... -| | | -| | |-- system System function wrappers or stuff that depends -| | | on the strict operating system support. -| | | Threads, localisation, env, time, shared library.. -| | | -| | `-- tal Toolkit Abstraction Layer: wrapper classes that -| | inherit from TDE* or TQt classes, depending on the -| | compilation type. -| | -| |-- kvirc The KVIrc executable sources -| | | -| | |-- build Again the build directory for automake. -| | | Makefile.am is here. -| | | -| | |-- include Again compile-time include files. Only links. -| | | -| | |-- kernel The core of the executable. The main function is -| | | here. Here is also the KviApp object and the options -| | | core management. -| | | -| | |-- kvs The NEW shiny scripting engine. -| | | At the time of writing this two-stage UNICODE -| | | KVS interpreter is not finished yet and thus almost -| | | nothing here is really hardwired to the rest -| | | of the core. -| | | -| | |-- module The module management stuff: the loader, the module -| | | interface definitions etc.. -| | | -| | |-- sparser The IRC server parser -| | | -| | |-- ui User interface. 99% of the core GUI is here. -| | | Here you can find KviFrame (the main window) -| | | KviMdiManager, KviWindow, KviChannel, KviQuery, -| | | KviConsole, KviInput, KviIrcView and KviUserListView -| | | which are the most common widgets in kvirc. -| | | -| | `-- uparser The currently used scripting engine (user parser). -| | If you want to implement just some simple features -| | (like new commands or functions) then this is the -| | place to look at. If you want to make some long -| | term hacks then it's probably better to look at the -| | kvs directory instead. -| | -| `-- modules Yes, the modules :D -| | -| |-- about The about dialog -| | -| |-- aliaseditor The alias editor window -| | -| |-- avatar Avatar manipulation stuff -| | -| |-- chan $chan.* scripting stuff -| | -| |-- channelsjoin The channelsjoin dialog -| | -| |-- clock This was a clock applet but actually it is not -| | working and thus not compiled. -| | -| |-- codetester The codetester window -| | -| |-- config config.* scripting stuff -| | -| |-- dcc This module implements the whole DCC protocol. -| | Windows, transfer threads etc: everyting is here. -| | -| |-- dialog dialog.* scripting stuff -| | -| |-- dockwidget The dock widget for KDE and windows. -| | -| |-- editor The scripting editor core widget. -| | -| |-- eventeditor The event editor window -| | -| |-- file file.* scripting stuff -| | -| |-- filetransferwindow The file transfers window -| | -| |-- help The help browser -| | -| |-- http http.* scripting stuff -| | -| |-- ident A small ident daemon -| | -| |-- iograph Another applet that is not compiled for now. -| | -| |-- lag Lag meter -| | -| |-- lamerizer A crypt/text-transformation engine -| | -| |-- links The links window -| | -| |-- list The channel list window -| | -| |-- log log.* scripting stuff -| | -| |-- logview The logviewer window -| | -| |-- mask mask.* scripting stuff -| | -| |-- mircimport A server entry importer from the mirc's servers.ini -| | -| |-- mp3player mp3player.* scripting stuff -| | This is an interface to the xmms program on unix -| | and to winamp on windows. On unix libxmms.so is -| | loaded at runtime. On windows there is also -| | a gen_kvirc.dll plugin for winamp that needs -| | to be loaded by the winamp program in order to make -| | communications with KVIrc possible. -| | -| |-- my my.* scripting stuff -| | -| |-- objects All the object oriented scripting stuff -| | -| |-- options The options dialog -| | -| |-- popupeditor The popup editor window -| | -| |-- raweditor The raw events editor window -| | -| |-- regchan regchan.* scripting stuff -| | -| |-- reguser reguser.* scripting stuff -| | -| |-- rijndael A crypting engine -| | -| |-- setup The module that is loaded when KVIrc is started -| | for the first time. It contains the initial -| | configuration wizard. -| | -| |-- sharedfile sharedfile.* scripting stuff -| | -| |-- sharedfileswindow The shared files window -| | -| |-- snd snd.* scripting stuff -| | -| |-- socketspy The socketspy window -| | -| |-- spaste spaste.* scripting stuff -| | -| |-- str str.* scripting stuff -| | -| |-- system system.* scripting stuff -| | -| |-- tb_options The options toolbar -| | -| |-- tb_scripting The scripting toolbar -| | -| |-- tb_winops The window operations toolbar -| | -| |-- term The embedded terminal emulator (needs KDE) -| | -| |-- tip The tip of the day -| | -| |-- tmphighlight tmphighlight.* scripting stuff -| | -| |-- toolbar toolbar.* scripting stuff -| | -| |-- toolbareditor The toolbar editor window -| | -| |-- url The url window -| | -| `-- window window.* scripting stuff -| -`-- win32build The directory for Windows builds - - -[pragma@phoenix src]# cat $(find ./ -name \*.h) | wc -l - 60189 -[pragma@phoenix src]# cat $(find ./ -name \*.cpp) | wc -l - 164400 - - ------------------------------------------------------------------------------- The coding style ------------------------------------------------------------------------------- -- cgit v1.2.3