package org.andromda.maven.plugin.bootstrap;
   
   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 andromda-bootstrap-plugin.<br/> Call <pre>  mvn andromda-bootstrap:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
   *
   * @version generated on Thu Sep 18 15:54:13 EDT 2014
   * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.9)
   * @goal help
   * @requiresProject false
   * @threadSafe
   */
  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.andromda.maven.plugins:andromda-bootstrap-plugin:3.5-SNAPSHOT", 0 );
          append( sb, "", 0 );
  
          append( sb, "AndroMDA Bootstrap Plugin", 0 );
          append( sb, "A plugin used to run AndroMDA in \'bootstrap\' mode", 1 );
          append( sb, "", 0 );
  
          if ( goal == null || goal.length() <= 0 )
          {
              append( sb, "This plugin has 3 goals:", 0 );
              append( sb, "", 0 );
          }
  
          if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
          {
              append( sb, "andromda-bootstrap:help", 0 );
              append( sb, "Display help information on andromda-bootstrap-plugin.\nCall\n\u00a0\u00a0mvn\u00a0andromda-bootstrap: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, "Expression: ${detail}", 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, "Expression: ${goal}", 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, "Expression: ${indentSize}", 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, "Expression: ${lineLength}", 3 );
                 append( sb, "", 0 );
             }
         }
 
         if ( goal == null || goal.length() <= 0 || "run".equals( goal ) )
         {
             append( sb, "andromda-bootstrap:run", 0 );
             append( sb, "This is exactly the same as the regular AndroMDAMojo in the andromda-maven-plugin, however this is the bootstrap plugin which is used to run AndroMDA in bootstrap mode (with the bootstrap artifacts).", 1 );
             append( sb, "", 0 );
             if ( detail )
             {
                 append( sb, "Available parameters:", 1 );
                 append( sb, "", 0 );
 
                 append( sb, "buildSourceDirectory", 2 );
                 append( sb, "The directory to which the build source is located (any generated source).", 3 );
                 append( sb, "Expression: ${project.build.directory}/src/main/java", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "configurationUri", 2 );
                 append( sb, "This is the URI to the AndroMDA configuration file.", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: file:${basedir}/conf/andromda.xml", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "lastModifiedCheck", 2 );
                 append( sb, "Whether or not a last modified check should be performed before running AndroMDA again.", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: false", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "modelOutputHistory", 2 );
                 append( sb, "The directory where the model generation output history is located (Modelname file containing a list of files generated by that model).", 3 );
                 append( sb, "Expression: ${project.build.directory}/history", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "propertyFiles", 2 );
                 append( sb, "(no description available)", 3 );
                 append( sb, "Expression: ${project.build.filters}", 3 );
                 append( sb, "", 0 );
             }
         }
 
         if ( goal == null || goal.length() <= 0 || "test-translation-library".equals( goal ) )
         {
             append( sb, "andromda-bootstrap:test-translation-library", 0 );
             append( sb, "The bootstrap version of the translation-library test.", 1 );
             append( sb, "", 0 );
             if ( detail )
             {
                 append( sb, "Available parameters:", 1 );
                 append( sb, "", 0 );
 
                 append( sb, "configurationUri", 2 );
                 append( sb, "This is the URI to the AndroMDA configuration file.", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: file:${basedir}/conf/test/andromda.xml", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "propertyFiles", 2 );
                 append( sb, "(no description available)", 3 );
                 append( sb, "Expression: ${project.build.filters}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "reportDirectory", 2 );
                 append( sb, "Base directory to which the cartridge test report is written", 3 );
                 append( sb, "Expression: ${project.build.directory}/translation-library-test/reports", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "skip", 2 );
                 append( sb, "Set this to \'true\' to bypass cartridge tests entirely. Its use is NOT RECOMMENDED, but quite convenient on occasion.", 3 );
                 append( sb, "Expression: ${maven.test.skip}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "skipTests", 2 );
                 append( sb, "Set this to \'true\' to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.", 3 );
                 append( sb, "Expression: ${skipTests}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "testFailureIgnore (Default: false)", 2 );
                 append( sb, "Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.", 3 );
                 append( sb, "Expression: ${maven.test.failure.ignore}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "traceExpression", 2 );
                 append( sb, "Whether or not the expression shall be \'traced\' (i.e. the TraceTranslator will run instead of the specified translator). This is helpful, in allowing us to see which expressions are being parsed in what order, etc.", 3 );
                 append( sb, "Expression: ${trace.expression}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "translationName", 2 );
                 append( sb, "When specified, only this translation will be tested (If more than one TestTranslation-* file is found).", 3 );
                 append( sb, "Expression: ${translation.name}", 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;
     }
 }