root/dydoc/Dydoc.java

//
//      ===========================================================================
//
//      Title:          Dydoc.java
//      Description:    Somehwat similar to javadoc
//      Author:         Rapha‘l Szwarc <zoe (underscore) info (at) mac (dot) com>
//      Creation Date:  Thu Dec 09 2004
//      Legal:          Copyright (C) 2004 Rapha‘l Szwarc
//
//      This software is provided 'as-is', without any express or implied warranty. 
//      In no event will the author be held liable for any damages arising from 
//      the use of this software.
//
//      Permission is granted to anyone to use this software for any purpose, 
//      including commercial applications, and to alter it and 
//      redistribute it freely, subject to the following restrictions:
//
//      1. The origin of this software must not be misrepresented; 
//      you must not claim that you wrote the original software. 
//      If you use this software in a product, an acknowledgment
//      in the product documentation would be appreciated but is not required.
//
//      2. Altered source versions must be plainly marked as such, 
//      and must not be misrepresented as being the original software.
//
//      3. This notice may not be removed or altered from any source distribution.
//
//      ---------------------------------------------------------------------------
//

package alt.dev.dydoc;

import java.io.File;

import java.net.URI;

import java.util.Collections;
import java.util.Collection;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.HashMap;
import java.util.HashSet;
import java.util.TreeSet;
import java.util.Iterator;

import alt.dev.pl.PL;

import alt.dev.szfoundation.SZClassLoader;
import alt.dev.szfoundation.SZLog;

public class Dydoc extends Object implements Runnable
{

//      ===========================================================================
//      Constant(s)
//      ---------------------------------------------------------------------------

//      ===========================================================================
//      Class variable(s)
//      ---------------------------------------------------------------------------

//      ===========================================================================
//      Instance variable(s)
//      ---------------------------------------------------------------------------

        private URI             _uri = null;
        private transient PL    _properties = null;

//      ===========================================================================
//      Constructor method(s)
//      ---------------------------------------------------------------------------

        public Dydoc(final URI anURI)
        {
                super();
                
                this.setURI( anURI );
        }

//      ===========================================================================
//      Class method(s)
//      ---------------------------------------------------------------------------

        public static void main(final String[] someArguments) throws Throwable
        {
                try
                {
                        Dydoc   aTool = null;
                        URI     anURI = null;
                        
                        SZClassLoader.setup();
                        
                        System.setProperty( "platform.file.encoding", System.getProperty( "file.encoding" ) );
                        System.setProperty( "file.encoding", "UTF-8" );
                        System.setProperty( "java.awt.headless", Boolean.TRUE.toString() );
                        
                        if ( ( someArguments != null ) && ( someArguments.length > 0 ) )
                        {
                                try
                                {
                                        anURI = new URI( someArguments[ 0 ] );
                                }
                                catch (Exception anException)
                                {
                                        SZLog.warning( anException );
                                }
                        }
                        
                        aTool = new Dydoc( anURI );
                        aTool.run();

                        System.exit( 0 );
                }
                catch (Throwable anException)
                {
                        SZLog.error( anException );
                }

                System.exit( 1 );
        }

//      ===========================================================================
//      Instance method(s)
//      ---------------------------------------------------------------------------

        public URI uri()
        {
                return _uri;
        }
        
        private void setURI(final URI aValue)
        {
                _uri = aValue;
        }
        
//      ===========================================================================
//      Properties method(s)
//      ---------------------------------------------------------------------------

        public PL properties()
        {
                if ( _properties == null )
                {
                        URI     anURI = this.uri();
                        
                        _properties = new PL();
                        
                        if ( ( anURI == null ) || ( anURI.getPath().endsWith( ".plist" ) == false ) )
                        {
                                File    aFile = new File( "dydoc.plist" );
                                
                                if ( aFile.exists() == true )
                                {
                                        anURI = aFile.toURI();
                                }
                        }
                        
                        if ( ( anURI != null ) && ( anURI.getPath().endsWith( ".plist" ) == true ) )
                        {
                                SZLog.info( "Loading properties from " + anURI );
                        
                                try
                                {
                                        _properties.load( anURI );
                                }
                                catch (Exception anException)
                                {
                                        SZLog.warning( anException );
                                }
                        }
                }
                
                return _properties;
        }
        
