xemacs-beta: src/specifier.c comparison

comparison src/specifier.c @ 408:501cfd01ee6d r21-2-34

Import from CVS: tag r21-2-34

author	cvs
date	Mon, 13 Aug 2007 11:18:11 +0200
parents	2f8bb876ab1d
children	de805c49cfc1

comparison

equal deleted inserted replaced

-:ed6218a7d4d3
+:501cfd01ee6d
 DEFUN ("make-specifier", Fmake_specifier, 1, 1, 0, /*
 Return a new specifier object of type TYPE.
 A specifier is an object that can be used to keep track of a property
 whose value can be per-buffer, per-window, per-frame, or per-device,
-and can further be restricted to a particular console-type or device-class.
+and can further be restricted to a particular console-type or
-Specifiers are used, for example, for the various built-in properties of a
+device-class.  Specifiers are used, for example, for the various
-face; this allows a face to have different values in different frames,
+built-in properties of a face; this allows a face to have different
-buffers, etc.  For more information, see `specifier-instance',
+values in different frames, buffers, etc.
+When speaking of the value of a specifier, it is important to
+distinguish between the *setting* of a specifier, called an
+\"instantiator\", and the *actual value*, called an \"instance\".  You
+put various possible instantiators (i.e. settings) into a specifier
+and associate them with particular locales (buffer, window, frame,
+device, global), and then the instance (i.e. actual value) is
+retrieved in a specific domain (window, frame, device) by looking
+through the possible instantiators (i.e. settings).  This process is
+called \"instantiation\".
+To put settings into a specifier, use `set-specifier', or the
+lower-level functions `add-spec-to-specifier' and
+`add-spec-list-to-specifier'.  You can also temporarily bind a setting
+to a specifier using `let-specifier'.  To retrieve settings, use
+`specifier-specs', or its lower-level counterpart
+`specifier-spec-list'.  To determine the actual value, use
+`specifier-instance'.
+For more information, see `set-specifier', `specifier-instance',
 `specifier-specs', and `add-spec-to-specifier'; or, for a detailed
-description of specifiers, including how they are instantiated over a
+description of specifiers, including how exactly the instantiation
-particular domain (i.e. how their value in that domain is determined),
+process works, see the chapter on specifiers in the XEmacs Lisp
-see the chapter on specifiers in the XEmacs Lisp Reference Manual.
+Reference Manual.
 TYPE specifies the particular type of specifier, and should be one of
-the symbols 'generic, 'integer, 'boolean, 'color, 'font, 'image,
+the symbols 'generic, 'integer, 'natnum, 'boolean, 'color, 'font,
-'face-boolean, 'gutter, 'gutter-size, 'gutter-visible or 'toolbar.
+'image, 'face-boolean, 'display-table, 'gutter, 'gutter-size,
+'gutter-visible or 'toolbar.
 For more information on particular types of specifiers, see the
-functions `generic-specifier-p', `integer-specifier-p',
+functions `make-generic-specifier', `make-integer-specifier',
-`boolean-specifier-p', `color-specifier-p', `font-specifier-p',
+`make-natnum-specifier', `make-boolean-specifier',
-`image-specifier-p', `face-boolean-specifier-p', `gutter-specifier-p,
+`make-color-specifier', `make-font-specifier', `make-image-specifier',
-`gutter-size-specifier-p, `gutter-visible-specifier-p and
+`make-face-boolean-specifier', `make-gutter-size-specifier',
-`toolbar-specifier-p'.
+`make-gutter-visible-specifier', `default-toolbar', `default-gutter',
+and `current-display-table'.
 */
 (type))
 {
 /* This function can GC */
-struct specifier_methods *meths = decode_specifier_type (type,
+struct specifier_methods *meths = decode_specifier_type (type, ERROR_ME);
-							   ERROR_ME);
 return make_specifier (meths);
 }
 DEFUN ("specifierp", Fspecifierp, 1, 1, 0, /*
 }
 DEFUN ("valid-specifier-domain-p", Fvalid_specifier_domain_p, 1, 1, 0, /*
 Return t if DOMAIN is a valid specifier domain.
 A domain is used to instance a specifier (i.e. determine the specifier's
-value in that domain).  Valid domains are windows, frames, and devices.
+value in that domain).  Valid domains are image instances, windows, frames,
-\(nil is not valid.)
+and devices. \(nil is not valid.) image instances are pseudo-domains since
+instantiation will actually occur in the window the image instance itself is
+instantiated in.
 */
 (domain))
 {
 /* This cannot GC. */
 return ((DEVICEP (domain) && DEVICE_LIVE_P (XDEVICE (domain))) ||
 	  (FRAMEP  (domain) && FRAME_LIVE_P  (XFRAME  (domain))) ||
-	  (WINDOWP (domain) && WINDOW_LIVE_P (XWINDOW (domain))))
+	  (WINDOWP (domain) && WINDOW_LIVE_P (XWINDOW (domain))) ||
+	  /* #### get image instances out of domains! */
+	  IMAGE_INSTANCEP (domain))
 ? Qt : Qnil;
 }
 DEFUN ("valid-specifier-locale-type-p", Fvalid_specifier_locale_type_p, 1, 1, 0, /*
 Given a specifier LOCALE-TYPE, return non-nil if it is valid.
 {
 if (NILP (Fvalid_specifier_domain_p (domain)))
 signal_simple_error ("Invalid specifier domain", domain);
 }
-static Lisp_Object
+Lisp_Object
 decode_domain (Lisp_Object domain)
 {
 if (NILP (domain))
 return Fselected_window (Qnil);
 check_valid_domain (domain);
 struct gcpro gcpro1, gcpro2;
 GCPRO2 (specifier, inst_list);
 sp = XSPECIFIER (specifier);
-device = DFW_DEVICE (domain);
+device = DOMAIN_DEVICE (domain);
 if (no_quit)
 /* The instantiate method is allowed to call eval.  Since it
 is quite common for this function to get called from somewhere in
 redisplay we need to make sure that quits are ignored.  Otherwise
 sp = XSPECIFIER (specifier);
 /* Attempt to determine buffer, window, frame, and device from the
 domain. */
-if (WINDOWP (domain))
+/* #### get image instances out of domains! */
+if (IMAGE_INSTANCEP (domain))
+window = DOMAIN_WINDOW (domain);
+else if (WINDOWP (domain))
 window = domain;
 else if (FRAMEP (domain))
 frame = domain;
 else if (DEVICEP (domain))
 device = domain;
 else
-/* #### dmoore - dammit, this should just signal an error or something
+/* dmoore writes: [dammit, this should just signal an error or something
-shouldn't it?
+shouldn't it?]
-#### No. Errors are handled in Lisp primitives implementation.
+No. Errors are handled in Lisp primitives implementation.
 Invalid domain is a design error here - kkm. */
 abort ();
 if (NILP (buffer) && !NILP (window))
 buffer = XWINDOW (window)->buffer;
 is supposed to require only that the specifier type is passed,
 while with this approach the actual specifier is needed.)
 What really needs to be done is to write a function
 `make-specifier-type' that creates new specifier types.
-#### I'll look into this for 19.14.
-*/
+#### [I'll look into this for 19.14.]  Well, sometime. (Currently
+May 2000, 21.2 is in development.  19.14 was released in June 1996.) */
 "A generic specifier is a generalized kind of specifier with user-defined\n"
 "semantics.  The instantiator can be any kind of Lisp object, and the\n"
 "instance computed from it is likewise any kind of Lisp object.  The\n"
 "SPECIFIER-DATA should be an alist of methods governing how the specifier\n"
 #endif /* 0 */
 DEFUN ("generic-specifier-p", Fgeneric_specifier_p, 1, 1, 0, /*
 Return non-nil if OBJECT is a generic specifier.
-A generic specifier allows any kind of Lisp object as an instantiator,
+See `make-generic-specifier' for a description of possible generic
-and returns back the Lisp object unchanged when it is instantiated.
+instantiators.
 */
 (object))
 {
 return GENERIC_SPECIFIERP (object) ? Qt : Qnil;
 }
 CHECK_INT (instantiator);
 }
 DEFUN ("integer-specifier-p", Finteger_specifier_p, 1, 1, 0, /*
 Return non-nil if OBJECT is an integer specifier.
+See `make-integer-specifier' for a description of possible integer
+instantiators.
 */
 (object))
 {
 return INTEGER_SPECIFIERP (object) ? Qt : Qnil;
 }
 CHECK_NATNUM (instantiator);
 }
 DEFUN ("natnum-specifier-p", Fnatnum_specifier_p, 1, 1, 0, /*
 Return non-nil if OBJECT is a natnum (non-negative-integer) specifier.
+See `make-natnum-specifier' for a description of possible natnum
+instantiators.
 */
 (object))
 {
 return NATNUM_SPECIFIERP (object) ? Qt : Qnil;
 }
 signal_simple_error ("Must be t or nil", instantiator);
 }
 DEFUN ("boolean-specifier-p", Fboolean_specifier_p, 1, 1, 0, /*
 Return non-nil if OBJECT is a boolean specifier.
+See `make-boolean-specifier' for a description of possible boolean
+instantiators.
 */
 (object))
 {
 return BOOLEAN_SPECIFIERP (object) ? Qt : Qnil;
 }
 /*                        Display table specifier type                  */
 /************************************************************************/
 DEFINE_SPECIFIER_TYPE (display_table);
