avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dona...@apache.org
Subject cvs commit: jakarta-avalon-phoenix/tools/etc/.Refactory pretty.settings
Date Thu, 23 May 2002 11:39:42 GMT
donaldp     02/05/23 04:39:42

  Modified:    .        build.xml
  Added:       tools/etc/.Refactory pretty.settings
  Log:
  Integrate jrefactory pretty printer sweep over sourcecode. The pretty printer does not get
the style 100% right (does not align hanging lines) but it is useful as a first pass before
IDEA or similar.
  
  Revision  Changes    Path
  1.127     +14 -1     jakarta-avalon-phoenix/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-phoenix/build.xml,v
  retrieving revision 1.126
  retrieving revision 1.127
  diff -u -r1.126 -r1.127
  --- build.xml	20 May 2002 12:09:50 -0000	1.126
  +++ build.xml	23 May 2002 11:39:42 -0000	1.127
  @@ -12,7 +12,7 @@
    Leo Simons <mail@leosimons.com>
   
   Legal:
  -  Copyright (c) 1999-2001 The Apache Software Foundation. All Rights Reserved.
  +  Copyright (c) 1999-2002 The Apache Software Foundation. All Rights Reserved.
   
   ==============================================================================
   -->
  @@ -120,6 +120,18 @@
           </available>
       </target>
   
  +    <target name="pretty">
  +       <taskdef name="pretty"
  +          classname="org.acm.seguin.ant.Pretty"
  +          classpath="${jrefactory.jar}" />
  +       <pretty settingsDir="tools/etc" cvs="true" compileDir="${build.classes}">
  +          <fileset dir="${src.dir}">
  +             <include name="**/*.java" />
  +             <!--<exclude name="org/**/*.java" />-->
  +          </fileset>
  +       </pretty>
  +    </target>
  +
       <!-- Prepares the build directory -->
       <target name="prepare" depends="check-environment">
   
  @@ -538,6 +550,7 @@
           <delete dir="${bin.dist.dir}" />
           <delete>
               <fileset dir="." includes="**/*~" defaultexcludes="no"/>
  +            <fileset dir="." includes="velocity.log*"/>
           </delete>
       </target>
   
  
  
  
  1.1                  jakarta-avalon-phoenix/tools/etc/.Refactory/pretty.settings
  
  Index: pretty.settings
  ===================================================================
  #  Version
  version=3.8
  
  header.1=/*
  header.2= * Copyright (C) The Apache Software Foundation. All rights reserved.
  header.3= *
  header.4= * This software is published under the terms of the Apache Software License
  header.5= * version 1.1, a copy of which has been included with this distribution in
  header.6= * the LICENSE.txt file.
  header.7= */
   
  # This is the number of characters to indent for each block.
  indent=4
  
  # This is the number of characters to indent for each block.
  # The character used to indent each block
  # * tab - use tabs to indent
  # * space - use spaces to indent
  indent.char=space
  
  # The following parameter should be changed to true if you
  # like your parens to have a space before and after them
  # if ( x == y )    //expr.space=true
  # if (x == y)      //expr.space=false
  expr.space=true
  
  # The following parameter is the minimum number of blank lines
  # between methods, nested classes, and nested interfaces.
  # It is also the number of lines before and after
  # field declarations, though field declarations will have
  # what ever spacing you used.
  # Note that this is a minimum.  If your code already
  # has more space between methods, then it won't shrink
  # the number of blank lines.
  lines.between=1
  
  # Is there a space after the cast
  cast.space=false
  
  # Do we force a space after a cast?
  cast.force.nospace=false
  
  # What do you do when a newline is unexpectedly encountered?
  # * double - The pretty printer inserts 2 indents
  # * single - The pretty printer inserts 1 indent
  # * param - Like single, except method arguments are indented to the parens
  surprise.return=param
  
  # Should throws part of a method/constructor declaration always be
  # on its own line?
  throws.newline=true
  
  # When the catch.start.line setting is true, catch statements look like
  # try {
  # //  Something here
  # }
  # catch (IOException ioe) {
  # //  Something here
  # }
  # When the catch.start.line setting is false, catch statements look like
  # try {
  # //  Something here
  # } catch (IOException ioe) {
  # //  Something here
  # }
  catch.start.line=true
  
  # Should if/then/else statements look like
  # (true) is:
  # if (someTest()) {
  # //  Something here
  # }
  # else {
  # //  Something here
  # }
  # (false) is:
  # if (someTest()) {
  # //  Something here
  # } else {
  # //  Something here
  # }
  else.start.line=true
  
  # Indent the name of the field (instance variable or class
  # variable) to this column (-1 for just one space)
  field.name.indent=-1
  
  # End of line character(s) - either CR, CRNL, or NL
  # * CR - carriage return
  # * NL - newline
  # * CRNL - carriage return and newline
  end.line=CRNL
  
  # This features sprecifies how to space out a field or a local
  # variable declaration.
  # * single - a space between the modifiers, the type, the name and the initializer
  # * dynamic - determine the spacing between the modifiers, type, name, and initializers
