/*
 * The contents of this file are subject to the Mozilla Public
 * License Version 1.1 (the "MPL"); you may not use this file
 * except in compliance with the MPL. You may obtain a copy of
 * the MPL at http://www.mozilla.org/MPL/
 * 
 * Software distributed under the MPL is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the MPL for the specific language governing
 * rights and limitations under the MPL.
 * 
 * The Original Code is XMLterm.
 * 
 * The Initial Developer of the Original Code is Ramalingam Saravanan.
 * Portions created by Ramalingam Saravanan <svn@xmlterm.org> are
 * Copyright (C) 1999 Ramalingam Saravanan. All Rights Reserved.
 * 
 * Contributor(s):
 */

// mozLineTerm.h: Declaration of mozLineTerm class
// which implements the LineTerm and LineTermAux interfaces.
// and provides an XPCOM/XPCONNECT wrapper to the LINETERM module

#include "nspr.h"
#include "nscore.h"
#include "nsString.h"

#include "nsIServiceManager.h"

#include "nsIDocument.h"
#include "nsIDOMHTMLDocument.h"

#include "mozILineTermAux.h"

#define MAXCOL 4096            // Maximum columns in line buffer

class mozLineTerm : public mozILineTermAux
{
public:
  mozLineTerm();
  virtual ~mozLineTerm();

  // nsISupports interface
  NS_DECL_ISUPPORTS

  // mozILineTerm interface
  NS_IMETHOD GetCursorRow(PRInt32 *aCursorRow);
  NS_IMETHOD SetCursorRow(PRInt32 aCursorRow);

  NS_IMETHOD GetCursorColumn(PRInt32 *aCursorColumn);
  NS_IMETHOD SetCursorColumn(PRInt32 aCursorColumn);

  NS_IMETHOD GetEchoFlag(PRBool *aEchoFlag);
  NS_IMETHOD SetEchoFlag(PRBool aEchoFlag);

  NS_IMETHOD Open(const PRUnichar *command,
                  const PRUnichar *promptRegexp,
                  PRInt32 options, PRInt32 processType,
                  nsIDOMDocument *domDoc);

  NS_IMETHOD Close(const PRUnichar* aCookie);

  NS_IMETHOD Write(const PRUnichar *buf, const PRUnichar* aCookie);

  NS_IMETHOD Read(PRInt32 *opcodes,
                  PRInt32 *buf_row, PRInt32 *buf_col,
                  const PRUnichar* aCookie,
                  PRUnichar **_retval);

  // mozILineTermAux interface add ons
  // (not scriptable, no authentication cookie required)
  NS_IMETHOD OpenAux(const PRUnichar *command,
                     const PRUnichar *promptRegexp,
                     PRInt32 options, PRInt32 processType,
                     nsIDOMDocument *domDoc,
                     nsIObserver* anObserver,
                     nsString& aCookie);

  NS_IMETHOD SuspendAux(PRBool aSuspend);

  NS_IMETHOD CloseAux(void);

  NS_IMETHOD CloseAllAux(void);

  NS_IMETHOD ReadAux(PRInt32 *opcodes,
                     PRInt32 *buf_row, PRInt32 *buf_col,
                     PRUnichar **_retval, PRUnichar **retstyle);
  // others

  /** GTK event callback function
   */
  static void Callback(gpointer data,
                       gint source,
                       GdkInputCondition condition);

  /** Flag controlling logging of user input to STDERR */
  static PRBool mLoggingEnabled;

protected:
  /** Checks if Mozilla preference settings are secure
   * @param _retval (output) true if settings are secure
   */
  NS_IMETHOD ArePrefsSecure(PRBool *_retval);

  /** Checks if document principal is secure and returns principal string
   * @param domDOC DOM document object
   * @param aPrincipalStr (output) document principal string
   */
  NS_IMETHOD GetSecurePrincipal(nsIDOMDocument *domDoc,
                                char** aPrincipalStr);

  /** lineterm descriptor index returned by lterm_new (>= 0) */
  int mLTerm;

  /** current cursor row position */
  int mCursorRow;

  /** current cursor column position */
  int mCursorColumn;

  /** flag controlling whether is LineTerm is suspended */
  PRBool mSuspended;

  /** flag controlling input echo in LineTerm */
  PRBool mEchoFlag;

  /** non-owning reference to Observer to be notified when data is available
   * for reading from LineTerm
   */
  nsIObserver* mObserver;

  /** cookie string used for authentication (stored in document.cookie) */
  nsString mCookie;

  /** record of last time when timestamp was displayed in user input log */
  PRTime mLastTime;

};