/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- * * The contents of this file are subject to the Netscape Public * License Version 1.1 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.mozilla.org/NPL/ * * Software distributed under the License is distributed on an "AS * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or * implied. See the License for the specific language governing * rights and limitations under the License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is Netscape * Communications Corporation. Portions created by Netscape are * Copyright (C) 1998 Netscape Communications Corporation. All * Rights Reserved. * * Contributor(s): * Chak Nanga * David Epstein */ TestEmbed is a C++ test app based upon mfcEmbed. It includes individual test cases for Embedding interface methods. Interfaces include nsIFile & nsILocalFile, nsISHistory, nsIWebNavigation, nsIWebProgressListener, nsIClipboardCommands, and nsIRequest. Individual tests also exist for methods found in nsIGlobalHistory and nsIProfile. In addition to the mfcEmbed menus, it contains 5 menus: Tests, Interfaces, Tools, Verified Bugs, and Clipboard Commands. Executed test cases print output to a file called TestOutput.txt. This will be created in the C:\temp folder. See build instructions below. General Overview: ----------------- 1. The TestEmbedApp creates BrowserFrames 2. BrowserFrame creates the toolbar, statusbar, URLbar BrowserView etc. BrowserFrames implement the IBrowserFrameGlue interface using which new BrowserFrames can be created, statusbar updated etc. 3. BrowserView creates the embeddable browser instance and manages user interaction such as URL navigation etc. BrowserView connects the BrowserImpl with the BrowserFrame via the IBrowserFrameGlue interface 4. BrowserImpl implements the set of required/optional Gecko embedding interfaces Start by first looking at TestEmbed.cpp Files: StdAfx.h - Includes the required Mozilla header files TestEmbed.cpp - CWinApp derived class - Creates the browser's main frame window etc using the CreateNewBrowserFrame() and loads the HomePage - Makes the required NS_InitEmbedding() and the NS_TermEmbedding() calls in the app's InitInstance() and ExitInstance() functions - Keeps track of the list of new BrowserFrames created which it cleans up properly in ExitInstance() BrowserFrm.cpp - This is the browser's Frame window i.e. the one with the "chrome" - with the toolbar, urlbar etc. - Creates the toolbar, URLbar, statusbar, progressbar also the browser's view window. BrowserFrameGlue.cpp - Implements the IBrowserFrameGlue interface. This interface contains platform specific implementations of functions to update the statusbar, creating new browser frames etc. Embedded browser's callbacks use this interface when needed BrowserView.cpp - Creates the embedded browser object and handles most aspects of the embedded browser interactions - like URL navigation, clipboard interactions etc - Also has code to keep the menu/toolbar/statusbar UI items up to date - It's the view which conntects the BrowserFrame to the BrowserImpl (see below) by passing it the pointer to IBrowserFrameGlue BrowserImpl*.cpp - Implements the required and/or optional embedded browser interfaces (BrowserImpl.cpp implements the set of interfaces which are required by Gecko of all embedding apps. The other interfaces implemented in the BrowserImpl*.cpp files are optional) - Calls on the statusbar/progressbar update functions exposed via the IBrowserFrameGlue in response to the nsIProgressListener interface callbacks Dialogs.cpp - Contains dialog box code for displaying Prompts, getting passwords, getting username/passwords etc - Contains the CFindDialog class - used for searching text in a web page winEmbedFileLocProvider.cpp, ProfilesDlg.cpp, ProfileMgr.cpp - Profile management related code (by Conrad Carlen) Tests.cpp - This is where individual test cases are stored. The file is divided into three sections: 1) individual test cases corresponding to the "Tests" menu. 2) tools that are helpful, corresponding to the "Tools" menu. These include routines like removing all entries from Global History. 3) Interfaces. These correspond to the "Interfaces" menu and contain modular tests for embedding interface methods. QAUtils.cpp - This contains routines that are useful to QA. Such tasks as printing to a logfile, displaying messages to the screen, formatting output data, and retrieving the name of an nsI request are stored here. makefile.win - We define "_AFXDLL" and for the compiler and specify "-SUBSYSTEM:windows" for the linker using LCFLAGS and LLFLAGS, respectively - We also define "USE_SINGLE_SIGN_ON" to enable the single sign-on support testembed.dsp and testembed.dsw - These VisualStudio workspace/project files can be used to open/build this sample inside of the VC++ IDE Instructions for building: 1) Open a dos shell. 2) cd ../mozilla/embedding/qa/testembed // testEmbed directory 3) nmake -f makefile.win // compile testEmbed 4) cd ../../../dist/WIN32_D.OBJ/bin/ // navigate to the bin dir 5) testembed.exe // run testEmbed.exe A few suggestions: 1) Don't run nsIWebNavigation tests after turning on the Web Progress listener (from Tests menu). This will create all types of listener msgs in your logfile and display many msgs on the screen. 2) Best way to use web progress listener is to turn it on, then change URL (from the Tests menu). Change a few more urls and monitor the output. 3) Before running nsISHistory interface tests, load 1-2 urls. That will create a session history. The same applies for the nsIWebNavigation interfaces tests. One loaded url will enable back/forward navigation. 4) nsIRequest tests are in progress. They are implemented in BrowserImplWebPrgrsLstnr.cpp. A menu item was created under "Interfaces". This basically does the setup for nsIRequest tests: turns on web progress listener, and prompts user for a url.