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 FQ_NAMES_IN_TYPES = new DescriptorRendererBuilder().build();
058
059 DescriptorRenderer SHORT_NAMES_IN_TYPES = new DescriptorRendererBuilder().setShortNames(true).setIncludeSynthesizedParameterNames(false).build();
060
061 DescriptorRenderer DEBUG_TEXT = new DescriptorRendererBuilder().setDebugMode(true).build();
062
063 DescriptorRenderer HTML_COMPACT_WITH_MODIFIERS = new DescriptorRendererBuilder()
064 .setWithDefinedIn(false)
065 .setTextFormat(TextFormat.HTML).build();
066
067 DescriptorRenderer HTML = new DescriptorRendererBuilder().setTextFormat(TextFormat.HTML).build();
068
069 DescriptorRenderer HTML_FOR_UNINFERRED_TYPE_PARAMS = new DescriptorRendererBuilder()
070 .setUninferredTypeParameterAsName(true)
071 .setModifiers()
072 .setShortNames(true)
073 .setTextFormat(TextFormat.HTML).build();
074
075 @NotNull
076 String renderType(@NotNull JetType type);
077
078 @NotNull
079 String renderTypeArguments(@NotNull List<TypeProjection> typeArguments);
080
081 @NotNull
082 String renderAnnotation(@NotNull AnnotationDescriptor annotation);
083
084 @NotNull
085 @Override
086 String render(@NotNull DeclarationDescriptor declarationDescriptor);
087
088 @NotNull
089 String renderFunctionParameters(@NotNull FunctionDescriptor functionDescriptor);
090
091 enum TextFormat {
092 PLAIN, HTML
093 }
094
095 enum OverrideRenderingPolicy {
096 RENDER_OVERRIDE, RENDER_OPEN, RENDER_OPEN_OVERRIDE
097 }
098
099 enum Modifier {
100 VISIBILITY, MODALITY, OVERRIDE, ANNOTATIONS, INNER, MEMBER_KIND
101 }
102
103 /** @see DefaultValueParameterHandler */
104 interface ValueParametersHandler {
105 void appendBeforeValueParameters(@NotNull FunctionDescriptor function, @NotNull StringBuilder stringBuilder);
106 void appendAfterValueParameters(@NotNull FunctionDescriptor function, @NotNull StringBuilder stringBuilder);
107
108 void appendBeforeValueParameter(@NotNull ValueParameterDescriptor parameter, @NotNull StringBuilder stringBuilder);
109 void appendAfterValueParameter(@NotNull ValueParameterDescriptor parameter, @NotNull StringBuilder stringBuilder);
110 }
111
112 class DefaultValueParameterHandler implements ValueParametersHandler {
113 @Override
114 public void appendBeforeValueParameters(@NotNull FunctionDescriptor function, @NotNull StringBuilder stringBuilder) {
115 stringBuilder.append("(");
116 }
117
118 @Override
119 public void appendAfterValueParameters(@NotNull FunctionDescriptor function, @NotNull StringBuilder stringBuilder) {
120 stringBuilder.append(")");
121 }
122
123 @Override
124 public void appendBeforeValueParameter(@NotNull ValueParameterDescriptor parameter, @NotNull StringBuilder stringBuilder) {
125 }
126
127 @Override
128 public void appendAfterValueParameter(@NotNull ValueParameterDescriptor parameter, @NotNull StringBuilder stringBuilder) {
129 FunctionDescriptor function = (FunctionDescriptor) parameter.getContainingDeclaration();
130 if (parameter.getIndex() != function.getValueParameters().size() - 1) {
131 stringBuilder.append(", ");
132 }
133 }
134 }
135 }