Printing code made by a macro

Printing code made by a macro

[Heime]

Is there a proper way to display the code produced by a macro ?  Perhaps call
a function to print it by passing the macro command ?

(print-code (mymacro (* 2 3) (* 5 8) ))

Which would print (+ 3 8)

How would one write print-code ?

Re: Printing code made by a macro

[Eduardo Ochs]

On Sat, 5 Aug 2023 at 20:43, Heime <heimeborgia@protonmail.com> wrote:

>
> Is there a proper way to display the code produced by a macro ?  Perhaps
> call
> a function to print it by passing the macro command ?
>
> (print-code (mymacro (* 2 3) (* 5 8) ))
>
> Which would print (+ 3 8)
>
> How would one write print-code ?
>

 Hi Heime,

eev has a function, called "find-eppm", that takes a sexp, expands it
with macro-expand, pretty-prints the expansion, and displays the
pretty-printed code in a temporary buffer. If you'd like to try it,
install eev, run this,

  (require 'eev-load)

and then type `C-x C-e' after the last parenthesis here:

  (find-eppm '

  (define-minor-mode MAIN-mode
    "Help 1"
    :init-value t
    :global t
    :lighter (propertize " MAIN" 'face 'region))

  )

The reason for the "(require 'eev-load)" is explained here:

  http://anggtwu.net/eev-intros/find-eev-quick-intro.html#1
  http://anggtwu.net/eev-current/eev-load.el.html#autoloads

Cheers,
  Edrx

Re: Printing code made by a macro

[Heime]

------- Original Message -------
On Sunday, August 6th, 2023 at 12:31 PM, Eduardo Ochs <eduardoochs@gmail.com> wrote:


> On Sat, 5 Aug 2023 at 20:43, Heime <heimeborgia@protonmail.com> wrote:
> 
> > 
> > Is there a proper way to display the code produced by a macro ? Perhaps call
> > a function to print it by passing the macro command ?
> > 
> > (print-code (mymacro (* 2 3) (* 5 8) ))
> > 
> > Which would print (+ 3 8)
> > 
> > How would one write print-code ?
> 
> 
> Hi Heime,
> 
> eev has a function, called "find-eppm", that takes a sexp, expands it
> with macro-expand, pretty-prints the expansion, and displays the
> pretty-printed code in a temporary buffer. 

You wrote eev ?

> If you'd like to try it, install eev, run this,
> 
> (require 'eev-load)
> 
> and then type `C-x C-e' after the last parenthesis here:
> 
> (find-eppm '
> 
> (define-minor-mode MAIN-mode
> "Help 1"
> :init-value t
> :global t
> :lighter (propertize " MAIN" 'face 'region))
> 
> )
> 
> The reason for the "(require 'eev-load)" is explained here:
> 
> http://anggtwu.net/eev-intros/find-eev-quick-intro.html#1
> http://anggtwu.net/eev-current/eev-load.el.html#autoloads
> 
> Cheers,
> Edrx
>

Re: Printing code made by a macro

[Eduardo Ochs]

On Sat, 5 Aug 2023, 21:44 Heime, <heimeborgia@protonmail.com> wrote:

>
> You wrote eev ?
>
>
Yes, but it has at least 10 other users besides me...
  Cheers,
    Edrx =)

Re: Printing code made by a macro

[Heime]

------- Original Message -------
On Sunday, August 6th, 2023 at 12:50 PM, Eduardo Ochs <eduardoochs@gmail.com> wrote:


> On Sat, 5 Aug 2023, 21:44 Heime, heimeborgia@protonmail.com wrote:
> 
> > You wrote eev ?
> 
> Yes, but it has at least 10 other users besides me...
> Cheers,
> Edrx =)

This find-eppm of yours, does it involve a lot of code in its implementation ?
I thought that find-eppm is only to find code as text in files, rather than 
printing code results from macros.

Re: Printing code made by a macro

[Heime]

