/*
 * Created on 09.08.2003
 *
 */
package net.sourceforge.phpdt.internal.ui.util;

import org.eclipse.core.resources.IFile;

/**
 * @author khartlage
 *
 */
public class PHPFileUtil {
  public final static char[] SUFFIX_php = ".php".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_PHP = ".PHP".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_php3 = ".php3".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_PHP3 = ".PHP3".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_php4 = ".php4".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_PHP4 = ".PHP4".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_php5 = ".php5".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_PHP5 = ".PHP5".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_phtml = ".phtml".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_PHTML = ".PHTML".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_module = ".module".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_MODULE = ".MODULE".toCharArray(); //$NON-NLS-1$
  
  public final static char[] SUFFIX_inc = ".inc".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_INC = ".INC".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_html = ".html".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_HTML = ".HTML".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_tpl = ".tpl".toCharArray(); //$NON-NLS-1$
  public final static char[] SUFFIX_TPL = ".TPL".toCharArray(); //$NON-NLS-1$

  public  static boolean isPHPFile(IFile file) {
    String extension = file.getFileExtension();
    return isPHPFileName(file.getLocation().toString());
  }

  /**
   * Returns true iff str.toLowerCase().endsWith(".php")
   * implementation is not creating extra strings.
   */
  public final static boolean isPHPFileName(String name) {
    return isPHP_FileName(name) || 
           isPHP3_FileName(name) || 
           isPHP4_FileName(name) ||  
           isPHP5_FileName(name) ||
           isModule_FileName(name) || 
           isPHTML_FileName(name) || 
           isINC_FileName(name);
  }
  
  /**
   * Returns true iff str.toLowerCase().endsWith(".php")
   * implementation is not creating extra strings.
   */
  private final static boolean isPHP_FileName(String name) {
    int nameLength = name == null ? 0 : name.length();
    int suffixLength = SUFFIX_PHP.length;
    if (nameLength < suffixLength)
      return false;

    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
      char c = name.charAt(offset + i);
      if (c != SUFFIX_php[i] && c != SUFFIX_PHP[i])
        return false;
    }
    return true;
  }

  /**
   * Returns true iff str.toLowerCase().endsWith(".php3")
   * implementation is not creating extra strings.
   */
  private final static boolean isPHP3_FileName(String name) {
    int nameLength = name == null ? 0 : name.length();
    int suffixLength = SUFFIX_PHP3.length;
    if (nameLength < suffixLength)
      return false;

    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
      char c = name.charAt(offset + i);
      if (c != SUFFIX_php3[i] && c != SUFFIX_PHP3[i])
        return false;
    }
    return true;
  }

  /**
   * Returns true iff str.toLowerCase().endsWith(".php4")
   * implementation is not creating extra strings.
   */
  private final static boolean isPHP4_FileName(String name) {
    int nameLength = name == null ? 0 : name.length();
    int suffixLength = SUFFIX_PHP4.length;
    if (nameLength < suffixLength)
      return false;

    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
      char c = name.charAt(offset + i);
      if (c != SUFFIX_php4[i] && c != SUFFIX_PHP4[i])
        return false;
    }
    return true;
  }

  /**
   * Returns true iff str.toLowerCase().endsWith(".php5")
   * implementation is not creating extra strings.
   */
  private final static boolean isPHP5_FileName(String name) {
    int nameLength = name == null ? 0 : name.length();
    int suffixLength = SUFFIX_PHP5.length;
    if (nameLength < suffixLength)
      return false;

    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
      char c = name.charAt(offset + i);
      if (c != SUFFIX_php5[i] && c != SUFFIX_PHP5[i])
        return false;
    }
    return true;
  }
  /**
   * Returns true iff str.toLowerCase().endsWith(".module")
   * implementation is not creating extra strings.
   */
  private final static boolean isModule_FileName(String name) {
    int nameLength = name == null ? 0 : name.length();
    int suffixLength = SUFFIX_MODULE.length;
    if (nameLength < suffixLength)
      return false;

    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
      char c = name.charAt(offset + i);
      if (c != SUFFIX_module[i] && c != SUFFIX_MODULE[i])
        return false;
    }
    return true;
  }
 /**
  * Returns true iff str.toLowerCase().endsWith(".phtml")
  * implementation is not creating extra strings.
  */
 private final static boolean isPHTML_FileName(String name) {
   int nameLength = name == null ? 0 : name.length();
   int suffixLength = SUFFIX_PHTML.length; 
   if (nameLength < suffixLength)
     return false;

   for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
     char c = name.charAt(offset + i);
     if (c != SUFFIX_phtml[i] && c != SUFFIX_PHTML[i])
       return false;
   }
   return true;
 }
  
  /**
   * Returns true iff str.toLowerCase().endsWith(".inc")
   * implementation is not creating extra strings.
   */
  private final static boolean isINC_FileName(String name) {
    int nameLength = name == null ? 0 : name.length();
    int suffixLength = SUFFIX_INC.length;
    if (nameLength < suffixLength)
      return false;

    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
      char c = name.charAt(offset + i);
      if (c != SUFFIX_inc[i] && c != SUFFIX_INC[i])
        return false;
    }
    return true;
  }
  
  /**
   * Returns true iff str.toLowerCase().endsWith(".html")
   * implementation is not creating extra strings.
   */
  public final static boolean isHTML_FileName(String name) {
    int nameLength = name == null ? 0 : name.length();
    int suffixLength = SUFFIX_HTML.length;
    if (nameLength < suffixLength)
      return false;

    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
      char c = name.charAt(offset + i);
      if (c != SUFFIX_html[i] && c != SUFFIX_HTML[i])
        return false;
    }
    return true;
  }
  /**
   * Returns true iff str.toLowerCase().endsWith(".tpl")
   * implementation is not creating extra strings.
   */
  public final static boolean isTPL_FileName(String name) {
    int nameLength = name == null ? 0 : name.length();
    int suffixLength = SUFFIX_TPL.length;
    if (nameLength < suffixLength)
      return false;

    for (int i = 0, offset = nameLength - suffixLength; i < suffixLength; i++) {
      char c = name.charAt(offset + i);
      if (c != SUFFIX_tpl[i] && c != SUFFIX_TPL[i])
        return false;
    }
    return true;
  }
  
  /**
	 * Returns true iff the file extension is a valid PHP Unit name
	 * implementation is not creating extra strings.
	 */
	public final static boolean isValidPHPUnitName(String filename) {
		return PHPFileUtil.isPHPFileName(filename) ||
		       PHPFileUtil.isHTML_FileName(filename) ||
			   PHPFileUtil.isTPL_FileName(filename);
	}
}