1/*  Part of XPCE --- The SWI-Prolog GUI toolkit
    2
    3    Author:        Jan Wielemaker and Anjo Anjewierden
    4    E-mail:        jan@swi.psy.uva.nl
    5    WWW:           http://www.swi.psy.uva.nl/projects/xpce/
    6    Copyright (c)  1985-2002, University of Amsterdam
    7    All rights reserved.
    8
    9    Redistribution and use in source and binary forms, with or without
   10    modification, are permitted provided that the following conditions
   11    are met:
   12
   13    1. Redistributions of source code must retain the above copyright
   14       notice, this list of conditions and the following disclaimer.
   15
   16    2. Redistributions in binary form must reproduce the above copyright
   17       notice, this list of conditions and the following disclaimer in
   18       the documentation and/or other materials provided with the
   19       distribution.
   20
   21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   22    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
   24    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
   25    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
   26    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
   27    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   28    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   29    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   30    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
   31    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   32    POSSIBILITY OF SUCH DAMAGE.
   33*/
   34
   35:- module(pce_prompter,
   36          [ prompter/2
   37          ]).   38:- use_module(library(pce)).   39:- use_module(library(pce_report)).   40:- require([ delete/3
   41           , maplist/3
   42           , term_to_atom/2
   43           ]).   44
   45/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   46This module defines a standard prompter-box for PCE applications.  It is
   47invoked with:
   48
   49    prompter(+Tile, +ListOfAttributes)
   50
   51where each attribute is a term of the form
   52
   53   +Label:+Type = -Value[/+Default]
   54
   55Examples:
   56
   57?- prompter('Create class',
   58            [ name:name = Name,
   59              super:name = Super
   60            ]).
   61
   62Last updated:   Wed Sep 13 1995 by Jan Wielemaker
   63                - Added menu/browser for multiple values.
   64                - Added automatic stretching of dialog items on resize
   65                - Improved type and error handling
   66
   67                Thu Aug  1 1996 by Jan Wielemaker
   68                - Fixed passing quoted types such as '0..100'
   69                - Added support for sliders for int- and real-ranges.
   70
   71                Sat May 18 2002 by Jan Wielemaker
   72                - Use report-dialog for messages
   73                - Properly handle clicking away to window
   74                - Make it a transient window
   75
   76NOTE:   Package is under development.  Needs support for more types;
   77        optional/obligatory fields and better error-messages.
   78- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
   79
   80:- pce_global(@prompter, make_promper).   81
   82make_promper(P) :-
   83    new(P, dialog),
   84    send(P, resize_message, message(@prolog, stretch_items, P)),
   85    send(new(report_dialog), below, P),
   86    send(P, done_message, message(P, return, cancel)).
   87
   88prompter(Title, Attributes) :-
   89    maplist(canonicalise_attribute, Attributes, CAtts),
   90    send(@prompter, clear),
   91    maplist(append_prompter(@prompter), CAtts),
   92    send(@prompter, append,
   93         new(Ok, button(ok, message(@prompter, return, ok))), next_row),
   94    send(Ok, default_button, @on),
   95    send(@prompter, append,
   96         button(cancel, message(@prompter, return, cancel))),
   97    get(@prompter, frame, Frame),
   98    send(Frame, label, Title),
   99    send(@prompter, fit),
  100    stretch_items(@prompter),
  101    (   send(@event, instance_of, event)
  102    ->  get(@event, position, @display, Pos),
  103        get(@event?receiver, frame, MainFrame),
  104        send(Frame, transient_for, MainFrame),
  105        send(Frame, modal, transient)
  106    ;   Pos = @default
  107    ),
  108    repeat,
  109        (   get(@prompter, confirm_centered, Pos, OK)
  110        ;   get(@prompter, confirm, OK) % second time
  111        ),
  112        (   OK == ok
  113        ->  maplist(read_prompter(@prompter), CAtts),
  114            !,
  115            send(@prompter, show, @off)
  116        ;   !,
  117            send(@prompter, show, @off),
  118            fail
  119        ).
  120
  121canonicalise_attribute(Label:Type = Value, Label:PceType = Value) :-
  122    pce_type(Type, PceType).
  123
  124pce_type(Type, Type) :-
  125    atom(Type),
  126    !.
  127pce_type(Term, Type) :-
  128    term_to_atom(Term, A0),
  129    atom_codes(A0, S0),
  130    delete(S0, 0' , S1),
  131    atom_codes(Type, S1).
  132
  133
  134                 /*******************************
  135                 *   STRETCH ITEMS TO THE RIGHT *
  136                 *******************************/
  137
  138stretch_items(Dialog) :-
  139    send(Dialog?graphicals, for_all,
  140         message(@prolog, stretch_item, @arg1)).
  141
  142stretchable(text_item).
  143stretchable(list_browser).
  144
  145stretch_item(Item) :-
  146    get(Item, class_name, ClassName),
  147    stretchable(ClassName),
  148    \+ (get(Item, right, RI), RI \== @nil),
  149    !,
  150    get(Item?device?visible, right_side, Right),
  151    get(Item?device?gap, width, W),
  152    R is Right - W,
  153    get(Item, left_side, L),
  154    Width is R - L,
  155    send(Item, do_set, width := Width).
  156stretch_item(_).
  157
  158
  159                /********************************
  160                *      CREATE DIALOG ITEMS      *
  161                ********************************/
  162
  163append_prompter(P, Label:Type = Value) :-
  164    make_dialog_item(Type, Label, DI),
  165    set_default(Value, DI),
  166    send(P, append, DI).
  167
  168                                                  % TBD: specialised types
  169make_dialog_item(Type, Label, DI) :-
  170    get(@pce, convert, Type, type, PceType),
  171    get(PceType, kind, Kind),
  172    dialog_item_from_type_kind(Kind, PceType, Label, DI),
  173    !.
  174make_dialog_item(Type, Label, DI) :-
  175    get(@pce, convert, Type, type, PceType),
  176    get(PceType, value_set, Set),
  177    !,
  178    get(Set, size, Size),
  179    (   Size < 6
  180    ->  new(DI, menu(Label, choice))
  181    ;   new(DI, list_browser(@default, 10, 6)),
  182        send(DI, label, Label),
  183        send(DI, name, Label)
  184    ),
  185    send(Set, for_all, message(DI, append, @arg1)).
  186make_dialog_item(Type, Label, DI) :-
  187    new(DI, text_item(Label, '')),
  188    send(DI, type, Type).
  189
  190
  191dialog_item_from_type_kind(int,   Type, Label, DI) :-
  192    !,
  193    new(DI, int_item(Label)),
  194    send(DI, type, Type).
  195dialog_item_from_type_kind(Range, Type, Label, DI) :-
  196    (   Range == int_range
  197    ;   Range == real_range
  198    ),
  199    !,
  200    get(Type?context, first, Low),
  201    get(Type?context, second, High),
  202    new(DI, slider(Label, Low, High, (Low+High)/2)).
  203
  204
  205                /********************************
  206                *          SET DEFAULTS         *
  207                ********************************/
  208
  209set_default(Value, DI) :-
  210    nonvar(Value),
  211    Value = _RVal/Default,
  212    !,
  213    send(DI, selection, Default).
  214set_default(_, _).
  215
  216                /********************************
  217                *           READ VALUES         *
  218                ********************************/
  219
  220read_prompter(P, Label:Type = Value) :-
  221    get(P, member, Label, DI),
  222    (   get(DI, selection, V0)
  223    ->  canonicalise(DI, V0, V1),
  224        (   get(@pce, convert, V1, Type, Val)
  225        ->  (   nonvar(Value),
  226                Value = RVal/_
  227            ->  RVal = Val
  228            ;   Value = Val
  229            )
  230        ;   send(DI, report, warning, 'Invalid value for %s', Label),
  231            fail
  232        )
  233    ;   send(DI, report, warning, 'No selection for %s', Label),
  234        fail
  235    ).
  236
  237
  238canonicalise(DI, A, B) :-
  239    send(DI, instance_of, text_item),
  240    !,
  241    get(A, strip, B).
  242canonicalise(DI, A, B) :-
  243    send(DI, instance_of, list_browser),
  244    !,
  245    get(A, key, B).
  246canonicalise(_, Val, Val).                                % TBD