How to use `narrow'?

How to use `narrow'?

[Ilya Zakharevich]

My idea how *I* would use `narrow' is like this:

  Suppose I have a file which is "in multiple modes".  E.g., consider
  some "literate programming" style text, or one which contains a
  HERE-document with a program in a different language than the main
  text of the document:

    $var = <<EOV;		 # E.g., this is Perl

       // Here is some code in JavaScript
       ...

    EOV

  So I would like to narrow to the region "inside the HERE-document",
  and switch the mode to "other mode" (above, from CPerl mode to
  JavaScript mode).

However, I looked, and `font-lock' does `widen' before it starts up;
so all the effect of narrowing is gone...  Is there any *use* of
narrowing?

Thanks,
Ilya

P.S. I ask this since now CPerl has a (contributed) code to
     `narrow-to-here-doc', and I would like to document why this would
     be useful...

How to use `narrow'?

[Gian Uberto Lauri]

>>>>> "IZ" == Ilya Zakharevich <nospam-abuse@ilyaz.org> writes:

IZ> My idea how *I* would use `narrow' is like this:

IZ>   Suppose I have a file which is "in multiple modes".

...

IZ>   So I would like to narrow to the region "inside the
IZ> HERE-document", and switch the mode to "other mode" (above, from
IZ> CPerl mode to JavaScript mode).

...

IZ> However, I looked, and `font-lock' does `widen' before it starts
IZ> up; so all the effect of narrowing is gone...  Is there any *use*
IZ> of narrowing?

font-lock widens then narrows, afaik.

So what's narrowed stays narrowed at least for what concerns the user.

-- 
 /\            ___
/___/\__|_|\_|__|___Gian Uberto Lauri_____________________
  //--\ | | \|  |   Integralista GNUslamico  
\/		    e allevatore di bug da competizione

Re: How to use `narrow'?

[Ilya Zakharevich]

[A complimentary Cc of this posting was sent to
Gian Uberto Lauri
<saint@eng.it>], who wrote in article <mailman.11713.1129623266.20277.help-gnu-emacs@gnu.org>:
> IZ> My idea how *I* would use `narrow' is like this:
> IZ>   Suppose I have a file which is "in multiple modes".
...
> IZ>   So I would like to narrow to the region "inside the
> IZ> HERE-document", and switch the mode to "other mode" (above, from
> IZ> CPerl mode to JavaScript mode).
> ...
> IZ> However, I looked, and `font-lock' does `widen' before it starts
> IZ> up; so all the effect of narrowing is gone...  Is there any *use*
> IZ> of narrowing?
> 
> font-lock widens then narrows, afaik.

> So what's narrowed stays narrowed at least for what concerns the user.