------- Original Message -------
On Sunday, August 6th, 2023 at 1:15 PM, Heime <heimeborgia@protonmail.com> wrote:


> ------- Original Message -------
> On Sunday, August 6th, 2023 at 12:50 PM, Eduardo Ochs eduardoochs@gmail.com wrote:
> 
> 
> 
> > On Sat, 5 Aug 2023, 21:44 Heime, heimeborgia@protonmail.com wrote:
> > 
> > > You wrote eev ?
> > 
> > Yes, but it has at least 10 other users besides me...
> > Cheers,
> > Edrx =)
> 
> 
> This find-eppm of yours, does it involve a lot of code in its implementation ?
> I thought that find-eppm is only to find code as text in files, rather than
> printing code results from macros.

Do you know in which file you implemented find-eppm ?

Re: Printing code made by a macro

[Eduardo Ochs]

On Sat, 5 Aug 2023 at 23:16, Heime <heimeborgia@protonmail.com> wrote:

>
> Do you know in which file you implemented find-eppm ?
>

 Hi Heime,

`find-eppm' uses the functions `find-epp', `find-eoutput-rerun',
`ee-goto-position' and `ee-goto-rest' and the variable
`ee-buffer-name'. You can go to their definitions in the source code
of eev by using these sexp hyperlinks,

  (find-evariable 'ee-buffer-name)
  (find-efunction 'ee-goto-position)
  (find-efunction 'ee-goto-rest)
  (find-efunction 'find-eoutput-rerun)
  (find-efunction 'find-epp)
  (find-efunction 'find-eppm)

  (find-eevfile "eev-blinks.el" "defvar ee-buffer-name")
  (find-eev     "eev-blinks.el" "ee-goto-position")
  (find-eev     "eev-blinks.el" "find-eoutput")
  (find-eev     "eev-blinks.el" "find-epp")

or with these URLs:

  http://anggtwu.net/eev-current/eev-blinks.el.html
  http://anggtwu.net/eev-current/eev-blinks.el.html#ee-goto-position
  http://anggtwu.net/eev-current/eev-blinks.el.html#find-eoutput
  http://anggtwu.net/eev-current/eev-blinks.el.html#find-epp

Cheers,
  Edrx

Re: Printing code made by a macro

[Heime]

Sent with Proton Mail secure email.

------- Original Message -------
On Sunday, August 6th, 2023 at 2:54 PM, Eduardo Ochs <eduardoochs@gmail.com> wrote:


> On Sat, 5 Aug 2023 at 23:16, Heime heimeborgia@protonmail.com wrote:
> 
> > Do you know in which file you implemented find-eppm ?
> 
> 
> Hi Heime,
> 
> `find-eppm' uses the functions` find-epp', `find-eoutput-rerun',` ee-goto-position' and `ee-goto-rest' and the variable` ee-buffer-name'. You can go to their definitions in the source code
> of eev by using these sexp hyperlinks,

They do seem quite straightforward.  code would then just be the call to my macro.  
Then you change the code (via macroexpand) to a string, followed by printing in a 
dedicated buffer.

> (find-evariable 'ee-buffer-name)
> (find-efunction 'ee-goto-position)
> (find-efunction 'ee-goto-rest)
> (find-efunction 'find-eoutput-rerun)
> (find-efunction 'find-epp)
> (find-efunction 'find-eppm)
> 
> (find-eevfile "eev-blinks.el" "defvar ee-buffer-name")
> (find-eev "eev-blinks.el" "ee-goto-position")
> (find-eev "eev-blinks.el" "find-eoutput")
> (find-eev "eev-blinks.el" "find-epp")
> 
> or with these URLs:
> 
> http://anggtwu.net/eev-current/eev-blinks.el.html
> http://anggtwu.net/eev-current/eev-blinks.el.html#ee-goto-position
> http://anggtwu.net/eev-current/eev-blinks.el.html#find-eoutput
> http://anggtwu.net/eev-current/eev-blinks.el.html#find-epp
> 
> Cheers,
> Edrx

Re: Printing code made by a macro

[Eli Zaretskii]

> Date: Sat, 05 Aug 2023 23:42:50 +0000
> From: Heime <heimeborgia@protonmail.com>
> 
> 
> Is there a proper way to display the code produced by a macro ?  Perhaps call
> a function to print it by passing the macro command ?
> 
> (print-code (mymacro (* 2 3) (* 5 8) ))
> 
> Which would print (+ 3 8)
> 
> How would one write print-code ?

By using macroexpand?

Re: Printing code made by a macro

[Sebastian Miele]

> From: Heime <heimeborgia@protonmail.com>
> Date: Sat, 2023-08-05 23:42 +0000
>
> Is there a proper way to display the code produced by a macro?

https://github.com/emacsorphanage/macrostep can do that in an
interactive way.  From its README:

  macrostep is an Emacs minor mode for interactively stepping through
  the expansion of macros in Emacs Lisp source code.  It lets you see
  exactly what happens at each step of the expansion process by
  pretty-printing the expanded forms inline in the source buffer, which
  is temporarily read-only while macro expansions are visible.

Re: Printing code made by a macro

[Heime]

------- Original Message -------
On Sunday, August 6th, 2023 at 2:54 PM, Eduardo Ochs <eduardoochs@gmail.com> wrote:


> On Sat, 5 Aug 2023 at 23:16, Heime <heimeborgia@protonmail.com> wrote:
> 
> > 
> > Do you know in which file you implemented find-eppm ?
> 
> 
> Hi Heime,
> 
> `find-eppm' uses the functions `find-epp', `find-eoutput-rerun',
> `ee-goto-position' and `ee-goto-rest' and the variable
> `ee-buffer-name'. You can go to their definitions in the source code
> of eev by using these sexp hyperlinks,

I am now looping to find pp-to-string and find-estring-elisp

Where are they ?
 
You call these "find-" tools (e.g. find-eppm) which I can use
to print code derived from a macro.  Although in actual fact,
you use them to print code that is found in elisp files.  And 
thusly  you call them "find-" tools.  It just happens that I 
can use them to pretty print the output of my macro, even though
no code will be found in my libraries.  Is this the correct 
evaluation of find-eppm ?


> (find-evariable 'ee-buffer-name)
> (find-efunction 'ee-goto-position)
> (find-efunction 'ee-goto-rest)
> (find-efunction 'find-eoutput-rerun)
> (find-efunction 'find-epp)
> (find-efunction 'find-eppm)
> 
> (find-eevfile "eev-blinks.el" "defvar ee-buffer-name")
> (find-eev "eev-blinks.el" "ee-goto-position")
> (find-eev "eev-blinks.el" "find-eoutput")
> (find-eev "eev-blinks.el" "find-epp")
> 
> or with these URLs:
> 
> http://anggtwu.net/eev-current/eev-blinks.el.html
> http://anggtwu.net/eev-current/eev-blinks.el.html#ee-goto-position
> http://anggtwu.net/eev-current/eev-blinks.el.html#find-eoutput
> http://anggtwu.net/eev-current/eev-blinks.el.html#find-epp
> 
> Cheers,
> Edrx
>

Re: Printing code made by a macro

[Heime]

------- Original Message -------
On Sunday, August 6th, 2023 at 12:50 PM, Eduardo Ochs <eduardoochs@gmail.com> wrote:


> On Sat, 5 Aug 2023, 21:44 Heime, <heimeborgia@protonmail.com> wrote:
> 
> > 
> > You wrote eev ?
> 
> 
> Yes, but it has at least 10 other users besides me...
> Cheers,
> Edrx =)

Eduardo, it would be really helpful (especially to those using eev from source) to 
start using version numbers for your eev.

Could you do that ? What version would you describe the current eev ?

You have mentioned having a series of workshops in 2021 and 2022, where very few 
people attended them.  That has happened to me as well.  Why do you think few
people attended ?

"But they inspired me to produce many pages and videos."  Very Good :)

  

Re: Printing code made by a macro

[Eduardo Ochs]

On Sun, 6 Aug 2023 at 14:24, Heime <heimeborgia@protonmail.com> wrote:
>
> I am now looping to find pp-to-string and find-estring-elisp
>
> Where are they ?
>
> You call these "find-" tools (e.g. find-eppm) which I can use
> to print code derived from a macro.  Although in actual fact,
> you use them to print code that is found in elisp files.  And
> thusly  you call them "find-" tools.  It just happens that I
> can use them to pretty print the output of my macro, even though
> no code will be found in my libraries.  Is this the correct
> evaluation of find-eppm ?

Hi Heime,

eev has lots of functions to inspect how Emacs represents things in
memory and only a few functions to jump to their source code, and the
functions in eev that start with the prefix `find-' are the ones that
are usually used as elisp hyperlinks... for example, this - note that
it is a sexp of the form "(find-... ...)" - is an elisp hyperlink:

  (find-efunction 'find-eppm)

if you follow it it will take you to the definition of the function
`find-eppm' in the file "eev-blinks.el". Elisp hyperlinks are
explained here:

  (find-eev-quick-intro "2. Evaluating Lisp")
  (find-eev-quick-intro "3. Elisp hyperlinks")
  http://anggtwu.net/eev-intros/find-eev-quick-intro.html#2
  http://anggtwu.net/eev-intros/find-eev-quick-intro.html#3

The "Emacs way" to get help about a function is to put the point on
the name of the function and then type `C-h f RET'; this creates a
temporary buffer with lots of information, and one of the first things
in that temporary buffer is a link to where the function is defined.
The "eev way" to get help about a function is to put the point on the
name of the function and then type `M-h M-f RET'; this creates a
temporary buffer with lots of elisp hyperlinks. If you do `M-h M-f
RET' with the point on `find-eppm' some of the elisp hyperlinks that
will appear are these ones:

  (find-efunction-links 'find-eppm)
  (eek "M-h M-f  find-eppm")
  (find-eev-quick-intro "4.2. `find-ekey-links' and friends")

  (find-efunctiondescr 'find-eppm)
  (find-efunction      'find-eppm)
  (find-efunctionpp    'find-eppm)

  (symbol-file 'find-eppm 'defun)
  (find-fline (symbol-file 'find-eppm 'defun))
  (find-epp (assoc (symbol-file 'find-eppm 'defun) load-history))

Try them - I mean, try the ones above and then try all the ones in the
temporary buffer... you will see that some of them do things that are
easy to understand, and some other ones do things that are very
low-level and very technical... but you are trying to learn things
that are very low-level and very technical, so I think that you will
like them. Also, take a look at this:

  (find-elisp-intro)
  http://anggtwu.net/eev-intros/find-elisp-intro.html

I have the impression that its section 6

  (find-elisp-intro "6. Defining functions")
  http://anggtwu.net/eev-intros/find-elisp-intro.html#6

explains some things about how functions are stored in memory that may
be useful to you...

Btw, eev has a mailing list:

  https://lists.nongnu.org/mailman/listinfo/eev
  https://lists.gnu.org/archive/html/eev/

More later! Cheers =),
  Eduardo
  http://anggtwu.net/eepitch.html

Re: Printing code made by a macro

[Heime]

------- Original Message -------
On Monday, August 7th, 2023 at 8:36 AM, Eduardo Ochs <eduardoochs@gmail.com> wrote:


> On Sun, 6 Aug 2023 at 14:24, Heime heimeborgia@protonmail.com wrote:
> 
> > I am now looping to find pp-to-string and find-estring-elisp
> > 
> > Where are they ?
> > 
> > You call these "find-" tools (e.g. find-eppm) which I can use
> > to print code derived from a macro. Although in actual fact,
> > you use them to print code that is found in elisp files. And
> > thusly you call them "find-" tools. It just happens that I
> > can use them to pretty print the output of my macro, even though
> > no code will be found in my libraries. Is this the correct
> > evaluation of find-eppm ?
> 
> 
> Hi Heime,
> 
> eev has lots of functions to inspect how Emacs represents things in
> memory and only a few functions to jump to their source code, and the
> functions in eev that start with the prefix `find-' are the ones that 
> are usually used as elisp hyperlinks

Right.  I am using find-eppm to print the result of my macros, rather than
for the original purpose of hyperlinks.  So my use can be described as some
sort of hack on your code.  Is it so ?

> For example, this - note that it is a sexp of the form "(find-... ...)" - 
> is an elisp hyperlink: (find-efunction 'find-eppm) if you follow it it 
> will take you to the definition of the function` find-eppm' in the file 
> "eev-blinks.el". 

> Elisp hyperlinks are explained here:
> 
> (find-eev-quick-intro "2. Evaluating Lisp")
> (find-eev-quick-intro "3. Elisp hyperlinks")
> http://anggtwu.net/eev-intros/find-eev-quick-intro.html#2
> http://anggtwu.net/eev-intros/find-eev-quick-intro.html#3
> 
> The "Emacs way" to get help about a function is to put the point on
> the name of the function and then type `C-h f RET'; this creates a temporary buffer with lots of information, and one of the first things in that temporary buffer is a link to where the function is defined. The "eev way" to get help about a function is to put the point on the name of the function and then type` M-h M-f RET'; this creates a
> temporary buffer with lots of elisp hyperlinks. If you do `M-h M-f RET' with the point on` find-eppm' some of the elisp hyperlinks that
> will appear are these ones:
> 
> (find-efunction-links 'find-eppm)
> (eek "M-h M-f find-eppm")
> (find-eev-quick-intro "4.2. `find-ekey-links' and friends")
> 
> (find-efunctiondescr 'find-eppm)
> (find-efunction 'find-eppm)
> (find-efunctionpp 'find-eppm)
> 
> (symbol-file 'find-eppm 'defun)
> (find-fline (symbol-file 'find-eppm 'defun))
> (find-epp (assoc (symbol-file 'find-eppm 'defun) load-history))
> 
> Try them - I mean, try the ones above and then try all the ones in the
> temporary buffer... you will see that some of them do things that are
> easy to understand, and some other ones do things that are very
> low-level and very technical... but you are trying to learn things
> that are very low-level and very technical, so I think that you will
> like them. Also, take a look at this:
> 
> (find-elisp-intro)
> http://anggtwu.net/eev-intros/find-elisp-intro.html
> 
> I have the impression that its section 6
> 
> (find-elisp-intro "6. Defining functions")
> http://anggtwu.net/eev-intros/find-elisp-intro.html#6
> 
> explains some things about how functions are stored in memory that may
> be useful to you...
> 
> Btw, eev has a mailing list:
> 
> https://lists.nongnu.org/mailman/listinfo/eev
> https://lists.gnu.org/archive/html/eev/
> 
> More later! Cheers =),
> Eduardo
> http://anggtwu.net/eepitch.html

Re: Printing code made by a macro

[Emanuel Berg]

Heime wrote:

> Right. I am using find-eppm to print the result of my
> macros, rather than for the original purpose of hyperlinks.
> So my use can be described as some sort of hack on your
> code. Is it so?

:)

-- 
underground experts united
https://dataswamp.org/~incal

Re: Printing code made by a macro

[Pierre Rouleau]

On Sat, Aug 5, 2023 at 7:43 PM Heime <heimeborgia@protonmail.com> wrote:

>
> Is there a proper way to display the code produced by a macro
>

The macrostep package (https://melpa.org/#/macrostep) provides interactive
use of the built-in macroexpand.

-- 
/Pierre