/*
 *  This file is part of the XForms library package.
 *
 *  XForms 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; either version 2.1, or
 *  (at your option) any later version.
 *
 *  XForms 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 XForms.  If not, see <http://www.gnu.org/licenses/>.
 */


/**
 * \file browser.c
 *
 *  This file is part of the XForms library package.
 *  Copyright (c) 1996-2002  T.C. Zhao and Mark Overmars
 *  All rights reserved.
 *
 *   Browser composite.
 *   scrollbar redrawing can be further optimized.
 */


#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "include/forms.h"
#include "flinternal.h"
#include "private/pbrowser.h"
#include "private/flvasprintf.h"


/***************************************
 * Some attribue of the object changed, we better recalculate how
 * it should oook like
 ***************************************/

static void
attrib_change( FL_OBJECT * ob )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    /* Text box stuff */

    sp->tb->x = ob->x;
    sp->tb->y = ob->y;

    fli_set_object_visibility( sp->tb, FL_VISIBLE );
    sp->tb->input = ob->input;

    sp->tb->type    = ob->type;
    sp->tb->boxtype = ob->boxtype;
    sp->tb->lcol    = ob->lcol;
    sp->tb->col1    = ob->col1;
    sp->tb->col2    = ob->col2;
    sp->tb->bw      = ob->bw;
    fli_notify_object( sp->tb, FL_RESIZED );

    /* Scrollbars */

    if (    ob->boxtype == FL_DOWN_BOX
         && sp->hsl->type == FL_HOR_NICE_SCROLLBAR )
    {
        sp->hsl->boxtype = FL_FRAME_BOX;
        sp->vsl->boxtype = FL_FRAME_BOX;
    }
    else if (    ob->boxtype == FL_DOWN_BOX
              && sp->hsl->type == FL_HOR_SCROLLBAR )
    {
        sp->hsl->boxtype = FL_UP_BOX;
        sp->vsl->boxtype = FL_UP_BOX;
    }
    else
    {
        sp->hsl->boxtype = ob->boxtype;
        sp->vsl->boxtype = ob->boxtype;
    }

    sp->hsl->bw = sp->vsl->bw = ob->bw;

    if ( ! sp->user_set && ob->boxtype != FL_DOWN_BOX )
        sp->vw = sp->vw_def = sp->hh = sp->hh_def =
                                          fli_get_default_scrollbarsize( ob );
}


/***************************************
 ***************************************/

static void
get_geometry( FL_OBJECT * obj )
{
    FLI_BROWSER_SPEC *comp = obj->spec;
    FL_OBJECT *tb = comp->tb;
    FLI_TBOX_SPEC *sp = comp->tb->spec;
    int h_on = comp->h_on,
        v_on = comp->v_on;
    double old_xrel = fli_tbox_get_rel_xoffset( tb );
    double old_yrel = fli_tbox_get_rel_yoffset( tb );

    comp->hh = comp->vw = 0;
    comp->h_on = comp->v_on = 0;

    tb->w = obj->w;
    tb->h = obj->h;
    fli_tbox_recalc_area( tb );

    /* Check if we need a vertical slider */

    if (    ( sp->max_height > sp->h && comp->v_pref != FL_OFF )
         || comp->v_pref == FL_ON )
    {
        comp->v_on  = 1;
        comp->vw    = comp->vw_def;

        tb->w      -= comp->vw;
        fli_tbox_recalc_area( tb );
    }

    /* Check if we need a horizontal slider */

    if (    ( sp->max_width > sp->w && comp->h_pref != FL_OFF )
         || comp->h_pref == FL_ON )
    {
        comp->h_on  = 1;
        comp->hh    = comp->hh_def;

        tb->h      -= comp->hh;
        fli_tbox_recalc_area( tb );
    }

    /* Due to the addition of a horizontal slider also a vertical slider
       may now be needed, so recheck for this possibility */

    if ( ! comp->v_on && sp->max_height > sp->h && comp->v_pref != FL_OFF )
    {
        comp->v_on  = 1;
        comp->vw    = comp->vw_def;

        tb->w      -= comp->vw;
        fli_tbox_recalc_area( tb );
    }

    if ( comp->v_on )
    {
        comp->vsl->x = obj->x + obj->w - comp->vw;
        comp->vsl->y = obj->y;
        comp->vsl->w = comp->vw;
        comp->vsl->h = obj->h - comp->hh;
        fli_notify_object( comp->vsl, FL_RESIZED );

        comp->vval  = old_yrel;
        comp->vsize = comp->vinc1 = ( double ) sp->h / sp->max_height;
        comp->vinc2 = ( double ) sp->def_height / sp->max_height;
    }
    else
    {
        comp->vsize = 1.0;
        comp->vval  = 0.0;
    }

    if ( comp->h_on )
    {
        comp->hsl->x = obj->x;
        comp->hsl->y = obj->y + obj->h - comp->hh;
        comp->hsl->w = obj->w - comp->vw;
        comp->hsl->h = comp->hh;
        fli_notify_object( comp->hsl, FL_RESIZED );

        comp->hval  = old_xrel;
        comp->hsize = ( double ) sp->w / sp->max_width;
        comp->hinc1 = ( 8.0 * sp->def_height ) / sp->max_width;
        comp->hinc2 = ( sp->def_height - 2.0 ) / sp->max_width;
    }
    else
    {
        comp->hsize = 1.0;
        comp->hval  = 1.0;
    }

    comp->dead_area = comp->h_on && comp->v_on;
    fli_set_object_visibility( comp->hsl, comp->h_on );
    fli_set_object_visibility( comp->vsl, comp->v_on );

    comp->attrib = 1;

    sp->no_redraw = 1;

    if ( comp->v_on )
    {
        comp->vval = fli_tbox_set_rel_yoffset( tb, comp->vval );
        fl_set_scrollbar_value( comp->vsl, comp->vval );
        fl_set_scrollbar_size( comp->vsl, comp->vsize );
    }

    if ( comp->h_on )
    {
        comp->hval = fli_tbox_set_rel_xoffset( tb, comp->hval );
        fl_set_scrollbar_value( comp->hsl, comp->hval );
        fl_set_scrollbar_size( comp->hsl, comp->hsize );    
    }

    sp->no_redraw = 0;

    if ( h_on != comp->h_on || v_on != comp->v_on )
        fli_notify_object( tb, FL_RESIZED );
}