so everything lines up
  # * javadoc.dynamic - determine the spacing between the modifiers, type, name, and initializers
so everything lines up, except when the field is prefixed by a javadoc comment
  # * align.equals - align the equals statements of field declaration, but nothing else
  variable.spacing=single
  
  # When a dynamic field spacing is used, this value specifies
  # the number of additional spaces to add between the modifiers,
  # type, name, and initializer.
  dynamic.variable.spacing=1
  
  # Should the local variables be aligned with the { and }
  # or should they be indented to align with the other code?
  # false means align with the code, true means align
  # with the { }
  variable.align.with.block=false
  
  # The amount to indent a case statement (in terms of indent.char)
  case.indent=4
  
  # This determines if there should be a space after keywords
  # such as if, while, or for.  When this value is true, you get:
  # if (true) {
  # //  Do something
  # }
  # When this value is false, you get:
  # if(true) {
  # //  Do something
  # }
  keyword.space=false
  
  # Do we force a blank line before and after local variable declarations?
  insert.space.around.local.variables=false
  
  # This is the number of lines to insert after a package statement.
  lines.after.package=1
  
  # Do we keep all the newlines around imports?
  maintain.newlines.around.imports=false
  
  # This is the number of lines to insert before a class.
  lines.before.class=1
  
  # Should the values inside the array initializer be indented
  indent.in.initializer=true
  
  # Should there be a space after a !
  bang.space=false
  
  # Determines whether there should be a space between a method call
  # and the opening brace that follows it.  This is only included if
  # the method call has
  method.space=false
  
  # Determines if there is a space inside the cast parens
  cast.inside.space=true
  
  # Should there be a space around operations such as +, -, <, etc?
  space.around.ops=true
  
  # Style for { and }
  # C style means that { is at the end of the line
  # and } is on a line by itself.  For example,
  # if (myTest) {
  #     //  This is c style
  # }
  # PASCAL style means both { and } are on lines
  # by themselves.  For example,
  # if (myTest)
  # {
  #     //  This is PASCAL style
  # }
  # EMACS style means both { and } are on lines
  # by themselves and indented one level.
  # For example,
  # if (myTest)
  #   {
  #     //  This is EMACS style
  #   }
  # * C - C style
  # * PASCAL - PASCAL style
  # * EMACS - EMACS style
  block.style=PASCAL
  
  # To handle sun's coding standard, you want the method to begin
  # with a PASCAL coding style and the {} beneath that to be C style.
  # This parameter allows you to set the method style different
  # from the rest.
  # * C - C style
  # * PASCAL - PASCAL style
  # * EMACS - EMACS style
  method.block.style=PASCAL
  
  # To handle sun's coding standard, you want the class to begin
  # with a PASCAL coding style and the {} beneath that to be C style.
  # This parameter allows you to set the class style different
  # from the rest.
  # * C - C style
  # * PASCAL - PASCAL style
  # * EMACS - EMACS style
  class.block.style=PASCAL
  
  # Do we force if and while and for statements to have a block?  { ... }
  force.block=true
  
  # Empty methods and constructors remain on a single line
  empty.block.single.line=true
  
  # Remove {} when they surround only 1 statement
  remove.excess.blocks=false
  
  # Should each single line comment be indented a certain number of spaces
  # from the margin?  For this to work right be sure to indent each line with
  # spaces.
  singleline.comment.ownline=true
  
  # Absolute indent before a single line comment.
  singleline.comment.absoluteindent=0
  
  # Space used before the start of a single line
  # from the end of the code.  This value is used
  # to determine the number of spaces and how these
  # spaces are used based on the next few settings.
  singleline.comment.incrementalindent=0
  
  # This feature describes how the pretty printer should
  # indent single line comments (//) that share the line
  # with source code.  The two choices are incremental and absolute.
  # * incremental - use an incremental indent
  # * absolute - use the absolute indent level
  singleline.comment.indentstyle.shared=incremental
  
  # This feature describes how the pretty printer should
  # indent single line comments (//) that are on their
  # own line.  The two choices are code and absolute.
  # * code - use the same indent as the current code
  # * absolute - use the absolute indent level
  singleline.comment.indentstyle.ownline=code
  
  # How to format C Style comments.  Valid values are:
  # * leave - leave alone
  # * maintain.space.star - there is a row of stars to the right, but we maintain the spaces
