blob: 3396d0a5336014755ed7cb9f3ab433d1a5601edd [file] [log] [blame]
/*
* Copyright 2000-2010 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 org.jetbrains.android.actions;
import com.android.SdkConstants;
import com.android.builder.model.SourceProvider;
import com.android.ide.common.resources.configuration.FolderConfiguration;
import com.android.resources.ResourceFolderType;
import com.android.resources.ResourceType;
import com.intellij.CommonBundle;
import com.intellij.openapi.actionSystem.*;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.fileTypes.StdFileTypes;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.InputValidator;
import com.intellij.openapi.ui.Messages;
import com.intellij.openapi.util.Computable;
import com.intellij.openapi.util.io.FileUtilRt;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.PsiDirectory;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiManager;
import com.intellij.psi.xml.XmlFile;
import org.jetbrains.android.facet.AndroidFacet;
import org.jetbrains.android.facet.IdeaSourceProvider;
import org.jetbrains.android.util.AndroidBundle;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.File;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
/**
* @author Eugene.Kudelevsky
*/
public class CreateResourceFileAction extends CreateResourceActionBase {
private static final Logger LOG = Logger.getInstance("#org.jetbrains.android.actions.CreateResourceFileAction");
private final Map<String, CreateTypedResourceFileAction> mySubactions = new HashMap<String, CreateTypedResourceFileAction>();
private String myRootElement;
private boolean myNavigate;
@NotNull
public static CreateResourceFileAction getInstance() {
AnAction action = ActionManager.getInstance().getAction("Android.CreateResourcesActionGroup");
assert action instanceof CreateResourceFileActionGroup;
return ((CreateResourceFileActionGroup)action).getCreateResourceFileAction();
}
public CreateResourceFileAction() {
super(AndroidBundle.message("new.resource.action.title"), AndroidBundle.message("new.resource.action.description"),
StdFileTypes.XML.getIcon());
}
public void add(CreateTypedResourceFileAction action) {
mySubactions.put(action.getResourceType(), action);
}
public Collection<CreateTypedResourceFileAction> getSubactions() {
return mySubactions.values();
}
@Override
protected boolean isAvailable(DataContext context) {
if (!super.isAvailable(context)) return false;
return isOutsideResourceTypeFolder(context);
}
/** Returns true if the context points to an Android module, but outside of a specific resource type folder */
static boolean isOutsideResourceTypeFolder(@NotNull DataContext context) {
// Avoid listing these actions in folders where we have a more specific action (e.g. "Add Layout File")
VirtualFile file = CommonDataKeys.VIRTUAL_FILE.getData(context);
if (file != null) {
if (!file.isDirectory()) {
file = file.getParent();
}
if (file != null && ResourceFolderType.getFolderType(file.getName()) != null) {
// TODO: Also check that it's really a resource folder!
return false;
}
}
// Offer creating resource files from anywhere in the project (as is done for Java Classes) as long as it's within an Android module
Module module = LangDataKeys.MODULE.getData(context);
if (module != null) {
return AndroidFacet.getInstance(module) != null;
}
PsiElement element = CommonDataKeys.PSI_ELEMENT.getData(context);
return element != null && AndroidFacet.getInstance(element) != null;
}
@Nullable
public static XmlFile createFileResource(@NotNull AndroidFacet facet,
@NotNull final ResourceFolderType resType,
@Nullable String resName,
@Nullable String rootElement,
@Nullable FolderConfiguration config,
boolean chooseResName,
@Nullable String dialogTitle,
boolean navigate) {
final PsiElement[] elements = doCreateFileResource(facet, resType, resName, rootElement,
config, chooseResName, dialogTitle, navigate);
if (elements.length == 0) {
return null;
}
assert elements.length == 1 && elements[0] instanceof XmlFile;
return (XmlFile)elements[0];
}
@Deprecated
@Nullable
public static XmlFile createFileResource(@NotNull AndroidFacet facet,
@NotNull final ResourceType resType,
@Nullable String resName,
@Nullable String rootElement,
@Nullable FolderConfiguration config,
boolean chooseResName,
@Nullable String dialogTitle) {
// THIS IS WRONG. You can't create resource folders from a ResourceType; you should use a ResourceFolderType.
// For example, a ResourceType.STRING has no corresponding resource folder; it should be ResourceFolderType.VALUES.
// However, I changed the type in this method to ResourceFolderType, and it cascaded down to a lot of references,
// which in turn were called by many other references, so I'm adding a conversion here; we should revisit
// this soon and switch to the correct type. (The correct method exists below; this method should be deleted.)
ResourceFolderType folderType = ResourceFolderType.getTypeByName(resType.getName());
assert folderType != null : resType;
return createFileResource(facet, folderType, resName, rootElement, config, chooseResName, dialogTitle, true);
}
@Nullable
public static XmlFile createFileResource(@NotNull AndroidFacet facet,
@NotNull final ResourceFolderType folderType,
@Nullable String resName,
@Nullable String rootElement,
@Nullable FolderConfiguration config,
boolean chooseResName,
@Nullable String dialogTitle) {
return createFileResource(facet, folderType, resName, rootElement, config, chooseResName, dialogTitle, true);
}
@NotNull
private static PsiElement[] doCreateFileResource(@NotNull AndroidFacet facet,
@NotNull final ResourceFolderType resType,
@Nullable String resName,
@Nullable String rootElement,
@Nullable FolderConfiguration config,
boolean chooseResName,
@Nullable String dialogTitle,
final boolean navigate) {
final CreateResourceFileAction action = getInstance();
final String subdirName;
final Module selectedModule;
final VirtualFile resourceDir;
final AndroidFacet selectedFacet;
if (ApplicationManager.getApplication().isUnitTestMode()) {
subdirName = resType.getName();
selectedModule = facet.getModule();
selectedFacet = facet;
resourceDir = facet.getPrimaryResourceDir();
}
else {
final MyDialog dialog = new MyDialog(facet, action.mySubactions.values(), resType, resName, rootElement,
config, chooseResName, action, facet.getModule(), true,
null);
dialog.setNavigate(navigate);
if (dialogTitle != null) {
dialog.setTitle(dialogTitle);
}
if (!dialog.showAndGet()) {
return PsiElement.EMPTY_ARRAY;
}
if (chooseResName) {
resName = dialog.getFileName();
}
subdirName = dialog.getSubdirName();
selectedModule = dialog.getSelectedModule();
selectedFacet = AndroidFacet.getInstance(selectedModule);
assert selectedFacet != null;
SourceProvider provider = dialog.getSourceProvider();
if (provider != null) {
Collection<VirtualFile> resDirectories = IdeaSourceProvider.create(provider).getResDirectories();
if (resDirectories.isEmpty()) {
resourceDir = resDirectories.iterator().next();
} else {
resourceDir = selectedFacet.getPrimaryResourceDir();
}
} else {
resourceDir = selectedFacet.getPrimaryResourceDir();
}
}
final Project project = facet.getModule().getProject();
final PsiDirectory psiResDir = resourceDir != null ? PsiManager.getInstance(project).findDirectory(resourceDir) : null;
if (psiResDir == null) {
Messages.showErrorDialog(project, "Cannot find resource directory for module " + selectedFacet.getModule().getName(),
CommonBundle.getErrorTitle());
return PsiElement.EMPTY_ARRAY;
}
final String finalResName = resName;
final PsiElement[] elements = ApplicationManager.getApplication().runWriteAction(new Computable<PsiElement[]>() {
@Nullable
@Override
public PsiElement[] compute() {
MyInputValidator validator = action.createValidator(project, psiResDir, subdirName);
return validator.checkInput(finalResName) && validator.canClose(finalResName)
? validator.getCreatedElements()
: null;
}
});
return elements != null ? elements : PsiElement.EMPTY_ARRAY;
}
@NotNull
@Override
public PsiElement[] invokeDialog(@NotNull final Project project, @NotNull final DataContext dataContext) {
Module module = LangDataKeys.MODULE.getData(dataContext);
if (module == null) {
return PsiElement.EMPTY_ARRAY;
}
final AndroidFacet facet = AndroidFacet.getInstance(module);
LOG.assertTrue(facet != null);
VirtualFile[] files = CommonDataKeys.VIRTUAL_FILE_ARRAY.getData(dataContext);
ResourceFolderType folderType = getUniqueFolderType(files);
FolderConfiguration config = null;
if (files != null && files.length > 0) {
config = files.length == 1 ? FolderConfiguration.getConfigForFolder(files[0].getName()) : null;
}
final MyDialog dialog =
new MyDialog(facet, mySubactions.values(), folderType, null, null, config, true, CreateResourceFileAction.this, facet.getModule(),
false, findResourceDirectory(dataContext)) {
@Override
protected InputValidator createValidator(@NotNull String subdirName) {
Module module = LangDataKeys.MODULE.getData(dataContext);
assert module != null;
PsiDirectory resourceDirectory = getResourceDirectory(dataContext, true);
return CreateResourceFileAction.this.createValidator(module.getProject(), resourceDirectory, subdirName);
}
};
dialog.show();
return PsiElement.EMPTY_ARRAY;
}
@Nullable
static ResourceFolderType getUniqueFolderType(@Nullable VirtualFile[] files) {
ResourceFolderType folderType = null;
if (files != null && files.length > 0) {
for (VirtualFile file : files) {
if (!file.isDirectory()) {
file = file.getParent();
}
if (file != null) {
ResourceFolderType type = ResourceFolderType.getFolderType(file.getName());
if (type != null) {
// Ensure that if there are multiple files, they all have the same type
if (type != folderType && folderType != null) {
folderType = null;
break;
}
else {
folderType = type;
}
}
}
}
}
return folderType;
}
@NotNull
private MyInputValidator createValidator(Project project, final PsiDirectory resDir, final String subdirName) {
PsiDirectory resSubdir = resDir.findSubdirectory(subdirName);
if (resSubdir == null) {
resSubdir = ApplicationManager.getApplication().runWriteAction(new Computable<PsiDirectory>() {
@Override
public PsiDirectory compute() {
return resDir.createSubdirectory(subdirName);
}
});
}
return new MyInputValidator(project, resSubdir);
}
@NotNull
@Override
protected PsiElement[] create(String newName, PsiDirectory directory) throws Exception {
CreateTypedResourceFileAction action = getActionByDir(directory);
if (action == null) {
throw new IllegalArgumentException("Incorrect directory");
}
if (myRootElement != null && myRootElement.length() > 0) {
return action.doCreateAndNavigate(newName, directory, myRootElement, false, myNavigate);
}
return action.create(newName, directory);
}
private CreateTypedResourceFileAction getActionByDir(PsiDirectory directory) {
String baseDirName = directory.getName();
final int index = baseDirName.indexOf(SdkConstants.RES_QUALIFIER_SEP);
if (index >= 0) {
baseDirName = baseDirName.substring(0, index);
}
return mySubactions.get(baseDirName);
}
@Override
protected String getErrorTitle() {
return CommonBundle.getErrorTitle();
}
@Override
protected String getCommandName() {
return AndroidBundle.message("new.resource.command.name");
}
@Nullable
@Override
protected String getActionName(PsiDirectory directory, String newName) {
return doGetActionName(directory, newName);
}
static String doGetActionName(PsiDirectory directory, String newName) {
if (FileUtilRt.getExtension(newName).length() == 0) {
newName += ".xml";
}
return AndroidBundle.message("new.resource.action.name", directory.getName() + File.separator + newName);
}
private static class MyDialog extends CreateResourceFileDialog {
private final CreateResourceFileAction myAction;
private boolean myNavigate = true;
protected MyDialog(@NotNull AndroidFacet facet,
Collection<CreateTypedResourceFileAction> actions,
@Nullable ResourceFolderType predefinedResourceType,
@Nullable String predefinedFileName,
@Nullable String predefinedRootElement,
@Nullable FolderConfiguration predefinedConfig,
boolean chooseFileName,
@NotNull CreateResourceFileAction action,
@NotNull Module module,
boolean chooseModule,
@Nullable PsiDirectory resDirectory) {
super(facet, actions, predefinedResourceType, predefinedFileName, predefinedRootElement,
predefinedConfig, chooseFileName, module, chooseModule, resDirectory);
myAction = action;
}
@Override
protected void doOKAction() {
myAction.myRootElement = getRootElement();
myAction.myNavigate = myNavigate;
super.doOKAction();
}
public void setNavigate(boolean navigate) {
myNavigate = navigate;
}
}
}