/***************************************
 * The "dead area" is the small square in the lower right hand corner
 * of the browser (beside the horizontal slider and below the vertical
 * one) that shows up when both sliders are displayed.
 ***************************************/

static void
draw_dead_area( FL_OBJECT * obj )
{
    FLI_BROWSER_SPEC *sp = obj->spec;

    if ( FL_ObjWin( sp->tb ) )
    {
        fl_winset( FL_ObjWin( sp->tb ) );
        fl_draw_box( FL_FLAT_BOX, obj->x + obj->w - sp->vw,
                     obj->y + obj->h - sp->hh, sp->vw, sp->hh,
                     sp->vsl->col1, 1 );
    }
}


/***************************************
 * Called for events concerning the browser
 ***************************************/

static int
handle_browser( FL_OBJECT * obj,
                int         event,
                FL_Coord    mx   FL_UNUSED_ARG,
                FL_Coord    my   FL_UNUSED_ARG,
                int         key  FL_UNUSED_ARG,
                void      * ev   FL_UNUSED_ARG )
{
    FLI_BROWSER_SPEC *sp = obj->spec;

    switch ( event )
    {
        case FL_RESIZED :
        case FL_ATTRIB :
            sp->attrib = 1;
            break;

        case FL_DRAW:
            if ( sp->attrib )
            {
                attrib_change( obj );
                get_geometry( obj );
                sp->attrib = 0;
            }

            draw_dead_area( obj );
            /* fall through */

        case FL_DRAWLABEL:
            fl_draw_object_label( obj );
            break;

        case FL_FREEMEM:
            fl_free( sp );
            break;
    }

    return FL_RETURN_NONE;
}


/***************************************
 ***************************************/

static void
redraw_scrollbar( FL_OBJECT * ob )
{
    FLI_BROWSER_SPEC *comp = ob->spec;

    attrib_change( ob );
    get_geometry( ob );

    fl_freeze_form( ob->form );

    if ( comp->v_on )
    {
        fl_set_scrollbar_size( comp->vsl, comp->vsize );
        fl_set_scrollbar_value( comp->vsl, comp->vval );

        if ( comp->vsize != 1.0 )
            fl_set_scrollbar_increment( comp->vsl, comp->vinc1, comp->vinc2 );
    }

    if ( comp->h_on )
    {
        fl_set_scrollbar_size( comp->hsl, comp->hsize );
        fl_set_scrollbar_value( comp->hsl, comp->hval );

        if ( comp->hsize != 1.0 )
            fl_set_scrollbar_increment( comp->hsl, comp->hinc1, comp->hinc2 );
    }

    if ( comp->attrib )
    {
        if ( comp->v_on )
            fl_redraw_object( comp->vsl );
        if ( comp->h_on )
            fl_redraw_object( comp->hsl );
        fl_redraw_object( comp->tb );

        comp->attrib = 0;
    }

    draw_dead_area( ob );
    fl_unfreeze_form( ob->form );
}


/***************************************
 ***************************************/

