merging of the xwidget branch to master

merging of the xwidget branch to master

[joakim]

I think soon would be a good time to merge the xwidget branch to master.

While it isn't perfect, it will never be, and it's usable in practice
now I believe. We are also fairly early in the release cycle.

The feature is self contained, as well as I have been able to make it.

I've gotten a code review from Eli that I'm working through. I've
addressed the most serious issues, and the rest can continue in master.

So, now I would like to now what I must fix before merging, and what
work can reasonable continue in master.

-- 
Joakim Verona

Re: merging of the xwidget branch to master

[joakim]

joakim@verona.se writes:

> I think soon would be a good time to merge the xwidget branch to master.
>
> While it isn't perfect, it will never be, and it's usable in practice
> now I believe. We are also fairly early in the release cycle.
>
> The feature is self contained, as well as I have been able to make it.
>
> I've gotten a code review from Eli that I'm working through. I've
> addressed the most serious issues, and the rest can continue in master.
>
> So, now I would like to now what I must fix before merging, and what
> work can reasonable continue in master.

I merged the xwidget branch to master now.

Despite my best efforts, breakage will surely ensue, and I would very
much apreciate help with that.

If you want to test the new feature, ensure you have gtk3 and
webkit-devel intalled.

./configure --with-xwidgets  --with-x-toolkit=gtk3
make
src/emacs
m-x xwidget-webkit-browse-url RET www.fsf.org RET

You will then be able to browse the fsf website graphically inside
emacs.


-- 
Joakim Verona

Re: merging of the xwidget branch to master

[Dmitry Antipov]

On 02/01/2015 03:46 AM, joakim@verona.se wrote:

> I merged the xwidget branch to master now.

(silently and boringly) this violates
http://www.gnu.org/prep/standards/standards.html#Writing-C
obviously enough to suggest to pipe it through 'indent -gnu'
as soon as possible, before others would like to take a look.

Dmitry

Re: merging of the xwidget branch to master

[joakim]

Dmitry Antipov <dmantipov@yandex.ru> writes:

> On 02/01/2015 03:46 AM, joakim@verona.se wrote:
>
>> I merged the xwidget branch to master now.
>
> (silently and boringly) this violates
> http://www.gnu.org/prep/standards/standards.html#Writing-Cobviously enough to suggest to pipe it through 'indent -gnu'
> as soon as possible, before others would like to take a look.

Thanks for the suggestion.

>
> Dmitry
>

-- 
Joakim Verona

Re: merging of the xwidget branch to master

[Jonas Bernoulli]

joakim@verona.se writes:

> ./configure --with-xwidgets  --with-x-toolkit=gtk3

What additinal packages do I have to install?  I am on Debian and the
only package I have installed specifically for this is libwebkitgtk-dev.
After doing that I still get:

  What window system should Emacs use?                    x11
  What toolkit should Emacs use?                          GTK3
  ...
  Does Emacs support Xwidgets?                            no
       Does xwidgets support webkit(requires gtk3)?       no
       Does xwidgets support gobject introspection?       no


  Thank,
  Jonas

Re: merging of the xwidget branch to master

[joakim]

Jonas Bernoulli <jonas@bernoul.li> writes:

> joakim@verona.se writes:
>
>> ./configure --with-xwidgets  --with-x-toolkit=gtk3
>
> What additinal packages do I have to install?  I am on Debian and the
> only package I have installed specifically for this is libwebkitgtk-dev.
> After doing that I still get:
>
>   What window system should Emacs use?                    x11
>   What toolkit should Emacs use?                          GTK3
>   ...
>   Does Emacs support Xwidgets?                            no
>        Does xwidgets support webkit(requires gtk3)?       no
>        Does xwidgets support gobject introspection?       no
>
>
>   Thank,
>   Jonas

I'm not familiar enough with Debian.

I have a working Dockerfile recipy for Fedora here:
https://github.com/jave/xwidget-aux/blob/master/emacs-xwidget-docker-f20/Dockerfile

I could do one for Debian as well, but perhaps the Fedora one is good
enough for you to adapt to Debian?

-- 
Joakim Verona

Re: merging of the xwidget branch to master

[Steinar Bang]

>>>>> joakim@verona.se:

> I'm not familiar enough with Debian.

> I have a working Dockerfile recipy for Fedora here:
> https://github.com/jave/xwidget-aux/blob/master/emacs-xwidget-docker-f20/Dockerfile

