package org.apache.maven.plugin.patch;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import org.apache.maven.plugin.AbstractMojo;

 import org.apache.maven.plugin.MojoExecutionException;

 /**

  * Display help information on maven-patch-plugin.<br/> Call <pre>  mvn patch:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.

  *

  * @version generated on Fri Jan 01 15:35:23 CET 2010

  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.5.1)

  * @goal help

  * @requiresProject false

  */

 public class HelpMojo

     extends AbstractMojo

 {

     /**

      * If <code>true</code>, display all settable properties for each goal.

      * 

      * @parameter expression="${detail}" default-value="false"

      */

     private boolean detail;

     /**

      * The name of the goal for which to show help. If unspecified, all goals will be displayed.

      * 

      * @parameter expression="${goal}"

      */

     private java.lang.String goal;

     /**

      * The maximum length of a display line, should be positive.

      * 

      * @parameter expression="${lineLength}" default-value="80"

      */

     private int lineLength;

     /**

      * The number of spaces per indentation level, should be positive.

      * 

      * @parameter expression="${indentSize}" default-value="2"

      */

     private int indentSize;

     /** {@inheritDoc} */

     public void execute()

         throws MojoExecutionException

     {

         if ( lineLength <= 0 )

         {

             getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );

             lineLength = 80;

         }

         if ( indentSize <= 0 )

         {

             getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );

             indentSize = 2;

         }

         StringBuffer sb = new StringBuffer();

         append( sb, "org.apache.maven.plugins:maven-patch-plugin:1.1.1", 0 );

         append( sb, "", 0 );

         append( sb, "Maven Patch Plugin", 0 );

         append( sb, "The Patch Plugin is used to apply patches to source files.", 1 );

         append( sb, "", 0 );

         if ( goal == null || goal.length() <= 0 )

         {

             append( sb, "This plugin has 2 goals:", 0 );

             append( sb, "", 0 );

         }

         if ( goal == null || goal.length() <= 0 || "apply".equals( goal ) )

         {

             append( sb, "patch:apply", 0 );

             append( sb, "Apply one or more patches to project sources.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "backups (Default: false)", 2 );

                 append( sb, "Whether to make backups of the original files before modding them.", 3 );

                 append( sb, "", 0 );

                 append( sb, "destFile", 2 );

                 append( sb, "The output file which is the original file, plus modifications from the patch. By default, the file(s) will be patched inplace.", 3 );

                 append( sb, "", 0 );

                 append( sb, "failFast (Default: true)", 2 );

                 append( sb, "Flag being true if the desired behavior is to fail the build on the first failed patch detected.", 3 );

                 append( sb, "", 0 );

                 append( sb, "failurePhrases", 2 );

                 append( sb, "List of phrases to watch for in the command output from the patch tool. If one is found, it will cause the build to fail. All phrases should be lower-case only. By default, the phrases fail, skip and reject are used.", 3 );

                 append( sb, "", 0 );

                 append( sb, "ignoredPatches", 2 );

                 append( sb, "When the strictPatching flag is set, this parameter is useful to mark certain contents of the patch-source directory that should be ignored without causing the build to fail.", 3 );

                 append( sb, "", 0 );

                 append( sb, "ignoreWhitespace (Default: true)", 2 );

                 append( sb, "Whether to ignore whitespaces when applying the patches.", 3 );

                 append( sb, "", 0 );

                 append( sb, "naturalOrderProcessing (Default: false)", 2 );

                 append( sb, "Setting natural order processing to true will cause all patches in a directory to be processed in a natural order alleviating the need to declare patches directly in the project file.", 3 );

                 append( sb, "", 0 );

                 append( sb, "optimizations (Default: true)", 2 );

                 append( sb, "Flag to enable/disable optimization file from being written. This file tracks the patches that were applied the last time this goal actually executed. It is required for cases where project-sources optimizations are enabled, since project-sources will not be re-unpacked if they are at least as fresh as the source archive. If we avoid re-unpacking project sources, we need to make sure we don\'t reapply patches.\nNote: If the list of patches changes and this flag is enabled, a \'mvn clean\' must be executed before the next build, to remove the tracking file.", 3 );

                 append( sb, "", 0 );

                 append( sb, "originalFile", 2 );

                 append( sb, "The original file which will be modified by the patch. By default, the patch tool will automatically derive the original file from the header of the patch file.", 3 );

                 append( sb, "", 0 );

                 append( sb, "patchDirectory (Default: src/main/patches)", 2 );

                 append( sb, "The base directory for the file names specified by the parameter patches.", 3 );

                 append( sb, "", 0 );

                 append( sb, "patches", 2 );

                 append( sb, "The list of patch file names, supplying the order in which patches should be applied. The path names in this list must be relative to the base directory specified by the parameter patchDirectory. This parameter is mutually exclusive with the patchfile parameter.", 3 );

                 append( sb, "", 0 );

                 append( sb, "patchFile", 2 );

                 append( sb, "The single patch file to apply. This parameter is mutually exclusive with the patches parameter.", 3 );

                 append( sb, "", 0 );

                 append( sb, "patchTrackingFile (Default: ${project.build.directory}/optimization-files/patches-applied.txt)", 2 );

                 append( sb, "This is the tracking file used to maintain a list of the patches applied to the unpacked project sources which are currently in the target directory. If this file is present, and project-source unpacking is optimized (meaning it won\'t re-unpack unless the project-sources archive is newer), this goal will not execute and no patches will be applied in the current build.", 3 );

                 append( sb, "", 0 );

                 append( sb, "removeEmptyFiles (Default: false)", 2 );

                 append( sb, "When set to true, the empty files resulting from the patching process are removed. Empty ancestor directories are removed as well.", 3 );

                 append( sb, "", 0 );

                 append( sb, "reverse (Default: false)", 2 );

                 append( sb, "Whether to treat these patches as having reversed source and dest in the patch syntax.", 3 );

                 append( sb, "", 0 );

                 append( sb, "skipApplication (Default: false)", 2 );

                 append( sb, "Whether to skip this goal\'s execution.", 3 );

                 append( sb, "", 0 );

                 append( sb, "strictPatching (Default: false)", 2 );

                 append( sb, "Flag that, when set to true, will make sure that all patches included in the patches list must be present and describe the full contents of the patch directory. If strictPatching is set to true, and the patches list has a value that does not correspond to a file in the patch directory, the build will fail. If strictPatching is set to true, and the patch directory contains files not listed in the patches parameter, the build will fail. If set to false, only the patches listed in the patches parameter that have corresponding files will be applied; the rest will be ignored.", 3 );

                 append( sb, "", 0 );

                 append( sb, "strip (Default: 0)", 2 );

                 append( sb, "The number of directories to be stripped from patch file paths, before applying, starting from the leftmost, or root-est.", 3 );

                 append( sb, "", 0 );

                 append( sb, "targetDirectory (Default: ${project.build.sourceDirectory})", 2 );

                 append( sb, "The target directory for applying patches. Files in this directory will be modified.", 3 );

                 append( sb, "", 0 );

                 append( sb, "useDefaultIgnores (Default: true)", 2 );

                 append( sb, "Whether to exclude default ignored patch items, such as .svn or CVS directories.", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )

         {

             append( sb, "patch:help", 0 );

             append( sb, "Display help information on maven-patch-plugin.\nCall\n\u00a0\u00a0mvn\u00a0patch:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "detail (Default: false)", 2 );

                 append( sb, "If true, display all settable properties for each goal.", 3 );

                 append( sb, "", 0 );

                 append( sb, "goal", 2 );

                 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );

                 append( sb, "", 0 );

                 append( sb, "indentSize (Default: 2)", 2 );

                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );

                 append( sb, "", 0 );

                 append( sb, "lineLength (Default: 80)", 2 );

                 append( sb, "The maximum length of a display line, should be positive.", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( getLog().isInfoEnabled() )

         {

             getLog().info( sb.toString() );

         }

     }

     /**

      * <p>Repeat a String <code>n</code> times to form a new string.</p>

      *

      * @param str String to repeat

      * @param repeat number of times to repeat str

      * @return String with repeated String

      * @throws NegativeArraySizeException if <code>repeat < 0</code>

      * @throws NullPointerException if str is <code>null</code>

      */

     private static String repeat( String str, int repeat )

     {

         StringBuffer buffer = new StringBuffer( repeat * str.length() );

         for ( int i = 0; i < repeat; i++ )

         {

             buffer.append( str );

         }

         return buffer.toString();

     }

     /** 

      * Append a description to the buffer by respecting the indentSize and lineLength parameters.

      * <b>Note</b>: The last character is always a new line.

      * 

      * @param sb The buffer to append the description, not <code>null</code>.

      * @param description The description, not <code>null</code>.

      * @param indent The base indentation level of each line, must not be negative.

      */

     private void append( StringBuffer sb, String description, int indent )

     {

         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )

         {

             sb.append( it.next().toString() ).append( '\n' );

         }

     }

     /** 

      * Splits the specified text into lines of convenient display length.

      * 

      * @param text The text to split into lines, must not be <code>null</code>.

      * @param indent The base indentation level of each line, must not be negative.

      * @param indentSize The size of each indentation, must not be negative.

      * @param lineLength The length of the line, must not be negative.

      * @return The sequence of display lines, never <code>null</code>.

      * @throws NegativeArraySizeException if <code>indent < 0</code>

      */

     private static List toLines( String text, int indent, int indentSize, int lineLength )

     {

         List lines = new ArrayList();

         String ind = repeat( "\t", indent );

         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );

         for ( int i = 0; i < plainLines.length; i++ )

         {

             toLines( lines, ind + plainLines[i], indentSize, lineLength );

         }

         return lines;

     }

     /** 

      * Adds the specified line to the output sequence, performing line wrapping if necessary.

      * 

      * @param lines The sequence of display lines, must not be <code>null</code>.

      * @param line The line to add, must not be <code>null</code>.

      * @param indentSize The size of each indentation, must not be negative.

      * @param lineLength The length of the line, must not be negative.

      */

     private static void toLines( List lines, String line, int indentSize, int lineLength )

     {

         int lineIndent = getIndentLevel( line );

         StringBuffer buf = new StringBuffer( 256 );

         String[] tokens = line.split( " +" );

         for ( int i = 0; i < tokens.length; i++ )

         {

             String token = tokens[i];

             if ( i > 0 )

             {

                 if ( buf.length() + token.length() >= lineLength )

                 {

                     lines.add( buf.toString() );

                     buf.setLength( 0 );

                     buf.append( repeat( " ", lineIndent * indentSize ) );

                 }

                 else

                 {

                     buf.append( ' ' );

                 }

             }

             for ( int j = 0; j < token.length(); j++ )

             {

                 char c = token.charAt( j );

                 if ( c == '\t' )

                 {

                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );

                 }

                 else if ( c == '\u00A0' )

                 {

                     buf.append( ' ' );

                 }

                 else

                 {

                     buf.append( c );

                 }

             }

         }

         lines.add( buf.toString() );

     }

     /** 

      * Gets the indentation level of the specified line.

      * 

      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.

      * @return The indentation level of the line.

      */

     private static int getIndentLevel( String line )

     {

         int level = 0;

         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )

         {

             level++;

         }

         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )

         {

             if ( line.charAt( i ) == '\t' )

             {

                 level++;

                 break;

             }

         }

         return level;

     }

 }