Skip to content
Snippets Groups Projects
  • Nat Goodspeed's avatar
    464a0df4
    DRTVWR-418: Unify control flow through LLAppViewer across platforms. · 464a0df4
    Nat Goodspeed authored
    The LLApp API used to consist of init(), mainLoop(), cleanup() methods. This
    makes sense -- but on Mac that structure was being subverted. The method
    called mainLoop() was in fact being called once per frame. There was
    initialization code in the method, which (on Mac) needed to be skipped with an
    already-initialized bool. There was a 'while' loop which (on Mac) needed to be
    turned into an 'if' instead so the method would return after every frame.
    
    Rename LLApp::mainLoop() to frame(). Propagate through subclasses LLAppViewer
    and LLCrashLogger. Document the fact that frame() returns true to mean "done."
    (This was always the case, but had to be inferred from the code.)
    
    Rename the Mac Objective-C function mainLoop to oneFrame. Rename the C++ free
    function it calls from runMainLoop() to pumpMainLoop(). Add comments to
    llappdelegate-objc.mm explaining (inferred) control flow.
    
    Change the Linux viewer main() and the Windows viewer WINMAIN() from a single
    LLAppViewer::mainLoop() call to repeatedly call frame() until it returns true.
    
    Move initialization code from the top of LLAppViewer::frame() to the init()
    method, where it more properly belongs. Remove corresponding
    mMainLoopInitialized flag (and all references) from LLAppViewer.
    
    Remove 'while (! LLApp::isExiting())' (or on Mac, 'if (! LLApp::isExiting())')
    from LLAppViewer::frame() -- thus unindenting the whole body of the 'while'
    and causing many lines of apparent change. (Apologies to reviewers.)
    
    There are four LLApp states: APP_STATUS_RUNNING, APP_STATUS_QUITTING,
    APP_STATUS_STOPPED and APP_STATUS_ERROR. Change LLAppViewer::frame() return
    value from (isExiting()) (QUITTING or ERROR) to (! isRunning()). I do not know
    under what circumstances the state might transition to STOPPED during a
    frame() call, but I'm quite sure that if it does, we don't want to call
    frame() again. We only want a subsequent call if the state is RUNNING.
    
    Also rename mainLoop() method in LLCrashLogger subclasses
    LLCrashLoggerWindows, LLCrashLoggerMac, LLCrashLoggerLinux. Of course it's
    completely up to the frame() method whether to yield control; none of those in
    fact do. Honor protocol by returning true (frame() is done), even though each
    one's main() caller ignores the return value.
    
    In fact LLCrashLoggerWindows::mainLoop() wasn't using the return protocol
    correctly anyway, returning wParam or 0 or 1 -- possibly because the return
    protocol was never explicitly documented. It should always return true: "I'm
    done, don't call me again."
    464a0df4
    History
    DRTVWR-418: Unify control flow through LLAppViewer across platforms.
    Nat Goodspeed authored
    The LLApp API used to consist of init(), mainLoop(), cleanup() methods. This
    makes sense -- but on Mac that structure was being subverted. The method
    called mainLoop() was in fact being called once per frame. There was
    initialization code in the method, which (on Mac) needed to be skipped with an
    already-initialized bool. There was a 'while' loop which (on Mac) needed to be
    turned into an 'if' instead so the method would return after every frame.
    
    Rename LLApp::mainLoop() to frame(). Propagate through subclasses LLAppViewer
    and LLCrashLogger. Document the fact that frame() returns true to mean "done."
    (This was always the case, but had to be inferred from the code.)
    
    Rename the Mac Objective-C function mainLoop to oneFrame. Rename the C++ free
    function it calls from runMainLoop() to pumpMainLoop(). Add comments to
    llappdelegate-objc.mm explaining (inferred) control flow.
    
    Change the Linux viewer main() and the Windows viewer WINMAIN() from a single
    LLAppViewer::mainLoop() call to repeatedly call frame() until it returns true.
    
    Move initialization code from the top of LLAppViewer::frame() to the init()
    method, where it more properly belongs. Remove corresponding
    mMainLoopInitialized flag (and all references) from LLAppViewer.
    
    Remove 'while (! LLApp::isExiting())' (or on Mac, 'if (! LLApp::isExiting())')
    from LLAppViewer::frame() -- thus unindenting the whole body of the 'while'
    and causing many lines of apparent change. (Apologies to reviewers.)
    
    There are four LLApp states: APP_STATUS_RUNNING, APP_STATUS_QUITTING,
    APP_STATUS_STOPPED and APP_STATUS_ERROR. Change LLAppViewer::frame() return
    value from (isExiting()) (QUITTING or ERROR) to (! isRunning()). I do not know
    under what circumstances the state might transition to STOPPED during a
    frame() call, but I'm quite sure that if it does, we don't want to call
    frame() again. We only want a subsequent call if the state is RUNNING.
    
    Also rename mainLoop() method in LLCrashLogger subclasses
    LLCrashLoggerWindows, LLCrashLoggerMac, LLCrashLoggerLinux. Of course it's
    completely up to the frame() method whether to yield control; none of those in
    fact do. Honor protocol by returning true (frame() is done), even though each
    one's main() caller ignores the return value.
    
    In fact LLCrashLoggerWindows::mainLoop() wasn't using the return protocol
    correctly anyway, returning wParam or 0 or 1 -- possibly because the return
    protocol was never explicitly documented. It should always return true: "I'm
    done, don't call me again."
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
llapp_tut.cpp 4.20 KiB
/** 
 * @file llapp_tut.cpp
 * @author Phoenix
 * @date 2006-09-12
 *
 * $LicenseInfo:firstyear=2006&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2006-2011, Linden Research, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#include <tut/tut.hpp>

#include "linden_common.h"
#include "llapp.h"
#include "lltut.h"


namespace tut
{
	struct application
	{
		class LLTestApp : public LLApp
		{
		public:
			virtual bool init() { return true; }
			virtual bool cleanup() { return true; }
			virtual bool frame() { return true; }
		};
		LLTestApp* mApp;
		application()
		{
			mApp = new LLTestApp;
		}
		~application()
		{
			delete mApp;
		}
	};

	typedef test_group<application> application_t;
	typedef application_t::object application_object_t;
	tut::application_t tut_application("application");

	template<> template<>
	void application_object_t::test<1>()
	{
		LLSD defaults;
		defaults["template"] = "../../../scripts/messages/message_template.msg";
		defaults["configdir"] = ".";
		defaults["datadir"] = "data";
		mApp->setOptionData(LLApp::PRIORITY_DEFAULT, defaults);

		LLSD datadir_sd = mApp->getOption("datadir");
		ensure_equals("data type", datadir_sd.type(), LLSD::TypeString);
		ensure_equals(
			"data value", datadir_sd.asString(), std::string("data"));
	}

	template<> template<>
	void application_object_t::test<2>()
	{
		const int ARGC = 13;
		const char* ARGV[ARGC] =
		{
			"", // argv[0] is usually the application name
			"-crashcount",
			"2",
			"-space",
			"spaceserver.grid.lindenlab.com",
			"-db_host",
			"localhost",
			"--allowlslhttprequests",
			"-asset-uri",
			"http://test.lindenlab.com/assets",
			"-data",
			"127.0.0.1",
			"--smtp"
		};
		bool ok = mApp->parseCommandOptions(ARGC, const_cast<char**>(ARGV));
		ensure("command line parsed", ok);
		ensure_equals(
			"crashcount", mApp->getOption("crashcount").asInteger(), 2);
		ensure_equals(
			"space",
			mApp->getOption("space").asString(),
			std::string("spaceserver.grid.lindenlab.com"));
		ensure_equals(
			"db_host",
			mApp->getOption("db_host").asString(),
			std::string("localhost"));
		ensure("allowlshlttprequests", mApp->getOption("smtp"));
		ensure_equals(
			"asset-uri",
			mApp->getOption("asset-uri").asString(),
			std::string("http://test.lindenlab.com/assets"));
		ensure_equals(
			"data",
			mApp->getOption("data").asString(),
			std::string("127.0.0.1"));
		ensure("smtp", mApp->getOption("smtp"));
	}

	template<> template<>
	void application_object_t::test<3>()
	{
		const int ARGC = 4;
		const char* ARGV[ARGC] =
		{
			"", // argv[0] is usually the application name
			"crashcount",
			"2",
			"--space"
		};
		bool ok = mApp->parseCommandOptions(ARGC, const_cast<char**>(ARGV));
		ensure("command line parse failure", !ok);
	}

	template<> template<>
	void application_object_t::test<4>()
	{
		const int ARGC = 4;
		const char* ARGV[ARGC] =
		{
			"", // argv[0] is usually the application name
			"--crashcount",
			"2",
			"space"
		};
		bool ok = mApp->parseCommandOptions(ARGC, const_cast<char**>(ARGV));
		ensure("command line parse failure", !ok);
	}


	template<> template<>
	void application_object_t::test<5>()
	{
		LLSD options;
		options["boolean-test"] = true;
		mApp->setOptionData(LLApp::PRIORITY_GENERAL_CONFIGURATION, options);
		ensure("bool set", mApp->getOption("boolean-test").asBoolean());
		options["boolean-test"] = false;
		mApp->setOptionData(LLApp::PRIORITY_RUNTIME_OVERRIDE, options);
		ensure("bool unset", !mApp->getOption("boolean-test").asBoolean());
	}
}