SourceFileProcessor.java
/*
* Copyright (C) Christian Schulte <cs@schulte.it>, 2005-206
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* o Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* $JOMC: SourceFileProcessor.java 5043 2015-05-27 07:03:39Z schulte $
*
*/
package org.jomc.tools;
import java.io.File;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.io.StringWriter;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.channels.FileLock;
import java.text.MessageFormat;
import java.util.LinkedList;
import java.util.List;
import java.util.ResourceBundle;
import java.util.logging.Level;
import org.apache.commons.lang.StringUtils;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.exception.VelocityException;
import org.jomc.model.Implementation;
import org.jomc.model.Implementations;
import org.jomc.model.Instance;
import org.jomc.model.Module;
import org.jomc.model.Specification;
import org.jomc.tools.model.SourceFileType;
import org.jomc.tools.model.SourceFilesType;
import org.jomc.tools.model.SourceSectionType;
import org.jomc.tools.model.SourceSectionsType;
import org.jomc.util.LineEditor;
import org.jomc.util.Section;
import org.jomc.util.SectionEditor;
import org.jomc.util.TrailingWhitespaceEditor;
/**
* Processes source code files.
*
* <p>
* <b>Use Cases:</b><br/><ul>
* <li>{@link #manageSourceFiles(File) }</li>
* <li>{@link #manageSourceFiles(Module, File) }</li>
* <li>{@link #manageSourceFiles(Specification, File) }</li>
* <li>{@link #manageSourceFiles(Implementation, File) }</li>
* </ul></p>
*
* @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
* @version $JOMC: SourceFileProcessor.java 5043 2015-05-27 07:03:39Z schulte $
*/
public class SourceFileProcessor extends JomcTool
{
/**
* The source file editor of the instance.
*/
private SourceFileProcessor.SourceFileEditor sourceFileEditor;
/**
* Source files model.
*/
@Deprecated
private SourceFilesType sourceFilesType;
/**
* Creates a new {@code SourceFileProcessor} instance.
*/
public SourceFileProcessor()
{
super();
}
/**
* Creates a new {@code SourceFileProcessor} instance taking a {@code SourceFileProcessor} instance to initialize
* the instance with.
*
* @param tool The instance to initialize the new instance with,
*
* @throws NullPointerException if {@code tool} is {@code null}.
* @throws IOException if copying {@code tool} fails.
*/
public SourceFileProcessor( final SourceFileProcessor tool ) throws IOException
{
super( tool );
this.sourceFilesType = tool.sourceFilesType != null ? tool.sourceFilesType.clone() : null;
this.sourceFileEditor = tool.sourceFileEditor;
}
/**
* Gets the source files model of the instance.
* <p>
* This accessor method returns a reference to the live object, not a snapshot. Therefore any modification you
* make to the returned object will be present inside the object. This is why there is no {@code set} method.
* </p>
*
* @return The source files model of the instance.
*
* @see #getSourceFileType(org.jomc.model.Specification)
* @see #getSourceFileType(org.jomc.model.Implementation)
*
* @deprecated As of JOMC 1.2, please add source file models to {@code Specification}s and {@code Implementation}s
* directly. This method will be removed in version 2.0.
*/
@Deprecated
public SourceFilesType getSourceFilesType()
{
if ( this.sourceFilesType == null )
{
this.sourceFilesType = new SourceFilesType();
}
return this.sourceFilesType;
}
/**
* Gets the model of a specification source file of the modules of the instance.
*
* @param specification The specification to get a source file model for.
*
* @return The source file model for {@code specification}. As of JOMC 1.2, this method returns {@code null} if no
* source file model is found.
*
* @throws NullPointerException if {@code specification} is {@code null}.
*
* @deprecated As of JOMC 1.2, please use method {@link #getSourceFilesType(org.jomc.model.Specification)}. This
* method will be removed in version 2.0.
*/
@Deprecated
public SourceFileType getSourceFileType( final Specification specification )
{
if ( specification == null )
{
throw new NullPointerException( "specification" );
}
SourceFileType sourceFileType = null;
if ( this.getModules() != null
&& this.getModules().getSpecification( specification.getIdentifier() ) != null )
{
sourceFileType = this.getSourceFilesType().getSourceFile( specification.getIdentifier() );
if ( sourceFileType == null )
{
sourceFileType = specification.getAnyObject( SourceFileType.class );
}
}
else if ( this.isLoggable( Level.WARNING ) )
{
this.log( Level.WARNING, getMessage( "specificationNotFound", specification.getIdentifier() ), null );
}
return sourceFileType;
}
/**
* Gets the source files model of a specification of the modules of the instance.
*
* @param specification The specification to get a source files model for.
*
* @return The source files model for {@code specification} or {@code null}, if no source files model is found.
*
* @throws NullPointerException if {@code specification} is {@code null}.
*
* @since 1.2
*/
public SourceFilesType getSourceFilesType( final Specification specification )
{
if ( specification == null )
{
throw new NullPointerException( "specification" );
}
SourceFilesType model = null;
if ( this.getModules() != null
&& this.getModules().getSpecification( specification.getIdentifier() ) != null )
{
final SourceFileType sourceFileType = this.getSourceFileType( specification );
if ( sourceFileType != null )
{
model = new SourceFilesType();
model.getSourceFile().add( sourceFileType );
}
else
{
model = specification.getAnyObject( SourceFilesType.class );
}
}
else if ( this.isLoggable( Level.WARNING ) )
{
this.log( Level.WARNING, getMessage( "specificationNotFound", specification.getIdentifier() ), null );
}
return model;
}
/**
* Gets the model of an implementation source file of the modules of the instance.
*
* @param implementation The implementation to get a source file model for.
*
* @return The source file model for {@code implementation}. As of JOMC 1.2, this method returns {@code null} if no
* source file model is found.
*
* @throws NullPointerException if {@code implementation} is {@code null}.
*
* @deprecated As of JOMC 1.2, please use method {@link #getSourceFilesType(org.jomc.model.Implementation)}. This
* method will be removed in version 2.0.
*/
@Deprecated
public SourceFileType getSourceFileType( final Implementation implementation )
{
if ( implementation == null )
{
throw new NullPointerException( "implementation" );
}
SourceFileType sourceFileType = null;
if ( this.getModules() != null
&& this.getModules().getImplementation( implementation.getIdentifier() ) != null )
{
sourceFileType = this.getSourceFilesType().getSourceFile( implementation.getIdentifier() );
if ( sourceFileType == null )
{
sourceFileType = implementation.getAnyObject( SourceFileType.class );
}
}
else if ( this.isLoggable( Level.WARNING ) )
{
this.log( Level.WARNING, getMessage( "implementationNotFound", implementation.getIdentifier() ), null );
}
return sourceFileType;
}
/**
* Gets the source files model of an implementation of the modules of the instance.
*
* @param implementation The implementation to get a source files model for.
*
* @return The source files model for {@code implementation} or {@code null}, if no source files model is found.
*
* @throws NullPointerException if {@code implementation} is {@code null}.
*
* @since 1.2
*/
public SourceFilesType getSourceFilesType( final Implementation implementation )
{
if ( implementation == null )
{
throw new NullPointerException( "implementation" );
}
SourceFilesType model = null;
if ( this.getModules() != null
&& this.getModules().getImplementation( implementation.getIdentifier() ) != null )
{
final SourceFileType sourceFileType = this.getSourceFileType( implementation );
if ( sourceFileType != null )
{
model = new SourceFilesType();
model.getSourceFile().add( sourceFileType );
}
else
{
final Instance instance = this.getModules().getInstance( implementation.getIdentifier() );
assert instance != null : "Instance '" + implementation.getIdentifier() + "' not found.";
model = instance.getAnyObject( SourceFilesType.class );
}
}
else if ( this.isLoggable( Level.WARNING ) )
{
this.log( Level.WARNING, getMessage( "implementationNotFound", implementation.getIdentifier() ), null );
}
return model;
}
/**
* Gets the source file editor of the instance.
*
* @return The source file editor of the instance.
*
* @since 1.2
*
* @see #setSourceFileEditor(org.jomc.tools.SourceFileProcessor.SourceFileEditor)
*/
public final SourceFileProcessor.SourceFileEditor getSourceFileEditor()
{
if ( this.sourceFileEditor == null )
{
this.sourceFileEditor =
new SourceFileProcessor.SourceFileEditor( new TrailingWhitespaceEditor( this.getLineSeparator() ),
this.getLineSeparator() );
}
return this.sourceFileEditor;
}
/**
* Sets the source file editor of the instance.
*
* @param value The new source file editor of the instance or {@code null}.
*
* @since 1.2
*
* @see #getSourceFileEditor()
*/
public final void setSourceFileEditor( final SourceFileProcessor.SourceFileEditor value )
{
this.sourceFileEditor = value;
}
/**
* Gets a new editor for editing the source file of a given specification of the modules of the instance.
*
* @param specification The specification whose source file to edit.
*
* @return A new editor for editing the source file of {@code specification}.
*
* @throws NullPointerException if {@code specification} is {@code null}.
*
* @deprecated As of JOMC 1.2, please use method {@link #getSourceFileEditor()}. This method will be removed in
* version 2.0.
*
* @see SourceFileEditor#edit(org.jomc.model.Specification, org.jomc.tools.model.SourceFileType, java.io.File)
*/
@Deprecated
public SourceFileProcessor.SourceFileEditor getSourceFileEditor( final Specification specification )
{
if ( specification == null )
{
throw new NullPointerException( "specification" );
}
return this.getSourceFileEditor();
}
/**
* Gets a new editor for editing the source file of a given implementation of the modules of the instance.
*
* @param implementation The implementation whose source file to edit.
*
* @return A new editor for editing the source file of {@code implementation}.
*
* @throws NullPointerException if {@code implementation} is {@code null}.
*
* @deprecated As of JOMC 1.2, please use method {@link #getSourceFileEditor()}. This method will be removed in
* version 2.0.
*
* @see SourceFileEditor#edit(org.jomc.model.Implementation, org.jomc.tools.model.SourceFileType, java.io.File)
*/
@Deprecated
public SourceFileProcessor.SourceFileEditor getSourceFileEditor( final Implementation implementation )
{
if ( implementation == null )
{
throw new NullPointerException( "implementation" );
}
return this.getSourceFileEditor();
}
/**
* Manages the source files of the modules of the instance.
*
* @param sourcesDirectory The directory holding the source files to manage.
*
* @throws NullPointerException if {@code sourcesDirectory} is {@code null}.
* @throws IOException if managing source files fails.
*
* @see #manageSourceFiles(org.jomc.model.Module, java.io.File)
*/
public void manageSourceFiles( final File sourcesDirectory ) throws IOException
{
if ( sourcesDirectory == null )
{
throw new NullPointerException( "sourcesDirectory" );
}
if ( this.getModules() != null )
{
for ( int i = this.getModules().getModule().size() - 1; i >= 0; i-- )
{
this.manageSourceFiles( this.getModules().getModule().get( i ), sourcesDirectory );
}
}
else if ( this.isLoggable( Level.WARNING ) )
{
this.log( Level.WARNING, getMessage( "modulesNotFound", this.getModel().getIdentifier() ), null );
}
}
/**
* Manages the source files of a given module of the modules of the instance.
*
* @param module The module to process.
* @param sourcesDirectory The directory holding the source files to manage.
*
* @throws NullPointerException if {@code module} or {@code sourcesDirectory} is {@code null}.
* @throws IOException if managing source files fails.
*
* @see #manageSourceFiles(org.jomc.model.Specification, java.io.File)
* @see #manageSourceFiles(org.jomc.model.Implementation, java.io.File)
*/
public void manageSourceFiles( final Module module, final File sourcesDirectory ) throws IOException
{
if ( module == null )
{
throw new NullPointerException( "module" );
}
if ( sourcesDirectory == null )
{
throw new NullPointerException( "sourcesDirectory" );
}
if ( this.getModules() != null && this.getModules().getModule( module.getName() ) != null )
{
if ( module.getSpecifications() != null )
{
for ( int i = 0, s0 = module.getSpecifications().getSpecification().size(); i < s0; i++ )
{
this.manageSourceFiles( module.getSpecifications().getSpecification().get( i ), sourcesDirectory );
}
}
if ( module.getImplementations() != null )
{
for ( int i = 0, s0 = module.getImplementations().getImplementation().size(); i < s0; i++ )
{
this.manageSourceFiles( module.getImplementations().getImplementation().get( i ), sourcesDirectory );
}
}
}
else if ( this.isLoggable( Level.WARNING ) )
{
this.log( Level.WARNING, getMessage( "moduleNotFound", module.getName() ), null );
}
}
/**
* Manages the source files of a given specification of the modules of the instance.
*
* @param specification The specification to process.
* @param sourcesDirectory The directory holding the source files to manage.
*
* @throws NullPointerException if {@code specification} or {@code sourcesDirectory} is {@code null}.
* @throws IOException if managing source files fails.
*
* @see #getSourceFileEditor()
* @see #getSourceFilesType(org.jomc.model.Specification)
*/
public void manageSourceFiles( final Specification specification, final File sourcesDirectory ) throws IOException
{
if ( specification == null )
{
throw new NullPointerException( "specification" );
}
if ( sourcesDirectory == null )
{
throw new NullPointerException( "sourcesDirectory" );
}
if ( this.getModules() != null
&& this.getModules().getSpecification( specification.getIdentifier() ) != null )
{
if ( specification.isClassDeclaration() )
{
boolean manage = true;
final Implementations implementations = this.getModules().getImplementations();
if ( implementations != null )
{
for ( int i = 0, s0 = implementations.getImplementation().size(); i < s0; i++ )
{
final Implementation impl = implementations.getImplementation().get( i );
if ( impl.isClassDeclaration() && specification.getClazz().equals( impl.getClazz() ) )
{
this.manageSourceFiles( impl, sourcesDirectory );
manage = false;
break;
}
}
}
if ( manage )
{
final SourceFilesType model = this.getSourceFilesType( specification );
if ( model != null )
{
for ( int i = 0, s0 = model.getSourceFile().size(); i < s0; i++ )
{
this.getSourceFileEditor().edit(
specification, model.getSourceFile().get( i ), sourcesDirectory );
}
}
}
}
}
else if ( this.isLoggable( Level.WARNING ) )
{
this.log( Level.WARNING, getMessage( "specificationNotFound", specification.getIdentifier() ), null );
}
}
/**
* Manages the source files of a given implementation of the modules of the instance.
*
* @param implementation The implementation to process.
* @param sourcesDirectory The directory holding the source files to manage.
*
* @throws NullPointerException if {@code implementation} or {@code sourcesDirectory} is {@code null}.
* @throws IOException if managing source files fails.
*
* @see #getSourceFileEditor()
* @see #getSourceFilesType(org.jomc.model.Implementation)
*/
public void manageSourceFiles( final Implementation implementation, final File sourcesDirectory )
throws IOException
{
if ( implementation == null )
{
throw new NullPointerException( "implementation" );
}
if ( sourcesDirectory == null )
{
throw new NullPointerException( "sourcesDirectory" );
}
if ( this.getModules() != null
&& this.getModules().getImplementation( implementation.getIdentifier() ) != null )
{
if ( implementation.isClassDeclaration() )
{
final SourceFilesType model = this.getSourceFilesType( implementation );
if ( model != null )
{
for ( int i = 0, s0 = model.getSourceFile().size(); i < s0; i++ )
{
this.getSourceFileEditor().edit(
implementation, model.getSourceFile().get( i ), sourcesDirectory );
}
}
}
}
else if ( this.isLoggable( Level.WARNING ) )
{
this.log( Level.WARNING, getMessage( "implementationNotFound", implementation.getIdentifier() ), null );
}
}
private static String getMessage( final String key, final Object... arguments )
{
if ( key == null )
{
throw new NullPointerException( "key" );
}
return MessageFormat.format( ResourceBundle.getBundle(
SourceFileProcessor.class.getName().replace( '.', '/' ) ).getString( key ), arguments );
}
private static String getMessage( final Throwable t )
{
return t != null
? t.getMessage() != null && t.getMessage().trim().length() > 0
? t.getMessage()
: getMessage( t.getCause() )
: null;
}
/**
* Extension to {@code SectionEditor} adding support for editing source code files.
*
* @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
* @version $JOMC: SourceFileProcessor.java 5043 2015-05-27 07:03:39Z schulte $
*
* @see #edit(org.jomc.model.Specification, org.jomc.tools.model.SourceFileType, java.io.File)
* @see #edit(org.jomc.model.Implementation, org.jomc.tools.model.SourceFileType, java.io.File)
*/
public class SourceFileEditor extends SectionEditor
{
/**
* {@code Specification} of the instance or {@code null}.
*/
private Specification specification;
/**
* {@code Implementation} of the instance or {@code null}.
*/
private Implementation implementation;
/**
* The source code file to edit.
*/
private SourceFileType sourceFileType;
/**
* The {@code VelocityContext} of the instance.
*/
private VelocityContext velocityContext;
/**
* List of sections added to the input.
*/
@Deprecated
private List<Section> addedSections;
/**
* List of sections without corresponding model entry.
*/
@Deprecated
private List<Section> unknownSections;
/**
* Creates a new {@code SourceFileEditor} instance.
*
* @since 1.2
*/
public SourceFileEditor()
{
this( (LineEditor) null, (String) null );
}
/**
* Creates a new {@code SourceFileEditor} instance taking a string to use for separating lines.
*
* @param lineSeparator String to use for separating lines.
*
* @since 1.2
*/
public SourceFileEditor( final String lineSeparator )
{
this( (LineEditor) null, lineSeparator );
}
/**
* Creates a new {@code SourceFileEditor} instance taking an editor to chain.
*
* @param editor The editor to chain.
*
* @since 1.2
*/
public SourceFileEditor( final LineEditor editor )
{
this( editor, null );
}
/**
* Creates a new {@code SourceFileEditor} instance taking an editor to chain and a string to use for separating
* lines.
*
* @param editor The editor to chain.
* @param lineSeparator String to use for separating lines.
*
* @since 1.2
*/
public SourceFileEditor( final LineEditor editor, final String lineSeparator )
{
super( editor, lineSeparator );
}
/**
* Creates a new {@code SourceFileEditor} taking a {@code Specification} to edit source code of.
*
* @param specification The specification to edit source code of.
*
* @deprecated As of JOMC 1.2, please use method {@link #edit(org.jomc.model.Specification, org.jomc.tools.model.SourceFileType, java.io.File)}.
* This constructor will be removed in version 2.0.
*/
@Deprecated
public SourceFileEditor( final Specification specification )
{
this( specification, null, null );
}
/**
* Creates a new {@code SourceFileEditor} taking a {@code Specification} to edit source code of and a line
* separator.
*
* @param specification The specification to edit source code of.
* @param lineSeparator The line separator of the editor.
*
* @deprecated As of JOMC 1.2, please use method {@link #edit(org.jomc.model.Specification, org.jomc.tools.model.SourceFileType, java.io.File)}.
* This constructor will be removed in version 2.0.
*/
@Deprecated
public SourceFileEditor( final Specification specification, final String lineSeparator )
{
this( specification, null, lineSeparator );
}
/**
* Creates a new {@code SourceFileEditor} taking a {@code Specification} to edit source code of and an editor to
* chain.
*
* @param specification The specification backing the editor.
* @param lineEditor The editor to chain.
*
* @deprecated As of JOMC 1.2, please use method {@link #edit(org.jomc.model.Specification, org.jomc.tools.model.SourceFileType, java.io.File)}.
* This constructor will be removed in version 2.0.
*/
@Deprecated
public SourceFileEditor( final Specification specification, final LineEditor lineEditor )
{
this( specification, lineEditor, null );
}
/**
* Creates a new {@code SourceFileEditor} taking a {@code Specification} to edit source code of, an editor to
* chain and a line separator.
*
* @param specification The specification backing the editor.
* @param lineEditor The editor to chain.
* @param lineSeparator The line separator of the editor.
*
* @deprecated As of JOMC 1.2, please use method {@link #edit(org.jomc.model.Specification, org.jomc.tools.model.SourceFileType, java.io.File)}.
* This constructor will be removed in version 2.0.
*/
@Deprecated
public SourceFileEditor( final Specification specification, final LineEditor lineEditor,
final String lineSeparator )
{
super( lineEditor, lineSeparator );
this.specification = specification;
this.implementation = null;
assert getModules().getSpecification( specification.getIdentifier() ) != null :
"Specification '" + specification.getIdentifier() + "' not found.";
}
/**
* Creates a new {@code SourceFileEditor} taking an {@code Implementation} to edit source code of.
*
* @param implementation The implementation to edit source code of.
*
* @deprecated As of JOMC 1.2, please use method {@link #edit(org.jomc.model.Implementation, org.jomc.tools.model.SourceFileType, java.io.File)}.
* This constructor will be removed in version 2.0.
*/
@Deprecated
public SourceFileEditor( final Implementation implementation )
{
this( implementation, null, null );
}
/**
* Creates a new {@code SourceFileEditor} taking an {@code Implementation} to edit source code of and a line
* separator.
*
* @param implementation The implementation to edit source code of.
* @param lineSeparator The line separator of the editor.
*
* @deprecated As of JOMC 1.2, please use method {@link #edit(org.jomc.model.Implementation, org.jomc.tools.model.SourceFileType, java.io.File)}.
* This constructor will be removed in version 2.0.
*/
@Deprecated
public SourceFileEditor( final Implementation implementation, final String lineSeparator )
{
this( implementation, null, lineSeparator );
}
/**
* Creates a new {@code SourceFileEditor} taking an {@code Implementation} to edit source code of and an editor
* to chain.
*
* @param implementation The implementation to edit source code of.
* @param lineEditor The editor to chain.
*
* @deprecated As of JOMC 1.2, please use method {@link #edit(org.jomc.model.Implementation, org.jomc.tools.model.SourceFileType, java.io.File)}.
* This constructor will be removed in version 2.0.
*/
@Deprecated
public SourceFileEditor( final Implementation implementation, final LineEditor lineEditor )
{
this( implementation, lineEditor, null );
}
/**
* Creates a new {@code SourceFileEditor} taking an {@code Implementation} to edit source code of, an editor
* to chain and a line separator.
*
* @param implementation The implementation to edit source code of.
* @param lineEditor The editor to chain.
* @param lineSeparator The line separator of the editor.
*
* @deprecated As of JOMC 1.2, please use method {@link #edit(org.jomc.model.Implementation, org.jomc.tools.model.SourceFileType, java.io.File)}.
* This constructor will be removed in version 2.0.
*/
@Deprecated
public SourceFileEditor( final Implementation implementation, final LineEditor lineEditor,
final String lineSeparator )
{
super( lineEditor, lineSeparator );
this.implementation = implementation;
this.specification = null;
assert getModules().getImplementation( implementation.getIdentifier() ) != null :
"Implementation '" + implementation.getIdentifier() + "' not found.";
}
/**
* Edits a source file of a given specification.
*
* @param specification The specification to edit a source file of.
* @param sourceFileType The model of the source file to edit.
* @param sourcesDirectory The directory holding the source file to edit.
*
* @throws NullPointerException if {@code specification}, {@code sourceFileType} or {@code sourcesDirectory} is
* {@code null}.
* @throws IOException if editing fails.
*
* @since 1.2
*/
public final void edit( final Specification specification, final SourceFileType sourceFileType,
final File sourcesDirectory ) throws IOException
{
if ( specification == null )
{
throw new NullPointerException( "specification" );
}
if ( sourceFileType == null )
{
throw new NullPointerException( "sourceFileType" );
}
if ( sourcesDirectory == null )
{
throw new NullPointerException( "sourcesDirectory" );
}
try
{
if ( getModules() != null
&& getModules().getSpecification( specification.getIdentifier() ) != null )
{
this.specification = specification;
this.sourceFileType = sourceFileType;
this.velocityContext = SourceFileProcessor.this.getVelocityContext();
this.velocityContext.put( "specification", specification );
this.velocityContext.put( "smodel", sourceFileType );
this.editSourceFile( sourcesDirectory );
}
else
{
throw new IOException( getMessage( "specificationNotFound", specification.getIdentifier() ) );
}
}
finally
{
this.specification = null;
this.implementation = null;
this.sourceFileType = null;
this.velocityContext = null;
}
}
/**
* Edits a source file of a given implementation.
*
* @param implementation The implementation to edit a source file of.
* @param sourceFileType The model of the source file to edit.
* @param sourcesDirectory The directory holding the source file to edit.
*
* @throws NullPointerException if {@code implementation}, {@code sourceFileType} or {@code sourcesDirectory} is
* {@code null}.
* @throws IOException if editing fails.
*
* @since 1.2
*/
public final void edit( final Implementation implementation, final SourceFileType sourceFileType,
final File sourcesDirectory ) throws IOException
{
if ( implementation == null )
{
throw new NullPointerException( "implementation" );
}
if ( sourceFileType == null )
{
throw new NullPointerException( "sourceFileType" );
}
if ( sourcesDirectory == null )
{
throw new NullPointerException( "sourcesDirectory" );
}
try
{
if ( getModules() != null
&& getModules().getImplementation( implementation.getIdentifier() ) != null )
{
this.implementation = implementation;
this.sourceFileType = sourceFileType;
this.velocityContext = SourceFileProcessor.this.getVelocityContext();
this.velocityContext.put( "implementation", implementation );
this.velocityContext.put( "smodel", sourceFileType );
this.editSourceFile( sourcesDirectory );
}
else
{
throw new IOException( getMessage( "implementationNotFound", implementation.getIdentifier() ) );
}
}
finally
{
this.specification = null;
this.implementation = null;
this.sourceFileType = null;
this.velocityContext = null;
}
}
/**
* Gets a list of sections added to the input.
* <p>
* This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you
* make to the returned list will be present inside the object. This is why there is no {@code set} method
* for the added sections property.
* </p>
*
* @return A list of sections added to the input.
*
* @deprecated As of JOMC 1.2, deprecated without replacement. This method will be removed in version 2.0.
*/
@Deprecated
public List<Section> getAddedSections()
{
if ( this.addedSections == null )
{
this.addedSections = new LinkedList<Section>();
}
return this.addedSections;
}
/**
* Gets a list of sections without corresponding model entry.
* <p>
* This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you
* make to the returned list will be present inside the object. This is why there is no {@code set} method
* for the unknown sections property.
* </p>
*
* @return A list of sections without corresponding model entry.
*
* @deprecated As of JOMC 1.2, deprecated without replacement. This method will be removed in version 2.0.
*/
@Deprecated
public List<Section> getUnknownSections()
{
if ( this.unknownSections == null )
{
this.unknownSections = new LinkedList<Section>();
}
return this.unknownSections;
}
/**
* Gets the currently edited source code file.
*
* @return The currently edited source code file.
*
* @deprecated As of JOMC 1.2, deprecated without replacement. This method will be removed in version 2.0.
*/
@Deprecated
protected SourceFileType getSourceFileType()
{
if ( this.sourceFileType == null )
{
if ( this.specification != null )
{
return SourceFileProcessor.this.getSourceFileType( this.specification );
}
if ( this.implementation != null )
{
return SourceFileProcessor.this.getSourceFileType( this.implementation );
}
}
return this.sourceFileType;
}
/**
* Gets a new velocity context used for merging templates.
*
* @return A new velocity context used for merging templates.
*
* @throws IOException if creating a new context instance fails.
*
* @deprecated As of JOMC 1.2, deprecated without replacement. This method will be removed in version 2.0.
*/
@Deprecated
protected VelocityContext getVelocityContext() throws IOException
{
if ( this.velocityContext == null )
{
final VelocityContext ctx = SourceFileProcessor.this.getVelocityContext();
if ( this.specification != null )
{
ctx.put( "specification", this.specification );
}
if ( this.implementation != null )
{
ctx.put( "implementation", this.implementation );
}
return ctx;
}
return this.velocityContext;
}
/**
* {@inheritDoc}
* <p>
* This method creates any sections declared in the model of the source file as returned by method
* {@code getSourceFileType} prior to rendering the output of the editor.
* </p>
*
* @param section The section to start rendering the editor's output with.
*
* @see #createSection(java.lang.String, java.lang.String, org.jomc.tools.model.SourceSectionType)
*/
@Override
protected String getOutput( final Section section ) throws IOException
{
this.getAddedSections().clear();
this.getUnknownSections().clear();
final SourceFileType model = this.getSourceFileType();
if ( model != null )
{
this.createSections( model, model.getSourceSections(), section );
}
return super.getOutput( section );
}
/**
* {@inheritDoc}
* <p>
* This method searches the model of the source file for a section matching {@code s} and updates properties
* {@code headContent} and {@code tailContent} of {@code s} according to the templates declared in the model
* as returned by method {@code getSourceFileType}.
* </p>
*
* @param s The section to edit.
*/
@Override
protected void editSection( final Section s ) throws IOException
{
try
{
super.editSection( s );
final SourceFileType model = this.getSourceFileType();
if ( s.getName() != null && model != null && model.getSourceSections() != null )
{
final SourceSectionType sourceSectionType =
model.getSourceSections().getSourceSection( s.getName() );
if ( sourceSectionType != null )
{
if ( s.getStartingLine() != null )
{
s.setStartingLine( getIndentation( sourceSectionType.getIndentationLevel() )
+ s.getStartingLine().trim() );
}
if ( s.getEndingLine() != null )
{
s.setEndingLine( getIndentation( sourceSectionType.getIndentationLevel() )
+ s.getEndingLine().trim() );
}
if ( sourceSectionType.getHeadTemplate() != null
&& ( !sourceSectionType.isEditable()
|| s.getHeadContent().toString().trim().length() == 0 ) )
{
final StringWriter writer = new StringWriter();
final Template template = getVelocityTemplate( sourceSectionType.getHeadTemplate() );
final VelocityContext ctx = getVelocityContext();
ctx.put( "template", template );
ctx.put( "ssection", sourceSectionType );
template.merge( ctx, writer );
writer.close();
s.getHeadContent().setLength( 0 );
s.getHeadContent().append( writer.toString() );
ctx.remove( "template" );
ctx.remove( "ssection" );
}
if ( sourceSectionType.getTailTemplate() != null
&& ( !sourceSectionType.isEditable()
|| s.getTailContent().toString().trim().length() == 0 ) )
{
final StringWriter writer = new StringWriter();
final Template template = getVelocityTemplate( sourceSectionType.getTailTemplate() );
final VelocityContext ctx = getVelocityContext();
ctx.put( "template", template );
ctx.put( "ssection", sourceSectionType );
template.merge( ctx, writer );
writer.close();
s.getTailContent().setLength( 0 );
s.getTailContent().append( writer.toString() );
ctx.remove( "template" );
ctx.remove( "ssection" );
}
}
else
{
if ( isLoggable( Level.WARNING ) )
{
if ( this.implementation != null )
{
final Module m =
getModules().getModuleOfImplementation( this.implementation.getIdentifier() );
log( Level.WARNING, getMessage(
"unknownImplementationSection", m.getName(), this.implementation.getIdentifier(),
model.getIdentifier(), s.getName() ), null );
}
else if ( this.specification != null )
{
final Module m =
getModules().getModuleOfSpecification( this.specification.getIdentifier() );
log( Level.WARNING, getMessage(
"unknownSpecificationSection", m.getName(), this.specification.getIdentifier(),
model.getIdentifier(), s.getName() ), null );
}
}
this.getUnknownSections().add( s );
}
}
}
catch ( final VelocityException e )
{
// JDK: As of JDK 6, "new IOException( message, cause )".
throw (IOException) new IOException( getMessage( e ) ).initCause( e );
}
}
private void createSections( final SourceFileType sourceFileType, final SourceSectionsType sourceSectionsType,
final Section section ) throws IOException
{
if ( sourceSectionsType != null && section != null )
{
for ( int i = 0, s0 = sourceSectionsType.getSourceSection().size(); i < s0; i++ )
{
final SourceSectionType sourceSectionType = sourceSectionsType.getSourceSection().get( i );
Section childSection = section.getSection( sourceSectionType.getName() );
if ( childSection == null && !sourceSectionType.isOptional() )
{
childSection = this.createSection( StringUtils.defaultString( sourceFileType.getHeadComment() ),
StringUtils.defaultString( sourceFileType.getTailComment() ),
sourceSectionType );
section.getSections().add( childSection );
if ( isLoggable( Level.FINE ) )
{
log( Level.FINE, getMessage(
"addedSection", sourceFileType.getIdentifier(), childSection.getName() ), null );
}
this.getAddedSections().add( childSection );
}
this.createSections( sourceFileType, sourceSectionType.getSourceSections(), childSection );
}
}
}
/**
* Creates a new {@code Section} instance for a given {@code SourceSectionType}.
*
* @param headComment Characters to use to start a comment in the source file.
* @param tailComment Characters to use to end a comment in the source file.
* @param sourceSectionType The {@code SourceSectionType} to create a new {@code Section} instance for.
*
* @return A new {@code Section} instance for {@code sourceSectionType}.
*
* @throws NullPointerException if {@code headComment}, {@code tailComment} or {@code sourceSectionType} is
* {@code null}.
* @throws IOException if creating a new {@code Section} instance fails.
*
* @since 1.2
*/
private Section createSection( final String headComment, final String tailComment,
final SourceSectionType sourceSectionType ) throws IOException
{
if ( headComment == null )
{
throw new NullPointerException( "headComment" );
}
if ( tailComment == null )
{
throw new NullPointerException( "tailComment" );
}
if ( sourceSectionType == null )
{
throw new NullPointerException( "sourceSectionType" );
}
final Section s = new Section();
s.setName( sourceSectionType.getName() );
final StringBuilder head = new StringBuilder( 255 );
head.append( getIndentation( sourceSectionType.getIndentationLevel() ) ).append( headComment );
s.setStartingLine( head + " SECTION-START[" + sourceSectionType.getName() + ']' + tailComment );
s.setEndingLine( head + " SECTION-END" + tailComment );
return s;
}
private void editSourceFile( final File sourcesDirectory ) throws IOException
{
if ( sourcesDirectory == null )
{
throw new NullPointerException( "sourcesDirectory" );
}
if ( !sourcesDirectory.isDirectory() )
{
throw new IOException( getMessage( "directoryNotFound", sourcesDirectory.getAbsolutePath() ) );
}
final SourceFileType model = this.getSourceFileType();
if ( model != null && model.getLocation() != null )
{
final File f = new File( sourcesDirectory, model.getLocation() );
try
{
String content = "";
String edited = null;
boolean creating = false;
if ( !f.exists() )
{
if ( model.getTemplate() != null )
{
final StringWriter writer = new StringWriter();
final Template template = getVelocityTemplate( model.getTemplate() );
final VelocityContext ctx = this.getVelocityContext();
ctx.put( "template", template );
template.merge( ctx, writer );
writer.close();
content = writer.toString();
ctx.remove( "template" );
creating = true;
}
}
else
{
if ( isLoggable( Level.FINER ) )
{
log( Level.FINER, getMessage( "reading", f.getAbsolutePath() ), null );
}
content = this.readSourceFile( f );
}
try
{
edited = super.edit( content );
}
catch ( final IOException e )
{
// JDK: As of JDK 6, "new IOException( message, cause )".
throw (IOException) new IOException( getMessage(
"failedEditing", f.getAbsolutePath(), getMessage( e ) ) ).initCause( e );
}
if ( !edited.equals( content ) || edited.length() == 0 )
{
if ( !f.getParentFile().exists() && !f.getParentFile().mkdirs() )
{
throw new IOException( getMessage(
"failedCreatingDirectory", f.getParentFile().getAbsolutePath() ) );
}
if ( isLoggable( Level.INFO ) )
{
log( Level.INFO, getMessage(
creating ? "creating" : "editing", f.getAbsolutePath() ), null );
}
this.writeSourceFile( f, edited );
}
else if ( isLoggable( Level.FINER ) )
{
log( Level.FINER, getMessage( "unchanged", f.getAbsolutePath() ), null );
}
}
catch ( final VelocityException e )
{
// JDK: As of JDK 6, "new IOException( message, cause )".
throw (IOException) new IOException( getMessage(
"failedEditing", f.getAbsolutePath(), getMessage( e ) ) ).initCause( e );
}
}
}
private String readSourceFile( final File file ) throws IOException
{
if ( file == null )
{
throw new NullPointerException( "file" );
}
RandomAccessFile randomAccessFile = null;
FileChannel fileChannel = null;
FileLock fileLock = null;
boolean suppressExceptionOnClose = true;
//final Charset charset = Charset.forName( getInputEncoding() );
final int length = file.length() > 0L ? Long.valueOf( file.length() ).intValue() : 1;
final ByteBuffer buf = ByteBuffer.allocate( length );
final StringBuilder appendable = new StringBuilder( length );
try
{
randomAccessFile = new RandomAccessFile( file, "r" );
fileChannel = randomAccessFile.getChannel();
fileLock = fileChannel.lock( 0L, file.length(), true );
fileChannel.position( 0L );
buf.clear();
int read = fileChannel.read( buf );
while ( read != -1 )
{
// JDK: As of JDK 6, new String( byte[], int, int, Charset )
appendable.append( new String( buf.array(), buf.arrayOffset(), read, getInputEncoding() ) );
buf.clear();
read = fileChannel.read( buf );
}
suppressExceptionOnClose = false;
return appendable.toString();
}
finally
{
this.releaseAndClose( fileLock, fileChannel, randomAccessFile, suppressExceptionOnClose );
}
}
private void writeSourceFile( final File file, final String content ) throws IOException
{
if ( file == null )
{
throw new NullPointerException( "file" );
}
if ( content == null )
{
throw new NullPointerException( "content" );
}
RandomAccessFile randomAccessFile = null;
FileChannel fileChannel = null;
FileLock fileLock = null;
boolean suppressExceptionOnClose = true;
final byte[] bytes = content.getBytes( getOutputEncoding() );
try
{
randomAccessFile = new RandomAccessFile( file, "rw" );
fileChannel = randomAccessFile.getChannel();
fileLock = fileChannel.lock( 0L, bytes.length, false );
fileChannel.truncate( bytes.length );
fileChannel.position( 0L );
fileChannel.write( ByteBuffer.wrap( bytes ) );
fileChannel.force( true );
suppressExceptionOnClose = false;
}
finally
{
this.releaseAndClose( fileLock, fileChannel, randomAccessFile, suppressExceptionOnClose );
}
}
private void releaseAndClose( final FileLock fileLock, final FileChannel fileChannel,
final RandomAccessFile randomAccessFile, final boolean suppressExceptions )
throws IOException
{
try
{
if ( fileLock != null )
{
fileLock.release();
}
}
catch ( final IOException e )
{
if ( suppressExceptions )
{
log( Level.SEVERE, null, e );
}
else
{
throw e;
}
}
finally
{
try
{
if ( fileChannel != null )
{
fileChannel.close();
}
}
catch ( final IOException e )
{
if ( suppressExceptions )
{
log( Level.SEVERE, null, e );
}
else
{
throw e;
}
}
finally
{
try
{
if ( randomAccessFile != null )
{
randomAccessFile.close();
}
}
catch ( final IOException e )
{
if ( suppressExceptions )
{
log( Level.SEVERE, null, e );
}
else
{
throw e;
}
}
}
}
}
}
}