separating functions, fpath, and autoload

separating functions, fpath, and autoload

[TJ Luoma]

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

I'm in the midst of an effort to try to learn some of zsh's more powerful
features, since I've been using zsh forever and feel like I only use 1% of
what it can do.

One of the things that I've wanted to do for awhile is separate out some of
my more complex functions to remove them from my .zshrc file and put them
into their own files. This should make them easier to track/change/etc and
it makes things a lot easier to read and debug.

Unfortunately, I can't seem to get it to work right. I'm sure I'm doing
something wrong because I don't really know what I'm doing, so I'll explain
what I've tried, and hopefully someone can explain where I've gone wrong.

I added this to my .zshrc

if [ -d "$ZDOTDIR/functions" ]
then
fpath=($ZDOTDIR/functions $fpath)
fi

The goal there was to add '$ZDOTDIR/functions' to the functions list, which
I think is the right way to do this.

I can verify that works, I think, by using 'echo $fpath':

$ echo $fpath
/Users/luomat/Dropbox/dotfiles/zsh/completion
/Users/luomat/Dropbox/dotfiles/zsh/functions
/usr/local/share/zsh/site-functions /usr/share/zsh/site-functions
/usr/share/zsh/5.3/functions

/Users/luomat/Dropbox/dotfiles is my $ZDOTDIR

The first file in '/Users/luomat/Dropbox/dotfiles/zsh/functions' is called
'msg'. For simplicity's sake, let's assume the contents of 'msg' is simply
this:

function msg  {

  echo "$@"

}

(It's actually more complicated than that, but that's the overall idea.)

I tried that, and then I tried

autoload msg

and I didn't get an error, but when I check 'which msg' I get this:

msg () {
# undefined
builtin autoload -X
}

so I've messed up something along the line.

Any help would be appreciated.

Thanks!

Tj


--
TJ Luoma
TJ @ MacStories <http://www.macstories.net/author/tjluoma/>
Personal Website: luo.ma <http://luo.ma/> (aka RhymesWithDiploma.com
<http://rhymeswithdiploma.com/>)
Twitter: @tjluoma <http://twitter.com/tjluoma>

Re: separating functions, fpath, and autoload

[TJ Luoma]

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

Of course, two minutes after I send my message, I had a thought.

I need to _use_ the 'msg' function before it will be defined. Before that,
it is the regular thing that I showed in my previous example, but once I
_use_ it, then it gets loaded, and is available.

Do I have that right?

So 'autoload' does not mean "load this right now" but rather "be prepared
to load this when it is asked for" ?

Tj


--
TJ Luoma
TJ @ MacStories <http://www.macstories.net/author/tjluoma/>
Personal Website: luo.ma <http://luo.ma/> (aka RhymesWithDiploma.com
<http://rhymeswithdiploma.com/>)
Twitter: @tjluoma <http://twitter.com/tjluoma>



On Mon, Aug 13, 2018 at 9:49 AM TJ Luoma <luomat@gmail.com> wrote:

>
> I'm in the midst of an effort to try to learn some of zsh's more powerful
> features, since I've been using zsh forever and feel like I only use 1% of
> what it can do.
>
> One of the things that I've wanted to do for awhile is separate out some
> of my more complex functions to remove them from my .zshrc file and put
> them into their own files. This should make them easier to track/change/etc
> and it makes things a lot easier to read and debug.
>
> Unfortunately, I can't seem to get it to work right. I'm sure I'm doing
> something wrong because I don't really know what I'm doing, so I'll explain
> what I've tried, and hopefully someone can explain where I've gone wrong.
>
> I added this to my .zshrc
>
> if [ -d "$ZDOTDIR/functions" ]
> then
> fpath=($ZDOTDIR/functions $fpath)
> fi
>
> The goal there was to add '$ZDOTDIR/functions' to the functions list,
> which I think is the right way to do this.
>
> I can verify that works, I think, by using 'echo $fpath':
>
> $ echo $fpath
> /Users/luomat/Dropbox/dotfiles/zsh/completion
> /Users/luomat/Dropbox/dotfiles/zsh/functions
> /usr/local/share/zsh/site-functions /usr/share/zsh/site-functions
> /usr/share/zsh/5.3/functions
>
> /Users/luomat/Dropbox/dotfiles is my $ZDOTDIR
>
> The first file in '/Users/luomat/Dropbox/dotfiles/zsh/functions' is called
> 'msg'. For simplicity's sake, let's assume the contents of 'msg' is simply
> this:
>
> function msg  {
>
>   echo "$@"
>
> }
>
> (It's actually more complicated than that, but that's the overall idea.)
>
> I tried that, and then I tried
>
> autoload msg
>
> and I didn't get an error, but when I check 'which msg' I get this:
>
> msg () {
> # undefined
> builtin autoload -X
> }
>
> so I've messed up something along the line.
>
> Any help would be appreciated.
>
> Thanks!
>
> Tj
>
>
> --
> TJ Luoma
> TJ @ MacStories <http://www.macstories.net/author/tjluoma/>
> Personal Website: luo.ma <http://luo.ma/> (aka RhymesWithDiploma.com
> <http://rhymeswithdiploma.com/>)
> Twitter: @tjluoma <http://twitter.com/tjluoma>
>
>