after it
  # * align.star - place a row of stars to the right and align on those
  # * align.blank - just align the comments to the right (no star)
  c.style.format=align.star
  
  # For one of the methods above that use the align type, this is
  # the number of spaces to include after the * or blank
  c.style.indent=1
  
  # Limits the level that javadoc comments are forced
  # into the document.  The following are valid
  # levels:
  # method.minimum applies to constructors and methods
  # * all - all items must have javadoc
  # * private - same as all
  # * package - all items except private items must have javadoc
  # * default - same as package
  # * protected - protected and public items must have javadoc
  # * public - only public items must have javadoc
  # * none - nothing is required to have javadoc
  method.minimum=none
  
  # field.minimum applies to fields
  # * all - all items must have javadoc
  # * private - same as all
  # * package - all items except private items must have javadoc
  # * default - same as package
  # * protected - protected and public items must have javadoc
  # * public - only public items must have javadoc
  # * none - nothing is required to have javadoc
  field.minimum=none
  
  # class.minimum applies to classes and interfaces
  # * all - all items must have javadoc
  # * private - same as all
  # * package - all items except private items must have javadoc
  # * default - same as package
  # * protected - protected and public items must have javadoc
  # * public - only public items must have javadoc
  # * none - nothing is required to have javadoc
  class.minimum=none
  
  # Star count for javadoc
  javadoc.star=1
  
  # Wordwrap length for javadoc.  If the sum of the number of
  # characters on the line exceeds this value, then the javadoc
  # comment will be wordwrapped.
  javadoc.wordwrap.max=80
  
  # This feature keeps a method that is deeply indented from
  # only having a few words on each line.  This feature requires
  # that there be this many characters after the comment starts
  # before the javadoc comment is wordwrapped.
  javadoc.wordwrap.min=40
  
  # Whether we put a space before the @
  space.before.javadoc=true
  
  # Do you want to lineup the names and descriptions
  # in javadoc comments?
  javadoc.id.lineup=false
  
  # How many spaces should javadoc comments be indented?
  javadoc.indent=1
  
  # Wordwrap the javadoc comments
  reformat.comments=true
  
  # What tag name should be used for exceptions
  exception.tag.name=@throws
  
  # Should inner classes be documented
  document.nested.classes=true
  
  # Are javadoc comments allowed to be a single line long
  allow.singleline.javadoc=false
  
  # Include javadoc comments where ever they appear.  Javadoc comments
  # were originally only allowed to occur at a few places:  immediately
  # before a method, immediately before a field, and immediately
  # before a class or interface.  Since it is also common for people
  # to include the /*** pattern at the beginning of a file, this will be
  # preserved as well.
  # This was the case until JBuilder pressed the javadoc style comment into
  # a new line of work - handling @todo tags.  Suddenly it was permissible
  # to include javadoc comments anywhere in the file.
  # With keep.all.javadoc set to false, you get the original behavior.  All
  # javadoc comments that were not in the correct place were cleaned up for
  # you.  With this set to true, you can place the @todo tags wherever you please.
  keep.all.javadoc=true
  
  # Default description of the class
  class.descr=
  
  # Default description of the interface
  interface.descr=
  
  # Default description of the constructor  {0} stands for the name
  # of the constructor
  constructor.descr=Constructor for the {0} object
  
  # Default description of the method
  method.descr=Description of the Method
  
  # Default description of the getter.  {0} is the name of the
  # attribute, {1} is the name of the class, {2} is 'class'
  # or 'object' depending on whether it is static or not,
  # {3} is the name of the attribute with the first letter lowercased
  # {4} is the name of the attribute broken into words
  getter.descr=Gets the {3} attribute of the {1} {2}
  
  # Return description for getters.  {0} is the name of the attribute,
  # {3} is the name of the attribute with the first letter lowercased
  # {4} is the name of the attribute broken into words
  getter.return.descr=The {3} value
  
  # Default description of the setter.  {0} is the name of the
  # attribute, {1} is the name of the class, {2} is 'class'
  # or 'object' depending on whether it is static or not,
  # {3} is the name of the attribute with the first letter lowercased
  # {4} is the name of the attribute broken into words
  setter.descr=Sets the {3} attribute of the {1} {2}
  
  # Parameter description for setters.  {0} is the name of the attribute,
  # {3} is the name of the attribute with the first letter lowercased
  # {4} is the name of the attribute broken into words
  setter.param.descr=The new {3} value
  
  # Default field description
  field.descr=
  
  # Default description of the run method.  {0} is not
  # applicable, {1} is the name of the class, {2} is 'class'
  # or 'object' depending on whether it is static or not
  run.descr=Main processing method for the {1} {2}
  
  # Default description of the run method.  {0} is not
  # applicable, {1} is the name of the class, {2} is 'class'
  # or 'object' depending on whether it is static or not
  main.descr=The main program for the {1} {2}
  
  # Description of the main arguments
  main.param.descr=The command line arguments
  
  # Default description of the add method.  {0} is the name of the
  # attribute, {1} is the name of the class, {2} is 'class'
  # or 'object' depending on whether it is static or not,
  # {3} is the name of the attribute with the first letter lowercased
  adder.descr=Adds a feature to the {0} attribute of the {1} {2}
  
  # Description of the add argument
  adder.param.descr=The feature to be added to the {0} attribute
  
  # JUnit has a particular format for the names of methods.
  # These setup for the unit tests are done in a method named
  # setUp, the cleanup afterwards is done in tearDown, and
  # the unit tests all start with the word test.  The following
  # are the default descriptions of these methods.
  junit.setUp.descr=The JUnit setup method
  
  junit.test.descr=A unit test for JUnit
  
  junit.tearDown.descr=The teardown method for JUnit
  
  junit.suite.descr=A unit test suite for JUnit
  
  junit.suite.return.descr=The test suite
  
  #
  #  The following are the tags and the order
  #  that are required in javadocs.  If there is
  #  description, then they are not required and the
  #  system is only specifying the order in which they
  #  should appear.  If a description is provided, then
  #  the tag is required.
  #
  author.descr={0}
  version.descr=$Revision: 1.1 $ $Date: 2002/05/23 11:39:42 $
  created.descr={1}
  
  param.descr=Description of the Parameter
  return.descr=Description of the Return Value
  exception.descr=
  
  class.tags=version
  method.tags=
  field.tags=
   
  # This feature describes what type of characters are used for
  # the java files.
  # * 1 - ASCII (1 byte characters)
  # * 2 - Unicode (2 byte characters - far east)
  # * 3 - ASCII full (2 byte characters - far east)
  char.stream.type=1
  
  # If you would like the pretty printer to make a backup
  # of the file before applying the pretty printer to the file,
  # add an extension here.
  pretty.printer.backup.ext=~
  
  # Insert the header
  
  # Insert the footer
  
  # Should we sort the types and imports?
  sort.top=true
  
  # List the prefixes of imports that should be
  # sorted to the top.  For instance, 
  # java,javax,org.w3c
  import.sort.important=
  
  # If you want classes that are written by you to move to the end
  # of the list of imports change this value.
  # * 0 - Keep all the imports in alphabetical order
  # * 1 - If the package and the import start with the same value - com or org - put them