> I could do one for Debian as well, but perhaps the Fedora one is good
> enough for you to adapt to Debian?

Here is a close approximation of the yum package list for debian:
 apt-get install git gobject-introspection ncurses-devel libjpeg62-turbo-dev libxpm-dev libjpeg62-dev libtiff5-dev libncurses5-dev libgif-dev texinfo

I didn't find equivalents for: libungif-dev, ncurses-dev and libnsurses-dev

A google for "libungif debian" found that the libgif4 package contains
libungif.so.4:
 https://packages.debian.org/cgi-bin/search_contents.pl?word=libungif.so.4&searchmode=searchfiles&case=insensitive&version=unstable&arch=

And the libgif-dev package has the same version number as libgif4, so I
used that instead of libungif-devel.

The ncurses-devel stuff may be included in debian's libncurses-dev...?

But libnsurses-dev is still a mystery

Re: merging of the xwidget branch to master

[David Engster]

Steinar Bang writes:
>>>>>> joakim@verona.se:
>
>> I'm not familiar enough with Debian.
>
>> I have a working Dockerfile recipy for Fedora here:
>> https://github.com/jave/xwidget-aux/blob/master/emacs-xwidget-docker-f20/Dockerfile
>
>> I could do one for Debian as well, but perhaps the Fedora one is good
>> enough for you to adapt to Debian?
>
> Here is a close approximation of the yum package list for debian:
>  apt-get install git gobject-introspection ncurses-devel
> libjpeg62-turbo-dev libxpm-dev libjpeg62-dev libtiff5-dev
> libncurses5-dev libgif-dev texinfo

Next to the usual libraries for building Emacs, you need to install
libgtk-3-dev, libwebkitgtk-3.0-dev, and libgirepository1.0-dev.

However, it does not build for me:

  CC       xwidget.o
In file included from xwidget.c:79:0:
/usr/include/gtk-3.0/gtk/gtkscrolledwindow.h:26:2: error: #error "Only <gtk/gtk.h> can be included directly."
make[1]: *** [xwidget.o] Error 1

That's on 1d11624 in the Emacs repository.

> But libnsurses-dev is still a mystery

That's a typo.

-David

Re: merging of the xwidget branch to master

[joakim]

David Engster <deng@randomsample.de> writes:

> Steinar Bang writes:
>>>>>>> joakim@verona.se:
>>
>>> I'm not familiar enough with Debian.
>>
>>> I have a working Dockerfile recipy for Fedora here:
>>> https://github.com/jave/xwidget-aux/blob/master/emacs-xwidget-docker-f20/Dockerfile>
>>> I could do one for Debian as well, but perhaps the Fedora one is good
>>> enough for you to adapt to Debian?
>>
>> Here is a close approximation of the yum package list for debian:
>>  apt-get install git gobject-introspection ncurses-devel
>> libjpeg62-turbo-dev libxpm-dev libjpeg62-dev libtiff5-dev
>> libncurses5-dev libgif-dev texinfo
>
> Next to the usual libraries for building Emacs, you need to install
> libgtk-3-dev, libwebkitgtk-3.0-dev, and libgirepository1.0-dev.
>
> However, it does not build for me:
>
>   CC       xwidget.o
> In file included from xwidget.c:79:0:
> /usr/include/gtk-3.0/gtk/gtkscrolledwindow.h:26:2: error: #error "Only <gtk/gtk.h> can be included directly."
> make[1]: *** [xwidget.o] Error 1
>
> That's on 1d11624 in the Emacs repository.

Thats odd.

I can try to recreate the issue.

Which one of these Dockerfiles resemble your environment?

https://registry.hub.docker.com/_/debian/

>
>> But libnsurses-dev is still a mystery
>
> That's a typo.
>
> -David

-- 
Joakim Verona

Re: merging of the xwidget branch to master

[David Engster]