static void
hcb( FL_OBJECT * obj,
     long        data  FL_UNUSED_ARG )
{
    FLI_BROWSER_SPEC *comp = obj->parent->spec;
    double hp = fli_tbox_set_rel_xoffset( comp->tb,
                                          fl_get_scrollbar_value( comp->hsl ) );

    if ( obj->returned & FL_RETURN_END )
        obj->parent->returned |= FL_RETURN_END;

    if ( hp != comp->old_hp )
        obj->parent->returned |= FL_RETURN_CHANGED;

    if (    obj->parent->how_return & FL_RETURN_END_CHANGED
         && ! (    obj->parent->returned & FL_RETURN_CHANGED
                && obj->parent->returned & FL_RETURN_END ) )
            obj->parent->returned = FL_RETURN_NONE;

    if ( obj->parent->returned & FL_RETURN_END )
        comp->old_hp = hp;

    if ( obj->returned & FL_RETURN_CHANGED && comp->hcb )
        comp->hcb( obj->parent, fli_tbox_get_topline( comp->tb ) + 1,
                   comp->hcb_data );
}


/***************************************
 ***************************************/

static void
vcb( FL_OBJECT * obj,
     long        data  FL_UNUSED_ARG )
{
    FLI_BROWSER_SPEC *comp = obj->parent->spec;
    double vp = fli_tbox_set_rel_yoffset( comp->tb,
                                          fl_get_scrollbar_value( comp->vsl ) );

    if ( obj->returned & FL_RETURN_END )
        obj->parent->returned |= FL_RETURN_END;

    if ( vp != comp->old_vp )
        obj->parent->returned |= FL_RETURN_CHANGED;

    if (    obj->parent->how_return & FL_RETURN_END_CHANGED
         && ! (    obj->parent->returned & FL_RETURN_CHANGED
                && obj->parent->returned & FL_RETURN_END ) )
            obj->parent->returned = FL_RETURN_NONE;

    if ( obj->parent->returned & FL_RETURN_END )
        comp->old_vp = vp;

    if ( obj->returned & FL_RETURN_CHANGED && comp->vcb )
        comp->vcb( obj->parent, fli_tbox_get_topline( comp->tb ) + 1,
                   comp->vcb_data );
}


/***************************************
 * Textbox callback routine, we simply pass the return value of the
 * textbox on as the parents new return value after a readjustment of
 * the scollbars.
 ***************************************/

static void
tbcb( FL_OBJECT * obj,
      long        data  FL_UNUSED_ARG )
{
    FLI_BROWSER_SPEC *psp = obj->parent->spec;
    double vp = fli_tbox_get_rel_yoffset( obj );
    double hp = fli_tbox_get_rel_xoffset( obj );

    if ( obj->returned & FL_RETURN_CHANGED )
    {
        if ( hp != psp->old_hp )
        {
            fl_set_scrollbar_value( psp->hsl, psp->old_hp = hp );
            if ( psp->hcb )
                psp->hcb( obj->parent, fli_tbox_get_topline( psp->tb ) + 1,
                          psp->hcb_data );
        }

        if ( vp != psp->old_vp )
        {
            fl_set_scrollbar_value( psp->vsl, psp->old_vp = vp );
            if ( psp->vcb )
                psp->vcb( obj->parent, fli_tbox_get_topline( psp->tb ) + 1,
                          psp->vcb_data );
        }
    }   

    obj->parent->returned = obj->returned;
}


/***************************************
 * Textbox dblclick callback
 ***************************************/

static void
tb_dblcallback( FL_OBJECT * ob,
                long        data  FL_UNUSED_ARG )
{
    FLI_BROWSER_SPEC *sp = ob->parent->spec;

    if ( sp->callback )
        sp->callback( ob->parent, sp->callback_data );
}


/***************************************
 ***************************************/

static int
tbpost( FL_OBJECT * ob,
        int         ev,
        FL_Coord    mx,
        FL_Coord    my,
       int          key,
        void      * xev )
{
    FL_OBJECT *br = ob->parent;

    return br->posthandle ? br->posthandle( br, ev, mx, my, key, xev ) : 0;
}


/***************************************
 ***************************************/

static int
tbpre( FL_OBJECT * ob,
       int         ev,
       FL_Coord    mx,
       FL_Coord    my,
      int          key,
       void      * xev )
{

    FL_OBJECT *br = ob->parent;

    return br->prehandle ? br->prehandle( br, ev, mx, my, key, xev ) : 0;
}


/***************************************
 ***************************************/

int
fli_get_default_scrollbarsize( FL_OBJECT * ob )
{
    int delta = ( FL_abs( ob->bw ) + 3 * ( ob->bw > 0 ) );
    int flat = IS_FLATBOX( ob->boxtype ) ? 2 : 0;

    if ( ob->w > 250 && ob->h > 250 )
        return 15 + delta - flat;
    else if ( ob->w < 150 || ob->h < 150 )
        return 13 + delta - flat;
    else
        return 14 + delta - flat;
}


