All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jetbrains.jet.util.slicedmap.Slices Maven / Gradle / Ivy

There is a newer version: 2.0.0-RC2
Show newest version
/*
 * Copyright 2010-2013 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jetbrains.jet.util.slicedmap;

import com.intellij.openapi.diagnostic.Logger;
import org.jetbrains.annotations.NotNull;

import java.util.Arrays;
import java.util.List;

public class Slices {
    private static final Logger LOG = Logger.getInstance(Slices.class);

    public static final RewritePolicy ONLY_REWRITE_TO_EQUAL = new RewritePolicy() {
        @Override
        public  boolean rewriteProcessingNeeded(K key) {
            return true;
        }

        @Override
        public  boolean processRewrite(WritableSlice slice, K key, V oldValue, V newValue) {
            if (!((oldValue == null && newValue == null) || (oldValue != null && oldValue.equals(newValue)))) {
                // NOTE: Use BindingTraceContext.TRACK_REWRITES to debug this exception
                LOG.error("Rewrite at slice " + slice +
                        " key: " + key +
                        " old value: " + oldValue + '@' + System.identityHashCode(oldValue) +
                        " new value: " + newValue + '@' + System.identityHashCode(newValue));
            }
            return true;
        }
    };

    private Slices() {
    }

    public interface KeyNormalizer {
        KeyNormalizer DO_NOTHING = new KeyNormalizer() {
            @Override
            public Object normalize(Object key) {
                return key;
            }
        };

        K normalize(K key);
    }

    public static  SliceBuilder sliceBuilder() {
        return new SliceBuilder(ONLY_REWRITE_TO_EQUAL);
    }

    public static  WritableSlice createSimpleSlice() {
        return new BasicWritableSlice(ONLY_REWRITE_TO_EQUAL);
    }

    public static  WritableSlice createCollectiveSlice() {
        return new BasicWritableSlice(ONLY_REWRITE_TO_EQUAL, true);
    }

    public static  WritableSlice createSimpleSetSlice() {
        return createRemovableSetSlice();
    }

    public static  WritableSlice createCollectiveSetSlice() {
        return new SetSlice(RewritePolicy.DO_NOTHING, true);
    }

    public static  RemovableSlice createRemovableSetSlice() {
        return new SetSlice(RewritePolicy.DO_NOTHING, false);
    }

    public static class SliceBuilder {
        private V defaultValue = null;
        private List> furtherLookupSlices = null;
        private WritableSlice opposite = null;
        private KeyNormalizer keyNormalizer = null;

        private final RewritePolicy rewritePolicy;

        private String debugName;

        private SliceBuilder(RewritePolicy rewritePolicy) {
            this.rewritePolicy = rewritePolicy;
        }

        public SliceBuilder setDefaultValue(V defaultValue) {
            this.defaultValue = defaultValue;
            return this;
        }

        public SliceBuilder setFurtherLookupSlices(ReadOnlySlice... furtherLookupSlices) {
            this.furtherLookupSlices = Arrays.asList(furtherLookupSlices);
            return this;
        }

        public SliceBuilder setOpposite(WritableSlice opposite) {
            this.opposite = opposite;
            return this;
        }

        public SliceBuilder setDebugName(@NotNull String debugName) {
            this.debugName = debugName;
            return this;
        }

        public SliceBuilder setKeyNormalizer(KeyNormalizer keyNormalizer) {
            this.keyNormalizer = keyNormalizer;
            return this;
        }

        public RemovableSlice  build() {
            SliceWithOpposite result = doBuild();
            if (debugName != null) {
                result.setDebugName(debugName);
            }
            return result;
        }

        private SliceWithOpposite doBuild() {
            if (defaultValue != null) {
                return new SliceWithOpposite(rewritePolicy, opposite, keyNormalizer) {
                    @Override
                    public V computeValue(SlicedMap map, K key, V value, boolean valueNotFound) {
                        if (valueNotFound) return defaultValue;
                        return super.computeValue(map, key, value, false);
                    }
                };
            }
            if (furtherLookupSlices != null) {
                return new SliceWithOpposite(rewritePolicy, opposite, keyNormalizer) {
                    @Override
                    public V computeValue(SlicedMap map, K key, V value, boolean valueNotFound) {
                        if (valueNotFound) {
                            for (ReadOnlySlice slice : furtherLookupSlices) {
                                V v = map.get(slice, key);
                                if (v != null) {
                                    return v;
                                }
                            }
                            return defaultValue;
                        }
                        return super.computeValue(map, key, value, false);
                    }
                };
            }
            return new SliceWithOpposite(rewritePolicy, opposite, keyNormalizer);
        }
    }

    public static class BasicRemovableSlice extends BasicWritableSlice implements RemovableSlice {
        protected BasicRemovableSlice(RewritePolicy rewritePolicy) {
            super(rewritePolicy);
        }

        protected BasicRemovableSlice(RewritePolicy rewritePolicy, boolean isCollective) {
            super(rewritePolicy, isCollective);
        }
    }

    public static class SliceWithOpposite extends BasicRemovableSlice {
        private final WritableSlice opposite;
        private final KeyNormalizer keyNormalizer;

        public SliceWithOpposite(RewritePolicy rewritePolicy, WritableSlice opposite, KeyNormalizer keyNormalizer) {
            super(rewritePolicy);
            this.opposite = opposite;
            this.keyNormalizer = keyNormalizer;
        }

        @Override
        public void afterPut(MutableSlicedMap map, K key, V value) {
            if (opposite != null) {
                map.put(opposite, value, key);
            }
        }
        @Override
        public SlicedMapKey makeKey(K key) {
            if (keyNormalizer == null) {
                return super.makeKey(key);
            }
            return super.makeKey(keyNormalizer.normalize(key));
        }

    }

    public static class SetSlice extends BasicRemovableSlice {

        protected SetSlice(RewritePolicy rewritePolicy) {
            this(rewritePolicy, false);
        }

        protected SetSlice(RewritePolicy rewritePolicy, boolean collective) {
            super(rewritePolicy, collective);
        }

        @Override
        public Boolean computeValue(SlicedMap map, K key, Boolean value, boolean valueNotFound) {
            Boolean result = super.computeValue(map, key, value, valueNotFound);
            return result != null ? result : false;
        }
    }

}