% Copyright (C) 2003-2019 Olivier Boudeville
%
% This file is part of the Ceylan-Myriad library.
%
% This library is free software: you can redistribute it and/or modify
% it under the terms of the GNU Lesser General Public License or
% the GNU General Public License, as they are published by the Free Software
% Foundation, either version 3 of these Licenses, or (at your option)
% any later version.
% You can also redistribute it and/or modify it under the terms of the
% Mozilla Public License, version 1.1 or later.
%
% 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 and the GNU General Public License
% for more details.
%
% You should have received a copy of the GNU Lesser General Public
% License, of the GNU General Public License and of the Mozilla Public License
% along with this library.
% If not, see <http://www.gnu.org/licenses/> and
% <http://www.mozilla.org/MPL/>.
%
% Author: Olivier Boudeville [olivier (dot) boudeville (at) esperide (dot) com]


% Testing the OpenGL support.
%
% See the gui_opengl.erl tested module.
%
-module(gui_opengl_test).


% For run/0 export and al:
-include("test_facilities.hrl").


-record( my_test_state, {

	% Internal state of the gui subsystem:
	gui_state :: term(), %gui:state(),

	% Test-specific state:
	test_main_frame :: gui:frame()

}).

-type my_test_state() :: #my_test_state{}.

% FIXME:
-export_type([ my_test_state/0 ]).


-spec run_test_gui() -> void().
run_test_gui() ->

	test_facilities:display( "~nStarting the test of OpenGL support." ),

	InitialState = gui:start(),

	%gui:set_debug_level( [ calls, life_cycle ] ),

	MainFrame = gui:create_frame( "GUI OpenGL Test" ),

	_StatusBar = gui:create_status_bar( MainFrame ),

	gui:show( MainFrame ),

	SubscribedEvents = [
		  { MainFrame, onWindowClosed } ],

	LoopState = gui:handle_events( InitialState,
									 SubscribedEvents ),

	receive

		{ onWindowClosed, [ MainFrame, _Id, _UserData, _WxEvent ] } ->
			gui:destruct_window( MainFrame ),
			trace_utils:trace( "Main frame closed, test success." ),
			gui:stop( LoopState )

	end.





% Runs the test.
-spec run() -> no_return().
run() ->

	test_facilities:start( ?MODULE ),

	case executable_utils:is_batch() of

		true ->
			test_facilities:display( "(not running the OpenGL test, "
									 "being in batch mode)" );

		false ->
			run_test_gui()

	end,

	test_facilities:stop().