/***************************************
 * Creates a new browser object to be added to a form
 ***************************************/

FL_OBJECT *
fl_create_browser( int          type,
                   FL_Coord     x,
                   FL_Coord     y,
                   FL_Coord     w,
                   FL_Coord     h,
                   const char * label )
{
    FL_OBJECT *ob;
    FLI_BROWSER_SPEC *sp;
    int D;

    ob = fl_make_object( FL_BROWSER, type, x, y, w, h, label,
                         handle_browser );

    sp = ob->spec = fl_calloc( 1, sizeof *sp );
    sp->tb = fli_create_tbox( type, x, y, w, h, NULL );

    sp->callback  = NULL;
    sp->hsize     = sp->vsize = sp->hval = sp->vval =
    sp->hinc1     = sp->hinc2 = sp->vinc1 = sp->vinc2 = 0.0;
    sp->hcb       = sp->vcb = NULL;
    sp->hcb_data  = sp->vcb_data = NULL;
    sp->old_hp    = sp->old_vp = 0.0;
    sp->attrib    = 1;

    /* Copy browser attributes from textbox */

    ob->boxtype  = sp->tb->boxtype;
    ob->lcol     = sp->tb->lcol;
    ob->col1     = sp->tb->col1;
    ob->col2     = sp->tb->col2;
    ob->align    = sp->tb->align;

    /* Textbox handlers */
 
    fl_set_object_callback( sp->tb, tbcb, 0 );
    fli_tbox_set_dblclick_callback( sp->tb, tb_dblcallback, 0 );
    fl_set_object_posthandler( sp->tb, tbpost );
    fl_set_object_prehandler( sp->tb, tbpre );

    /* Scrollbars */

    D = sp->vw_def = sp->hh_def = fli_get_default_scrollbarsize( ob );
    sp->v_pref = sp->h_pref = FL_AUTO;

    sp->hsl = fl_create_scrollbar( fli_context->hscb, x, y + h - D,
                                   w - D, D, NULL );
    fli_set_object_visibility( sp->hsl, sp->h_pref == FL_ON );
    fl_set_object_callback( sp->hsl, hcb, 0 );
    fl_set_scrollbar_value( sp->hsl, 0.0 );
    fl_set_scrollbar_bounds( sp->hsl, 0.0, 1.0 );
    sp->hsl->resize = FL_RESIZE_NONE;

    sp->vsl = fl_create_scrollbar( fli_context->vscb, x + w - D, y,
                                   D, h - D, NULL );
    fli_set_object_visibility( sp->vsl, sp->v_pref == FL_ON );
    fl_set_object_callback( sp->vsl, vcb, 0 );
    fl_set_scrollbar_value( sp->vsl, 0.0 );
    fl_set_scrollbar_bounds( sp->hsl, 0.0, 1.0 );
    sp->vsl->resize = FL_RESIZE_NONE;

    fl_add_child( ob, sp->tb  );
    fl_add_child( ob, sp->hsl );
    fl_add_child( ob, sp->vsl );

    /* In older versions scrollbars and browsers weren't returned to e.g.
       fl_do_forms() but still a callback associated with the object
       got called. To emulate the old behaviour we have to set the
       return policy to default to FL_RETURN_NONE and only change that
       to FL_RETURN_CHANGED when a callback is installed (which is done
       in fl_set_object_callback()) */

#if ! USE_BWC_BS_HACK
    fl_set_object_return( ob, FL_RETURN_SELECTION | FL_RETURN_DESELECTION );
#else
    fl_set_object_return( ob, FL_RETURN_NONE );
#endif

    fl_set_object_return( sp->hsl, FL_RETURN_ALWAYS );
    fl_set_object_return( sp->vsl, FL_RETURN_ALWAYS );
    fl_set_object_return( sp->tb,  FL_RETURN_ALWAYS );

    return ob;
}


/***************************************
 * Adds a new browser object to the current form
 ***************************************/

FL_OBJECT *
fl_add_browser( int          type,
                FL_Coord     x,
                FL_Coord     y,
                FL_Coord     w,
                FL_Coord     h,
                const char * label )
{
    FL_OBJECT *ob = fl_create_browser( type, x, y, w, h, label );

    fl_add_object( fl_current_form, ob );

    return ob;
}


/***************************************
 * Switches the vertical scrollbar of the browser on or off
 ***************************************/

void
fl_set_browser_vscrollbar( FL_OBJECT * obj,
                           int         on_off )
{
    FLI_BROWSER_SPEC *comp = obj->spec;

    if ( comp->v_pref == on_off )
        return;

    comp->v_pref = on_off;
    redraw_scrollbar( obj );
    fli_tbox_react_to_vert( comp->tb, on_off );
    get_geometry( obj );
    fl_redraw_object( obj );
}


