feature request 1245255, no uninitialized variable warning for functions with referen...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / wizards / HTMLFileWizard.java
1 package net.sourceforge.phpeclipse.wizards;
2
3 /**********************************************************************
4  Copyright (c) 2000, 2002 IBM Corp. and others.
5  All rights reserved. This program and the accompanying materials
6  are made available under the terms of the Common Public License v1.0
7  which accompanies this distribution, and is available at
8  http://www.eclipse.org/legal/cpl-v10.html
9
10  Contributors:
11  IBM Corporation - Initial implementation
12  www.phpeclipse.de
13  **********************************************************************/
14
15 import java.io.ByteArrayInputStream;
16 import java.io.IOException;
17 import java.io.InputStream;
18 import java.lang.reflect.InvocationTargetException;
19
20 import net.sourceforge.phpdt.internal.corext.codemanipulation.StubUtility;
21 import net.sourceforge.phpdt.internal.corext.template.php.CodeTemplateContext;
22 import net.sourceforge.phpdt.internal.corext.template.php.CodeTemplateContextType;
23 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
24
25 import org.eclipse.core.resources.IContainer;
26 import org.eclipse.core.resources.IFile;
27 import org.eclipse.core.resources.IProject;
28 import org.eclipse.core.resources.IResource;
29 import org.eclipse.core.resources.IWorkspaceRoot;
30 import org.eclipse.core.resources.ResourcesPlugin;
31 import org.eclipse.core.runtime.CoreException;
32 import org.eclipse.core.runtime.IProgressMonitor;
33 import org.eclipse.core.runtime.IStatus;
34 import org.eclipse.core.runtime.Path;
35 import org.eclipse.core.runtime.Status;
36 import org.eclipse.jface.dialogs.MessageDialog;
37 import org.eclipse.jface.operation.IRunnableWithProgress;
38 import org.eclipse.jface.text.templates.Template;
39 import org.eclipse.jface.viewers.ISelection;
40 import org.eclipse.jface.viewers.IStructuredSelection;
41 import org.eclipse.jface.wizard.Wizard;
42 import org.eclipse.ui.INewWizard;
43 import org.eclipse.ui.IWorkbench;
44 import org.eclipse.ui.IWorkbenchPage;
45 import org.eclipse.ui.IWorkbenchWizard;
46 import org.eclipse.ui.PartInitException;
47 import org.eclipse.ui.PlatformUI;
48 import org.eclipse.ui.ide.IDE;
49
50 /**
51  * This wizard creates one file with the extension "html".
52  */
53 public class HTMLFileWizard extends Wizard implements INewWizard {
54
55   private HTMLFileWizardPage page;
56
57   private ISelection selection;
58
59   // the name of the file to create
60   private String fFileName;
61
62   public HTMLFileWizard() {
63     super();
64     setNeedsProgressMonitor(true);
65   }
66
67   /**
68    * Adding the page to the wizard.
69    */
70   public void addPages() {
71     page = new HTMLFileWizardPage(selection);
72     addPage(page);
73   }
74
75   /**
76    * This method is called when 'Finish' button is pressed in the wizard. We will create an operation and run it using wizard as
77    * execution context.
78    */
79   public boolean performFinish() {
80     final String containerName = page.getContainerName();
81     final String fileName = page.getFileName();
82     IRunnableWithProgress op = new IRunnableWithProgress() {
83       public void run(IProgressMonitor monitor) throws InvocationTargetException {
84         try {
85           doFinish(containerName, fileName, monitor);
86         } catch (CoreException e) {
87           throw new InvocationTargetException(e);
88         } finally {
89           monitor.done();
90         }
91       }
92     };
93     try {
94       getContainer().run(true, false, op);
95     } catch (InterruptedException e) {
96       return false;
97     } catch (InvocationTargetException e) {
98       Throwable realException = e.getTargetException();
99       MessageDialog.openError(getShell(), PHPWizardMessages.getString("Wizard.error"), realException.getMessage());
100       return false;
101     }
102     return true;
103   }
104
105   /**
106    * The worker method. It will find the container, create the file if missing or just replace its contents, and open the editor on
107    * the newly created file.
108    */
109   private void doFinish(String containerName, String fileName, IProgressMonitor monitor) throws CoreException {
110     // create a sample file
111     monitor.beginTask(PHPWizardMessages.getString("Wizard.Monitor.creating") + " " + fileName, 2);
112     IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot();
113     IResource resource = root.findMember(new Path(containerName));
114     if (!resource.exists() || !(resource instanceof IContainer)) {
115       throwCoreException(PHPWizardMessages.getString("Wizard.Monitor.containerDoesNotExistException"));
116     }
117     IContainer container = (IContainer) resource;
118     final IFile file = container.getFile(new Path(fileName));
119     IProject project = file.getProject();
120     String projectName = project.getName();
121     try {
122       InputStream stream;
123       stream = openContentStream(fileName, projectName);
124       if (file.exists()) {
125         file.setContents(stream, true, true, monitor);
126       } else {
127         file.create(stream, true, monitor);
128       }
129       stream.close();
130     } catch (IOException e) {
131     }
132     monitor.worked(1);
133     monitor.setTaskName(PHPWizardMessages.getString("Wizard.Monitor.openingFile"));
134     getShell().getDisplay().asyncExec(new Runnable() {
135       public void run() {
136         IWorkbenchPage page = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage();
137         try {
138           IDE.openEditor(page, file, true);
139         } catch (PartInitException e) {
140         }
141       }
142     });
143     monitor.worked(1);
144   }
145
146   /**
147    * We will initialize file contents with a sample text.
148    */
149   private InputStream openContentStream(String fileName, String projectname) {
150     try {
151       Template template = PHPeclipsePlugin.getDefault().getCodeTemplateStore().findTemplate(CodeTemplateContextType.NEWHTML);
152       if (template == null) {
153         return null;
154       }
155       String lineDelimiter = System.getProperty("line.separator", "\n"); //$NON-NLS-1$ //$NON-NLS-2$
156       CodeTemplateContext context = new CodeTemplateContext(template.getContextTypeId(), null, lineDelimiter);
157       context.setFileNameVariable(fileName, projectname);
158       return new ByteArrayInputStream(StubUtility.evaluateTemplate(context, template).getBytes());
159     } catch (CoreException e) {
160       e.printStackTrace();
161       return null;
162     }
163   }
164
165   private void throwCoreException(String message) throws CoreException {
166     IStatus status = new Status(IStatus.ERROR, "net.sourceforge.phpeclipse.wizards", IStatus.OK, message, null);
167     throw new CoreException(status);
168   }
169
170   /**
171    * We will accept the selection in the workbench to see if we can initialize from it.
172    *
173    * @see IWorkbenchWizard#init(IWorkbench, IStructuredSelection)
174    */
175   public void init(IWorkbench workbench, IStructuredSelection selection) {
176     this.selection = selection;
177   }
178
179   /**
180    * Sets the name of the file to create (used to set the class name in the new file)
181    */
182   public void setFileName(String name) {
183     fFileName = name;
184   }
185 }