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