/*
* Copyright 2000-2014 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 com.intellij.ide.ui;
import com.intellij.ide.IdeBundle;
import com.intellij.ide.SearchTopHitProvider;
import com.intellij.ide.ui.search.BooleanOptionDescription;
import com.intellij.openapi.application.ApplicationBundle;
import com.intellij.openapi.keymap.KeyMapBundle;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.codeStyle.MinusculeMatcher;
import com.intellij.psi.codeStyle.NameUtil;
import com.intellij.util.Consumer;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collection;
import java.util.List;
/**
* @author Konstantin Bulenkov
*/
public abstract class OptionsTopHitProvider implements SearchTopHitProvider {
@NotNull
public abstract Collection<BooleanOptionDescription> getOptions(@Nullable Project project);
@Override
public final void consumeTopHits(@NonNls String pattern, Consumer<Object> collector, Project project) {
if (!pattern.startsWith("#")) return;
pattern = pattern.substring(1);
final List<String> parts = StringUtil.split(pattern, " ");
if (parts.size() == 0) return;
String id = parts.get(0);
if (getId().startsWith(id)) {
pattern = pattern.substring(id.length()).trim().toLowerCase();
final MinusculeMatcher matcher = NameUtil.buildMatcher("*" + pattern, NameUtil.MatchingCaseSensitivity.NONE);
for (BooleanOptionDescription option : getOptions(project)) {
if (matcher.matches(option.getOption())) {
collector.consume(option);
}
}
}
}
public abstract String getId();
public boolean isEnabled(@Nullable Project project) {
return true;
}
static String messageApp(String property) {
return StringUtil.stripHtml(ApplicationBundle.message(property), false);
}
static String messageIde(String property) {
return StringUtil.stripHtml(IdeBundle.message(property), false);
}
static String messageKeyMap(String property) {
return StringUtil.stripHtml(KeyMapBundle.message(property), false);
}
/*
* Marker interface for option provider containing only descriptors which are backed by toggle actions.
* E.g. UiSettings.SHOW_STATUS_BAR is backed by View > Status Bar action.
*/
@Deprecated
public interface CoveredByToggleActions { // for search everywhere only
}
}