BookmarkBridge User Manual


Chapter 3. How BookmarkBridge Works

Source Code Roadmap

This section gives a brief overview of the source code for BookmarkBridge. It describes each source code file and the important files used for compiling.

bknode.cpp
This file implements the BkNode, BkBookmark, and BkFolder classes. These classes implement the bookmark tree, used to represent the bookmarks and folder within each browser.
bkutil.cpp
This file implements the BkUtil class. This class implements the high-level functionality used to read bookmarks and save bookmarks. The code in this class is used by the GUI and by the command-line operations. It depends on several other important classes to perform its work.
bridgecfg.cpp
This file implements the BridgeCfg class. This class reads and writes the configuration file, bridgeconf.xml. It stores the configuration in several public variables and completely hides the configuration file itself.
browserbk.cpp
This file implements the BrowserBk class. This is an abstract base class from which classes for each browser derive. It includes code to combine a browser's bookmarks into the combined bookmark tree, and to detect and resolve differences between the bookmarks of different browsers. It implements several pure virtual functions that interface to browser specific code. This allows BookmarkBridge to support many different browsers with no changes to the core program logic.
browserlist.cpp
This file is a place-holder for a global array listing each browser supported by BookmarkBridge. To implement support for a new browser, simply derive a class from BrowserBk and add an entry to the list in this file.
dlgabout.cpp
This file implements the About dialog box.
dlgaddbrowser.cpp
This file implements the Add Browser dialog box. This is a dialog presented to the user when they want to add a new browser configuration by clicking on the Add button in the Settings window.
dlgbrowsers.cpp
This file implements the Browsers dialog box. This is a dialog presented to the user when they want to add a configured browser as a source or destination.
dlghelp.cpp
This file implements the help dialog box.
dlgmain.cpp
This file implements the main dialog window of BookmarkBridge.
dlgsettings.cpp
This file implements the Setting dialog box.
dlgviewbookmarks.cpp
This file implements the View Bookmarks dialog box.
iexplore.cpp
This file implements Internet Explorer functionality.
main.cpp
This file contains the main() function entry point. It parses command-line options and launches the main dialog box.
mozilla.cpp
This file implements Mozilla/Netscape functionality.
xbelread.cpp
This file reads the XBEL file, containing the bookmark tree.
xbelwrite.cpp
This file writes the XBEL file, containing the bookmark tree.
xgetopt.cpp
This file, used only with Windows, implements the getopt() function.
xmlparser.cpp
This file interfaces with libxml2 and provides a state machine for parsing recursive XML or HTML files.
Table of Contents          Previous: Compiling BookmarkBridge From Source          Next: None


BookmarkBridge is Copyright © 2003 by Ken Schenke. All Rights Reserved. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.