/***************************************
 * Switches the horizontal scrollbar of the browser on or off
 ***************************************/

void
fl_set_browser_hscrollbar( FL_OBJECT * obj,
                           int         on_off )
{
    FLI_BROWSER_SPEC *comp = obj->spec;

    if ( comp->h_pref == on_off )
        return;

    comp->h_pref = on_off;
    redraw_scrollbar( obj );
    fli_tbox_react_to_hori( comp->tb, on_off );
    get_geometry( obj );
    fl_redraw_object( obj );
}


/***************************************
 * Sets the callback for the horizontal scrollbar of the browser
 ***************************************/

void
fl_set_browser_hscroll_callback( FL_OBJECT                  * ob,
                                 FL_BROWSER_SCROLL_CALLBACK   cb,
                                 void                       * data )
{
      FLI_BROWSER_SPEC *comp = ob->spec;

      comp->hcb = cb;
      comp->hcb_data = data;
}


/***************************************
 * Returns the callback for the horizontal scrollbar of the browser
 ***************************************/

FL_BROWSER_SCROLL_CALLBACK
fl_get_browser_hscroll_callback( FL_OBJECT * ob )
{
      return ( ( FLI_BROWSER_SPEC * ) ob->spec )->hcb;
}


/***************************************
 * Sets the callback for the vertical scrollbar of the browser
 ***************************************/

void
fl_set_browser_vscroll_callback( FL_OBJECT                  * ob,
                                 FL_BROWSER_SCROLL_CALLBACK   cb,
                                 void                       * data )
{
      FLI_BROWSER_SPEC *comp = ob->spec;

      comp->vcb = cb;
      comp->vcb_data = data;
}


/***************************************
 * Returns the callback for the vertical scrollbar of the browser
 ***************************************/

FL_BROWSER_SCROLL_CALLBACK
fl_get_browser_vscroll_callback( FL_OBJECT * ob )
{
      return ( ( FLI_BROWSER_SPEC * ) ob->spec )->vcb;
}


/***************************************
 * Meant for the textbox to handle scroll callback properly
 ***************************************/

void
fli_adjust_browser_scrollbar( FL_OBJECT * ob )
{
      FLI_BROWSER_SPEC *comp = ob->spec;

      fl_call_object_callback( comp->hsl );
      fl_call_object_callback( comp->vsl );
}


/***************************************
 * Removes all text from the browser
 ***************************************/

void
fl_clear_browser( FL_OBJECT * ob )
{
    FLI_BROWSER_SPEC *comp = ob->spec;

    fl_freeze_form( ob->form );
    fli_tbox_clear( comp->tb );
    fl_set_scrollbar_value( comp->hsl, 0.0 );
    fl_set_scrollbar_size( comp->hsl, 1.0 );
    fl_set_scrollbar_value( comp->vsl, 0.0 );
    fl_set_scrollbar_size( comp->vsl, 1.0 );
    redraw_scrollbar( ob );
    fl_unfreeze_form( ob->form );
}


/***************************************
 * Returns the x-offset of the text shown in the browser as
 * the number of pixels
 ***************************************/

FL_Coord
fl_get_browser_xoffset( FL_OBJECT * obj )
{
    FLI_BROWSER_SPEC *sp = obj->spec;

    return fli_tbox_get_xoffset( sp->tb );
}


/***************************************
 * Returns the x-offset of the text shown in the browser as a
 * number between 0 (starts of lines are shown) and 1 (end of
 * longest line is shown)
 ***************************************/

double
fl_get_browser_rel_xoffset( FL_OBJECT * obj )
{
    FLI_BROWSER_SPEC *sp = obj->spec;

    return fli_tbox_get_rel_xoffset( sp->tb );
}


/***************************************
 * Sets the x-offset of the text shown in the browser as given
 * by the number of pixels
 ***************************************/

void
fl_set_browser_xoffset( FL_OBJECT * ob,
                        FL_Coord    npixels )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_set_xoffset( sp->tb, npixels );
    redraw_scrollbar( ob );
}


/***************************************
 * Sets the x-offset of the text shown in the browser as given
 * by a value between 0 (show start of lines) and 1 (show end
 * of longest line)
 ***************************************/

void
fl_set_browser_rel_xoffset( FL_OBJECT * ob,
                            double      val )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_set_rel_xoffset( sp->tb, val );
    redraw_scrollbar( ob );
}


/***************************************
 * Returns the y-offset of the text shown in the browser as
 * the number of pixels
 ***************************************/

