4b9f279df61d167000f81fcc4b0147224bcdf5be
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / util / PHPFileUtil.java
1 /*
2  * Created on 09.08.2003
3  *
4  */
5 package net.sourceforge.phpdt.internal.ui.util;
6
7 import org.eclipse.core.resources.IFile;
8
9 /**
10  * @author khartlage
11  *
12  */
13 public class PHPFileUtil {
14   public final static char[] SUFFIX_php = ".php".toCharArray(); //$NON-NLS-1$
15   public final static char[] SUFFIX_PHP = ".PHP".toCharArray(); //$NON-NLS-1$
16   public final static char[] SUFFIX_php3 = ".php3".toCharArray(); //$NON-NLS-1$
17   public final static char[] SUFFIX_PHP3 = ".PHP3".toCharArray(); //$NON-NLS-1$
18   public final static char[] SUFFIX_php4 = ".php4".toCharArray(); //$NON-NLS-1$
19   public final static char[] SUFFIX_PHP4 = ".PHP4".toCharArray(); //$NON-NLS-1$
20   public final static char[] SUFFIX_php5 = ".php5".toCharArray(); //$NON-NLS-1$
21   public final static char[] SUFFIX_PHP5 = ".PHP5".toCharArray(); //$NON-NLS-1$
22   public final static char[] SUFFIX_phtml = ".phtml".toCharArray(); //$NON-NLS-1$
23   public final static char[] SUFFIX_PHTML = ".PHTML".toCharArray(); //$NON-NLS-1$
24   
25   public final static char[] SUFFIX_inc = ".inc".toCharArray(); //$NON-NLS-1$
26   public final static char[] SUFFIX_INC = ".INC".toCharArray(); //$NON-NLS-1$
27   public final static char[] SUFFIX_html = ".html".toCharArray(); //$NON-NLS-1$
28   public final static char[] SUFFIX_HTML = ".HTML".toCharArray(); //$NON-NLS-1$
29   public final static char[] SUFFIX_tpl = ".tpl".toCharArray(); //$NON-NLS-1$
30   public final static char[] SUFFIX_TPL = ".TPL".toCharArray(); //$NON-NLS-1$
31
32   public  static boolean isPHPFile(IFile file) {
33     String extension = file.getFileExtension();
34     return isPHPFileName(file.getLocation().toString());
35   }
36
37   /**
38    * Returns true iff str.toLowerCase().endsWith(".php")
39    * implementation is not creating extra strings.
40    */
41   public final static boolean isPHPFileName(String name) {
42     return isPHP_FileName(name) || 
43            isPHP3_FileName(name) || 
44            isPHP4_FileName(name) || 
45            isPHP5_FileName(name) || 
46            isPHTML_FileName(name) || 
47            isINC_FileName(name);
48   }
49   //  static public boolean isPHPFile(String extension) {
50   //    if ("php".equalsIgnoreCase(extension)
51   //      || "php3".equalsIgnoreCase(extension)
52   //      || "php4".equalsIgnoreCase(extension)
53   //      || "inc".equalsIgnoreCase(extension)) {
54   //      return true;
55   //    }
56   //    return false;
57   //  }
58
59   /**
60    * Returns true iff str.toLowerCase().endsWith(".php")
61    * implementation is not creating extra strings.
62    */
63   private final static boolean isPHP_FileName(String name) {
64     int nameLength = name == null ? 0 : name.length();
65     int suffixLength = SUFFIX_PHP.length;
66     if (nameLength < suffixLength)
67       return false;
68
69     for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
70       char c = name.charAt(offset + i);
71       if (c != SUFFIX_php[i] && c != SUFFIX_PHP[i])
72         return false;
73     }
74     return true;
75   }
76
77   /**
78    * Returns true iff str.toLowerCase().endsWith(".php3")
79    * implementation is not creating extra strings.
80    */
81   private final static boolean isPHP3_FileName(String name) {
82     int nameLength = name == null ? 0 : name.length();
83     int suffixLength = SUFFIX_PHP3.length;
84     if (nameLength < suffixLength)
85       return false;
86
87     for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
88       char c = name.charAt(offset + i);
89       if (c != SUFFIX_php3[i] && c != SUFFIX_PHP3[i])
90         return false;
91     }
92     return true;
93   }
94
95   /**
96    * Returns true iff str.toLowerCase().endsWith(".php4")
97    * implementation is not creating extra strings.
98    */
99   private final static boolean isPHP4_FileName(String name) {
100     int nameLength = name == null ? 0 : name.length();
101     int suffixLength = SUFFIX_PHP4.length;
102     if (nameLength < suffixLength)
103       return false;
104
105     for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
106       char c = name.charAt(offset + i);
107       if (c != SUFFIX_php4[i] && c != SUFFIX_PHP4[i])
108         return false;
109     }
110     return true;
111   }
112
113   /**
114    * Returns true iff str.toLowerCase().endsWith(".php4")
115    * implementation is not creating extra strings.
116    */
117   private final static boolean isPHP5_FileName(String name) {
118     int nameLength = name == null ? 0 : name.length();
119     int suffixLength = SUFFIX_PHP5.length;
120     if (nameLength < suffixLength)
121       return false;
122
123     for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
124       char c = name.charAt(offset + i);
125       if (c != SUFFIX_php5[i] && c != SUFFIX_PHP5[i])
126         return false;
127     }
128     return true;
129   }
130   
131  /**
132   * Returns true iff str.toLowerCase().endsWith(".php4")
133   * implementation is not creating extra strings.
134   */
135  private final static boolean isPHTML_FileName(String name) {
136    int nameLength = name == null ? 0 : name.length();
137    int suffixLength = SUFFIX_PHTML.length;
138    if (nameLength < suffixLength)
139      return false;
140
141    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
142      char c = name.charAt(offset + i);
143      if (c != SUFFIX_phtml[i] && c != SUFFIX_PHTML[i])
144        return false;
145    }
146    return true;
147  }
148   
149   /**
150    * Returns true iff str.toLowerCase().endsWith(".inc")
151    * implementation is not creating extra strings.
152    */
153   private final static boolean isINC_FileName(String name) {
154     int nameLength = name == null ? 0 : name.length();
155     int suffixLength = SUFFIX_INC.length;
156     if (nameLength < suffixLength)
157       return false;
158
159     for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
160       char c = name.charAt(offset + i);
161       if (c != SUFFIX_inc[i] && c != SUFFIX_INC[i])
162         return false;
163     }
164     return true;
165   }
166   
167   /**
168    * Returns true iff str.toLowerCase().endsWith(".html")
169    * implementation is not creating extra strings.
170    */
171   public final static boolean isHTML_FileName(String name) {
172     int nameLength = name == null ? 0 : name.length();
173     int suffixLength = SUFFIX_HTML.length;
174     if (nameLength < suffixLength)
175       return false;
176
177     for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
178       char c = name.charAt(offset + i);
179       if (c != SUFFIX_html[i] && c != SUFFIX_HTML[i])
180         return false;
181     }
182     return true;
183   }
184   /**
185    * Returns true iff str.toLowerCase().endsWith(".tpl")
186    * implementation is not creating extra strings.
187    */
188   public final static boolean isTPL_FileName(String name) {
189     int nameLength = name == null ? 0 : name.length();
190     int suffixLength = SUFFIX_TPL.length;
191     if (nameLength < suffixLength)
192       return false;
193
194     for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
195       char c = name.charAt(offset + i);
196       if (c != SUFFIX_tpl[i] && c != SUFFIX_TPL[i])
197         return false;
198     }
199     return true;
200   }
201   
202   /**
203          * Returns true iff the file extension is a valid PHP Unit name
204          * implementation is not creating extra strings.
205          */
206         public final static boolean isValidPHPUnitName(String filename) {
207                 return PHPFileUtil.isPHPFileName(filename) ||
208                        PHPFileUtil.isHTML_FileName(filename) ||
209                            PHPFileUtil.isTPL_FileName(filename);
210         }
211 }