Re: separating functions, fpath, and autoload

[Pier Paolo Grassi]

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

that should be correct, the autoload will be executed when you first invoke
msg, have you tried invoking it?
Il giorno lun 13 ago 2018 alle 15:50 TJ Luoma <luomat@gmail.com> ha scritto:

> I'm in the midst of an effort to try to learn some of zsh's more powerful
> features, since I've been using zsh forever and feel like I only use 1% of
> what it can do.
>
> One of the things that I've wanted to do for awhile is separate out some of
> my more complex functions to remove them from my .zshrc file and put them
> into their own files. This should make them easier to track/change/etc and
> it makes things a lot easier to read and debug.
>
> Unfortunately, I can't seem to get it to work right. I'm sure I'm doing
> something wrong because I don't really know what I'm doing, so I'll explain
> what I've tried, and hopefully someone can explain where I've gone wrong.
>
> I added this to my .zshrc
>
> if [ -d "$ZDOTDIR/functions" ]
> then
> fpath=($ZDOTDIR/functions $fpath)
> fi
>
> The goal there was to add '$ZDOTDIR/functions' to the functions list, which
> I think is the right way to do this.
>
> I can verify that works, I think, by using 'echo $fpath':
>
> $ echo $fpath
> /Users/luomat/Dropbox/dotfiles/zsh/completion
> /Users/luomat/Dropbox/dotfiles/zsh/functions
> /usr/local/share/zsh/site-functions /usr/share/zsh/site-functions
> /usr/share/zsh/5.3/functions
>
> /Users/luomat/Dropbox/dotfiles is my $ZDOTDIR
>
> The first file in '/Users/luomat/Dropbox/dotfiles/zsh/functions' is called
> 'msg'. For simplicity's sake, let's assume the contents of 'msg' is simply
> this:
>
> function msg  {
>
>   echo "$@"
>
> }
>
> (It's actually more complicated than that, but that's the overall idea.)
>
> I tried that, and then I tried
>
> autoload msg
>
> and I didn't get an error, but when I check 'which msg' I get this:
>
> msg () {
> # undefined
> builtin autoload -X
> }
>
> so I've messed up something along the line.
>
> Any help would be appreciated.
>
> Thanks!
>
> Tj
>
>
> --
> TJ Luoma
> TJ @ MacStories <http://www.macstories.net/author/tjluoma/>
> Personal Website: luo.ma <http://luo.ma/> (aka RhymesWithDiploma.com
> <http://rhymeswithdiploma.com/>)
> Twitter: @tjluoma <http://twitter.com/tjluoma>
>
-- 
Pier Paolo Grassi

Re: separating functions, fpath, and autoload

[Daniel Shahaf]

In more words:

'autoload foo' marks 'foo' as the name of a function that will be
instantiated upon the first call to it.  After calling foo, you'll
see the actual definition of foo: 'autoload foo; foo; which foo'.
You can pass +X to 'autoload' to load the function immediately
(before it's called).

More below.

Pier Paolo Grassi wrote on Mon, 13 Aug 2018 15:56 +0200:
> that should be correct, the autoload will be executed when you first invoke
> msg, have you tried invoking it?
> Il giorno lun 13 ago 2018 alle 15:50 TJ Luoma <luomat@gmail.com> ha scritto:
> > if [ -d "$ZDOTDIR/functions" ]
> > then
> > fpath=($ZDOTDIR/functions $fpath)

Another way:

fpath=( $ZDOTDIR/functions(N) $fpath )

or even

fpath[1,0]=( $ZDOTDIR/functions(N) )

then you don't need an if.

ticking clock

[Ray Andrews]

I did this in zshrc:

     ## 2018-08-10: ticking clock:
     #RPS1=$'%t %w'
     RPS1='%B%F{yellow}[%D{%L:%M:%S}]%f %w'
     TMOUT=1
     TRAPALRM() { zle reset-prompt }

Nice to have the time ticking away there, but it kills back-scrolling -- 
I scroll up, but every tick moves back to the bottom.  Fixable?

Re: ticking clock

[Vin Shelton]

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

Hi, Ray -

You could turn off your terminal emulator's scroll to the bottom on output
option.

I think a better solution would be to change your clock
(conky,taskbar/tasklet or whatever) to have resolution down to the second.

  - Vin

On Mon, Aug 13, 2018 at 11:38 AM, Ray Andrews <rayandrews@eastlink.ca>
wrote:

> I did this in zshrc:
>
>     ## 2018-08-10: ticking clock:
>     #RPS1=$'%t %w'
>     RPS1='%B%F{yellow}[%D{%L:%M:%S}]%f %w'
>     TMOUT=1
>     TRAPALRM() { zle reset-prompt }
>
> Nice to have the time ticking away there, but it kills back-scrolling -- I
> scroll up, but every tick moves back to the bottom.  Fixable?
>
>

Re: ticking clock

[Ray Andrews]

On 13/08/18 09:29 AM, Vin Shelton wrote:
> Hi, Ray -
>
> You could turn off your terminal emulator's scroll to the bottom on output
> option.

That works.  But of course usually I do want it to  scroll, just not 
when the clock ticks.  Dunno, maybe zsh has some sort of 'only tick when 
visible' sort of thing.

>
> I think a better solution would be to change your clock
> (conky,taskbar/tasklet or whatever) to have resolution down to the second.

I've got the desktop's clock up there on the menu bar, but it is nice to 
have one on the command line too.  Not hardly important, but worth 
asking about.

Thanks Vin.

Re: ticking clock

[Bart Schaefer]

On Mon, Aug 13, 2018 at 12:57 PM, Ray Andrews <rayandrews@eastlink.ca> wrote:
>
> I've got the desktop's clock up there on the menu bar, but it is nice to
> have one on the command line too.

I do that by putting the ticking clock in the terminal emulator title
bar instead of in the prompt.

I also use a premcd to start the ticking, and initially set a longer
TMOUT so that it usually ticks only when I'm not actively editing the
buffer (I figure if I'm actively entering commands, having it update
after each command is often enough).

Re: ticking clock

[Ray Andrews]

On 13/08/18 02:54 PM, Bart Schaefer wrote:

> I also use a premcd to start the ticking, and initially set a longer
> TMOUT so that it usually ticks only when I'm not actively editing the
> buffer (I figure if I'm actively entering commands, having it update
> after each command is often enough).
So no way to have it tick only when it's idle, and never force a 
scroll?  I can see that forcing the prompt to rewrite is normally an 
'event' so it would naturally force a scroll, so this is probably 
'unnatural' in a way, but it sounds like it could be doable.  This is 
small potatoes tho, hardly any sort of issue.
>

Re: ticking clock

[Bart Schaefer]

On Mon, Aug 13, 2018 at 3:45 PM, Ray Andrews <rayandrews@eastlink.ca> wrote:
>
> So no way to have it tick only when it's idle, and never force a scroll?

The terminal emulator doesn't "inform" the shell when you scroll back,
so there's no way for the shell to know that it should stop sending
output.

Some emulators have "scroll to bottom on tty input" as well as (or
instead of) "on tty output" -- if possible with your emulator, you
could try enabling only the former.

Re: ticking clock

[Ray Andrews]

On 14/08/18 10:27 AM, Bart Schaefer wrote:
> On Mon, Aug 13, 2018 at 3:45 PM, Ray Andrews <rayandrews@eastlink.ca> wrote:
>> So no way to have it tick only when it's idle, and never force a scroll?
> The terminal emulator doesn't "inform" the shell when you scroll back,
> so there's no way for the shell to know that it should stop sending
> output.
Right , so the prompt doesn't even know if it's visible.  And I can see 
that it's no small thing for the shell to try to convince the terminal 
not to detect that it's been written to in some particular situation.
> Some emulators have "scroll to bottom on tty input" as well as (or
> instead of) "on tty output" -- if possible with your emulator, you
> could try enabling only the former.

Sure.  There's little practical difficulty, I'm mostly interested in the 
theory of the thing.  Thanks Bart.


>

Re: ticking clock

[Sebastian Gniazdowski]

On Mon, 13 Aug 2018 at 18:09, Ray Andrews <rayandrews@eastlink.ca> wrote:
> I did this in zshrc:
>
>      ## 2018-08-10: ticking clock:
>      #RPS1=$'%t %w'
>      RPS1='%B%F{yellow}[%D{%L:%M:%S}]%f %w'
>      TMOUT=1
>      TRAPALRM() { zle reset-prompt }
>
> Nice to have the time ticking away there, but it kills back-scrolling --
> I scroll up, but every tick moves back to the bottom.  Fixable?

Maybe the terminal emulator has configuration option to not scroll
down on view-update? Turning it on is useful in general, allows to
e.g. scroll up and read ./configure log while it's still processing.

-- 
Sebastian Gniazdowski
News: https://twitter.com/ZdharmaI
IRC: https://kiwiirc.com/client/chat.freenode.net:+6697/#zplugin