FL_Coord
fl_get_browser_yoffset( FL_OBJECT * obj )
{
    FLI_BROWSER_SPEC *sp = obj->spec;

    return fli_tbox_get_yoffset( sp->tb );
}


/***************************************
 * Returns the y-offset of the text shown in the browser as a
 * number between 0 (start of text is shown) and 1 (end of
 * text is shown)
 ***************************************/

double
fl_get_browser_rel_yoffset( FL_OBJECT * obj )
{
    FLI_BROWSER_SPEC *sp = obj->spec;

    return fli_tbox_get_rel_yoffset( sp->tb );
}


/***************************************
 * Sets the y-offset of the text shown in the browser as given
 * by the number of pixels
 ***************************************/

void
fl_set_browser_yoffset( FL_OBJECT * ob,
                        FL_Coord    npixels )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_set_yoffset( sp->tb, npixels );
    redraw_scrollbar( ob );
}


/***************************************
 * Sets the y-offset of the text shown in the browser as given
 * by a value between 0 (show start of text) and 1 (show end of
 * text)
 ***************************************/

void
fl_set_browser_rel_yoffset( FL_OBJECT * ob,
                            double      val )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_set_rel_yoffset( sp->tb, val );
    redraw_scrollbar( ob );
}


/***************************************
 * Returns the y-offset for a line (or -1 if the line does not exist).
 ***************************************/

int
fl_get_browser_line_yoffset( FL_OBJECT * obj,
                             int         line )
{
    FLI_BROWSER_SPEC *sp = obj->spec;

    return fli_tbox_get_line_yoffset( sp->tb, line + 1 );
}


/***************************************
 * Move a line to the top of the browser
 ***************************************/

void
fl_set_browser_topline( FL_OBJECT * ob,
                        int         line )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_set_topline( sp->tb, line - 1 );
    redraw_scrollbar( ob );
}


/***************************************
 * Move a line to the bottom of the browser
 ***************************************/

void
fl_set_browser_bottomline( FL_OBJECT * ob,
                           int         line )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_set_bottomline( sp->tb, line - 1 );
    redraw_scrollbar( ob );
}


/***************************************
 * Marks a line of the browser as selected
 ***************************************/

void
fl_select_browser_line( FL_OBJECT * ob,
                        int         line )
{
    fli_tbox_select_line( ( ( FLI_BROWSER_SPEC * ) ob->spec )->tb, line - 1 );
}


/***************************************
 * Adds a line (given by a forma string and the appropriate number of
 * argumens) to the (end of the) browser and shifts the displayed
 * area so that the line is visible
 ***************************************/

void
fl_addto_browser( FL_OBJECT  * obj,
                  const char * text )
{
    fli_tbox_add_line( ( ( FLI_BROWSER_SPEC * ) obj->spec )->tb, text, 1 );
    redraw_scrollbar( obj );
}


/***************************************
 * Adds a line (specified using a format string and an unspecified number
 * of further arguments) to the (end of the) browser and shifts the
 * displayed area so that the line is visible
 ***************************************/

void
fl_addto_browser_f( FL_OBJECT  * obj,
                    const char * fmt,
                    ...)
{
    char *buf;

    EXPAND_FORMAT_STRING( buf, fmt );
    fl_addto_browser( obj, buf );
    fl_free( buf );
}


/***************************************
 * Inserts a line into the browser before the line currently
 * having the number 'linenumb'
 ***************************************/

void
fl_insert_browser_line( FL_OBJECT  * ob,
                        int          linenumb,
                        const char * newtext )
{
    FLI_BROWSER_SPEC *sp = ob->spec;
    FLI_TBOX_SPEC *tbsp = sp->tb->spec;

    /* When inserting into an empty browser or appending at the end
       it's treated exactly the same way as for fl_add_browser_line()
       (including interpretation of newline characters). */

    if ( tbsp->num_lines == 0 || linenumb > tbsp->num_lines )
        fli_tbox_insert_lines( sp->tb, linenumb - 1, newtext );
    else
        fli_tbox_insert_line( sp->tb, linenumb - 1, newtext );

    redraw_scrollbar( ob );
}


/***************************************
 * Inserts a line (given by a format string and the aprropriate number
 * of arguments) into the browser before the line currently having the
 * number 'linenumb'
 ***************************************/

void
fl_insert_browser_line_f( FL_OBJECT  * ob,
                          int          linenumb,
                          const char * fmt,
                          ... )
{
    char *buf;

    EXPAND_FORMAT_STRING( buf, fmt );
    fl_insert_browser_line( ob, linenumb, buf );
    fl_free( buf );
}


/***************************************
 * Deletes the line at line number 'linenumb' from the browser
 ***************************************/

