buildframework/helium/sf/java/legacy/src/com/nokia/ant/HelpDef.java
author wbernard
Tue, 27 Apr 2010 08:33:08 +0300
changeset 587 85df38eb4012
child 628 7c4a911dc066
permissions -rw-r--r--
helium_9.0-a7879c935424
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
* All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
* This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
* which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
* Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
* Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
* Description: 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
*/
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
package com.nokia.ant;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
import java.util.Iterator;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
import org.apache.tools.ant.BuildEvent;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import org.apache.tools.ant.Project;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
import com.nokia.helium.core.ant.types.*;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
import org.apache.tools.ant.BuildListener;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
import org.apache.tools.ant.BuildLogger;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
 * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
public class HelpDef extends HlmPostDefImpl
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
{
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
     * @param project
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
     *            Object of the project
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
     * @param targetNames
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
     *            Array of target names to execute
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
    public void execute(Project project, String module, String[] targetNames)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
    {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
        String firstTarget;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
        // take target
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
        if (targetNames != null && targetNames.length > 0)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
        {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
            firstTarget = targetNames[0];
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
        else
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
        // no target, so set the default one
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
        {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
            firstTarget = "help";
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
        // If 'help' target is called, just run that and set other
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
        // target names as a property
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
        if (firstTarget.equals("help"))
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
        {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
            displayHelp(project, targetNames, firstTarget);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
        
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
        project.addBuildListener(new UnsubstListener());
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
    class UnsubstListener implements BuildListener {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
        public void buildFinished(BuildEvent event) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
            Project project = event.getProject();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
            String drivenotdef = project.getProperty("build.drive.notdefined");
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
            if (System.getProperty("os.name").toLowerCase().startsWith("win") && drivenotdef != null && drivenotdef.equals("true"))
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
            {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
                String drive = project.getProperty("build.drive");
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
                try {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
                    if (drive != null) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
                        Runtime.getRuntime().exec("subst /d " + drive);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
                    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
                } catch (java.io.IOException e) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
                    e = null; // ignoring the error
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
                }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    82
            }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
        
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
        public void buildStarted(BuildEvent event) { }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
        public void targetStarted(BuildEvent event) { }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
        public void targetFinished(BuildEvent event) { }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
        public void taskStarted(BuildEvent event) { }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    89
        public void taskFinished(BuildEvent event) { }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
        public void messageLogged(BuildEvent event) { }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    93
    private void displayHelp(Project project, String[] targetNames, String firstTarget)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
    {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
        if (targetNames.length > 1)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    96
        {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    97
            project.setProperty("help.target", targetNames[1]);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    98
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    99
        
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   100
        // Set Emacs mode to true for all listeners, so that help text does
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   101
        // not have [echo] at the start of each line
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   102
        Iterator iter = project.getBuildListeners().iterator();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   103
        while (iter.hasNext())
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   104
        {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   105
            BuildListener listener = (BuildListener) iter.next();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   106
            if (listener instanceof BuildLogger)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   107
            {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   108
                BuildLogger logger = (BuildLogger) listener;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   109
                logger.setEmacsMode(true);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   110
            }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   111
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   112
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   113
        // Run the 'help' target
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   114
        project.executeTarget(firstTarget);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   115
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   116
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   117
}