001    /*
002     * Copyright 2010-2013 JetBrains s.r.o.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.jetbrains.jet.renderer;
018    
019    import org.jetbrains.annotations.NotNull;
020    import org.jetbrains.jet.lang.descriptors.DeclarationDescriptor;
021    import org.jetbrains.jet.lang.descriptors.FunctionDescriptor;
022    import org.jetbrains.jet.lang.descriptors.ValueParameterDescriptor;
023    import org.jetbrains.jet.lang.descriptors.annotations.AnnotationDescriptor;
024    import org.jetbrains.jet.lang.types.JetType;
025    import org.jetbrains.jet.lang.types.TypeProjection;
026    
027    import java.util.List;
028    
029    public interface DescriptorRenderer extends Renderer<DeclarationDescriptor> {
030        DescriptorRenderer COMPACT_WITH_MODIFIERS = new DescriptorRendererBuilder().setWithDefinedIn(false).build();
031    
032        DescriptorRenderer SOURCE_CODE = new DescriptorRendererBuilder()
033                .setNormalizedVisibilities(true)
034                .setWithDefinedIn(false)
035                .setShortNames(false)
036                .setShowInternalKeyword(false)
037                .setOverrideRenderingPolicy(OverrideRenderingPolicy.RENDER_OVERRIDE)
038                .setUnitReturnType(false).build();
039    
040        DescriptorRenderer SOURCE_CODE_SHORT_NAMES_IN_TYPES = new DescriptorRendererBuilder()
041                .setNormalizedVisibilities(true)
042                .setWithDefinedIn(false)
043                .setShortNames(true)
044                .setShowInternalKeyword(false)
045                .setOverrideRenderingPolicy(OverrideRenderingPolicy.RENDER_OVERRIDE)
046                .setUnitReturnType(false).build();
047    
048        DescriptorRenderer COMPACT = new DescriptorRendererBuilder()
049                .setWithDefinedIn(false)
050                .setModifiers().build();
051    
052        DescriptorRenderer STARTS_FROM_NAME = new DescriptorRendererBuilder()
053                .setWithDefinedIn(false)
054                .setModifiers()
055                .setStartFromName(true).build();
056    
057        DescriptorRenderer TEXT = new DescriptorRendererBuilder().build();
058    
059        DescriptorRenderer SHORT_NAMES_IN_TYPES = new DescriptorRendererBuilder().setShortNames(true).build();
060    
061        DescriptorRenderer DEBUG_TEXT = new DescriptorRendererBuilder().setDebugMode(true).build();
062    
063        DescriptorRenderer HTML = new DescriptorRendererBuilder().setTextFormat(TextFormat.HTML).build();
064    
065        @NotNull
066        String renderType(@NotNull JetType type);
067    
068        @NotNull
069        String renderTypeArguments(@NotNull List<TypeProjection> typeArguments);
070    
071        @NotNull
072        String renderAnnotation(@NotNull AnnotationDescriptor annotation);
073    
074        @NotNull
075        @Override
076        String render(@NotNull DeclarationDescriptor declarationDescriptor);
077    
078        @NotNull
079        String renderFunctionParameters(@NotNull FunctionDescriptor functionDescriptor);
080    
081        enum TextFormat {
082            PLAIN, HTML
083        }
084    
085        enum OverrideRenderingPolicy {
086            RENDER_OVERRIDE, RENDER_OPEN, RENDER_OPEN_OVERRIDE
087        }
088    
089        enum Modifier {
090            VISIBILITY, MODALITY, OVERRIDE, ANNOTATIONS, INNER, MEMBER_KIND
091        }
092    
093        /** @see DefaultValueParameterHandler */
094        interface ValueParametersHandler {
095            void appendBeforeValueParameters(@NotNull FunctionDescriptor function, @NotNull StringBuilder stringBuilder);
096            void appendAfterValueParameters(@NotNull FunctionDescriptor function, @NotNull StringBuilder stringBuilder);
097    
098            void appendBeforeValueParameter(@NotNull ValueParameterDescriptor parameter, @NotNull StringBuilder stringBuilder);
099            void appendAfterValueParameter(@NotNull ValueParameterDescriptor parameter, @NotNull StringBuilder stringBuilder);
100        }
101    
102        class DefaultValueParameterHandler implements ValueParametersHandler {
103            @Override
104            public void appendBeforeValueParameters(@NotNull FunctionDescriptor function, @NotNull StringBuilder stringBuilder) {
105                stringBuilder.append("(");
106            }
107    
108            @Override
109            public void appendAfterValueParameters(@NotNull FunctionDescriptor function, @NotNull StringBuilder stringBuilder) {
110                stringBuilder.append(")");
111            }
112    
113            @Override
114            public void appendBeforeValueParameter(@NotNull ValueParameterDescriptor parameter, @NotNull StringBuilder stringBuilder) {
115            }
116    
117            @Override
118            public void appendAfterValueParameter(@NotNull ValueParameterDescriptor parameter, @NotNull StringBuilder stringBuilder) {
119                FunctionDescriptor function = (FunctionDescriptor) parameter.getContainingDeclaration();
120                if (parameter.getIndex() != function.getValueParameters().size() - 1) {
121                    stringBuilder.append(", ");
122                }
123            }
124        }
125    }