at the end
  # * 2 - When package and import share 2 directory levels, the imports are listed last
  # * 3 - When package and import share 3 directory levels, the imports are listed last
  import.sort.neighbourhood=0
  
  # The following controls the order of methods, fields,
  # classes, etc inside a class.
  # This orders the items in the class by their type
  # The items to order are fields, constructors, methods,
  # nested classes, nested interfaces, and initializers
  sort.1=Type(Field,Initializer,Constructor,Method,NestedClass,NestedInterface)
  
  # Maintain the order of fields with initializers
  sort.2=FieldInitializers()
  
  # How the protection should be used to sort fields and methods
  # * Protection(public) - Move public to the top
  # * Protection(private) - Move private to the top
  sort.3=Protection(public)
  
  # How static methods and fields should be sorted
  # * Class(Static,Instance) - Move static to the top
  # * Class(Instance,Static) - Move static to the bottom
  sort.4=Class(Static,Instance)
  
  # Order getters, setters, and other methods
  # Setters are methods that start with the word 'set'
  # Getters are methods that start with the word 'get' or 'is'
  sort.5=Method(setter,getter,other)
  
  # How final methods and fields should be sorted
  # * Final(top) - Move to the top
  # * Final(bottom) - Move to the bottom
  sort.6=Final(top)
  
  # Order methods so that bean objects are listed together
  sort.7=Bean()
  
  # Order methods and fields in alphabetical order
  sort.8=Alphabetical()
  
  
  
  

--
To unsubscribe, e-mail:   <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@jakarta.apache.org>


Mime
View raw message