'joakim' writes:
> David Engster <deng@randomsample.de> writes:
>
>> Steinar Bang writes:
>>>>>>>> joakim@verona.se:
>>>
>>>> I'm not familiar enough with Debian.
>>>
>>>> I have a working Dockerfile recipy for Fedora here:
>>>> https://github.com/jave/xwidget-aux/blob/master/emacs-xwidget-docker-f20/Dockerfile>
>>>> I could do one for Debian as well, but perhaps the Fedora one is good
>>>> enough for you to adapt to Debian?
>>>
>>> Here is a close approximation of the yum package list for debian:
>>>  apt-get install git gobject-introspection ncurses-devel
>>> libjpeg62-turbo-dev libxpm-dev libjpeg62-dev libtiff5-dev
>>> libncurses5-dev libgif-dev texinfo
>>
>> Next to the usual libraries for building Emacs, you need to install
>> libgtk-3-dev, libwebkitgtk-3.0-dev, and libgirepository1.0-dev.
>>
>> However, it does not build for me:
>>
>>   CC       xwidget.o
>> In file included from xwidget.c:79:0:
>> /usr/include/gtk-3.0/gtk/gtkscrolledwindow.h:26:2: error: #error
>> "Only <gtk/gtk.h> can be included directly."
>> make[1]: *** [xwidget.o] Error 1
>>
>> That's on 1d11624 in the Emacs repository.
>
> Thats odd.
>
> I can try to recreate the issue.
>
> Which one of these Dockerfiles resemble your environment?
>
> https://registry.hub.docker.com/_/debian/

That site does not seem to be available at the moment, but the issue
seems simple enough: the GTK people really don't want you to include
specific headers aside from gtk.h. If I remove the include for
gtkscrolledwindow.h, everything compiles fine.

For the record: this is on Debian 7 (Wheezy), which has libgtk3
3.4.2. The header gtkscrolledwindow.h has this as the top:

  #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  #error "Only <gtk/gtk.h> can be included directly."
  #endif

-David

Re: merging of the xwidget branch to master

[joakim]

David Engster <deng@randomsample.de> writes:

> 'joakim' writes:
>> David Engster <deng@randomsample.de> writes:
>>
>>> Steinar Bang writes:
>>>>>>>>> joakim@verona.se:
>>>>
>>>>> I'm not familiar enough with Debian.
>>>>
>>>>> I have a working Dockerfile recipy for Fedora here:
>>>>> https://github.com/jave/xwidget-aux/blob/master/emacs-xwidget-docker-f20/Dockerfile>>>>> I could do one for Debian as well, but perhaps the Fedora one is good
>>>>> enough for you to adapt to Debian?
>>>>
>>>> Here is a close approximation of the yum package list for debian:
>>>>  apt-get install git gobject-introspection ncurses-devel
>>>> libjpeg62-turbo-dev libxpm-dev libjpeg62-dev libtiff5-dev
>>>> libncurses5-dev libgif-dev texinfo
>>>
>>> Next to the usual libraries for building Emacs, you need to install
>>> libgtk-3-dev, libwebkitgtk-3.0-dev, and libgirepository1.0-dev.
>>>
>>> However, it does not build for me:
>>>
>>>   CC       xwidget.o
>>> In file included from xwidget.c:79:0:
>>> /usr/include/gtk-3.0/gtk/gtkscrolledwindow.h:26:2: error: #error
>>> "Only <gtk/gtk.h> can be included directly."
>>> make[1]: *** [xwidget.o] Error 1
>>>
>>> That's on 1d11624 in the Emacs repository.
>>
>> Thats odd.
>>
>> I can try to recreate the issue.
>>
>> Which one of these Dockerfiles resemble your environment?
>>
>> https://registry.hub.docker.com/_/debian/
>
> That site does not seem to be available at the moment, but the issue

Snippet from the docker registry:

Supported tags and respective Dockerfile links

    8.0, 8, jessie (jessie/Dockerfile)
    oldstable (oldstable/Dockerfile)
    sid (sid/Dockerfile)
    6.0.10, 6.0, 6, squeeze (squeeze/Dockerfile)
    stable (stable/Dockerfile)
    testing (testing/Dockerfile)
    unstable (unstable/Dockerfile)
    7.8, 7, wheezy, latest (wheezy/Dockerfile)
    rc-buggy (debian/rc-buggy/Dockerfile)
    experimental (debian/experimental/Dockerfile)

> seems simple enough: the GTK people really don't want you to include
> specific headers aside from gtk.h. If I remove the include for
> gtkscrolledwindow.h, everything compiles fine.
>
> For the record: this is on Debian 7 (Wheezy), which has libgtk3
> 3.4.2. The header gtkscrolledwindow.h has this as the top:
>
>   #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
>   #error "Only <gtk/gtk.h> can be included directly."
>   #endif

Funny that it works on Fedora with the direct include, so I really need
to get a debian compile working to check it.

BTW, did you manage to get the browser working then?

m-x xwidget-webkit-browse-url RET www.fsf.org RET

Then you should be able to scroll the browser with space and bakckspace.



