mcclim-cvs

mcclim-cvs@common-lisp.net

1697 discussions

[mcclim-cvs] CVS mcclim/Doc
by rstrandh 30 Oct '06

30 Oct '06

Update of /project/mcclim/cvsroot/mcclim/Doc In directory clnet:/tmp/cvs-serv27169 Modified Files: manual.tex Log Message: Section on how CLIM is different from traditional GUI toolkits. --- /project/mcclim/cvsroot/mcclim/Doc/manual.tex 2006/10/30 06:26:53 1.32 +++ /project/mcclim/cvsroot/mcclim/Doc/manual.tex 2006/10/30 08:21:01 1.33 @@ -95,6 +95,78 @@ and not well described. It will be noted here when they are partially implemented in McCLIM or not implemented at all. +\section{How CLIM is different} + +Many new users of CLIM have a hard time trying to understand how it +works and how to use it. A large part of the problem is that many +such users are used to more traditional GUI toolkits, and they try to +fit CLIM into their mental model of how GUI toolkits should work. + +But CLIM is much more than just a GUI toolkit, as suggested by its +name, it is an \emph{interface manager}, i.e. it is a complete +mediator between application ``business logic'' and the way the user +interacts with objects of the application. In fact, CLIM doesn't have +to be used with graphics output at all, as it contains a large +collection of functionality to manage text. + +Traditional GUI toolkits have an \emph{event loop}. Events are +delivered to GUI elements called \emph{gadgets} (or \emph{widgets}), +and the programmer attaches \emph{event handlers} to those gadgets in +order to invoke the functionality of the application logic. While +this way of structuring code is sometimes presented as a virtue +(``Event-driven programming''), it has an unfortunate side effect, +namely that event handlers are executed in a null context, so that it +becomes hard to even remember two consecutive events. The effect of +event-driven programming is that applications written that way have +very rudimentary interaction policies. + +At the lowest level, CLIM also has an event loop, but most application +programmers never have any reason to program at that level with CLIM. +Instead, CLIM has a \emph{command loop} at a much higher level than +the event loop. At each iteration of the command loop: + +\begin{itemize} +\item A command is acquired. You might satisfy this demand by + clicking on a menu item, by typing the name of a command, by hitting + some kind of keystroke, by pressing a button, or by pressing some + visible object with a command associated with it; +\item Arguments that are required by the command are acquired. Each + argument is often associated with a \emph{presentation type}, and + visible objects of the right presentation type can be clicked on + to satisfy this demand. You can also type a textual + representation of the argument, using completion, or you can use a + context menu; +\item The command is called on the arguments, usually resulting in + some significant modification of the data structure representing + your application logic; +\item A \emph{display routine} is called to update the views of the + application logic. The display routine may use features such as + incremental redisplay. +\end{itemize} + +Instead of attaching event handlers to gadgets, writing a CLIM +application therefore consists of: + +\begin{itemize} +\item writing CLIM commands that modify the application data + structures independently of how those commands are invoked, and + which may take application objects as arguments; +\item writing display routines that turn the application data + structures (and possibly some "view" object) into a collection of + visible representations (having presentation types) of application + objects; +\item writing completion routines that allow you to type in + application objects (of a certain presentation type) using + completions; +\item independently deciding how commands are to be invoked (menus, + buttons, presentations, textual commands, etc). +\end{itemize} + +By using CLIM as a mediator of command invocation and argument +acquisition, you can obtain some very modular code. Application logic +is completely separate from interaction policies, and the two can +evolve separately and independently. + \part{Getting Started} \chapter{CLIM Demos and Applications}

1 0

[mcclim-cvs] CVS mcclim/Doc
by rstrandh 30 Oct '06

30 Oct '06