-#define VALID_SINGLE_DISPTABLE_INSTANTIATOR_P(instantiator)			\
+#define VALID_SINGLE_DISPTABLE_INSTANTIATOR_P(instantiator)		   \
-(VECTORP (instantiator)							\
+(VECTORP (instantiator)						   \
-|| (CHAR_TABLEP (instantiator)						\
+|| (CHAR_TABLEP (instantiator)					   \
-&& (XCHAR_TABLE_TYPE (instantiator) == CHAR_TABLE_TYPE_CHAR		\
+&& (XCHAR_TABLE_TYPE (instantiator) == CHAR_TABLE_TYPE_CHAR	   \
-	   || XCHAR_TABLE_TYPE (instantiator) == CHAR_TABLE_TYPE_GENERIC))	\
+	   || XCHAR_TABLE_TYPE (instantiator) == CHAR_TABLE_TYPE_GENERIC)) \
 || RANGE_TABLEP (instantiator))
 static void
 display_table_validate (Lisp_Object instantiator)
 {
 }
 }
 DEFUN ("display-table-specifier-p", Fdisplay_table_specifier_p, 1, 1, 0, /*
 Return non-nil if OBJECT is a display-table specifier.
+See `current-display-table' for a description of possible display-table
+instantiators.
 */
 (object))
 {
 return DISPLAYTABLE_SPECIFIERP (object) ? Qt : Qnil;
 }

Mercurial > hg > xemacs-beta

comparison src/specifier.c @ 408:501cfd01ee6d r21-2-34