>
> -David

-- 
Joakim Verona

Re: merging of the xwidget branch to master

[David Engster]

'joakim' writes:
> David Engster <deng@randomsample.de> writes:
>
>> 'joakim' writes:
>>> David Engster <deng@randomsample.de> writes:
>>>
>>>> Steinar Bang writes:
>>>>>>>>>> joakim@verona.se:
>>>>>
>>>>>> I'm not familiar enough with Debian.
>>>>>
>>>>>> I have a working Dockerfile recipy for Fedora here:
>>>>>> https://github.com/jave/xwidget-aux/blob/master/emacs-xwidget-docker-f20/Dockerfile>>>>>
>>>>>> I could do one for Debian as well, but perhaps the Fedora one is
>>>>>> good
>>>>>> enough for you to adapt to Debian?
>>>>>
>>>>> Here is a close approximation of the yum package list for debian:
>>>>>  apt-get install git gobject-introspection ncurses-devel
>>>>> libjpeg62-turbo-dev libxpm-dev libjpeg62-dev libtiff5-dev
>>>>> libncurses5-dev libgif-dev texinfo
>>>>
>>>> Next to the usual libraries for building Emacs, you need to install
>>>> libgtk-3-dev, libwebkitgtk-3.0-dev, and libgirepository1.0-dev.
>>>>
>>>> However, it does not build for me:
>>>>
>>>>   CC       xwidget.o
>>>> In file included from xwidget.c:79:0:
>>>> /usr/include/gtk-3.0/gtk/gtkscrolledwindow.h:26:2: error: #error
>>>> "Only <gtk/gtk.h> can be included directly."
>>>> make[1]: *** [xwidget.o] Error 1
>>>>
>>>> That's on 1d11624 in the Emacs repository.
>>>
>>> Thats odd.
>>>
>>> I can try to recreate the issue.
>>>
>>> Which one of these Dockerfiles resemble your environment?
>>>
>>> https://registry.hub.docker.com/_/debian/
>>
>> That site does not seem to be available at the moment, but the issue
>
> Snippet from the docker registry:
>
> Supported tags and respective Dockerfile links

[...]

>     7.8, 7, wheezy, latest (wheezy/Dockerfile)

This. And you need a bunch of packages, of course. I guess these

build-essential, libncurses5-dev, texinfo, liblockfile-dev,
librsvg2-dev, libgif-dev, libtiff-dev, libpng-dev, libjpeg-dev,
libm17n-dev, libotf-dev, libgpm-dev, libdbus-1-dev, autoconf, automake,
autotools-dev, imagemagick, libgtk-3-dev, libwebkitgtk-3.0-dev,
libgirepository1.0-dev

should get you started.

>> seems simple enough: the GTK people really don't want you to include
>> specific headers aside from gtk.h. If I remove the include for
>> gtkscrolledwindow.h, everything compiles fine.
>>
>> For the record: this is on Debian 7 (Wheezy), which has libgtk3
>> 3.4.2. The header gtkscrolledwindow.h has this as the top:
>>
>>   #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
>>   #error "Only <gtk/gtk.h> can be included directly."
>>   #endif
>
> Funny that it works on Fedora with the direct include, so I really need
> to get a debian compile working to check it.
>
> BTW, did you manage to get the browser working then?
>
> m-x xwidget-webkit-browse-url RET www.fsf.org RET
>
> Then you should be able to scroll the browser with space and bakckspace.

Yes.  I can also scroll with <prior> and <next>, while <up> and <down>
show the real trick. Pretty weird and cool at the same time. :-) Great
job.

-David

Re: merging of the xwidget branch to master

[Paul Eggert]

Jonas Bernoulli wrote:
> What additinal packages do I have to install?  I am on Debian and the
> only package I have installed specifically for this is libwebkitgtk-dev.

On Fedora 21, one should install webkitgtk3-devel and 
gobject-introspection-devel; I assume Debian is similar.

Also, use "./configure --with-xwidgets --with-x-toolkit=gtk3".

Re: merging of the xwidget branch to master

[Jonas Bernoulli]

Paul Eggert <eggert@cs.ucla.edu> writes:

> Jonas Bernoulli wrote:
>> What additinal packages do I have to install?  I am on Debian and the
>> only package I have installed specifically for this is libwebkitgtk-dev.
>
> On Fedora 21, one should install webkitgtk3-devel and 
> gobject-introspection-devel; I assume Debian is similar.