Eh???  There is no narrowing in font-lock (except some for C modes).
Thus fontification is based on the whole contents of the buffer (which
is multi-mode, thus can't be parsed by Emacs).

Yours,
Ilya

Re: How to use `narrow'?

[David Hansen]

On Tue, 18 Oct 2005 02:09:51 +0000 (UTC) Ilya Zakharevich wrote:

> My idea how *I* would use `narrow' is like this:
>
>   Suppose I have a file which is "in multiple modes".  E.g., consider
>   some "literate programming" style text, or one which contains a
>   HERE-document with a program in a different language than the main
>   text of the document:
>
>     $var = <<EOV;		 # E.g., this is Perl
>
>        // Here is some code in JavaScript
>        ...
>
>     EOV
>
>   So I would like to narrow to the region "inside the HERE-document",
>   and switch the mode to "other mode" (above, from CPerl mode to
>   JavaScript mode).
>
> However, I looked, and `font-lock' does `widen' before it starts up;
> so all the effect of narrowing is gone...  Is there any *use* of
> narrowing?

Is this working?

(add-hook 'java-scrip-mode-hook 
          (lambda ()
            (set
             (make-local-variable 'font-lock-dont-widen t))))

,----[ C-h v font-lock-dont-widen RET ]
| font-lock-dont-widen is a variable defined in `font-lock'.
| Its value is nil
| 
| Documentation:
| If non-nil, font-lock will work on the non-widened buffer.
| Useful for things like RMAIL and Info where the whole buffer is not
| a very meaningful entity to highlight.
`----

David

Re: How to use `narrow'?

[Anselm Helbig]

narrow-to-region is useful e.g. when you want to apply a command that
usually continues to the end of the buffer only to a part of the text,
sth like you do a query-replace and hit `!', or like repeating a
keyboard macro many times. 

if you need multiple modes, there's mmm-mode, two-mode and another one
i don't recall right now. none of these is a really perfect solution,
though. 

regards, 

anselm

Re: How to use `narrow'?

[Ilya Zakharevich]

[A complimentary Cc of this posting was sent to
David Hansen 
<david.hansen@gmx.net>], who wrote in article <87ek6j17i5.fsf@robotron.ath.cx>:
> Is this working?
> 
> (add-hook 'java-scrip-mode-hook 
>           (lambda ()
>             (set
>              (make-local-variable 'font-lock-dont-widen t))))

No, it does not help.  font-lock widens unconditionally.

> ,----[ C-h v font-lock-dont-widen RET ]
> | font-lock-dont-widen is a variable defined in `font-lock'.
> | Its value is nil
> | 
> | Documentation:
> | If non-nil, font-lock will work on the non-widened buffer.
> | Useful for things like RMAIL and Info where the whole buffer is not
> | a very meaningful entity to highlight.
> `----

I would prefer a solution which works in real world, not in some
imaginary settings...  However, it is nice that somebody realized that
widening is a problem.  When will we see it, in 22.1?

Thanks,
Ilya

Re: How to use `narrow'?

[David Hansen]

On Tue, 18 Oct 2005 19:41:51 +0000 (UTC) Ilya Zakharevich wrote:

> No, it does not help.  font-lock widens unconditionally.
>
>> ,----[ C-h v font-lock-dont-widen RET ]
>
> I would prefer a solution which works in real world, not in some
> imaginary settings...  However, it is nice that somebody realized that
> widening is a problem.  When will we see it, in 22.1?

I'm sorry, i forgot to mention that I'm running emacs from CVS.

David

Re: How to use `narrow'?

[Ilya Zakharevich]

[A complimentary Cc of this posting was sent to
David Hansen 
<david.hansen@gmx.net>], who wrote in article <874q7e1nfz.fsf@robotron.ath.cx>:
> On Tue, 18 Oct 2005 19:41:51 +0000 (UTC) Ilya Zakharevich wrote:
> 
> > No, it does not help.  font-lock widens unconditionally.
> >
> >> ,----[ C-h v font-lock-dont-widen RET ]
> >
> > I would prefer a solution which works in real world, not in some
> > imaginary settings...  However, it is nice that somebody realized that
> > widening is a problem.  When will we see it, in 22.1?

> I'm sorry, i forgot to mention that I'm running emacs from CVS.

Well, I guessed this.  But anyway, just font-lock-dont-widen is not
enough to have robust support for narrowing.  Obviously, there are
cases when this widen() *is* useful.  And there are cases when it is
harmful.

The only way I see which may be usable is a way to mark a *particular*
narrowing operation as requiring (or not) widen() during
fontification.  E.g., one could put some text property on the narrowed
region (as far as widen() is smart enough to remove this text property
afterwards...).

Is there anything like this in CVS?

Thanks,
Ilya

Re: How to use `narrow'?

[Stefan Monnier]

>> > No, it does not help.  font-lock widens unconditionally.
>> >
>> >> ,----[ C-h v font-lock-dont-widen RET ]
>> >
>> > I would prefer a solution which works in real world, not in some
>> > imaginary settings...  However, it is nice that somebody realized that
>> > widening is a problem.

Thanks Ilya for the compliment ;-)

>> > When will we see it, in 22.1?
>> I'm sorry, i forgot to mention that I'm running emacs from CVS.
> Well, I guessed this.  But anyway, just font-lock-dont-widen is not
> enough to have robust support for narrowing.  Obviously, there are
> cases when this widen() *is* useful.  And there are cases when it is
> harmful.

> The only way I see which may be usable is a way to mark a *particular*
> narrowing operation as requiring (or not) widen() during
> fontification.  E.g., one could put some text property on the narrowed
> region (as far as widen() is smart enough to remove this text property
> afterwards...).

Indeed, you're right.

> Is there anything like this in CVS?

No.  Narrowing is fairly badly defined in Emacs.  Sometimes it's used to
pretend the rest of the buffer doesn't exist at all, and other times it's
only meant to hide the rest of the buffer from some operations (e.g. from
display) without pretending the rest doesn't exist.

So, e.g. font-lock doesn't know whether to widen or not.  Same thing for
indentation, etc... it's pretty messy.  I personally try to stay away from
narrow except as an elisp tool for things like emulating the presence of
a `limit' argument to `looking-at'.

As for your original problem.  There are several packages that try to
provide support for multi-mode operation.  The approach they take to do that
vary, but I think they all end up using changing
font-lock-fontify-region-function so they can better control what is
highlighted how.  Maybe you could simply add support for mmm-mode or
multi-mode.el or somesuch and forget about narrowing ;-)


        Stefan