void
fl_delete_browser_line( FL_OBJECT * ob,
                        int         linenumb )
{
    fli_tbox_delete_line( ( ( FLI_BROWSER_SPEC * ) ob->spec )->tb,
                          linenumb - 1 );
    redraw_scrollbar( ob );
}


/***************************************
 * Replaces the browser line at line number 'linenumb' with a new one
 ***************************************/

void
fl_replace_browser_line( FL_OBJECT  * ob,
                         int          linenumb,
                         const char * newtext )
{
    fli_tbox_replace_line( ( ( FLI_BROWSER_SPEC * ) ob->spec )->tb,
                           linenumb - 1, newtext );
    redraw_scrollbar( ob );
}


/***************************************
 * Replaces the browser line at line number 'linenumb' with a new one
 * derived from the format string and the following arguments.
 ***************************************/

void
fl_replace_browser_line_f( FL_OBJECT  * ob,
                           int          linenumb,
                           const char * fmt,
                           ... )
{
    char *buf;

    EXPAND_FORMAT_STRING( buf, fmt );
    fl_replace_browser_line( ob, linenumb, buf );
    fl_free( buf );
}


/***************************************
 * Returns the text of the browser's line at line number 'linenum'.
 * Returned text may not be modified (and not free'ed!)
 ***************************************/

const char *
fl_get_browser_line( FL_OBJECT * ob,
                     int         linenumb )
{
    return fli_tbox_get_line( ( ( FLI_BROWSER_SPEC * ) ob->spec )->tb,
                              linenumb - 1 );
}


/***************************************
 * Returns the number of the last line of the browser
 ***************************************/

int
fl_get_browser_maxline( FL_OBJECT * obj )
{
    FLI_BROWSER_SPEC *sp = obj->spec;

    return fli_tbox_get_num_lines( sp->tb );
}


/***************************************
 * Unselects a line in the browser
 ***************************************/

void
fl_deselect_browser_line( FL_OBJECT * ob,
                          int         line )
{
    fli_tbox_deselect_line( ( ( FLI_BROWSER_SPEC * ) ob->spec )->tb, line - 1 );
}


/***************************************
 * De-selects all lines of the browser
 ***************************************/

void
fl_deselect_browser( FL_OBJECT * ob )
{
    fli_tbox_deselect( ( ( FLI_BROWSER_SPEC * ) ob->spec )->tb );
}


/***************************************
 * Tests if a certain line of the browser is selected
 ***************************************/

int
fl_isselected_browser_line( FL_OBJECT * ob,
                            int         line )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    return fli_tbox_is_line_selected( sp->tb, line - 1 );
}


/***************************************
 * Returns the line last selected (or deselected) by the user
 ***************************************/

int
fl_get_browser( FL_OBJECT * ob )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    return fli_tbox_get_selection( sp->tb );
}


/***************************************
 * Sets the font size to be used per default
 ***************************************/

void
fl_set_browser_fontsize( FL_OBJECT * ob,
                         int         size )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_set_fontsize( sp->tb, size );
    redraw_scrollbar( ob );
    fl_redraw_object( ob );
}


/***************************************
 * Sets the font style to be used per default
 ***************************************/

void
fl_set_browser_fontstyle( FL_OBJECT * ob,
                          int         style )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_set_fontstyle( sp->tb, style );
    redraw_scrollbar( ob );
    fl_redraw_object( ob );
}


/***************************************
 * Returns the number of the topmost line that is completely visible,
 * may return 0 if there are no lines in the browser
 ***************************************/

int
fl_get_browser_topline( FL_OBJECT * obj )
{
    FLI_BROWSER_SPEC *sp = obj->spec;

    return fli_tbox_get_topline( sp->tb ) + 1;
}


/***************************************
 * Loads a browser with text from a file
 ***************************************/

int
fl_load_browser( FL_OBJECT  * obj,
                 const char * f )
{
    FLI_BROWSER_SPEC *sp = obj->spec;
    int status;

    fl_clear_browser( obj );
    status = fli_tbox_load( sp->tb, f );
    redraw_scrollbar( obj );
    return status;
}


/***************************************
 * Adds a line to the (end of the) browser (does not make the line
 * visible)
 ***************************************/

void
fl_add_browser_line( FL_OBJECT  * ob,
                     const char * newtext )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_add_line( sp->tb, newtext, 0 );
    redraw_scrollbar( ob );
}


/***************************************
 * Adds a line to the (end of the) browser (does not make the line
 * visible)
 ***************************************/

void
fl_add_browser_line_f( FL_OBJECT  * ob,
                       const char * fmt,
                       ... )
{
    char *buf;

    EXPAND_FORMAT_STRING( buf, fmt );
    fl_add_browser_line( ob,buf );
    fl_free( buf );
}


/***************************************
 * Sets a callback for double clicks in the browser
 ***************************************/

