/*
 * Copyright (C) 2009 - 2010 Funambol, Inc.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program 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 General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 *
 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Powered by Funambol" logo. If the display of the logo is not reasonably
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Powered by Funambol".
 */
/* $Id$ */

#pragma once

#include "UserInteractionDefs.h"
#include "common/Buffer.h"
#include <sys/types.h>
#include "CritSection.h"

namespace NS_DM_Client
{

//------------------------------------------------------------------------------------------------------
class IFIFOWrapper;

class Messenger
{
public:
    StatusCode Init();
    bool Release();
    //------------------------------------------------------------------------------------------------------
    // e_Ok - display message
    // e_OperationCancelled - no message listener
    StatusCode Display(const String& message, const UIOptionalParameters& parameters);
    //------------------------------------------------------------------------------------------------------
    // e_Ok - user choise "Yes"
    // e_OperationCancelled:
    //  - user cancel
    //  - user choise "No"
    //  - MAXDT is spent and no DR or DR set as "No"
    //  - no message listener
    StatusCode Confirmation(const String& message, const UIOptionalParameters& parameters);
    //------------------------------------------------------------------------------------------------------
    // e_Ok - user type input
    // e_OperationCancelled:
    //  - user cancel
    //  - MAXDT is spent and no DR
    //  - no message listener
    StatusCode UserInput(const String& message, const UIOptionalParameters& parameters, String& input);
    //------------------------------------------------------------------------------------------------------
    // e_Ok - user set chiose
    // e_OperationCancelled:
    //  - user cancel
    //  - MAXDT is spent and no DR
    //  - no message listener
    StatusCode UserChoice(const String& message, const UIOptionalParameters& parameters,
        const UserAvialableChoiseSet& avialable_choise_set, UserChoiseSet& choise_set, bool allowMultipleChoise = true);
    //------------------------------------------------------------------------------------------------------
    // e_Ok - progress is displayed
    // e_OperationCancelled:
    //  - user cancel
    //  - no message listener

    // size_to_download:
    //  > 0 - size in bytes download needed
    //  = 0 - download is finished
    //  < 0 - download is terminated from the side of server
    StatusCode ProgressNotification(const String& message, const UIOptionalParameters& parameters,
        long size_to_download);
    //------------------------------------------------------------------------------------------------------

    ~Messenger();
protected:

    StatusCode ReadDisplay(const UIOptionalParameters& parameters);
    StatusCode ReadConfirmation(const UIOptionalParameters& parameters);
    StatusCode ReadUserInput(const UIOptionalParameters& parameters, String& input);
    StatusCode ReadUserChoice(const UIOptionalParameters& parameters, String& choise);
    StatusCode ReadProgressNotification(const UIOptionalParameters& parameters);

private:
    IFIFOWrapper* m_fifo_request;
    IFIFOWrapper* m_fifo_response;
    NS_Common::CritSection m_critical_section;
};

//------------------------------------------------------------------------------------------------------

/// abstract method for Messenger instance creation
Messenger* CreateMessenger();

}