There is no gobject-introspecton-dev or similar but I have now also
installed gobject-introspecton, which didn't make a difference.  I also
already had libglib2.0-dev and libglib2.0-0 installed which come with
these files:

$ find /usr/lib -name 'libgobject*'
/usr/lib/x86_64-linux-gnu/libgobject-2.0.a
/usr/lib/x86_64-linux-gnu/libgobject-2.0.so.0
/usr/lib/x86_64-linux-gnu/libgobject-2.0.so
/usr/lib/x86_64-linux-gnu/libgobject-2.0.so.0.3200.4

Ps: I am going on vacation now, so please excuse that I won't respond
    to helpful suggestions anytime soon.

Re: merging of the xwidget branch to master

[Eli Zaretskii]

> From: Jonas Bernoulli <jonas@bernoul.li>
> Date: Sun, 01 Feb 2015 10:55:22 +0100
> Cc: Emacs developers <emacs-devel@gnu.org>
> 
> joakim@verona.se writes:
> 
> > ./configure --with-xwidgets  --with-x-toolkit=gtk3
> 
> What additinal packages do I have to install?  I am on Debian and the
> only package I have installed specifically for this is libwebkitgtk-dev.
> After doing that I still get:
> 
>   What window system should Emacs use?                    x11
>   What toolkit should Emacs use?                          GTK3
>   ...
>   Does Emacs support Xwidgets?                            no
>        Does xwidgets support webkit(requires gtk3)?       no
>        Does xwidgets support gobject introspection?       no

As another comment on the configure script in this area, I would
suggest a prominent error message if xwidgets were requested, but the
configure script decided not to turn on this option.  Currently, it
does that silently (except for the above indication, which can easily
get lost among the others), which IMO is bad UI.  If the user asked
for xwidgets, but we cannot give it, we should complain loudly.

Re: merging of the xwidget branch to master

[Jonas Bernoulli]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Jonas Bernoulli <jonas@bernoul.li>
>> Date: Sun, 01 Feb 2015 10:55:22 +0100
>> Cc: Emacs developers <emacs-devel@gnu.org>
>> 
>> joakim@verona.se writes:
>> 
>> > ./configure --with-xwidgets  --with-x-toolkit=gtk3
>> 
>> What additinal packages do I have to install?  I am on Debian and the
>> only package I have installed specifically for this is libwebkitgtk-dev.
>> After doing that I still get:
>> 
>>   What window system should Emacs use?                    x11
>>   What toolkit should Emacs use?                          GTK3
>>   ...
>>   Does Emacs support Xwidgets?                            no
>>        Does xwidgets support webkit(requires gtk3)?       no
>>        Does xwidgets support gobject introspection?       no
>
> As another comment on the configure script in this area, I would
> suggest a prominent error message if xwidgets were requested, but the
> configure script decided not to turn on this option.  Currently, it
> does that silently (except for the above indication, which can easily
> get lost among the others), which IMO is bad UI.  If the user asked
> for xwidgets, but we cannot give it, we should complain loudly.

I had similar issues with other options, e.g.  `--with-imagemagick'
did not work because the installed version is to old (Debian lagging
behind), but I also got no warning except for the "no" which quickly
scrolled by.

Re: merging of the xwidget branch to master

[Eli Zaretskii]

> From: Jonas Bernoulli <jonas@bernoul.li>
> Cc: joakim@verona.se, emacs-devel@gnu.org
> Date: Mon, 02 Feb 2015 09:43:16 +0100
> 
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> >>   What window system should Emacs use?                    x11
> >>   What toolkit should Emacs use?                          GTK3
> >>   ...
> >>   Does Emacs support Xwidgets?                            no
> >>        Does xwidgets support webkit(requires gtk3)?       no
> >>        Does xwidgets support gobject introspection?       no
> >
> > As another comment on the configure script in this area, I would
> > suggest a prominent error message if xwidgets were requested, but the
> > configure script decided not to turn on this option.  Currently, it
> > does that silently (except for the above indication, which can easily
> > get lost among the others), which IMO is bad UI.  If the user asked
> > for xwidgets, but we cannot give it, we should complain loudly.
> 
> I had similar issues with other options, e.g.  `--with-imagemagick'
> did not work because the installed version is to old (Debian lagging
> behind), but I also got no warning except for the "no" which quickly
> scrolled by.

Showing "no" is already better than what we have with xwidgets.  But I
agree that an explicit error is even better.