[NETBEANS-1979] Create Mode from client code #1135

phipma · 2019-02-13T17:30:54Z

I have backed out the incompatible API changes and added a ModeUtility class following the advice from @JaroslavTulach. I hope this is better...?

Kind regards
Mark Phipps

Merge upstream

XML String so that a TopComponent may then be programatically docked into that Mode.

Allow any kind of Mode to be created programatically from a ModeConfig XML String so that a TopComponent may then be programatically docked into that Mode. Mark Phipps. mwgphipps@gmail.com mark.phipps@sucfin.com

…ira Issue. Merge branch 'master' of https://github.com/phipma/incubator-netbeans

Merge remote-tracking branch 'upstream/master'

…ending that interface and providing utility helper class.

…ur of extending that interface and providing utility helper class.

JaroslavTulach

I think the changes are OK in general. Consider the few suggested changes, increase specification version of the module in manifest.mf, add @since tag to refer to that version, and also write an entry into apichanges.xml to with references to the new API types.

JaroslavTulach · 2019-02-21T15:34:18Z

platform/core.windows/src/org/netbeans/core/windows/ModeImpl.java



 /** This class is an implementation of Mode interface.
 * It designates 'place' on screen, at wich TopComponent can occure.
 *
 * @author Peter Zavadsky
 */
