unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#64645: [PATCH] * src/lisp.h: Describe a simple mnemonics to understand XLI/XIL/XLP macros
@ 2023-07-15  9:49 Ihor Radchenko
  2023-07-15 10:05 ` Eli Zaretskii
  0 siblings, 1 reply; 2+ messages in thread
From: Ihor Radchenko @ 2023-07-15  9:49 UTC (permalink / raw)
  To: 64645

[-- Attachment #1: Type: text/plain, Size: 575 bytes --]

Tags: patch

Hi,

While reading the C sources, I kept stumbling upon the meaning of
XLI/XIL/XLP macros.  The attached patch adds a comment with simple
mnemonics to remember what they mean.

In GNU Emacs 30.0.50 (build 2, x86_64-pc-linux-gnu, GTK+ Version
 3.24.38, cairo version 1.17.8) of 2023-07-13 built on localhost
Repository revision: d97b77e6c66db46b198c696f83458aa141794727
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12101008
System Description: Gentoo Linux

Configured using:
 'configure --with-native-compilation'


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-src-lisp.h-Describe-a-simple-mnemonics-to-understand.patch --]
[-- Type: text/patch, Size: 1165 bytes --]

From f032a6a9c51cc0e9568c7cb36e30d365c14b5b8b Mon Sep 17 00:00:00 2001
Message-ID: <f032a6a9c51cc0e9568c7cb36e30d365c14b5b8b.1689414492.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Sat, 15 Jul 2023 12:46:43 +0300
Subject: [PATCH] * src/lisp.h: Describe a simple mnemonics to understand
 XLI/XIL/XLP macros

These macro names may be confusing for untrained mind.  Mnemonics
described in the added comment helps to remember what is what for new
readers.
---
 src/lisp.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/lisp.h b/src/lisp.h
index f10bce86b45..528db45dbcf 100644
--- a/src/lisp.h
+++ b/src/lisp.h
@@ -332,7 +332,11 @@ #define LISP_WORDS_ARE_POINTERS (EMACS_INT_MAX == INTPTR_MAX)
    see these functions for commentary.  */
 
 /* Convert among the various Lisp-related types: I for EMACS_INT, L
-   for Lisp_Object, P for void *.  */
+   for Lisp_Object, P for void *.
+   Useful mnemonics:
+   1. XLI :: X is Lisp Integer
+   2. XIL :: X Is Lisp
+   3. XLP :: X is Lisp Pointer */
 #if !CHECK_LISP_OBJECT_TYPE
 # if LISP_WORDS_ARE_POINTERS
 #  define lisp_h_XLI(o) ((EMACS_INT) (o))
-- 
2.41.0


[-- Attachment #3: Type: text/plain, Size: 224 bytes --]


-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* bug#64645: [PATCH] * src/lisp.h: Describe a simple mnemonics to understand XLI/XIL/XLP macros
  2023-07-15  9:49 bug#64645: [PATCH] * src/lisp.h: Describe a simple mnemonics to understand XLI/XIL/XLP macros Ihor Radchenko
@ 2023-07-15 10:05 ` Eli Zaretskii
  0 siblings, 0 replies; 2+ messages in thread
From: Eli Zaretskii @ 2023-07-15 10:05 UTC (permalink / raw)
  To: Ihor Radchenko; +Cc: 64645-done

> From: Ihor Radchenko <yantar92@posteo.net>
> Date: Sat, 15 Jul 2023 09:49:41 +0000
> 
> While reading the C sources, I kept stumbling upon the meaning of
> XLI/XIL/XLP macros.  The attached patch adds a comment with simple
> mnemonics to remember what they mean.

Thanks, I installed on the emacs-29 a different patch explaining the
mnemonics.





^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-07-15 10:05 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-07-15  9:49 bug#64645: [PATCH] * src/lisp.h: Describe a simple mnemonics to understand XLI/XIL/XLP macros Ihor Radchenko
2023-07-15 10:05 ` Eli Zaretskii

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).