/* Private declarations for cons library
   Copyright (C) 2002, 2003, 2005 Free Software Foundation, Inc.

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2, or (at
   your option) any later version.

   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 General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */

#ifndef _CONS_PRIV_H
#define _CONS_PRIV_H

#include "cons.h"


/* The kind of bells available.  */
typedef enum
  {
    BELL_OFF,
    BELL_VISUAL,
    BELL_AUDIBLE
  } bell_type_t;

#define CONS_EVT_MOUSE_MOVE	(1 << 1)
#define CONS_EVT_MOUSE_BUTTON	(1 << 2)
#define CONS_EVT_KEYPRESS	(1 << 4)
#define CONS_EVT_OUTPUT		(1 << 8)


/* Number of records the client is allowed to lag behind the
   server.  */
extern int _cons_slack;

/* If we jump down at input.  */
extern int _cons_jump_down_on_input;

/* If we jump down at output.  */
extern int _cons_jump_down_on_output;

/* The type of bell used for the visual bell.  */
extern bell_type_t _cons_visual_bell;

/* The type of bell used for the audible bell.  */
extern bell_type_t _cons_audible_bell;

/* The type of events that will make the mouse cursor visible.  */
extern int _cons_show_mouse;

/* The type of events that will hide the mouse cursor.  */
extern int _cons_hide_mouse;

/* The mouse sensitivity.  */
extern float _cons_mouse_sens;


/* Non-locking version of cons_vcons_scrollback.  Does also not update
   the display.  */
int _cons_vcons_scrollback (vcons_t vcons, cons_scroll_t type, float value);

/* Non-locking version of cons_vcons_input.  */
error_t _cons_vcons_input (vcons_t vcons, char *buf, size_t size);

/* Generate the console event EVENT for console VCONS.  */
void _cons_vcons_console_event (vcons_t vcons, int event);


/* Called by MiG to translate ports into cons_notify_t.  mutations.h
   arranges for this to happen for the fs_notify interfaces. */
static inline cons_notify_t
begin_using_notify_port (fs_notify_t port)
{
  return ports_lookup_port (cons_port_bucket, port, cons_port_class);
}

static inline cons_notify_t
begin_using_notify_payload (unsigned long payload)
{
  return ports_lookup_payload (cons_port_bucket, payload, cons_port_class);
}

/* Called by MiG after server routines have been run; this balances
   begin_using_notify_port, and is arranged for the fs_notify
   interfaces by mutations.h. */
static inline void
end_using_notify_port (cons_notify_t cred)
{
  if (cred)
    ports_port_deref (cred);
}

#endif	/* _CONS_PRIV_H */