void
fl_set_browser_dblclick_callback( FL_OBJECT      * ob,
                                  FL_CALLBACKPTR   cb,
                                  long             a )
{
    FLI_BROWSER_SPEC *comp = ob->spec;

    comp->callback = cb;
    comp->callback_data = a;
}


/***************************************
 * Sets the height of the vertical and the width of the horzontal
 * scrollbar
 ***************************************/

void
fl_set_browser_scrollbarsize( FL_OBJECT * ob,
                              int         hh,
                              int         vw )
{
    FLI_BROWSER_SPEC *comp = ob->spec;
    int redraw = 0;

    if ( hh > 0 && hh != comp->hsl->h )
    {
        comp->hsl->h = comp->hh_def = hh;
        redraw = 1;
    }

    if ( vw > 0 && vw != comp->vsl->w )
    {
        comp->vsl->w = comp->vw_def = vw;
        redraw = 1;
    }

    if ( redraw )
    {
        comp->user_set = 1;
        fl_redraw_object( ob );
        fl_redraw_object( comp->tb );
        fl_redraw_object( comp->hsl );
        fl_redraw_object( comp->vsl );
    }
}


/***************************************
 * Returns the position and width and height of the browsers text area
 ***************************************/

void
fl_get_browser_dimension( FL_OBJECT * obj,
                          FL_Coord  * x,
                          FL_Coord  * y,
                          FL_Coord  * w,
                          FL_Coord  * h )
{
    FLI_TBOX_SPEC *sp = ( ( FLI_BROWSER_SPEC * ) obj->spec )->tb->spec;

    *x = obj->x + sp->x;
    *y = obj->y + sp->y;
    *w = sp->w;
    *h = sp->h;
}


/***************************************
 * Makes a browser line selectable or unselectable
 ***************************************/

void
fl_set_browser_line_selectable( FL_OBJECT * ob,
                                int         line,
                                int         flag )
{
    fli_tbox_make_line_selectable( ob, line - 1, flag );
}


/***************************************
 * Appends characters to the end of the last line in the browser
 ***************************************/

void
fl_addto_browser_chars( FL_OBJECT  * ob,
                        const char * str )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    fli_tbox_add_chars( sp->tb, str );
    redraw_scrollbar( ob );
}


/***************************************
 * Appends characters to the end of the last line in the browser
 ***************************************/

void
fl_addto_browser_chars_f( FL_OBJECT  * ob,
                          const char * fmt,
                          ... )
{
    char *buf;

    EXPAND_FORMAT_STRING( buf, fmt );
    fl_addto_browser_chars_f( ob, buf );
    fl_free( buf );
}


/***************************************
 * Returns an approximation of the number of lines shown in the browser
 ***************************************/

int
fl_get_browser_screenlines( FL_OBJECT * ob )
{
    FLI_BROWSER_SPEC *sp = ob->spec;

    int t = fli_tbox_get_topline( sp->tb );
    int b = fli_tbox_get_bottomline( sp->tb );

    if ( t < 0 || b < 0 )
        return 0;
    return b - t + 1;
}


/***************************************
 * Sets the escape key used in the text
 ***************************************/

void
fl_set_browser_specialkey( FL_OBJECT * ob,
                           int         specialkey )
{
    FLI_TBOX_SPEC *sp = ( ( FLI_BROWSER_SPEC * ) ob->spec )->tb->spec;

    sp->specialkey = specialkey;
}


/***************************************
 * Brings a line into view
 ***************************************/

void
fl_show_browser_line( FL_OBJECT * ob,
                      int         line )
{
    fli_tbox_set_centerline( ( ( FLI_BROWSER_SPEC * ) ob->spec )->tb, line );
    redraw_scrollbar( ob );
}


/***************************************
 * Deprecated function, only left in for backward compatibility
 ***************************************/

int
fl_set_default_browser_maxlinelength( int n  FL_UNUSED_ARG )
{
    return 0;
}


/***************************************
 ***************************************/

int
fl_get_browser_scrollbar_repeat( FL_OBJECT * ob )
{
    return fl_get_slider_repeat( ( ( FLI_BROWSER_SPEC * ) ob->spec )->vsl );
}


/***************************************
 ***************************************/

void
fl_set_browser_scrollbar_repeat( FL_OBJECT * ob,
                                 int         millisec )
{
    if ( millisec > 0 )
    {
        fl_set_slider_repeat( ( ( FLI_BROWSER_SPEC * ) ob->spec )->vsl,
                              millisec );
        fl_set_slider_repeat( ( ( FLI_BROWSER_SPEC * ) ob->spec )->hsl,
                              millisec );
    }
}


/*
 * Local variables:
 * tab-width: 4
 * indent-tabs-mode: nil
 * End:
 */
