/*
* Copyright 2000-2009 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.
*/
/*
* @author max
*/
package com.intellij.codeStyle;
import com.intellij.lang.Language;
import com.intellij.openapi.components.ServiceManager;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.fileTypes.FileType;
import com.intellij.openapi.options.Configurable;
import com.intellij.openapi.project.Project;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public abstract class CodeStyleFacade {
public static CodeStyleFacade getInstance() {
return ServiceManager.getService(CodeStyleFacade.class);
}
public static CodeStyleFacade getInstance(@Nullable Project project) {
if (project == null) return getInstance();
return ServiceManager.getService(project, CodeStyleFacade.class);
}
/**
* Calculates the indent that should be used for the line at specified offset in the specified
* document.
*
* @param document the document for which the indent should be calculated.
* @param offset the caret offset in the editor.
* @return the indent string (containing of tabs and/or white spaces), or null if it
* was not possible to calculate the indent.
* @deprecated Use {@link #getLineIndent(Editor, Language, int)} instead.
*/
@Nullable
@Deprecated
public abstract String getLineIndent(@NotNull Document document, int offset);
/**
* Calculates the indent that should be used for the line at specified offset in the specified
* editor.
*
* @param editor The editor for which the indent must be returned.
* @param language Context language
* @param offset The caret offset in the editor.
* @return the indent string (containing of tabs and/or white spaces), or null if it
* was not possible to calculate the indent.
*/
public String getLineIndent(@NotNull Editor editor, @Nullable Language language, int offset) {
//noinspection deprecation
return getLineIndent(editor.getDocument(), offset);
}
public abstract int getIndentSize(FileType fileType);
public abstract boolean isSmartTabs(final FileType fileType);
public abstract int getRightMargin(Language language);
/**
* @return True if wrap on typing is enabled
* @deprecated Use isWrapOnTyping(language) instead
*/
public abstract boolean isWrapWhenTypingReachesRightMargin();
@SuppressWarnings("deprecation")
public boolean isWrapOnTyping(@Nullable Language language) {
return isWrapWhenTypingReachesRightMargin();
}
public abstract int getTabSize(final FileType fileType);
public abstract boolean useTabCharacter(final FileType fileType);
public abstract String getLineSeparator();
public abstract boolean projectUsesOwnSettings();
public abstract boolean isUnsuitableCodeStyleConfigurable(Configurable c);
}