        public Collection jarURIs()
        {
                Collection      aCollection = new ArrayList();
                Collection      someURINames = this.properties().getCollection( "jar.dirs", null );
                
                if ( ( this.uri() != null ) && ( this.uri().getPath().endsWith( ".jar" ) == true ) )
                {
                        aCollection.add( this.uri() );
                }
                else
                if ( someURINames != null )
                {
                        for ( Iterator anIterator = someURINames.iterator(); anIterator.hasNext(); )
                        {
                                String  aName = (String) anIterator.next();
                                
                                try
                                {
                                        URI     anURI = new URI( aName );
                                        
                                        aCollection.add( anURI );
                                }
                                catch (Exception anException)
                                {
                                        SZLog.warning( anException );
                                }
                        }
                }
                
                if ( aCollection.isEmpty() == true )
                {
                        aCollection = null;
                }
                
                return aCollection;
        }

        public boolean includeDependencies()
        {
                return this.properties().getBoolean( "dependencies", false );
        }

//      ===========================================================================
//      Convenience method(s)
//      ---------------------------------------------------------------------------

        public Collection classesWithURI(final URI anURI, final boolean includeDependencies)
        {
                if ( anURI != null )
                {
                        Collection      aCollection = new TreeSet( ClassInfo.ClassComparator.comparator() );
                        
                        SZLog.info( "Loading classes from " + anURI );

                        for ( Iterator anIterator = new JarIterator( anURI ); anIterator.hasNext(); )
                        {
                                Class   aClass = (Class) anIterator.next();
                                
                                if ( includeDependencies == true )
                                {
                                        ClassInfo.classDependencies( aClass, aCollection );
                                }
                                else
                                if ( ClassInfo.accept( aClass, aClass.getModifiers() ) == true )
                                {
                                        aCollection.add( aClass );
                                }
                        }
                        
                        if ( aCollection.isEmpty() == true )
                        {
                                aCollection = null;
                        }
                        
                        return aCollection;
                }
                
                return null;
        }

        public Collection classes()
        {
                Collection      someJarURIs = this.jarURIs();
                
                if ( someJarURIs != null )
                {
                        Collection      aCollection = new TreeSet( ClassInfo.ClassComparator.comparator() );
                        boolean         includeDependencies = this.includeDependencies();
                        
                        for ( Iterator anIterator = someJarURIs.iterator(); anIterator.hasNext(); )
                        {
                                URI             anURI = (URI) anIterator.next();
                                Collection      someClasses = this.classesWithURI( anURI, includeDependencies );
                                
                                if ( someClasses != null )
                                {
                                        aCollection.addAll( someClasses );
                                }
                        }
                        
                        if ( aCollection.isEmpty() == true )
                        {
                                aCollection = null;
                        }
                        
                        return aCollection;
                }
                
                return null;
        }
        
        public Map packages()
        {
                return ClassInfo.packages( this.classes() );
        }

//      ===========================================================================
//      Runnable method(s)
//      ---------------------------------------------------------------------------

        public void run()
        {
                Collection      someClasses = this.classes();
                
                if ( someClasses != null )
                {
                        PL              someProperties = this.properties();
                        ClassStub       aClassStub = new ClassStub( someProperties );
                        Map             somePackages = this.packages();
                        
                        if ( somePackages != null )
                        {
                                Map             someBindings = new HashMap();
                                                someBindings.put( "values", somePackages.keySet() );
                                                someBindings.put( "docProperties", someProperties );
                                DocDoc          aDocDoc = new DocDoc( null, null, someBindings );
                                DocStub         aDocStub = new DocStub( someProperties );
                                PackageStub     aPackageStub = new PackageStub( someProperties );
                                
                                SZLog.info( "Generating dydoc index..." );

                                aDocStub.stub( null );
                                aDocDoc.store();

                                SZLog.info( "Generating dydoc library indices..." );

                                for ( Iterator anIterator = somePackages.keySet().iterator(); anIterator.hasNext(); )
                                {
                                        Package         aPackage = (Package) anIterator.next();
                                                        aPackageStub.stub( aPackage );
                                                        someBindings = new HashMap();
                                                        someBindings.put( "value", aPackage );
                                                        someBindings.put( "values", somePackages.get( aPackage ) );
                                                        someBindings.put( "docProperties", someProperties );
                                        PackageDoc      aPackageDoc = new PackageDoc( null, null, someBindings );
                                        
                                        aPackageDoc.store();
                                }
                        }

                        SZLog.info( "Generating dydoc classes..." );

                        for ( Iterator anIterator = someClasses.iterator(); anIterator.hasNext(); )
                        {
                                Class           aClass = (Class) anIterator.next();
                                                aClassStub.stub( aClass );
                                Map             someBindings = new HashMap();
                                                someBindings.put( "value", aClass );
                                                someBindings.put( "values", someClasses );
                                                someBindings.put( "docProperties", someProperties );
                                ClassDoc        aClassDoc = new ClassDoc( null, null, someBindings );
                                
                                aClassDoc.store();
                        }

                        SZLog.info( "Done" );
                }
        }

}