src/macosx/native/jobjc/src/generator/java/com/apple/internal/jobjc/generator/ClassConsolidator.java

/*
 * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.apple.internal.jobjc.generator;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.apple.internal.jobjc.generator.model.Category;
import com.apple.internal.jobjc.generator.model.Clazz;
import com.apple.internal.jobjc.generator.model.Framework;

public class ClassConsolidator {
    private static String[] PREFERRED_FRAMEWORKS = { "Foundation", "AppKit" };

    static void consolidateClassesForFrameworks(final List<Framework> frameworks) throws Throwable {
        System.out.println("--2-- Resolving duplicate classes:");
        final Map<String, List<Clazz>> allClasses = new HashMap<String, List<Clazz>>();

        for (final Framework framework : frameworks) {
            for (final Clazz clazz : framework.classes) {
                final List<Clazz> existingClazzList = allClasses.get(clazz.name);
                if(existingClazzList != null)
                    existingClazzList.add(clazz);
                else
                    allClasses.put(clazz.name, new ArrayList<Clazz>(Arrays.asList(clazz)));
            }
        }

        final Map<String, Clazz> filteredClasses = new HashMap<String, Clazz>();
        final List<List<Clazz>> dreggs = new ArrayList<List<Clazz>>();

        final Collection<List<Clazz>> clazzLists = allClasses.values();
        for (final List<Clazz> clazzList : clazzLists) {
            if (clazzList.size() > 1) {
                // add to the list for later analysis
                dreggs.add(clazzList);
                continue;
            }

            // if there is only one class definition, go with it!
            final Clazz clazz = clazzList.get(0);
            filteredClasses.put(clazz.name, clazz);
        }

        // figure out which class is the real class, and convert the rest to categories
        for (final List<Clazz> dreg : dreggs)
            deriveCategoriesFrom(dreg, filteredClasses);

        // patch up the inheritance hierarchy
        System.out.println("Determining super classes:");
        for (final Framework framework : frameworks)
            framework.resolveSuperClasses(filteredClasses);
    }

    private static void deriveCategoriesFrom(final List<Clazz> clazzes, final Map<String, Clazz> filteredClasses) {
        final List<Clazz> clazzesToDerive = new ArrayList<Clazz>(clazzes);

        for (final String preferredFrameworkName : PREFERRED_FRAMEWORKS) {
            for (final Clazz clazz : clazzesToDerive) {
                if (!preferredFrameworkName.equals(clazz.parent.name)) continue;

                System.out.print("\t" + clazz.parent.name + " owns \"" + clazz.name + "\", ");
                addCategoriesAndPatchClasses(clazzes, clazz);
                filteredClasses.put(clazz.name, clazz);
                return;
            }
        }

        final List<String> frameworkNameList = new ArrayList<String>(clazzes.size());
        for (final Clazz clazz : clazzes) frameworkNameList.add(clazz.parent.name);
        throw new RuntimeException("Could not derived a preferred framework for: " + clazzes.get(0).name + ", from (" + Utils.joinWComma(frameworkNameList) + ")");
    }

    private static void addCategoriesAndPatchClasses(final List<Clazz> clazzes, final Clazz clazz) {
        final List<String> fwNames = new ArrayList<String>(clazzes.size());

        for (final Clazz cls : clazzes) {
            if (cls == clazz) continue;
            fwNames.add(cls.parent.name);
            cls.parent.classes.remove(cls);
            cls.parent.categories.add(new Category(cls, clazz));
        }

        System.out.println("creating categories in: " + Utils.joinWComma(fwNames));
    }
}