Bug 14732 – [gtk] Rename *Gdk to *Gtk

• Component: New Bugs
• Status: RESOLVED FIXED

[Holger Freyther]

Rename the WebKit/Gdk port to WebKit/Gtk. This should involve renaming the library and the files currently named *Gdk.
The question is what to do with the WebKitGtk namespace as WebKitGtk::FrameLoaderClientGtk looks redundant. Proposal would be to remove the Gtk from the namespace once we do the renaming.

Someone should prepare a script to do the renaming as svn-create-patch could be error prone.

[Adam Roben (:aroben)]

(In reply to comment #0)
> Rename the WebKit/Gdk port to WebKit/Gtk. This should involve renaming the
> library and the files currently named *Gdk.
> The question is what to do with the WebKitGtk namespace as
> WebKitGtk::FrameLoaderClientGtk looks redundant. Proposal would be to remove
> the Gtk from the namespace once we do the renaming.

   I think removing Gtk from both the namespace and the class names is good. WebKit::FrameLoaderClient is all you need.

> Someone should prepare a script to do the renaming as svn-create-patch could be
> error prone.

You should use WebKitTools/Scripts/do-{webcore,file}-rename to accomplish this. It's been used a few times before for tasks like this.

[Holger Freyther]

Add the Gtk keyword, even to the curl bugs.

[Juan A. Suarez]

Created attachment 15953 [details]
Rename files from *Gdk to *Gtk (first part)

This is the first part of the patch to fix this bug.

It renames files from *Gdk* to *Gtk*. Unfortunately, some directories couldn't be renamed, as subversion warns me that first it requires to do a commit first with the changes done.

This patch doesn't changes the API at all, but changes the Launcher, which now is called GtkLauncher. Anyway, both the launcher and the build system could still be called using '--gdk' option.

In the future I pretend upload to new patches.

  1) A patch that definitely changes all references from gdk to gtk (in the names of files and directories). This requires to commit the present patch.

  2) A patch that changes the gdk references in the API code. This will be done following the comments.

[Juan A. Suarez]

Created attachment 16008 [details]
Rename files from *Gdk to *Gtk (first part).

This patch changes the previous patch by adding a script to do the task.

At now, it renames all *Gdk files to *Gtk files, and updates the references in the  source code.

Besides this, the new library is WebKitGtk (instead of WebKitGdk), and the launcher becomes GtkLauncher.

Two changes are not done yet in this patch:

   * The scripts still uses "--gdk" option instead of "--gtk" option.
   * The directories were not renamed. This is due because we can't rename both the directories and its contents at the same time. So this script only renames the files inside the directories. ASAP they will be commited in the trunk, a patch to rename the directories will be uploaded.
   * The functions were not renamed. So we have, as example, "RenderThemeGdk" object instead of "RenderTheme". This task will be done in future.

[Adam Roben (:aroben)]

Comment on attachment 16008 [details]
Rename files from *Gdk to *Gtk (first part).

I think it would be better to use the do-webcore-rename script for this purpose. It has been used before and should work as desired.

[Holger Freyther]

Do we have any examples for do-webcore-rename? The script itself has no documentation and a grep didn't expose any examples.

[Adam Roben (:aroben)]

(In reply to comment #6)
> Do we have any examples for do-webcore-rename? The script itself has no
> documentation and a grep didn't expose any examples.

All you have to do is modify the %renames hash (some examples are included in the script):

my %renames = ( 
    "xxx" => "yyy",
    #"KURL" => "PlatformURL",
    #"KURLMac" => "PlatformURLMac",
    #"KURL_H_" => "PlatformURL_h",
);

[Juan A. Suarez]

(In reply to comment #5)
> (From update of attachment 16008 [details] [edit])
> I think it would be better to use the do-webcore-rename script for this
> purpose. It has been used before and should work as desired.
> 

So, how should I do the patch? Modifying the script itself, or creating a new copy from it?

[Adam Roben (:aroben)]

(In reply to comment #8)
> (In reply to comment #5)
> > (From update of attachment 16008 [details] [edit] [edit])
> > I think it would be better to use the do-webcore-rename script for this
> > purpose. It has been used before and should work as desired.
> > 
> 
> So, how should I do the patch? Modifying the script itself, or creating a new
> copy from it?

   Probably the best thing to do would be to modify the script locally to do the renames that you want, run the script, ensure everything builds and runs, then make a diff of the result and post it here as a patch. When you upload the patch, you can also paste into Bugzilla your %renames hash from the script that you used.

[Juan A. Suarez]

Created attachment 16054 [details]
Rename files from *Gdk to *Gtk (first part)

This patch is the result of using do-webcore-rename to do the rename from *Gdk to *Gtk.

This patch only renames the files.

[Juan A. Suarez]

Created attachment 16055 [details]
Hash files renamed

Here is a patch with the files renamed to be applied to do-webcore-rename.

[Adam Roben (:aroben)]

Comment on attachment 16055 [details]
Hash files renamed

This looks good to me. A committer should apply this patch, run the script, and commit the result with your ChangeLog from attachment 16054 [details]. I think also that some new *Gdk files have been added since this patch was uploaded -- perhaps the person running the script can add those as well.

[Adam Roben (:aroben)]

Comment on attachment 16054 [details]
Rename files from *Gdk to *Gtk (first part)

Clearing review flag since we'll want someone to run the script rather than commit this directly.

[Holger Freyther]

I have http://page.mi.fu-berlin.de/freyther/webkit/webkit-gdk-to-gtk-renaming-r0.patch (http://page.mi.fu-berlin.de/freyther/webkit/webkit-gdk-to-gtk-renaming.diff which includes the change to the hash as well) applied in my working copy and I'm ready to do a commit.

Additionally to the script I'm also changing the cmd line options and defines from gdk to gtk and rename the directories. I can do these things in two different commits but have waited for alp to spare a comment.

[Holger Freyther]

Created attachment 16361 [details]
The used hash for the renames

Just for reference.

[Holger Freyther]

Landed in r25703.

[Holger Freyther]

*** Bug 14497 has been marked as a duplicate of this bug. ***