-public final class ModeImpl implements Mode {
+public final class ModeImpl implements Mode.Xml {


OK, Mode.Xml sounds like a good way to extend the existing interface.

JaroslavTulach · 2019-02-21T15:35:31Z

platform/core.windows/src/org/netbeans/core/windows/WindowManagerImpl.java

@@ -48,7 +50,7 @@
 * @author Peter Zavadsky
 */
 @org.openide.util.lookup.ServiceProvider(service=org.openide.windows.WindowManager.class)
-public final class WindowManagerImpl extends WindowManager implements Workspace {
+public final class WindowManagerImpl extends WindowManager implements Workspace, WindowManager.ModeManager {


Unlike Mode, WindowManager is abstract class - e.g. the methods could be added to it. They would just need some default implementation.

Moving methods back into WindowManager from ModeUtilities.

JaroslavTulach · 2019-02-21T15:38:54Z

platform/core.windows/src/org/netbeans/core/windows/persistence/PersistenceManager.java

@@ -1364,6 +1363,16 @@ public static String escapeTcId4XmlContent (String tcName) {
        }
        return tcName;
    }
+
+    public ModeConfig createModeFromXml(String xml) throws IOException {
+        ModeParser modeParser = ModeParser.parseFromString("NO_NAME_YET", new HashSet(1));


We used to add // NOI18N to mark strings that shouldn't be translated. Having them in some static final String constant would be even better, especially when used sever times.

new HashSet(1) seems strange. Such size cannot even access a single element (as the ratio is 0.75 by default and 1 * 0.75 < 1), is that what you wanted?

I copied HashSet(1) from the original code in WindowManagerParser:

/** * Loads Mode configuration from the given file. * @param fo * @return * @throws IOException * @since 2.70 */ public static ModeConfig loadModeConfigFrom( FileObject fo ) throws IOException { String modeName = fo.getName(); ModeParser parser = new ModeParser(modeName, new HashSet(1)); parser.setInLocalFolder(true); parser.setLocalParentFolder(fo.getParent()); return parser.load(); }

That was the only occurrence of calling that ctor without a Set of TopComponent names I think...

Changing to static final and default HashSet ctor.

JaroslavTulach · 2019-02-21T15:44:04Z

platform/core.windows/test/unit/src/org/netbeans/core/windows/ModeManagerTest.java

+ *
+ * @author Mark Phipps
+ */
+public class ModeManagerTest extends NbTestCase {


OK, this looks like a test that tests something.

Changed name to WindowManagerModeTest.

JaroslavTulach · 2019-02-21T15:44:10Z

platform/core.windows/test/unit/src/org/netbeans/core/windows/ModeManagerTest.java

+        // Remove unwanted Modes.
+        for (Mode mode: wm.getModes()) {
+            if (mode.getName().startsWith("anonymous")) {
+                ModeUtility.removeMode(wm, mode);


ModeUtility!?

This will just be wm.removeMode(mode);

JaroslavTulach · 2019-02-21T15:48:51Z

platform/openide.windows/src/org/openide/windows/ModeUtility.java

+ * @see http://wiki.apidesign.org/wiki/ExtendingInterfaces
+ * 
+ * @author Mark Phipps
+ */


If we want to go this path of static utility helper method class, then I'd suggest to use ModeUtilities name. And again @since tag.

Renaming to ModeUtilities.

JaroslavTulach · 2019-02-21T15:50:40Z

platform/openide.windows/src/org/openide/windows/ModeUtility.java

+     * @param windowManager typically WindowManager.getDefault()
+     * @param xml the XML that was originally produced by {@link #toXml}
+     */
+    public final static void createModeFromXml(WindowManager windowManager, String xml) {


Strange parameters. I'd expect the method to call WindowManager.getDefault() itself.

Shouldn't the method return Mode or null? How can one distinguish between success and failure?

Yes - Changing to better indicate success or failure.

JaroslavTulach · 2019-02-21T15:51:27Z

platform/openide.windows/src/org/openide/windows/ModeUtility.java

+     * @param mode the {@link Mode} to remove
+     * @return success if the Mode can no longer be found in the Window Manager
+     */
+    public final static boolean removeMode(WindowManager windowManager, Mode mode) {


What about Mode.Xml.remove()?

That's an interface - not sure what you mean...

Yeah, it is an interface, but a newly defined one. E.g. it is possible to put new methods into it, right?

Sure, but at the point of removing a Mode from the WindowManager, there is no XML in play.
A Mode doesn't have to be an instance of Mode.XML to be removed. As far as I can see all Modes are ModeImpls anyway, which are defined with XML and the Mode.XML interface and ModeUtilities class provides the non-breaking-api way of accessing that.

Now I implemented the remove(), updateConstraints() and createMode() methods as abstract methods of WindowManager as you suggested.

Maybe you can judge these changes on my next push?

JaroslavTulach · 2019-02-21T15:51:52Z

platform/openide.windows/src/org/openide/windows/ModeUtility.java

+     * @param windowManager typically WindowManager.getDefault()
+     * @param xml the XML that was originally produced by {@link #toXml}
+     */
+    public final static void updateModeConstraintsFromXml(WindowManager windowManager, String xml) {


What about Mode.Xml.updateConstraints(String)?

Likewise your previous comment.

JaroslavTulach · 2019-02-21T15:52:26Z

platform/openide.windows/src/org/openide/windows/WindowManager.java

+     * Modes directly.
+     * 
+     * @see ModeXml
+     */


Missing @since tag.

Hi Jaroslav,

What should I change the version to? Currently manifest contents are:

Manifest-Version: 1.0 OpenIDE-Module: org.openide.windows OpenIDE-Module-Specification-Version: 6.80 OpenIDE-Module-Localizing-Bundle: org/openide/windows/Bundle.properties AutoUpdate-Essential-Module: true

Changing it to 6.81 Hope that's correct.

Not anymore. The current version is 6.81. You need to add something - at least 6.82.

OK - changed to 6.82 just now.

phipma · 2019-02-26T17:50:56Z

Thanks @JaroslavTulach I will make the changes you suggest as soon as I have time.

lkishalmi · 2019-03-09T05:08:58Z

Just added WIP label until the requested changes arrive.

@SInCE

Better indication of success or failure of Mode operations, rename ModeUtility to ModeUtilities, use abstract methods in WindowManager, update manifest.mf with 6.81, update apichanges.xml, add @SInCE tags.

phipma · 2019-03-18T15:17:39Z

Changes pushed, please check.
Thanks, Mark

phipma · 2019-03-26T18:11:25Z

Hi @JaroslavTulach , @lkishalmi, I can't change the work-in-progress label myself - don't know what to do to prompt a review of these latest changes, but they are ready when you are...
Cheers
Mark

phipma · 2019-05-14T17:36:56Z

Hi Fellas, @geertjanw @JaroslavTulach @lkishalmi do you have scope to progress this PR at all? Should I be doing something...?

geertjanw · 2019-05-14T18:03:41Z

Is there anything from your point of view that needs to be done? How confident are you of this one?

geertjanw · 2019-05-14T19:33:33Z

Removed that label, if it helps.

phipma · 2019-05-15T08:24:13Z

All done as far as I am concerned, I was hoping Jaroslav would review again and confirm "OpenIDE-Module-Specification-Version: 6.80"
#1135 (comment)

phipma · 2019-05-15T08:25:12Z

Sorry, I mean "OpenIDE-Module-Specification-Version: 6.81"

…beans into Create_Mode

geertjanw · 2019-05-16T17:02:32Z

Hi Mark, awesome work, and what do you think re iCLA, i.e., see this discussion:

https://lists.apache.org/thread.html/b379e8de4d8a7c835a72390a19cbde15bc598038e6bffa878872ed68@%3Cdev.netbeans.apache.org%3E

junichi11 · 2019-05-16T22:44:15Z

Maybe, we should squash and merge.

geertjanw · 2019-05-16T22:45:20Z

Ideally, @phipma would send in an iCLA first, just need to hear from him how he feels about that.

junichi11 · 2019-05-16T23:02:22Z

Yes :) I don't think that we should merge this PR as it is. So, I think @phipma should rebase and squash himself then push(force) it if possible ;)

phipma · 2019-05-17T10:29:09Z

I have sent the ICLA. My git skills are limited - I did a squash before, but not rebase... Can someone outline the steps I should take please?

junichi11 · 2019-05-17T11:39:51Z

I have sent the ICLA.

Great!

@phipma If you accept that we merge your changes as ONE commit, we can do that via the "Squash and merge" button. Otherwise, you should squash your changes properly yourself. (e.g. see https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)
@matthiasblaesing Could you please give @phipma some advice if possible?
Thanks.

phipma · 2019-05-17T11:43:11Z

Please go ahead and use the "squash and merge" button! Let's just get this done!

junichi11 · 2019-05-17T11:51:26Z

@phipma OK, thank you! BTW, did you look at this? #1135 (comment)
If changes are needed, please push commits :)

@geertjanw Let's squash and merge if there is no problem after the iCLA is accepted :)

…-netbeans into Create_Mode

…eans into Create_Mode

phipma · 2019-05-23T08:48:20Z

Hi @geertjanw, @junichi11 my ICLA was accepted last week, so is there anything else I need to do before you can squash and merge? Let me know if there is, thanks.

junichi11 · 2019-05-24T00:59:40Z

platform/core.windows/src/org/netbeans/core/windows/WindowManagerImpl.java

@@ -1531,7 +1595,7 @@ public void run() {
            if (IDESettings.isGui()) {
                // running in GUI mode, but
                if (!WindowManagerImpl.getInstance().isVisible()) {
-                    // window manager isn't yet visible => exit for now
+                        // window manager isn't yet visible => exit for now


Please remove whitespaces.

junichi11 · 2019-05-24T01:03:07Z

platform/core.windows/src/org/netbeans/core/windows/persistence/WindowManagerParser.java

+     * @return All the known modes in the XML configuration that they would
+     * be saved to disk as.
+     * @throws IOException
+     */


Maybe, the below is better. (* positions)

/** Extract all ModeConfigs in XML. * * @param wmc * @return All the known modes in the XML configuration that they would * be saved to disk as. * @throws IOException */

junichi11 · 2019-05-24T01:03:38Z

platform/core.windows/src/org/netbeans/core/windows/persistence/WindowManagerParser.java

    }
-
-    private void writeGroups (WindowManagerConfig wmc) throws IOException {
+


Please remove whitespaces.

junichi11 · 2019-05-24T01:12:52Z

@phipma I'm not sure about this area. So I've just had a look at formatting. Please have a look at the comments.

I'm going to merge this later because @JaroslavTulach has already approved this PR.
Any objections?

junichi11 · 2019-05-24T01:16:16Z

I've confirmed that "Mark Phipps" exists in http://people.apache.org/unlistedclas.html.

junichi11 · 2019-05-24T03:04:56Z

@phipma BTW, we should fix the commit message when we squash & merge via the button. Your commit messages are used as a list by default.

e.g.

* Merge remote-tracking branch 'apache/master'

* Merge pull request #1 from apache/master

* Allow any kind of Mode to be created programatically from a ModeConfig

* ...

* ...

Commit message title is this PR one, maybe.

So, please let us know the commit message you expect. Thanks!

phipma · 2019-05-24T08:59:53Z

@junichi11 I have made the changes you suggested: removed white space and reformatted comments.
I think the commit message that best describes the original intent of this pull request is, "Allow any kind of Mode to be created programatically from a ModeConfig XML String so that a TopComponent may then be programatically docked into that Mode."

So please use that when you squash and merge.
Many thanks,
Mark

junichi11 · 2019-05-25T00:15:22Z

@phipma Merged. Thank you for your contribution!

Allow any kind of Mode to be created programatically from a ModeConfig XML String so that a TopComponent may then be programatically docked into that Mode.

phipma added 13 commits October 31, 2018 21:14

Merge remote-tracking branch 'apache/master'

1b9cd72

Merge pull request #1 from apache/master

5e1d6d0

Merge upstream

Allow any kind of Mode to be created programatically from a ModeConfig

cc170aa

XML String so that a TopComponent may then be programatically docked into that Mode.

[NETBEANS-1979] Allow Modes to be created programatically.

e1eb6e7

Allow any kind of Mode to be created programatically from a ModeConfig XML String so that a TopComponent may then be programatically docked into that Mode. Mark Phipps. mwgphipps@gmail.com mark.phipps@sucfin.com

I changed the earlier commit message to include the [NETBEANS-1979] J…

4d9135e

…ira Issue. Merge branch 'master' of https://github.com/phipma/incubator-netbeans

Merge remote-tracking branch 'upstream/master'

8ab4e6f

Merge pull request #2 from apache/master

131f700

Merge remote-tracking branch 'upstream/master'

[NETBEANS-1979] Backout changes to original Mode api in favour of ext…

ed8f577

…ending that interface and providing utility helper class.

[NETBEANS-1979] Backout changes to original WindowManager api in favo…

bd968d6

…ur of extending that interface and providing utility helper class.

Added some more javadoc.

3887f56

Renamed ModeXml to ModeUtility.

72b74e4

Added unit tests.

4e92d2a

Added unit tests.

415db57

JaroslavTulach approved these changes Feb 21, 2019

View reviewed changes

lkishalmi added the work-in-progress label Mar 9, 2019

[NETBEANS-1979] Modifications suggested by Jaroslav on 21 Feb 2019:

d3defb1

Better indication of success or failure of Mode operations, rename ModeUtility to ModeUtilities, use abstract methods in WindowManager, update manifest.mf with 6.81, update apichanges.xml, add @SInCE tags.

phipma added 2 commits May 14, 2019 11:12

Merge remote-tracking branch 'upstream/master'

1d45c36

Merge branch 'master' into Create_Mode

6eeaa0b

geertjanw removed the work-in-progress label May 14, 2019

phipma added 2 commits May 15, 2019 13:18

Setting OpenIDE-Module-Specification-Version to 6.82

4212be8

Merge branch 'master' into Create_Mode

b4ccaae

phipma added 4 commits May 15, 2019 13:34

Setting OpenIDE-Module-Specification-Version to 6.82

a2222c9

Setting OpenIDE-Module-Specification-Version to 6.82

bf03d49

Merge branch 'Create_Mode' of https://github.com/phipma/incubator-net…

dc327a0

…beans into Create_Mode

Merge branch 'master' into Create_Mode

05dd01e

junichi11 added the Need Squashing label May 16, 2019

phipma added 5 commits May 17, 2019 13:05

[NETBEANS-1979] Added @SInCE 6.82.

0d3e991

Merge branch 'Create_Mode' of /home/mark/Development/github/incubator…

a791e8b

…-netbeans into Create_Mode

[NETBEANS-1979] Added @SInCE 6.82.

6702092

Merge remote-tracking branch 'upstream/master'

d07893b

Merge branch 'master' of /home/mark/Development/github/incubator-netb…

8c4f408

…eans into Create_Mode

junichi11 reviewed May 24, 2019

View reviewed changes

[NETBEANS-1979] Removed white space and re-aligned comments.

554e0e3

junichi11 merged commit 3b6c4f5 into apache:master May 25, 2019

		}

		private void writeGroups (WindowManagerConfig wmc) throws IOException {

[NETBEANS-1979] Create Mode from client code #1135

[NETBEANS-1979] Create Mode from client code #1135

Conversation

phipma commented Feb 13, 2019

JaroslavTulach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phipma commented Feb 26, 2019

lkishalmi commented Mar 9, 2019

phipma commented Mar 18, 2019

phipma commented Mar 26, 2019

phipma commented May 14, 2019

geertjanw commented May 14, 2019

geertjanw commented May 14, 2019

phipma commented May 15, 2019

phipma commented May 15, 2019

geertjanw commented May 16, 2019

junichi11 commented May 16, 2019

geertjanw commented May 16, 2019

junichi11 commented May 16, 2019

phipma commented May 17, 2019

junichi11 commented May 17, 2019 • edited Loading

phipma commented May 17, 2019

junichi11 commented May 17, 2019 • edited Loading

phipma commented May 23, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

junichi11 commented May 24, 2019

junichi11 commented May 24, 2019

junichi11 commented May 24, 2019

phipma commented May 24, 2019

junichi11 commented May 25, 2019

junichi11 commented May 17, 2019 •

edited

Loading

junichi11 commented May 17, 2019 •

edited

Loading