Update of /project/mcclim/cvsroot/mcclim/Doc In directory clnet:/tmp/cvs-serv12406 Modified Files: manual.tex Added Files: views.lisp Log Message: Added a new part (User manual) to the manual, and a first chapter (Using views) to that part. --- /project/mcclim/cvsroot/mcclim/Doc/manual.tex 2005/08/22 02:49:05 1.31 +++ /project/mcclim/cvsroot/mcclim/Doc/manual.tex 2006/10/30 06:26:53 1.32 @@ -607,6 +607,78 @@ What is finally displayed (in the interactor pane, which is the standard input of the frame), is ``the 15 of The third month''. +\part{User Manual} + +\chapter{Using views} + +The CLIM specification mentions a concept called a \emph{view}, and +also lists a number of predefined views to be used in various +different contexts. + +In this chapter we show how the \emph{view} concept can be used in +some concrete programming examples. In particular, we show how to use +a single pane to show different views of the application data +structure at different times. To switch between the different views, +we supply a set of commands that alter the +\texttt{stream-default-view} feature of all CLIM extended output +streams. + +The example shown here has been stripped to a bare minimum in order to +illustrate the important concepts. A more complete version can be +found in \texttt{Examples/views.lisp} in the McCLIM source tree. + +Here is the example: + +\verbatimtabinput{views.lisp} + +The example shows a stripped-down example of a simple database of +members of some organization. + +The main trick used in this example is the \texttt{display-main-pane} +function that is declared to be the display function of the main pane +in the application frame. The \texttt{display-main-pane} function +trampolines to a generic function called +\texttt{display-pane-with-view}, and which takes an additional +argument compared to the display functions of CLIM panes. This +additional argument is of type \texttt{view} which allows us to +dispatch not only on the type of frame and the type of pane, but also +on the type of the current default view. In this example the view +argument is simply taken from the default view of the pane. + +A possibility that is not obvious from reading the CLIM specification +is to have views that contain additional slots. Our example defines +two subclasses of the CLIM \texttt{view} class, namely +\texttt{members-view} and \texttt{person-view}. + +The first one of these does not contain any additional slots, and is +used when a global view of the members of our organization is wanted. +Since no instance-specific data is required in this view, we follow +the idea of the examples of the CLIM specification to instantiate a +singleton of this class and store that singleton in the +\texttt{stream-default-view} of our main pane whenever a global view +of our organization is required. + +The \texttt{person-view} class, on the other hand, is used when we +want a closer view of a single member of the organization. This class +therefore contains an additional slot which holds the particular +person instance we are interested in. The method on +\texttt{display-pane-with-view} that specializes on +\texttt{person-view} displays the data of the particular person that +is contained in the view. + +To switch between the views, we provide two commands. The command +\texttt{com-show-all} simply changes the default view of the main pane +to be the singleton instance of the \texttt{members-view} class. The +command \texttt{com-show-person} is more complicated. It takes an +argument of type person, creates an instance of the +\texttt{person-view} class initialized with the person that was passed +as an argument, and stores the instance as the default view of the +main pane. + +\chapter{Using command tables} + +(to be filled in) + \part{Reference Manual} \chapter{Concepts} --- /project/mcclim/cvsroot/mcclim/Doc/views.lisp 2006/10/30 06:26:53 NONE +++ /project/mcclim/cvsroot/mcclim/Doc/views.lisp 2006/10/30 06:26:53 1.1 ;;; part of application "business logic" (defclass person () ((%last-name :initarg :last-name :accessor last-name) (%first-name :initarg :first-name :accessor first-name) (%address :initarg :address :accessor address) (%membership-number :initarg :membership-number :reader membership-number))) ;;; constructor for the PERSON class. Not strictly necessary. (defun make-person (last-name first-name address membership-number) (make-instance 'person :last-name last-name :first-name first-name :address address :membership-number membership-number)) ;;; initial list of members of the organization we imagine for this example (defparameter *members* (list (make-person "Doe" "Jane" "123, Glencoe Terrace" 12345) (make-person "Dupont" "Jean" "111, Rue de la Republique" 54321) (make-person "Smith" "Eliza" "22, Trafalgar Square" 121212) (make-person "Nilsson" "Sven" "Uppsalagatan 33" 98765))) ;;; the CLIM view class that corresponds to a list of members, one member ;;; per line of text in a CLIM application pane. (defclass members-view (view) ()) ;;; since this view does not take any parameters in our simple example, ;;; we need only a single instance of it. (defparameter *members-view* (make-instance 'members-view)) ;;; the application frame. It contains instance-specific data ;;; such as the members of our organization. (define-application-frame views () ((%members :initform *members* :accessor members)) (:panes (main-pane :application :height 500 :width 500 :display-function 'display-main-pane ;; notice the initialization of the default view of ;; the application pane. :default-view *members-view*) (interactor :interactor :height 100 :width 500)) (:layouts (default (vertically () main-pane interactor)))) ;;; the trick here is to define a generic display function ;;; that is called on the frame, the pane AND the view, ;;; whereas the standard CLIM display functions are called ;;; only on the frame and the pane. (defgeneric display-pane-with-view (frame pane view)) ;;; this is the display function that is called in each iteration ;;; of the CLIM command loop. We simply call our own, more elaborate ;;; display function with the default view of the pane. (defun display-main-pane (frame pane) (display-pane-with-view frame pane (stream-default-view pane))) ;;; now we can start writing methods on our own display function ;;; for different views. This one displays the data each member ;;; on a line of its own. (defmethod display-pane-with-view (frame pane (view members-view)) (loop for member in (members frame) do (with-output-as-presentation (pane member 'person) (format pane "~a, ~a, ~a, ~a~%" (membership-number member) (last-name member) (first-name member) (address member))))) ;;; this CLIM view is used to display the information about ;;; a single person. It has a slot that indicates what person ;;; we want to view. (defclass person-view (view) ((%person :initarg :person :reader person))) ;;; this method on our own display function shows the detailed ;;; information of a single member. (defmethod display-pane-with-view (frame pane (view person-view)) (let ((person (person view))) (format pane "Last name: ~a~%First Name: ~a~%Address: ~a~%Membership Number: ~a~%" (last-name person) (first-name person) (address person) (membership-number person)))) ;;; entry point to start our applciation (defun views-example () (run-frame-top-level (make-application-frame 'views))) ;;; command to quit the application (define-views-command (com-quit :name t) () (frame-exit *application-frame*)) ;;; command to switch the default view of the application pane ;;; (which is the value of *standard-output*) to the one that ;;; shows a member per line. (define-views-command (com-show-all :name t) () (setf (stream-default-view *standard-output*) *members-view*)) ;;; command to switch to a view that displays a single member. ;;; this command takes as an argument the person to display. ;;; In this application, the only way to satisfy the demand for ;;; the argument is to click on a line of the members view. In ;;; more elaborate application, you might be able to type a ;;; textual representation (using completion) of the person. (define-views-command (com-show-person :name t) ((person 'person)) (setf (stream-default-view *standard-output*) (make-instance 'person-view :person person)))

1 0

[mcclim-cvs] CVS mcclim/Examples
by thenriksen 29 Oct '06

29 Oct '06

Update of /project/mcclim/cvsroot/mcclim/Examples In directory clnet:/tmp/cvs-serv3353/Examples Modified Files: views.lisp Log Message: Added a present and accept method so the parameters to command won't look quite as ugly. --- /project/mcclim/cvsroot/mcclim/Examples/views.lisp 2006/10/29 15:27:31 1.1 +++ /project/mcclim/cvsroot/mcclim/Examples/views.lisp 2006/10/29 23:13:48 1.2 @@ -50,6 +50,31 @@ (make-person "Smith" "Eliza" "22, Trafalgar Square" 121212) (make-person "Nilsson" "Sven" "Uppsalagatan 33" 98765))) +;;; we define a present method that is called when CLIM is told to +;;; display a person object to the user. +(define-presentation-method present ((object person) (type person) + stream view &key) + (declare (ignore view)) + (format stream "~A ~A" (first-name object) (last-name object))) + +;; we also define an accept method that CLIM uses to convert text +;; input to a person. Note that the text generated by the present +;; method is acceptable input for the accept method. +(define-presentation-method accept ((type person) stream view &key) + ;; this means we can have spaces in the input. + (with-delimiter-gestures (nil :override t) + ;; we just ask for a string and complain if it isn't a known + ;; name. We also do not want to show another input prompt, hence + ;; the :prompt and :prompt-mode parameters. + (let ((name (accept 'string :stream stream :view view + :prompt "" :prompt-mode :raw))) + (or (find name *members* + :test #'string= + :key #'(lambda (person) + (format nil "~A ~A" (first-name person) + (last-name person)))) + (simple-parse-error "~A is not a known person" name))))) + ;;; the CLIM view class that corresponds to a list of members, one member ;;; per line of text in a CLIM application pane. (defclass members-view (view) ())

1 0

[mcclim-cvs] CVS mcclim/Examples
by rstrandh 29 Oct '06

29 Oct '06

Update of /project/mcclim/cvsroot/mcclim/Examples In directory clnet:/tmp/cvs-serv17986 Added Files: views.lisp Log Message: An example showing the use of CLIM views. --- /project/mcclim/cvsroot/mcclim/Examples/views.lisp 2006/10/29 15:27:31 NONE +++ /project/mcclim/cvsroot/mcclim/Examples/views.lisp 2006/10/29 15:27:31 1.1 ;;; ;;; This example shows how to use CLIM view objects. We imagine a small ;;; database of members in some organization, and we sometimes want to ;;; see a list of all the members, with one member per line, and sometimes ;;; a detailed view of a single member, perhaps in order to check the ;;; payment record, or to modify some information such as the address. ;;; Copyright (c) 2006 by Robert Strandh ;;; This library is free software; you can redistribute it and/or ;;; modify it under the terms of the GNU Library General Public ;;; License as published by the Free Software Foundation; either ;;; version 2 of the License, or (at your option) any later version. ;;; ;;; This library 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 ;;; Library General Public License for more details. ;;; ;;; You should have received a copy of the GNU Library General Public ;;; License along with this library; if not, write to the ;;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, ;;; Boston, MA 02111-1307 USA. (defpackage :views-example (:use :clim-lisp :clim) (:export #:views-example)) (in-package :views-example) ;;; part of application "business logic" (defclass person () ((%last-name :initarg :last-name :accessor last-name) (%first-name :initarg :first-name :accessor first-name) (%address :initarg :address :accessor address) (%membership-number :initarg :membership-number :reader membership-number))) ;;; constructor for the PERSON class. Not strictly necessary. (defun make-person (last-name first-name address membership-number) (make-instance 'person :last-name last-name :first-name first-name :address address :membership-number membership-number)) ;;; initial list of members of the organization we imagine for this example (defparameter *members* (list (make-person "Doe" "Jane" "123, Glencoe Terrace" 12345) (make-person "Dupont" "Jean" "111, Rue de la Republique" 54321) (make-person "Smith" "Eliza" "22, Trafalgar Square" 121212) (make-person "Nilsson" "Sven" "Uppsalagatan 33" 98765))) ;;; the CLIM view class that corresponds to a list of members, one member ;;; per line of text in a CLIM application pane. (defclass members-view (view) ()) ;;; since this view does not take any parameters in our simple example, ;;; we need only a single instance of it. (defparameter *members-view* (make-instance 'members-view)) ;;; the application frame. It contains instance-specific data ;;; such as the members of our organization. (define-application-frame views () ((%members :initform *members* :accessor members)) (:panes (main-pane :application :height 500 :width 500 :display-function 'display-main-pane ;; notice the initialization of the default view of ;; the application pane. :default-view *members-view*) (interactor :interactor :height 100 :width 500)) (:layouts (default (vertically () main-pane interactor)))) ;;; the trick here is to define a generic display function ;;; that is called on the frame, the pane AND the view, ;;; whereas the standard CLIM display functions are called ;;; only on the frame and the pane. (defgeneric display-pane-with-view (frame pane view)) ;;; this is the display function that is called in each iteration ;;; of the CLIM command loop. We simply call our own, more elaborate ;;; display function with the default view of the pane. (defun display-main-pane (frame pane) (display-pane-with-view frame pane (stream-default-view pane))) ;;; now we can start writing methods on our own display function ;;; for different views. This one displays the data each member ;;; on a line of its own. (defmethod display-pane-with-view (frame pane (view members-view)) (loop for member in (members frame) do (with-output-as-presentation (pane member 'person) (format pane "~a, ~a, ~a, ~a~%" (membership-number member) (last-name member) (first-name member) (address member))))) ;;; this CLIM view is used to display the information about ;;; a single person. It has a slot that indicates what person ;;; we want to view. (defclass person-view (view) ((%person :initarg :person :reader person))) ;;; this method on our own display function shows the detailed ;;; information of a single member. (defmethod display-pane-with-view (frame pane (view person-view)) (let ((person (person view))) (format pane "Last name: ~a~%First Name: ~a~%Address: ~a~%Membership Number: ~a~%" (last-name person) (first-name person) (address person) (membership-number person)))) ;;; entry point to start our applciation (defun views-example () (run-frame-top-level (make-application-frame 'views))) ;;; command to quit the application (define-views-command (com-quit :name t) () (frame-exit *application-frame*)) ;;; command to switch the default view of the application pane ;;; (which is the value of *standard-output*) to the one that ;;; shows a member per line. (define-views-command (com-show-all :name t) () (setf (stream-default-view *standard-output*) *members-view*)) ;;; command to switch to a view that displays a single member. ;;; this command takes as an argument the person to display. ;;; In this application, the only way to satisfy the demand for ;;; the argument is to click on a line of the members view. In ;;; more elaborate application, you might be able to type a ;;; textual representation (using completion) of the person. (define-views-command (com-show-person :name t) ((person 'person)) (setf (stream-default-view *standard-output*) (make-instance 'person-view :person person)))

1 0

[mcclim-cvs] CVS mcclim
by crhodes 29 Oct '06

29 Oct '06

Update of /project/mcclim/cvsroot/mcclim In directory clnet:/tmp/cvs-serv21147 Modified Files: protocol-classes.lisp Log Message: Whitespace change --- /project/mcclim/cvsroot/mcclim/protocol-classes.lisp 2006/05/05 10:24:02 1.3 +++ /project/mcclim/cvsroot/mcclim/protocol-classes.lisp 2006/10/29 12:56:13 1.4 @@ -180,7 +180,7 @@ ()) ;;; 28.2 Application Frames -(define-protocol-class application-frame () +(define-protocol-class application-frame () ()) ;;; 28.5 Frame Managers

1 0

[mcclim-cvs] CVS mcclim
by thenriksen 29 Oct '06

29 Oct '06

Update of /project/mcclim/cvsroot/mcclim In directory clnet:/tmp/cvs-serv10070 Modified Files: utils.lisp Log Message: Added working `with-system-redefinition-allowed' for CLISP. --- /project/mcclim/cvsroot/mcclim/utils.lisp 2006/03/15 22:56:54 1.45 +++ /project/mcclim/cvsroot/mcclim/utils.lisp 2006/10/29 11:58:58 1.46 @@ -41,6 +41,11 @@ (eval-when (:compile-toplevel :load-toplevel :execute) (setf (excl:package-definition-lock (find-package :common-lisp)) t)))) +#+clisp +(defmacro with-system-redefinition-allowed (&body body) + `(ext:without-package-lock ("COMMON-LISP") + ,@body)) + #+openmcl (defmacro with-system-redefinition-allowed (&body body) `(progn @@ -90,7 +95,7 @@ `(progn ,@body)) -#-(or excl openmcl cmu sbcl) +#-(or excl openmcl cmu sbcl clisp) (defmacro with-system-redefinition-allowed (&body body) `(progn ,@body))

1 0

[mcclim-cvs] CVS mcclim
by afuchs 29 Oct '06

29 Oct '06

Update of /project/mcclim/cvsroot/mcclim In directory clnet:/tmp/cvs-serv19674 Modified Files: mcclim.asd Log Message: Get rid of the silly code deletion note in mcclim.asd (finally!) --- /project/mcclim/cvsroot/mcclim/mcclim.asd 2006/10/29 08:29:46 1.25 +++ /project/mcclim/cvsroot/mcclim/mcclim.asd 2006/10/29 08:31:06 1.26 @@ -100,14 +100,15 @@ (:module "Lisp-Dep" :depends-on ("decls") :components - ((:file #.(or - #+(and :cmu :mp (not :pthread)) "mp-cmu" - #+scl "mp-scl" - #+sb-thread "mp-sbcl" - #+excl "mp-acl" - #+openmcl "mp-openmcl" - #+lispworks "mp-lw" - #| fall back |# "mp-nil")))) + ((:file #.(first + (list + #+(and :cmu :mp (not :pthread)) "mp-cmu" + #+scl "mp-scl" + #+sb-thread "mp-sbcl" + #+excl "mp-acl" + #+openmcl "mp-openmcl" + #+lispworks "mp-lw" + #| fall back |# "mp-nil"))))) (:file "utils" :depends-on ("decls" "Lisp-Dep")) (:file "design" :depends-on ("decls" "protocol-classes" "Lisp-Dep" "utils")) (:file "X11-colors" :depends-on ("decls" "protocol-classes" "Lisp-Dep" "design"))

1 0

[mcclim-cvs] CVS mcclim/Backends/CLX
by afuchs 29 Oct '06

29 Oct '06

Update of /project/mcclim/cvsroot/mcclim/Backends/CLX In directory clnet:/tmp/cvs-serv19479/Backends/CLX Modified Files: port.lisp Log Message: Commit 2 of 3 acl fixes by Willem Broekema: * package.lisp depends on patch.lisp (how did I miss this all the time?) * use xlib::*x-tcp-port* --- /project/mcclim/cvsroot/mcclim/Backends/CLX/port.lisp 2006/03/23 08:45:26 1.122 +++ /project/mcclim/cvsroot/mcclim/Backends/CLX/port.lisp 2006/10/29 08:29:46 1.123 @@ -1428,7 +1428,8 @@ :remote-filename (format nil "/tmp/.X11-unix/X~D" display) :format :binary) (socket:make-socket :remote-host (string host) - :remote-port (+ *x-tcp-port* display) + :remote-port (+ xlib::*x-tcp-port* + display) :format :binary)))) (if (streamp stream) stream

1 0

[mcclim-cvs] CVS mcclim
by afuchs 29 Oct '06

29 Oct '06

Update of /project/mcclim/cvsroot/mcclim In directory clnet:/tmp/cvs-serv19479 Modified Files: mcclim.asd Log Message: Commit 2 of 3 acl fixes by Willem Broekema: * package.lisp depends on patch.lisp (how did I miss this all the time?) * use xlib::*x-tcp-port* --- /project/mcclim/cvsroot/mcclim/mcclim.asd 2006/10/28 17:11:30 1.24 +++ /project/mcclim/cvsroot/mcclim/mcclim.asd 2006/10/29 08:29:46 1.25 @@ -91,7 +91,7 @@ #+openmcl "fix-openmcl" #+lispworks "fix-lispworks" #+clisp "fix-clisp"))) - (:file "package" :depends-on ("Lisp-Dep")))) + (:file "package" :depends-on ("Lisp-Dep" "patch")))) (defsystem :clim-core :depends-on (:clim-lisp :spatial-trees)

1 0

[mcclim-cvs] CVS mcclim/Backends/Null
by dlichteblau 29 Oct '06

29 Oct '06

Update of /project/mcclim/cvsroot/mcclim/Backends/Null In directory clnet:/tmp/cvs-serv10722 Modified Files: port.lisp Log Message: removed bogus methods, lest they end up in yet another backend --- /project/mcclim/cvsroot/mcclim/Backends/Null/port.lisp 2006/03/24 11:45:03 1.1 +++ /project/mcclim/cvsroot/mcclim/Backends/Null/port.lisp 2006/10/29 00:21:35 1.2 @@ -69,13 +69,14 @@ (defmethod port-set-sheet-region ((port null-port) (graft graft) region) ()) -(defmethod port-set-sheet-transformation - ((port null-port) (graft graft) transformation) - ()) - -(defmethod port-set-sheet-transformation - ((port null-port) (sheet mirrored-sheet-mixin) transformation) - ()) +;; these don't exist +;;;(defmethod port-set-sheet-transformation +;;; ((port null-port) (graft graft) transformation) +;;; ()) +;;; +;;;(defmethod port-set-sheet-transformation +;;; ((port null-port) (sheet mirrored-sheet-mixin) transformation) +;;; ()) (defmethod port-set-sheet-region ((port null-port) (sheet mirrored-sheet-mixin) region)

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

mcclim-cvs